Skip navigation links

oracle.adf.view.rich.component.rich.layout
Class RichPanelFormLayout

java.lang.Object
javax.faces.component.UIComponent
org.apache.myfaces.trinidad.component.UIXComponent
org.apache.myfaces.trinidad.component.UIXComponentBase
org.apache.myfaces.trinidad.component.UIXPanel
oracle.adf.view.rich.component.rich.layout.RichPanelFormLayout

All Implemented Interfaces:

EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

public class RichPanelFormLayout

extends org.apache.myfaces.trinidad.component.UIXPanel

implements javax.faces.component.behavior.ClientBehaviorHolder

<html:p> 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. </html:p> <html:p> 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. </html:p> <html:p> When more complex field content is needed, use a panelLabelAndMessage around the content. </html:p> <html:p> 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 of buttons or fields. To align content with other labels and fields, use panelLabelAndMessage or use 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. </html:p> <section name="Grouping_Items_in_a_PanelFormLayout"> <html:p> PanelFormLayout supports grouping of its child components. If you place panelFormLayout children inside of a group, by default separators will be drawn around the group of items if adjacent to other form items. By default 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. </html:p> <html:p> By default visual group separators always appear (following the rules above). If you want a group but do not want the group separator to appear, you can set the group's startBoundary or endBoundary attributes to 'hide' to request that the corresponding boundary be hidden. Note that when a first group's endBoundary and a second group's startBoundary are both set, the separator will only be hidden if both values are set to 'hide' or one value is 'hide' while the other value is 'dontCare'. </html:p> <html:p> A group of items can also have a title, by setting the group's title attribute. Only groups that have their start boundaries displayed will show their title values. Note that you should use a group title that is not horizontally longer than the width of the current panelFormLayout column. If you choose a group title that is longer than the width of the panelFormLayout, the panelFormLayout will stretch horizontally to accommodate the title. </html:p> </section> <section name="Geometry_Management"> <html:ul> <html:li>If a panelFormLayout component gets stretched by its parent, it will automatically display scroll bars if the panelFormLayout contents do not fit within the allocated dimensions.</html:li> <html:li>This component does not stretch its children.</html:li> </html:ul> </section>

Events:

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 event might include the width of a column that supported client-side resizing.

Field Summary

static org.apache.myfaces.trinidad.bean.PropertyKey	CLIENT_ATTRIBUTES_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CLIENT_COMPONENT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CLIENT_LISTENERS_KEY
static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	CUSTOMIZATION_ID_KEY Deprecated.
static org.apache.myfaces.trinidad.bean.PropertyKey	FIELD_WIDTH_KEY
static String	FOOTER_FACET
static org.apache.myfaces.trinidad.bean.PropertyKey	INLINE_STYLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	LABEL_ALIGNMENT_KEY
static String	LABEL_ALIGNMENT_START
static String	LABEL_ALIGNMENT_TOP
static org.apache.myfaces.trinidad.bean.PropertyKey	LABEL_WIDTH_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	MAX_COLUMNS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	PARTIAL_TRIGGERS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	ROWS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SHORT_DESC_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	STYLE_CLASS_KEY
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	UNSECURE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	VISIBLE_KEY

Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

Fields inherited from class javax.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Constructor Summary

	RichPanelFormLayout() Construct an instance of the RichPanelFormLayout.
protected	RichPanelFormLayout(String rendererType) Construct an instance of the RichPanelFormLayout.

Method Summary

