Skip navigation links

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

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

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 RichPanelGroupLayout

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

implements javax.faces.component.behavior.ClientBehaviorHolder

The panelGroupLayout control is a layout element that arranges its children in one of a few simple patterns. Each pair of adjacent children will be separated by an optional separator child. It can lay out children consecutively (wrapping as needed), or in a single horizontal line, or vertically. <p/> Note about stretching layouts and flowing/scrolling layouts: <p/> With today's web browsers, it is not reliable to have vertically-stretched content inside of areas that also have scroll bars. If you want the outer areas of your page structure to stretch, you need to be careful of how you assemble your component tree.

• First, build up a structure of stretchable components (using panelSplitters and panelStretchLayouts).
• Second, inside of this structure, create islands of non-stretched content. These islands should be rooted with panelGroupLayouts with layout="scroll". This is an ideal component because it can be stretched and does not stretch its children--which likely don't support being stretched anyway.

Rules of thumb:

1. Never place a scrolling panelGroupLayout inside of another scrolling panelGroupLayout since users do not like nested scroll bars.
2. Never specify percentage heights in any component's inlineStyle attribute.
3. Never use the "position" style in any component's inlineStyle attribute.
4. Unless you are using fixed pixel heights on them, you would never place a panelSplitter or panelStretchLayout inside of any panelGroupLayout regardless of what you have set its layout attribute to.

If you believe that you need to break one of these rules, this is an indication that your page structure is not following the page structure guidelines and you will likely have troubles getting your application to render consistently across various web browsers and computing platforms.

• For specific details of about component stretching, please see the "geometry management" section in the tag documentation of each component.
• See the demo application for real world layout examples that you can use as a starting point in your application. A good starting point is the "Layout Basics" page listed under the "Framework Features" tab of the demo application.

<p/> You may also alternatively place a facetRef, iterator, or switcher inside of the panelGroupLayout and their resolved children will be treated as if they were direct children of the panelGroupLayout. If you don't want this behavior, you may wrap the children you want to be grouped in a group component. <section name="Geometry_Management"> <html:ul> <html:li>This component can be stretched by a parent layout component that stretches its children, e.g. panelStretchLayout if: <html:ul> <html:li>layout="scroll"</html:li> <html:li>layout="vertical"</html:li> </html:ul> </html:li> <html:li>This component cannot be stretched by a parent layout component that stretches its children if: <html:ul> <html:li>layout="default"</html:li> <html:li>layout="horizontal"</html:li> </html:ul> </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 String	HALIGN_CENTER
static String	HALIGN_END
static org.apache.myfaces.trinidad.bean.PropertyKey	HALIGN_KEY
static String	HALIGN_LEFT
static String	HALIGN_RIGHT
static String	HALIGN_START
static org.apache.myfaces.trinidad.bean.PropertyKey	INLINE_STYLE_KEY
static String	LANDMARK_BANNER
static String	LANDMARK_COMPLEMENTARY
static String	LANDMARK_CONTENTINFO
static org.apache.myfaces.trinidad.bean.PropertyKey	LANDMARK_KEY
static String	LANDMARK_MAIN
static String	LANDMARK_NAVIGATION
static String	LANDMARK_NONE
static String	LANDMARK_SEARCH
static String	LAYOUT_DEFAULT
static String	LAYOUT_HORIZONTAL
static org.apache.myfaces.trinidad.bean.PropertyKey	LAYOUT_KEY
static String	LAYOUT_SCROLL
static String	LAYOUT_VERTICAL
static org.apache.myfaces.trinidad.bean.PropertyKey	PARTIAL_TRIGGERS_KEY
static String	SEPARATOR_FACET
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.PropertyKey	THEME_KEY Deprecated.
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	UNSECURE_KEY
static String	VALIGN_BASELINE
static String	VALIGN_BOTTOM
static org.apache.myfaces.trinidad.bean.PropertyKey	VALIGN_KEY
static String	VALIGN_MIDDLE
static String	VALIGN_TOP
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

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

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	getHalign() Gets the horizontal alignment for horizontal, vertical and scroll layouts.
String	getInlineStyle() Gets the CSS styles to use for this component.
String	getLandmark() Gets Specifies the WAI-ARIA landmark role for this panelGroupLayout.
String	getLayout() Gets the type of layout.
String[]	getPartialTriggers() Gets the IDs of the components that should trigger a partial update.
javax.faces.component.UIComponent	getSeparator() Content to be rendered once between each of the other children.
String	getShortDesc() Gets the short description of the component.
String	getStyleClass() Gets a CSS style class to use for this component.
String	getTheme() Deprecated. The theme attribute on af:panelGroupLayout and af:panelStretchLayout is deprecated. (It will be kept around until ER 7480937 is implemented.) Ideally, only the theme attribute of the af:decorativeBox and af:document tags should be needed.
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.
String	getValign() Gets the vertical alignment of a horizontal layout.
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	setHalign(String halign) Sets the horizontal alignment for horizontal, vertical and scroll layouts.
void	setInlineStyle(String inlineStyle) Sets the CSS styles to use for this component.
void	setLandmark(String landmark) Sets Specifies the WAI-ARIA landmark role for this panelGroupLayout.
void	setLayout(String layout) Sets the type of layout.
void	setPartialTriggers(String[] partialTriggers) Sets the IDs of the components that should trigger a partial update.
void	setSeparator(javax.faces.component.UIComponent separatorFacet) Content to be rendered once between each of the other children.
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	setTheme(String theme) Deprecated. The theme attribute on af:panelGroupLayout and af:panelStretchLayout is deprecated. (It will be kept around until ER 7480937 is implemented.) Ideally, only the theme attribute of the af:decorativeBox and af:document tags should be needed.
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	setValign(String valign) Sets the vertical alignment of a horizontal layout.
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

