Skip navigation links

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

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

All Implemented Interfaces:

javax.faces.component.StateHolder

public class RichPanelStretchLayout

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

The panelStretchLayout component stretches the child in the center facet to fill all of available space. The available space may be constrained by the presence of other children in the top/bottom/start/end facets. When these children are present, they occupy space defined by the topHeight/bottomHeight and startWidth/endWidth attributes. <section name="Geometry_Management"> <html:ul> <html:li>This component can be stretched by a parent layout component that stretches its children. e.g., another panelStretchLayout, panelSplitter.</html:li> <html:li>This component uses <f:facet name="top">, <f:facet name="bottom">, <f:facet name="start">, <f:facet name="end">, and <f:facet name="center"> to organize content into each stretched panel. The contents of the facet may be stretched except when the height or width of the facet is set to "auto" via the topHeight, bottomHeight, startWidth, or endWidth attributes which would then cause that facet content to use its natural browser height or width. Examples of child components that can be stretched inside of the panelStretchLayout facets include: <html:ul> <html:li><af:decorativeBox></html:li> <html:li><af:panelAccordion></html:li> <html:li><af:panelBox></html:li> <html:li><af:panelCollection></html:li> <html:li><af:panelGroupLayout layout="scroll"></html:li> <html:li><af:panelGroupLayout layout="vertical"></html:li> <html:li><af:panelHeader></html:li> <html:li><af:panelSplitter></html:li> <html:li><af:panelStretchLayout></html:li> <html:li><af:panelTabbed></html:li> <html:li><af:region></html:li> <html:li><af:table></html:li> <html:li><af:tree></html:li> <html:li><af:treeTable></html:li> </html:ul> If you try to put a component inside of this component and that child component does not support being stretched, then the component hierarchy is illegal. To make it legal, you need to insert another intermediate component between this component and the child component. This intermediate component must support being stretched and must not stretch its children. An example of such a component that is commonly used for this purpose is <af:panelGroupLayout layout="scroll">. By using a wrapper like this, you create a flowing layout area where nothing will be stretched inside of it. Examples of components that do not support being stretched inside of these panelStretchLayout facets (and therefore need to be wrapped) include: <html:ul> <html:li><af:panelBorderLayout></html:li> <html:li><af:panelFormLayout></html:li> <html:li><af:panelGroupLayout layout="default"></html:li> <html:li><af:panelGroupLayout layout="horizontal"></html:li> <html:li><af:panelLabelAndMessage></html:li> <html:li><af:panelList></html:li> <html:li><trh:tableLayout></html:li> </html:ul> </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 events might include the width of a column that supported client-side resizing.

Field Summary