void	addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior)
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
Set	getClientAttributes() Gets a set of client attribute names.
Map<String,List<javax.faces.component.behavior.ClientBehavior>>	getClientBehaviors()
ClientListenerSet	getClientListeners() Gets a set of client listeners.
String	getCustomizationId() Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
String	getDefaultEventName()
Collection<String>	getEventNames()
String	getFamily()
String	getFieldWidth() Gets The preferred width of the fields.
javax.faces.component.UIComponent	getFooter() This facet is rendered under the columns and usually contains an af:group when you want to have more than a single item in the footer.
String	getInlineStyle() Gets the CSS styles to use for this component.
String	getLabelAlignment() Gets the alignment of label prompts for the form items.
String	getLabelWidth() Gets The preferred width of the labels.
int	getMaxColumns() Gets the maximum number of columns to show.
String[]	getPartialTriggers() Gets the IDs of the components that should trigger a partial update.
int	getRows() Gets the number of rows after which to start a new column.
String	getShortDesc() Gets the short description of the component.
String	getStyleClass() Gets a CSS style class to use for this component.
Set<String>	getUnsecure() Gets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client.
boolean	isClientComponent() Gets whether a client-side component will be generated.
boolean	isVisible() Gets the visibility of the component.
void	setClientAttributes(Set clientAttributes) Sets a set of client attribute names.
void	setClientComponent(boolean clientComponent) Sets whether a client-side component will be generated.
void	setClientListeners(ClientListenerSet clientListeners) Sets a set of client listeners.
void	setCustomizationId(String customizationId) Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
void	setFieldWidth(String fieldWidth) Sets The preferred width of the fields.
void	setFooter(javax.faces.component.UIComponent footerFacet) This facet is rendered under the columns and usually contains an af:group when you want to have more than a single item in the footer.
void	setInlineStyle(String inlineStyle) Sets the CSS styles to use for this component.
void	setLabelAlignment(String labelAlignment) Sets the alignment of label prompts for the form items.
void	setLabelWidth(String labelWidth) Sets The preferred width of the labels.
void	setMaxColumns(int maxColumns) Sets the maximum number of columns to show.
void	setPartialTriggers(String[] partialTriggers) Sets the IDs of the components that should trigger a partial update.
void	setRows(int rows) Sets the number of rows after which to start a new column.
void	setShortDesc(String shortDesc) Sets the short description of the component.
void	setStyleClass(String styleClass) Sets a CSS style class to use for this component.
void	setUnsecure(Set<String> unsecure) Sets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client.
void	setVisible(boolean visible) Sets the visibility of the component.

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcast, broadcastToMethodBinding, broadcastToMethodExpression, clearInitialState, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getComponentChangeFilters, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getListenersForEventClass, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, initialStateMarked, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeAttributeChangeListener, removeComponentChangeFilter, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setupFlattenedChildrenContext, setupFlattenedContext, setValueBinding, setValueExpression, subscribeToEvent, tearDownFlattenedChildrenContext, tearDownFlattenedContext, toString, unsubscribeFromEvent, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent

addPartialTarget, clearCachedClientIds, clearCachedClientIds, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, getStateHelper, getStateHelper, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setupChildrenEncodingContext, setupChildrenVisitingContext, setupEncodingContext, setUpEncodingContext, setupVisitingContext, tearDownChildrenEncodingContext, tearDownChildrenVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitAllChildren, visitChildren, visitChildren, visitTree, visitTree

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getTransientStateHelper, getTransientStateHelper, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

LABEL_ALIGNMENT_START

public static final String LABEL_ALIGNMENT_START

See Also:

Constant Field Values

LABEL_ALIGNMENT_TOP

public static final String LABEL_ALIGNMENT_TOP

See Also:

Constant Field Values

TYPE

public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE

INLINE_STYLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY

STYLE_CLASS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY

SHORT_DESC_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY

UNSECURE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey UNSECURE_KEY

VISIBLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey VISIBLE_KEY

CUSTOMIZATION_ID_KEY

@Deprecated
public static final org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY

Deprecated.

CLIENT_COMPONENT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_COMPONENT_KEY

CLIENT_ATTRIBUTES_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_ATTRIBUTES_KEY

PARTIAL_TRIGGERS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY

CLIENT_LISTENERS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_LISTENERS_KEY

FIELD_WIDTH_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey FIELD_WIDTH_KEY

LABEL_WIDTH_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey LABEL_WIDTH_KEY

MAX_COLUMNS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey MAX_COLUMNS_KEY

ROWS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey ROWS_KEY

LABEL_ALIGNMENT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey LABEL_ALIGNMENT_KEY

FOOTER_FACET

public static final String FOOTER_FACET

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

RichPanelFormLayout

public RichPanelFormLayout()

