UIComponent class: oracle.adf.view.rich.component.rich.layout.RichPanelFormLayout
Component type: oracle.adf.RichPanelFormLayout
The panelFormLayout positions input form controls, such that their labels and fields line up vertically. It supports multiple columns, and also supports a footer facet.
Usually, this component will simply contain labelled ADF Faces input components in its main content. This includes components whose names start with 'input' (like inputText and inputDate) and components that start with 'select' (like selectOneChoice, selectBooleanRadio, and selectManyChoice). These components must have their 'simple' attribute set to false, which is the default, and will cause the labels and fields inside the panelFormLayout to be aligned vertically.
When more complex field content is needed, use a panelLabelAndMessage around the content.
Other components can be added to panelFormLayout, but they will not line up with labels and fields automatically, and each will appear on its own row. You can use other panel components, like a horizontal layout panelGroupLayout, to layout a row. To align content with other labels and fields, use panelLabelAndMessage or the 'footer' facet. You may also alternatively place a facetRef, iterator, or switcher inside of the panelFormLayout and their resolved children will be treated as if they were direct children of the panelFormLayout.
PanelFormLayout supports grouping of its child components. If you place panelFormLayout children inside of a group, separators will be drawn around the group of items if adjacent to other form items. Separators won't be drawn at the top if the group is the first item in the column or, at the bottom if the group is the last item in the column. Grouped panelFormLayout items are kept in the same column of the panelFormLayout even when the assigned rows attribute is set to a value smaller than the number of items in the group. The panelFormLayout component also supports the group component in its footer facet so you can place more than one item in the footer. You can group footer items one additional time to get separators to appear.
<section name="Geometry_Management">
</section>
| Type | Phases | Description |
|---|---|---|
| org.apache.myfaces.trinidad.event.AttributeChangeEvent | Invoke Application, Apply Request Values |
Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing. |
| Name | Description |
|---|---|
| footer | This facet is rendered under the columns and usually contains an af:group.
This facet may not always line up perfectly, especially if the labels or fields are longer than expected. Try adjusting things with the labelWidth and fieldWidth attributes when necessary. Also, the columns attribute on inputText may be helpful. |
| Name | Type | Supports EL? | Description |
|---|---|---|---|
| attributeChangeListener | javax.el.MethodExpression | Only EL | a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing. |
| binding | oracle.adf.view.rich.component.<wbr/>rich.layout.RichPanelFormLayout | Only EL | an EL reference that will store the component instance on a bean. This can be used to give programmatic access to a component from a backing bean, or to move creation of the component to a backing bean. |
| clientComponent | boolean | Yes | whether a client-side component will be generated. A component may be generated whether or not this flag is set, but if client Javascript requires the component object, this must be set to true to guarantee the component's presence. Client component objects that are generated today by default may not be present in the future; setting this flag is the only way to guarantee a component's presence, and clients cannot rely on implicit behavior. However, there is a performance cost to setting this flag, so clients should avoid turning on client components unless absolutely necessary. |
| customizationId | String | Yes | The id used to locate this component when applying persistent customizations. Components without a customizationId set can not save customizations to the persistent store. Instead, any customizations will at most only apply to the current Session. Each customizationId must be unique in the document. |
| fieldWidth | String | Yes | the preferred width of the field. Usually a percentage, but may be specified as either a percentage or an absolute number of pixels. If the width is not specified, it will default appropriately. If specified as a percentage the labelWidth plus the fieldWidth should add up to 100%, regardless of the number of columns. If the fieldWidth is specified and is a percentage the labelWidth will be derived appropriately if not specified. |
| id | String | No | the identifier for the component. The identifier must follow a subset of the syntax allowed in HTML:
|
| inlineStyle | String | Yes | the CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. If the inlineStyle's CSS properties do not affect the DOM element you want affected, then you will have to create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style. |
| labelAlignment | String | Yes | Valid Values: start, top the alignment of label prompts for the form items. |
| labelWidth | String | Yes | the preferred width of the label. Usually a percentage, but may be specified as either a percentage or an absolute number of pixels. If the width is not specified, it will default appropriately. If specified as a percentage the labelWidth plus the fieldWidth should add up to 100%, regardless of the number of columns. If the labelWidth is specified and is a percentage the fieldWidth will be derived appropriately if not specified. |
| maxColumns | int | Yes | the maximum number of columns to show. This attribute defaults to 3 and 2 on PDAs. If this panelFormLayout is inside of another panelFormLayout, this will always be 1. |
| partialTriggers | String[] | Yes | the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too. Identifiers are relative to the source component (this component), and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root of the page, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc. |
| rendered | boolean | Yes | whether the component is rendered. When set to false, no output will be delivered for this component (the component will not in any way be rendered, and cannot be made visible on the client). |
| rows | int | Yes | the number of rows after which to start a new column. This attribute defaults to Integer.MAX_VALUE. The number of rows actually rendered depends also on the "maxColumns" property. If the children will not fit in the given number of rows and columns, the number of rows will increase to accomodate the children. |
| shortDesc | String | Yes | the short description of the component. This text is commonly used by user agents to display tooltip help text, in which case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window. |
| styleClass | String | Yes | a CSS style class to use for this component. The style class can be defined in your jspx page or in a skinning CSS file, for example, or you can use one of our public style classes, like 'AFInstructionText'. |
| visible | boolean | Yes | the visibility of the component. If it is "false", the component will be hidden on the client. Unlike "rendered", this does not affect the lifecycle on the server - the component may have its bindings executed, etc. - and the visibility of the component can be toggled on and off on the client, or toggled with PPR. When "rendered" is false, the component will not in any way be rendered, and cannot be made visible on the client. In most cases, use the "rendered" property instead of the "visible" property. Not supported on the following renderkits: org.apache.myfaces.trinidad.core |