static java.lang.String	BOTTOM_FACET
static org.apache.myfaces.trinidad.bean.PropertyKey	BOTTOM_HEIGHT_KEY
static java.lang.String	BOTTOM_LANDMARK_BANNER
static java.lang.String	BOTTOM_LANDMARK_COMPLEMENTARY
static java.lang.String	BOTTOM_LANDMARK_CONTENTINFO
static org.apache.myfaces.trinidad.bean.PropertyKey	BOTTOM_LANDMARK_KEY
static java.lang.String	BOTTOM_LANDMARK_MAIN
static java.lang.String	BOTTOM_LANDMARK_NAVIGATION
static java.lang.String	BOTTOM_LANDMARK_NONE
static java.lang.String	BOTTOM_LANDMARK_SEARCH
static java.lang.String	CENTER_FACET
static java.lang.String	CENTER_LANDMARK_BANNER
static java.lang.String	CENTER_LANDMARK_COMPLEMENTARY
static java.lang.String	CENTER_LANDMARK_CONTENTINFO
static org.apache.myfaces.trinidad.bean.PropertyKey	CENTER_LANDMARK_KEY
static java.lang.String	CENTER_LANDMARK_MAIN
static java.lang.String	CENTER_LANDMARK_NAVIGATION
static java.lang.String	CENTER_LANDMARK_NONE
static java.lang.String	CENTER_LANDMARK_SEARCH
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 java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	CUSTOMIZATION_ID_KEY Deprecated.
static java.lang.String	END_FACET
static java.lang.String	END_LANDMARK_BANNER
static java.lang.String	END_LANDMARK_COMPLEMENTARY
static java.lang.String	END_LANDMARK_CONTENTINFO
static org.apache.myfaces.trinidad.bean.PropertyKey	END_LANDMARK_KEY
static java.lang.String	END_LANDMARK_MAIN
static java.lang.String	END_LANDMARK_NAVIGATION
static java.lang.String	END_LANDMARK_NONE
static java.lang.String	END_LANDMARK_SEARCH
static org.apache.myfaces.trinidad.bean.PropertyKey	END_WIDTH_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	INLINE_STYLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	PARTIAL_TRIGGERS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SHORT_DESC_KEY
static java.lang.String	START_FACET
static java.lang.String	START_LANDMARK_BANNER
static java.lang.String	START_LANDMARK_COMPLEMENTARY
static java.lang.String	START_LANDMARK_CONTENTINFO
static org.apache.myfaces.trinidad.bean.PropertyKey	START_LANDMARK_KEY
static java.lang.String	START_LANDMARK_MAIN
static java.lang.String	START_LANDMARK_NAVIGATION
static java.lang.String	START_LANDMARK_NONE
static java.lang.String	START_LANDMARK_SEARCH
static org.apache.myfaces.trinidad.bean.PropertyKey	START_WIDTH_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	STYLE_CLASS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	THEME_KEY Deprecated.
static java.lang.String	TOP_FACET
static org.apache.myfaces.trinidad.bean.PropertyKey	TOP_HEIGHT_KEY
static java.lang.String	TOP_LANDMARK_BANNER
static java.lang.String	TOP_LANDMARK_COMPLEMENTARY
static java.lang.String	TOP_LANDMARK_CONTENTINFO
static org.apache.myfaces.trinidad.bean.PropertyKey	TOP_LANDMARK_KEY
static java.lang.String	TOP_LANDMARK_MAIN
static java.lang.String	TOP_LANDMARK_NAVIGATION
static java.lang.String	TOP_LANDMARK_NONE
static java.lang.String	TOP_LANDMARK_SEARCH
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

bindings

Constructor Summary

	RichPanelStretchLayout() Construct an instance of the RichPanelStretchLayout.
protected	RichPanelStretchLayout(java.lang.String rendererType) Construct an instance of the RichPanelStretchLayout.

Method Summary

protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
javax.faces.component.UIComponent	getBottom() Content to be rendered below the center facet.
java.lang.String	getBottomHeight() Gets the height of the bottom facet specified as a CSS length or auto such that this facet will no longer be stretched and instead will consume the initial offsetHeight given to its children by the browser.
java.lang.String	getBottomLandmark() Gets Specifies the WAI-ARIA landmark role for the content of the bottom facet.
javax.faces.component.UIComponent	getCenter() Content to be stretched in the center of the layout.
java.lang.String	getCenterLandmark() Gets Specifies the WAI-ARIA landmark role for the content of the center facet.
java.util.Set	getClientAttributes() Gets a set of client attribute names.
ClientListenerSet	getClientListeners() Gets a set of client listeners.
java.lang.String	getCustomizationId() Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
javax.faces.component.UIComponent	getEnd() Content to be rendered after the center facet and between any top and bottom children.
java.lang.String	getEndLandmark() Gets Specifies the WAI-ARIA landmark role for the content of the end facet.
java.lang.String	getEndWidth() Gets the width of the end facet specified as a CSS length or auto such that this facet will no longer be stretched and instead will consume the initial offsetWidth given to its children by the browser.
java.lang.String	getFamily()
java.lang.String	getInlineStyle() Gets the CSS styles to use for this component.
java.lang.String[]	getPartialTriggers() Gets the IDs of the components that should trigger a partial update.
java.lang.String	getShortDesc() Gets the short description of the component.
javax.faces.component.UIComponent	getStart() Content to be rendered before the center facet and between any top and bottom children.
java.lang.String	getStartLandmark() Gets Specifies the WAI-ARIA landmark role for the content of the start facet.
java.lang.String	getStartWidth() Gets the width of the start facet specified as a CSS length or auto such that this facet will no longer be stretched and instead will consume the initial offsetWidth given to its children by the browser.
java.lang.String	getStyleClass() Gets a CSS style class to use for this component.
java.lang.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.
javax.faces.component.UIComponent	getTop() Content to be rendered above the center facet.
java.lang.String	getTopHeight() Gets the height of the top facet specified as a CSS length or auto such that this facet will no longer be stretched and instead will consume the initial offsetHeight given to its children by the browser.
java.lang.String	getTopLandmark() Gets Specifies the WAI-ARIA landmark role for the content of the top facet.
java.util.Set<java.lang.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	setBottom(javax.faces.component.UIComponent bottomFacet) Content to be rendered below the center facet.
void	setBottomHeight(java.lang.String bottomHeight) Sets the height of the bottom facet specified as a CSS length or auto such that this facet will no longer be stretched and instead will consume the initial offsetHeight given to its children by the browser.
void	setBottomLandmark(java.lang.String bottomLandmark) Sets Specifies the WAI-ARIA landmark role for the content of the bottom facet.
void	setCenter(javax.faces.component.UIComponent centerFacet) Content to be stretched in the center of the layout.
void	setCenterLandmark(java.lang.String centerLandmark) Sets Specifies the WAI-ARIA landmark role for the content of the center facet.
void	setClientAttributes(java.util.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(java.lang.String customizationId) Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
void	setEnd(javax.faces.component.UIComponent endFacet) Content to be rendered after the center facet and between any top and bottom children.
void	setEndLandmark(java.lang.String endLandmark) Sets Specifies the WAI-ARIA landmark role for the content of the end facet.
void	setEndWidth(java.lang.String endWidth) Sets the width of the end facet specified as a CSS length or auto such that this facet will no longer be stretched and instead will consume the initial offsetWidth given to its children by the browser.
void	setInlineStyle(java.lang.String inlineStyle) Sets the CSS styles to use for this component.
void	setPartialTriggers(java.lang.String[] partialTriggers) Sets the IDs of the components that should trigger a partial update.
void	setShortDesc(java.lang.String shortDesc) Sets the short description of the component.
void	setStart(javax.faces.component.UIComponent startFacet) Content to be rendered before the center facet and between any top and bottom children.
void	setStartLandmark(java.lang.String startLandmark) Sets Specifies the WAI-ARIA landmark role for the content of the start facet.
void	setStartWidth(java.lang.String startWidth) Sets the width of the start facet specified as a CSS length or auto such that this facet will no longer be stretched and instead will consume the initial offsetWidth given to its children by the browser.
void	setStyleClass(java.lang.String styleClass) Sets a CSS style class to use for this component.
void	setTheme(java.lang.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	setTop(javax.faces.component.UIComponent topFacet) Content to be rendered above the center facet.
void	setTopHeight(java.lang.String topHeight) Sets the height of the top facet specified as a CSS length or auto such that this facet will no longer be stretched and instead will consume the initial offsetHeight given to its children by the browser.
void	setTopLandmark(java.lang.String topLandmark) Sets Specifies the WAI-ARIA landmark role for the content of the top facet.
void	setUnsecure(java.util.Set<java.lang.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, addFacesListener, broadcast, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeAttributeChangeListener, removeFacesListener, restoreState, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, toString, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl

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

addPartialTarget, encodeFlattenedChild, encodeFlattenedChildren, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setUpEncodingContext, setupVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitTree, visitTree

Methods inherited from class javax.faces.component.UIComponent

getContainerClientId

Methods inherited from class java.lang.Object

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

Field Detail

TOP_LANDMARK_NONE

public static final java.lang.String TOP_LANDMARK_NONE

See Also:

Constant Field Values

TOP_LANDMARK_BANNER

public static final java.lang.String TOP_LANDMARK_BANNER

See Also:

Constant Field Values

TOP_LANDMARK_COMPLEMENTARY

public static final java.lang.String TOP_LANDMARK_COMPLEMENTARY

See Also:

Constant Field Values

TOP_LANDMARK_CONTENTINFO

public static final java.lang.String TOP_LANDMARK_CONTENTINFO

See Also:

Constant Field Values

TOP_LANDMARK_MAIN

public static final java.lang.String TOP_LANDMARK_MAIN

See Also:

Constant Field Values

TOP_LANDMARK_NAVIGATION

public static final java.lang.String TOP_LANDMARK_NAVIGATION

See Also:

Constant Field Values

TOP_LANDMARK_SEARCH

public static final java.lang.String TOP_LANDMARK_SEARCH

See Also:

Constant Field Values

START_LANDMARK_NONE

public static final java.lang.String START_LANDMARK_NONE

See Also:

Constant Field Values

START_LANDMARK_BANNER

public static final java.lang.String START_LANDMARK_BANNER

See Also:

Constant Field Values

START_LANDMARK_COMPLEMENTARY

public static final java.lang.String START_LANDMARK_COMPLEMENTARY

See Also:

Constant Field Values

START_LANDMARK_CONTENTINFO

public static final java.lang.String START_LANDMARK_CONTENTINFO

See Also:

Constant Field Values

START_LANDMARK_MAIN

public static final java.lang.String START_LANDMARK_MAIN

See Also:

Constant Field Values

START_LANDMARK_NAVIGATION

public static final java.lang.String START_LANDMARK_NAVIGATION

See Also:

Constant Field Values

START_LANDMARK_SEARCH

public static final java.lang.String START_LANDMARK_SEARCH

See Also:

Constant Field Values

CENTER_LANDMARK_NONE

public static final java.lang.String CENTER_LANDMARK_NONE

See Also:

Constant Field Values

CENTER_LANDMARK_BANNER

public static final java.lang.String CENTER_LANDMARK_BANNER

See Also:

Constant Field Values

CENTER_LANDMARK_COMPLEMENTARY

public static final java.lang.String CENTER_LANDMARK_COMPLEMENTARY

See Also:

Constant Field Values

CENTER_LANDMARK_CONTENTINFO

public static final java.lang.String CENTER_LANDMARK_CONTENTINFO

See Also:

Constant Field Values

CENTER_LANDMARK_MAIN

public static final java.lang.String CENTER_LANDMARK_MAIN

See Also:

Constant Field Values

CENTER_LANDMARK_NAVIGATION

public static final java.lang.String CENTER_LANDMARK_NAVIGATION

See Also:

Constant Field Values

CENTER_LANDMARK_SEARCH

public static final java.lang.String CENTER_LANDMARK_SEARCH

See Also:

Constant Field Values

END_LANDMARK_NONE

public static final java.lang.String END_LANDMARK_NONE

See Also:

Constant Field Values

END_LANDMARK_BANNER

public static final java.lang.String END_LANDMARK_BANNER

See Also:

Constant Field Values

END_LANDMARK_COMPLEMENTARY

public static final java.lang.String END_LANDMARK_COMPLEMENTARY

See Also:

Constant Field Values

END_LANDMARK_CONTENTINFO

public static final java.lang.String END_LANDMARK_CONTENTINFO

See Also:

Constant Field Values

END_LANDMARK_MAIN

public static final java.lang.String END_LANDMARK_MAIN

See Also:

Constant Field Values

END_LANDMARK_NAVIGATION

public static final java.lang.String END_LANDMARK_NAVIGATION

See Also:

Constant Field Values

END_LANDMARK_SEARCH

public static final java.lang.String END_LANDMARK_SEARCH

See Also:

Constant Field Values

BOTTOM_LANDMARK_NONE

public static final java.lang.String BOTTOM_LANDMARK_NONE

See Also:

Constant Field Values

BOTTOM_LANDMARK_BANNER

public static final java.lang.String BOTTOM_LANDMARK_BANNER

See Also:

Constant Field Values

BOTTOM_LANDMARK_COMPLEMENTARY

public static final java.lang.String BOTTOM_LANDMARK_COMPLEMENTARY

See Also:

Constant Field Values

BOTTOM_LANDMARK_CONTENTINFO

public static final java.lang.String BOTTOM_LANDMARK_CONTENTINFO

See Also:

Constant Field Values

BOTTOM_LANDMARK_MAIN

public static final java.lang.String BOTTOM_LANDMARK_MAIN

See Also:

Constant Field Values

BOTTOM_LANDMARK_NAVIGATION

public static final java.lang.String BOTTOM_LANDMARK_NAVIGATION

See Also:

Constant Field Values

BOTTOM_LANDMARK_SEARCH

public static final java.lang.String BOTTOM_LANDMARK_SEARCH

See Also:

Constant Field Values

TYPE

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

TOP_HEIGHT_KEY

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

BOTTOM_HEIGHT_KEY

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

START_WIDTH_KEY

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

END_WIDTH_KEY

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

TOP_LANDMARK_KEY

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

START_LANDMARK_KEY

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

CENTER_LANDMARK_KEY

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

END_LANDMARK_KEY

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

BOTTOM_LANDMARK_KEY

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

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.

CENTER_FACET

public static final java.lang.String CENTER_FACET

See Also:

Constant Field Values

TOP_FACET

public static final java.lang.String TOP_FACET

See Also:

Constant Field Values

BOTTOM_FACET

public static final java.lang.String BOTTOM_FACET

See Also:

Constant Field Values

START_FACET

public static final java.lang.String START_FACET

See Also:

Constant Field Values

END_FACET

public static final java.lang.String END_FACET

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

RichPanelStretchLayout

public RichPanelStretchLayout()

Construct an instance of the RichPanelStretchLayout.

RichPanelStretchLayout

protected RichPanelStretchLayout(java.lang.String rendererType)

Construct an instance of the RichPanelStretchLayout.

Method Detail

getCenter

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

Content to be stretched in the center of the layout.

setCenter

public final void setCenter(javax.faces.component.UIComponent centerFacet)

Content to be stretched in the center of the layout.

getTop

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

Content to be rendered above the center facet. If present and topHeight not specified, the height will be 50px.

setTop

public final void setTop(javax.faces.component.UIComponent topFacet)

Content to be rendered above the center facet. If present and topHeight not specified, the height will be 50px.

getBottom

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

Content to be rendered below the center facet. If present and bottomHeight not specified, the height will be 50px.

setBottom

public final void setBottom(javax.faces.component.UIComponent bottomFacet)

Content to be rendered below the center facet. If present and bottomHeight not specified, the height will be 50px.

getStart

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

Content to be rendered before the center facet and between any top and bottom children. If present and startWidth not specified, the width will be 50px.

setStart

public final void setStart(javax.faces.component.UIComponent startFacet)

Content to be rendered before the center facet and between any top and bottom children. If present and startWidth not specified, the width will be 50px.

getEnd

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

Content to be rendered after the center facet and between any top and bottom children. If present and endWidth not specified, the width will be 50px.

setEnd

public final void setEnd(javax.faces.component.UIComponent endFacet)

Content to be rendered after the center facet and between any top and bottom children. If present and endWidth not specified, the width will be 50px.

getTopHeight

public final java.lang.String getTopHeight()

Gets the height of the top facet specified as a CSS length or auto such that this facet will no longer be stretched and instead will consume the initial offsetHeight given to its children by the browser. It is important to note that in an average page, a switch to a layout using automatic heights exhibited a 10 percent degradation in initial layout speed in Internet Explorer and a 5 percent degradation in Firefox. Results will vary but it is recommended that you use this sparingly in order to optimize your page. Also an automatic height will cause the facet child to not be stretched both vertically and horizontally. If necessary, you can make that automatic height child stretch horizontally by specifying a 100% width in the inlineStyle of that child. Note that many components such as the panelGroupLayout with layout set to scroll or vertical will have their own built-in stretched widths by default.

Returns:

the new topHeight value

setTopHeight

public final void setTopHeight(java.lang.String topHeight)

Sets the height of the top facet specified as a CSS length or auto such that this facet will no longer be stretched and instead will consume the initial offsetHeight given to its children by the browser. It is important to note that in an average page, a switch to a layout using automatic heights exhibited a 10 percent degradation in initial layout speed in Internet Explorer and a 5 percent degradation in Firefox. Results will vary but it is recommended that you use this sparingly in order to optimize your page. Also an automatic height will cause the facet child to not be stretched both vertically and horizontally. If necessary, you can make that automatic height child stretch horizontally by specifying a 100% width in the inlineStyle of that child. Note that many components such as the panelGroupLayout with layout set to scroll or vertical will have their own built-in stretched widths by default.

Parameters:

topHeight - the new topHeight value

getBottomHeight

public final java.lang.String getBottomHeight()

Gets the height of the bottom facet specified as a CSS length or auto such that this facet will no longer be stretched and instead will consume the initial offsetHeight given to its children by the browser. It is important to note that in an average page, a switch to a layout using automatic heights exhibited a 10 percent degradation in initial layout speed in Internet Explorer and a 5 percent degradation in Firefox. Results will vary but it is recommended that you use this sparingly in order to optimize your page. Also an automatic height will cause the facet child to not be stretched both vertically and horizontally. If necessary, you can make that automatic height child stretch horizontally by specifying a 100% width in the inlineStyle of that child. Note that many components such as the panelGroupLayout with layout set to scroll or vertical will have their own built-in stretched widths by default.

Returns:

the new bottomHeight value

setBottomHeight

public final void setBottomHeight(java.lang.String bottomHeight)

Sets the height of the bottom facet specified as a CSS length or auto such that this facet will no longer be stretched and instead will consume the initial offsetHeight given to its children by the browser. It is important to note that in an average page, a switch to a layout using automatic heights exhibited a 10 percent degradation in initial layout speed in Internet Explorer and a 5 percent degradation in Firefox. Results will vary but it is recommended that you use this sparingly in order to optimize your page. Also an automatic height will cause the facet child to not be stretched both vertically and horizontally. If necessary, you can make that automatic height child stretch horizontally by specifying a 100% width in the inlineStyle of that child. Note that many components such as the panelGroupLayout with layout set to scroll or vertical will have their own built-in stretched widths by default.

Parameters:

bottomHeight - the new bottomHeight value

getStartWidth

public final java.lang.String getStartWidth()

Gets the width of the start facet specified as a CSS length or auto such that this facet will no longer be stretched and instead will consume the initial offsetWidth given to its children by the browser. It is important to note that in an average page, a switch to a layout using automatic widths exhibited a 10 percent degradation in initial layout speed in Internet Explorer and a 5 percent degradation in Firefox. Results will vary but it is recommended that you use this sparingly in order to optimize your page. Also an automatic width will cause the facet child to not be stretched both vertically and horizontally. Note that many components such as the panelGroupLayout with layout set to scroll or vertical will have their own built-in stretched widths by default which will then report an unstable offsetWidth so these components cannot be used in conjunction with auto. You may never use auto in conjunction with a child component that uses a percentage length for its width. The facet content cannot rely on percentage widths or be any component that would naturally consume the entire width of its surrounding container if you want auto to be effective. Instead, the contents must use a stable, stand-alone width (not dependent upon the width of its parent container) when auto is specified.

Returns:

the new startWidth value

setStartWidth

public final void setStartWidth(java.lang.String startWidth)

Sets the width of the start facet specified as a CSS length or auto such that this facet will no longer be stretched and instead will consume the initial offsetWidth given to its children by the browser. It is important to note that in an average page, a switch to a layout using automatic widths exhibited a 10 percent degradation in initial layout speed in Internet Explorer and a 5 percent degradation in Firefox. Results will vary but it is recommended that you use this sparingly in order to optimize your page. Also an automatic width will cause the facet child to not be stretched both vertically and horizontally. Note that many components such as the panelGroupLayout with layout set to scroll or vertical will have their own built-in stretched widths by default which will then report an unstable offsetWidth so these components cannot be used in conjunction with auto. You may never use auto in conjunction with a child component that uses a percentage length for its width. The facet content cannot rely on percentage widths or be any component that would naturally consume the entire width of its surrounding container if you want auto to be effective. Instead, the contents must use a stable, stand-alone width (not dependent upon the width of its parent container) when auto is specified.

Parameters:

startWidth - the new startWidth value

getEndWidth

public final java.lang.String getEndWidth()

Gets the width of the end facet specified as a CSS length or auto such that this facet will no longer be stretched and instead will consume the initial offsetWidth given to its children by the browser. It is important to note that in an average page, a switch to a layout using automatic widths exhibited a 10 percent degradation in initial layout speed in Internet Explorer and a 5 percent degradation in Firefox. Results will vary but it is recommended that you use this sparingly in order to optimize your page. Also an automatic width will cause the facet child to not be stretched both vertically and horizontally. Note that many components such as the panelGroupLayout with layout set to scroll or vertical will have their own built-in stretched widths by default which will then report an unstable offsetWidth so these components cannot be used in conjunction with auto. You may never use auto in conjunction with a child component that uses a percentage length for its width. The facet content cannot rely on percentage widths or be any component that would naturally consume the entire width of its surrounding container if you want auto to be effective. Instead, the contents must use a stable, stand-alone width (not dependent upon the width of its parent container) when auto is specified.

Returns:

the new endWidth value

setEndWidth

public final void setEndWidth(java.lang.String endWidth)

Sets the width of the end facet specified as a CSS length or auto such that this facet will no longer be stretched and instead will consume the initial offsetWidth given to its children by the browser. It is important to note that in an average page, a switch to a layout using automatic widths exhibited a 10 percent degradation in initial layout speed in Internet Explorer and a 5 percent degradation in Firefox. Results will vary but it is recommended that you use this sparingly in order to optimize your page. Also an automatic width will cause the facet child to not be stretched both vertically and horizontally. Note that many components such as the panelGroupLayout with layout set to scroll or vertical will have their own built-in stretched widths by default which will then report an unstable offsetWidth so these components cannot be used in conjunction with auto. You may never use auto in conjunction with a child component that uses a percentage length for its width. The facet content cannot rely on percentage widths or be any component that would naturally consume the entire width of its surrounding container if you want auto to be effective. Instead, the contents must use a stable, stand-alone width (not dependent upon the width of its parent container) when auto is specified.

Parameters:

endWidth - the new endWidth value

getTopLandmark

public final java.lang.String getTopLandmark()

Gets Specifies the WAI-ARIA landmark role for the content of the top facet.

Returns:

the new topLandmark value

setTopLandmark

public final void setTopLandmark(java.lang.String topLandmark)

Sets Specifies the WAI-ARIA landmark role for the content of the top facet.

Parameters:

topLandmark - the new topLandmark value

getStartLandmark

public final java.lang.String getStartLandmark()

Gets Specifies the WAI-ARIA landmark role for the content of the start facet.

Returns:

the new startLandmark value

setStartLandmark

public final void setStartLandmark(java.lang.String startLandmark)

Sets Specifies the WAI-ARIA landmark role for the content of the start facet.

Parameters:

startLandmark - the new startLandmark value

getCenterLandmark

public final java.lang.String getCenterLandmark()

Gets Specifies the WAI-ARIA landmark role for the content of the center facet.

Returns:

the new centerLandmark value

setCenterLandmark

public final void setCenterLandmark(java.lang.String centerLandmark)

Sets Specifies the WAI-ARIA landmark role for the content of the center facet.

Parameters:

centerLandmark - the new centerLandmark value

getEndLandmark

public final java.lang.String getEndLandmark()

Gets Specifies the WAI-ARIA landmark role for the content of the end facet.

Returns:

the new endLandmark value

setEndLandmark

public final void setEndLandmark(java.lang.String endLandmark)

Sets Specifies the WAI-ARIA landmark role for the content of the end facet.

Parameters:

endLandmark - the new endLandmark value

getBottomLandmark

public final java.lang.String getBottomLandmark()

Gets Specifies the WAI-ARIA landmark role for the content of the bottom facet.

Returns:

the new bottomLandmark value

setBottomLandmark

public final void setBottomLandmark(java.lang.String bottomLandmark)

Sets Specifies the WAI-ARIA landmark role for the content of the bottom facet.

Parameters:

bottomLandmark - the new bottomLandmark value

getInlineStyle

public final java.lang.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. 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(java.lang.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. 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 java.lang.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(java.lang.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 java.lang.String getShortDesc()

Gets 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. For components that support the helpTopicId attribute it is recommended that helpTopicId is used as it is more flexible and is more accessibility-compliant.

Returns:

the new shortDesc value

setShortDesc

public final void setShortDesc(java.lang.String shortDesc)

Sets 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. For components that support the helpTopicId attribute it is recommended that helpTopicId is used as it is more flexible and is more accessibility-compliant.

Parameters:

shortDesc - the new shortDesc value

getUnsecure

public final java.util.Set<java.lang.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.

Returns:

the new unsecure value

setUnsecure

public final void setUnsecure(java.util.Set<java.lang.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.

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 java.lang.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(java.lang.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 java.util.Set getClientAttributes()

Gets a set of client attribute names.

Returns:

the new clientAttributes value

setClientAttributes

public final void setClientAttributes(java.util.Set clientAttributes)

Sets a set of client attribute names.

Parameters:

clientAttributes - the new clientAttributes value

getPartialTriggers

public final java.lang.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(java.lang.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 java.lang.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 the children of this component. By default, this component is not styled for the different themes, but can be used to change the theme without associated skin changes that will occur with af:document and af:decorativeBox. Themes are not compatible with tonal styles and therefore only one method can be used per page (themes or tonal styles). A blank theme will remove the current theme, and a value of "inherit", 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", "light", and "default".

Returns:

the new theme value

setTheme

@Deprecated
public final void setTheme(java.lang.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 the children of this component. By default, this component is not styled for the different themes, but can be used to change the theme without associated skin changes that will occur with af:document and af:decorativeBox. Themes are not compatible with tonal styles and therefore only one method can be used per page (themes or tonal styles). A blank theme will remove the current theme, and a value of "inherit", 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", "light", and "default".

Parameters:

theme - the new theme value

getFamily

public java.lang.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