Construct an instance of the RichPanelFormLayout.

RichPanelFormLayout

protected RichPanelFormLayout(String rendererType)

Construct an instance of the RichPanelFormLayout.

Method Detail

getFooter

public final javax.faces.component.UIComponent getFooter()

This facet is rendered under the columns and usually contains an af:group when you want to have more than a single item in the footer.

This facet may not always line up perfectly, particularly if the labels or fields used in the panelFormLayout are longer than what you have allocated for them. Adjust the allocations you have with the labelWidth and fieldWidth attributes when necessary. Remember that labelWidth and fieldWidth must use the same units. Also, the columns attribute on inputText may be helpful to reduce the amount of space that it consumes. In JSP pages, only one component is allowed. When using Facelets, multiple components are allowed.

setFooter

public final void setFooter(javax.faces.component.UIComponent footerFacet)

This facet is rendered under the columns and usually contains an af:group when you want to have more than a single item in the footer.

This facet may not always line up perfectly, particularly if the labels or fields used in the panelFormLayout are longer than what you have allocated for them. Adjust the allocations you have with the labelWidth and fieldWidth attributes when necessary. Remember that labelWidth and fieldWidth must use the same units. Also, the columns attribute on inputText may be helpful to reduce the amount of space that it consumes. In JSP pages, only one component is allowed. When using Facelets, multiple components are allowed.

getInlineStyle

public final String getInlineStyle()

Gets 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. Be aware that because of browser CSS precedence rules, CSS rendered on a DOM element takes precedence over external stylesheets like the skin file. Therefore skins will not be able to override what you set on this attribute. 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.

Returns:

the new inlineStyle value

setInlineStyle

public final void setInlineStyle(String inlineStyle)

Sets 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. Be aware that because of browser CSS precedence rules, CSS rendered on a DOM element takes precedence over external stylesheets like the skin file. Therefore skins will not be able to override what you set on this attribute. 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.

Parameters:

inlineStyle - the new inlineStyle value

getStyleClass

public final String getStyleClass()

Gets 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'.

Returns:

the new styleClass value

setStyleClass

public final void setStyleClass(String styleClass)

Sets 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'.

Parameters:

styleClass - the new styleClass value

getShortDesc

public final String getShortDesc()

Gets the short description of the component. The shortDesc text may be used in two different ways, depending on the component.

For components with images, the shortDesc is often used to render an HTML alt attribute for the image. Please see the accessibility guidelines section for correct alt text usage of the shortDesc attribute.

shortDesc is also commonly used to render an HTML title attribute, which is used by user agents to display tooltip help text. In this 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. For components that support the helpTopicId attribute and are not using the shortDesc as image alt text, it is recommended that helpTopicId is used instead of shortDesc as it is more flexible and provides more accessible descriptive text than the use of the title attribute.

Returns:

the new shortDesc value

setShortDesc

public final void setShortDesc(String shortDesc)

Sets the short description of the component. The shortDesc text may be used in two different ways, depending on the component.

For components with images, the shortDesc is often used to render an HTML alt attribute for the image. Please see the accessibility guidelines section for correct alt text usage of the shortDesc attribute.

shortDesc is also commonly used to render an HTML title attribute, which is used by user agents to display tooltip help text. In this 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. For components that support the helpTopicId attribute and are not using the shortDesc as image alt text, it is recommended that helpTopicId is used instead of shortDesc as it is more flexible and provides more accessible descriptive text than the use of the title attribute.

Parameters:

shortDesc - the new shortDesc value

getUnsecure

public final Set<String> getUnsecure()

Gets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client. Currently, this is supported only for the "disabled" attribute. Note that when you are able to set a property on the client, you will be allowed to by using the the .setProperty('attribute', newValue) method, but not the .setXXXAttribute(newValue) method. For example, if you have unsecure="disabled", then on the client you can use the method .setProperty('disabled', false), while the method .setDisabled(false) will not work and will provide a javascript error that setDisabled is not a function.

Returns:

the new unsecure value

setUnsecure

public final void setUnsecure(Set<String> unsecure)