LAYOUT_DEFAULT

public static final String LAYOUT_DEFAULT

See Also:

Constant Field Values

LAYOUT_HORIZONTAL

public static final String LAYOUT_HORIZONTAL

See Also:

Constant Field Values

LAYOUT_VERTICAL

public static final String LAYOUT_VERTICAL

See Also:

Constant Field Values

LAYOUT_SCROLL

public static final String LAYOUT_SCROLL

See Also:

Constant Field Values

VALIGN_MIDDLE

public static final String VALIGN_MIDDLE

See Also:

Constant Field Values

VALIGN_TOP

public static final String VALIGN_TOP

See Also:

Constant Field Values

VALIGN_BOTTOM

public static final String VALIGN_BOTTOM

See Also:

Constant Field Values

VALIGN_BASELINE

public static final String VALIGN_BASELINE

See Also:

Constant Field Values

HALIGN_START

public static final String HALIGN_START

See Also:

Constant Field Values

HALIGN_CENTER

public static final String HALIGN_CENTER

See Also:

Constant Field Values

HALIGN_END

public static final String HALIGN_END

See Also:

Constant Field Values

HALIGN_LEFT

public static final String HALIGN_LEFT

See Also:

Constant Field Values

HALIGN_RIGHT

public static final String HALIGN_RIGHT

See Also:

Constant Field Values

LANDMARK_NONE

public static final String LANDMARK_NONE

See Also:

Constant Field Values

LANDMARK_BANNER

public static final String LANDMARK_BANNER

See Also:

Constant Field Values

LANDMARK_COMPLEMENTARY

public static final String LANDMARK_COMPLEMENTARY

See Also:

Constant Field Values

LANDMARK_CONTENTINFO

public static final String LANDMARK_CONTENTINFO

See Also:

Constant Field Values

LANDMARK_MAIN

public static final String LANDMARK_MAIN

See Also:

Constant Field Values

LANDMARK_NAVIGATION

public static final String LANDMARK_NAVIGATION

See Also:

Constant Field Values

LANDMARK_SEARCH

public static final String LANDMARK_SEARCH

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

THEME_KEY

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

Deprecated.

LAYOUT_KEY

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

VALIGN_KEY

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

HALIGN_KEY

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

LANDMARK_KEY

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

SEPARATOR_FACET

public static final String SEPARATOR_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

RichPanelGroupLayout

public RichPanelGroupLayout()

Construct an instance of the RichPanelGroupLayout.

RichPanelGroupLayout

protected RichPanelGroupLayout(String rendererType)

Construct an instance of the RichPanelGroupLayout.

Method Detail

getSeparator

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

Content to be rendered once between each of the other children. In JSP pages, only one component is allowed. When using Facelets, multiple components are allowed.

setSeparator

public final void setSeparator(javax.faces.component.UIComponent separatorFacet)

Content to be rendered once between each of the other children. 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

getTheme

@Deprecated
public final String getTheme()

Deprecated. The theme attribute on af:panelGroupLayout and af:panelStretchLayout is deprecated. (It will be kept around until ER 7480937 is implemented.) Ideally, only the theme attribute of the af:decorativeBox and af:document tags should be needed.

Gets The component style theme to apply to this component. Themes are cascaded down through all child components. All HTML elements that are rendered by a rich component within a themed component will have the theme applied to its DOM. Themes are not compatible with tonal styles and therefore only one method can be used per page (themes or tonal styles). A blank theme (theme="") or a theme of "default" will remove the current theme (from the component as well as the children of the current component), and a value of "inherit", null (specified as theme="#{null}"), or not setting a theme will use the current theme. Skins are the sources of the the themes. Some skins may have no themed definitions. Suggested theme names include "dark", "medium" and "light".

Returns:

the new theme value

setTheme

@Deprecated
public final void setTheme(String theme)

Deprecated. The theme attribute on af:panelGroupLayout and af:panelStretchLayout is deprecated. (It will be kept around until ER 7480937 is implemented.) Ideally, only the theme attribute of the af:decorativeBox and af:document tags should be needed.

Sets The component style theme to apply to this component. Themes are cascaded down through all child components. All HTML elements that are rendered by a rich component within a themed component will have the theme applied to its DOM. Themes are not compatible with tonal styles and therefore only one method can be used per page (themes or tonal styles). A blank theme (theme="") or a theme of "default" will remove the current theme (from the component as well as the children of the current component), and a value of "inherit", null (specified as theme="#{null}"), or not setting a theme will use the current theme. Skins are the sources of the the themes. Some skins may have no themed definitions. Suggested theme names include "dark", "medium" and "light".

Parameters:

theme - the new theme value

getLayout

public final String getLayout()

Gets the type of layout. Acceptable values include:

• "default": consecutive layout as defined by the browser, with wrapping allowed, and following the bidirectional layout algorithm. As a result, in the presence of mixed right-to-left and left-to-right text, contents may not display consecutively.
• "horizontal": strictly consecutive without wrapping
• "vertical": vertically stacked
• "scroll": vertical, with scrollbars displayed if content overflows (this layout option is only intended for cases where the panelGroupLayout is being stretched such as when inside of a decorativeBox, panelSplitter, panelStretchLayout, or showDetailItem with stretchChildren set to first)

Returns:

the new layout value

setLayout

public final void setLayout(String layout)

Sets the type of layout. Acceptable values include:

• "default": consecutive layout as defined by the browser, with wrapping allowed, and following the bidirectional layout algorithm. As a result, in the presence of mixed right-to-left and left-to-right text, contents may not display consecutively.
• "horizontal": strictly consecutive without wrapping
• "vertical": vertically stacked
• "scroll": vertical, with scrollbars displayed if content overflows (this layout option is only intended for cases where the panelGroupLayout is being stretched such as when inside of a decorativeBox, panelSplitter, panelStretchLayout, or showDetailItem with stretchChildren set to first)

Parameters:

layout - the new layout value

getValign

public final String getValign()

Gets the vertical alignment of a horizontal layout. This is ignored if "layout" is not "horizontal".

Returns:

the new valign value

setValign

public final void setValign(String valign)

Sets the vertical alignment of a horizontal layout. This is ignored if "layout" is not "horizontal".

Parameters:

valign - the new valign value

getHalign

public final String getHalign()

Gets the horizontal alignment for horizontal, vertical and scroll layouts. This is ignored if "layout" is "default". Note that if "layout" is "horizontal", the browsers can only reliably handle horizontal alignment of components that have either fixed widths or that are "inline" such as outputText.

Returns:

the new halign value

setHalign

public final void setHalign(String halign)

Sets the horizontal alignment for horizontal, vertical and scroll layouts. This is ignored if "layout" is "default". Note that if "layout" is "horizontal", the browsers can only reliably handle horizontal alignment of components that have either fixed widths or that are "inline" such as outputText.

Parameters:

halign - the new halign value

getLandmark

public final String getLandmark()

Gets Specifies the WAI-ARIA landmark role for this panelGroupLayout.

Returns:

the new landmark value

setLandmark

public final void setLandmark(String landmark)

Sets Specifies the WAI-ARIA landmark role for this panelGroupLayout.

Parameters:

landmark - the new landmark 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