Sets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client. Currently, this is supported only for the "disabled" attribute. Note that when you are able to set a property on the client, you will be allowed to by using the the .setProperty('attribute', newValue) method, but not the .setXXXAttribute(newValue) method. For example, if you have unsecure="disabled", then on the client you can use the method .setProperty('disabled', false), while the method .setDisabled(false) will not work and will provide a javascript error that setDisabled is not a function.

Parameters:

unsecure - the new unsecure value

isVisible

public final boolean isVisible()

Gets 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.

Returns:

the new visible value

setVisible

public final void setVisible(boolean visible)

Sets 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.

Parameters:

visible - the new visible value

getCustomizationId

@Deprecated
public final String getCustomizationId()

Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.

Gets This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.

Returns:

the new customizationId value

setCustomizationId

@Deprecated
public final void setCustomizationId(String customizationId)

Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.

Sets This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.

Parameters:

customizationId - the new customizationId value

isClientComponent

public final boolean isClientComponent()

Gets 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.

Returns:

the new clientComponent value

setClientComponent

public final void setClientComponent(boolean clientComponent)

Sets 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.

Parameters:

clientComponent - the new clientComponent value

getClientAttributes

public final Set getClientAttributes()

Gets a set of client attribute names.

Returns:

the new clientAttributes value

setClientAttributes

public final void setClientAttributes(Set clientAttributes)

Sets a set of client attribute names.

Parameters:

clientAttributes - the new clientAttributes value

getPartialTriggers

public final String[] getPartialTriggers()

Gets 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.

Returns:

the new partialTriggers value

setPartialTriggers

public final void setPartialTriggers(String[] partialTriggers)

Sets 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.

Parameters:

partialTriggers - the new partialTriggers value

getClientListeners

public final ClientListenerSet getClientListeners()

Gets a set of client listeners.

Returns:

the new clientListeners value

setClientListeners

public final void setClientListeners(ClientListenerSet clientListeners)

Sets a set of client listeners.

Parameters:

clientListeners - the new clientListeners value

getFieldWidth

public final String getFieldWidth()

Gets The preferred width of the fields. The web browser may override this dimension if it cannot fit the fields in the space allocated. You may define the fieldWidth using any CSS unit such as em, px, or %. The units used for this value must be identical to the units used in the labelWidth value. If a fieldWidth is provided as a percentage the labelWidth and the fieldWidth should total up to 100% (regardless of the number of columns). If the fieldWidth is not specified, the browser will let the children components have a natural flowing layout which may mean that the footer facet contents do not line up with the main form items. However, if the fieldWidth is not specified but a labelWidth is specified as a percentage, the fieldWidth will be derived as the appropriate percentage value for you. Note that if you are using a percentage value, multiple columns, and a footer, you may see a slight offset between the positioning of the main form items and the footer items in some web browsers if that browser does not honor fractional divisions of percentages. To minimize this effect, it is recommended that a percentage labelWidth be evenly divisible by the number of columns.

Returns:

the new fieldWidth value

setFieldWidth

public final void setFieldWidth(String fieldWidth)

Sets The preferred width of the fields. The web browser may override this dimension if it cannot fit the fields in the space allocated. You may define the fieldWidth using any CSS unit such as em, px, or %. The units used for this value must be identical to the units used in the labelWidth value. If a fieldWidth is provided as a percentage the labelWidth and the fieldWidth should total up to 100% (regardless of the number of columns). If the fieldWidth is not specified, the browser will let the children components have a natural flowing layout which may mean that the footer facet contents do not line up with the main form items. However, if the fieldWidth is not specified but a labelWidth is specified as a percentage, the fieldWidth will be derived as the appropriate percentage value for you. Note that if you are using a percentage value, multiple columns, and a footer, you may see a slight offset between the positioning of the main form items and the footer items in some web browsers if that browser does not honor fractional divisions of percentages. To minimize this effect, it is recommended that a percentage labelWidth be evenly divisible by the number of columns.

Parameters:

fieldWidth - the new fieldWidth value

getLabelWidth

public final String getLabelWidth()

Gets The preferred width of the labels. The web browser may override this dimension if it cannot fit the labels in the space allocated. You may define the labelWidth using any CSS unit such as em, px, or %. The units used for this value must be identical to the units used in the fieldWidth value. If a labelWidth is provided as a percentage the labelWidth and the fieldWidth should total up to 100% (regardless of the number of columns). If the labelWidth is not specified, the browser will let the children components have a natural flowing layout which may mean that the footer facet contents do not line up with the main form items. However, if the labelWidth is not specified but a fieldWidth is specified as a percentage, the labelWidth will be derived as the appropriate percentage value for you. Note that if you are using a percentage value, multiple columns, and a footer, you may see a slight offset between the positioning of the main form items and the footer items in some web browsers if that browser does not honor fractional divisions of percentages. To minimize this effect, it is recommended that a percentage labelWidth be evenly divisible by the number of columns.

Returns:

the new labelWidth value

setLabelWidth

public final void setLabelWidth(String labelWidth)

Sets The preferred width of the labels. The web browser may override this dimension if it cannot fit the labels in the space allocated. You may define the labelWidth using any CSS unit such as em, px, or %. The units used for this value must be identical to the units used in the fieldWidth value. If a labelWidth is provided as a percentage the labelWidth and the fieldWidth should total up to 100% (regardless of the number of columns). If the labelWidth is not specified, the browser will let the children components have a natural flowing layout which may mean that the footer facet contents do not line up with the main form items. However, if the labelWidth is not specified but a fieldWidth is specified as a percentage, the labelWidth will be derived as the appropriate percentage value for you. Note that if you are using a percentage value, multiple columns, and a footer, you may see a slight offset between the positioning of the main form items and the footer items in some web browsers if that browser does not honor fractional divisions of percentages. To minimize this effect, it is recommended that a percentage labelWidth be evenly divisible by the number of columns.

Parameters:

labelWidth - the new labelWidth value

getMaxColumns

public final int getMaxColumns()

Gets 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.

Returns:

the new maxColumns value

setMaxColumns

public final void setMaxColumns(int maxColumns)

Sets 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.

Parameters:

maxColumns - the new maxColumns value

getRows

public final int getRows()

Gets the number of rows after which to start a new column. The number of rows actually rendered depends also on the "maxColumns" attribute. When the number of children rendered equals the rows value, the next child is rendered in the next column. If the children will not fit in the given number of rows and columns, the number of rows will increase to accommodate the children. When left blank, rows defaults to the maximum integer value.

Returns:

the new rows value

setRows

public final void setRows(int rows)

Sets the number of rows after which to start a new column. The number of rows actually rendered depends also on the "maxColumns" attribute. When the number of children rendered equals the rows value, the next child is rendered in the next column. If the children will not fit in the given number of rows and columns, the number of rows will increase to accommodate the children. When left blank, rows defaults to the maximum integer value.

Parameters:

rows - the new rows value

getLabelAlignment

public final String getLabelAlignment()

Gets the alignment of label prompts for the form items.

Returns:

the new labelAlignment value

setLabelAlignment

public final void setLabelAlignment(String labelAlignment)

Sets the alignment of label prompts for the form items.

Parameters:

labelAlignment - the new labelAlignment value

getDefaultEventName

public String getDefaultEventName()

Specified by:

getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getDefaultEventName in class org.apache.myfaces.trinidad.component.UIXComponentBase

getEventNames

public Collection<String> getEventNames()

Specified by:

getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder

getClientBehaviors

public Map<String,List<javax.faces.component.behavior.ClientBehavior>> getClientBehaviors()

Specified by:

getClientBehaviors in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getClientBehaviors in class org.apache.myfaces.trinidad.component.UIXComponentBase

addClientBehavior

public void addClientBehavior(String eventName,
                              javax.faces.component.behavior.ClientBehavior behavior)

Specified by:

addClientBehavior in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

addClientBehavior in class org.apache.myfaces.trinidad.component.UIXComponentBase

getFamily

public String getFamily()

Overrides:

getFamily in class org.apache.myfaces.trinidad.component.UIXPanel

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()

Overrides:

getBeanType in class org.apache.myfaces.trinidad.component.UIXPanel

Skip navigation links