<af:panelStretchLayout>

af:panelStretchLayout panelStretchLayout panel stretch layout

UIComponent class: oracle.adf.view.rich.component.rich.layout.RichPanelStretchLayout
Component type: oracle.adf.RichPanelStretchLayout

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.

Geometry Management

There are other ways in which you can control the geometry of this component when it is not being stretched by its ancestor:

Code Example(s)

<af:panelStretchLayout id="psl" topHeight="20" startWidth="100" endWidth="100" bottomHeight="20">
  <f:facet name="top">
    <af:outputText id="t" value="Top" inlineStyle="background-color: #FF6666;"/>
  </f:facet>
  <f:facet name="start">
    <af:outputText id="s" value="Start" inlineStyle="background-color: #FFFF66;"/>
  </f:facet>
  <f:facet name="center">
    <af:outputText id="c" value="Center" inlineStyle="background-color: #FFFFFF"/>
  </f:facet>
  <f:facet name="end">
    <af:outputText id="e" value="End" inlineStyle="background-color: #66FF66;"/>
  </f:facet>
  <f:facet name="bottom">
    <af:outputText id="b" value="Bottom" inlineStyle="background-color: #6666FF;"/>
  </f:facet>
</af:panelStretchLayout>
   

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.

Supported Facets

Name Description
bottom Content to be rendered below the center facet. If present and bottomHeight not specified, the height will be 50px.
center Content to be stretched in the center of the layout.
end 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.
start 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.
top Content to be rendered above the center facet. If present and topHeight not specified, the height will be 50px.

Attributes

Name Type Supports EL? Description
attributeChangeListener javax.el.MethodExpression Only EL a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
binding oracle.adf.view.rich.component.rich.layout.RichPanelStretchLayout Only EL an EL reference that will store the component instance on a bean. This can be used to give programmatic access to a component from a backing bean, or to move creation of the component to a backing bean.
bottomHeight String Yes 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. If dimensionsFrom resolves to "children", percent units are not allowed and the default value will be used instead.
bottomLandmark String Yes Valid Values: none, banner, complementary, contentinfo, main, navigation, search

Specifies the WAI-ARIA landmark role for the content of the bottom facet.
centerLandmark String Yes Valid Values: none, banner, complementary, contentinfo, main, navigation, search

Specifies the WAI-ARIA landmark role for the content of the center facet.
clientComponent boolean Yes whether a client-side component will be generated. A component may be generated whether or not this flag is set, but if client Javascript requires the component object, this must be set to true to guarantee the component's presence. Client component objects that are generated today by default may not be present in the future; setting this flag is the only way to guarantee a component's presence, and clients cannot rely on implicit behavior. However, there is a performance cost to setting this flag, so clients should avoid turning on client components unless absolutely necessary.
customizationId String Yes This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.
dimensionsFrom String Yes Valid Values: auto, children, parent

determines how the component will handle geometry management. This specifies where the dimensions of the panelStretchLayout come from:

  • auto - either "children" or "parent", depending on the container the panelStretchLayout is inside; if the panelStretchLayout is being stretched by its ancestor then "parent" will be used, otherwise "children" will be used
  • children - the panelStretchLayout will get its dimensions from the children (topHeight and bottomHeight will still be honored unless percent units are specified so the contents of these facets will be constrained to those dimensions and if those dimensions are set to auto then whatever those facets need for their height will contribute to the height of the panelStretchLayout). Note that any height assignment (e.g. inlineStyle or styleClass) on the panelStretchLayout must be omitted or else there would be a competing assignment for how tall the component will be.
  • parent (the default) - the panelStretchLayout will get its dimensions from the inlineStyle and if not provided from there then from its parent or if not provided from the parent then from the skin (topHeight and bottomHeight will be honored)
endLandmark String Yes Valid Values: none, banner, complementary, contentinfo, main, navigation, search

Specifies the WAI-ARIA landmark role for the content of the end facet.
endWidth String Yes 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.
id String No the identifier for the component. The identifier must follow a subset of the syntax allowed in HTML:
  • Must not be a zero-length String.
  • First character must be an ASCII letter (A-Za-z) or an underscore ('_').
  • Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').
inlineStyle String Yes the CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. If the inlineStyle's CSS properties do not affect the DOM element you want affected, then you will have to create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style.
partialTriggers String[] Yes the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too. Identifiers are relative to the source component (this component), and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root of the page, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc.
rendered boolean Yes whether the component is rendered. When set to false, no output will be delivered for this component (the component will not in any way be rendered, and cannot be made visible on the client). If you want to change a component's rendered attribute from false to true using PPR, set the partialTrigger attribute of its parent component so the parent refreshes and in turn will render this component.
shortDesc String Yes the short description of the component. This text is commonly used by user agents to display tooltip help text, in which case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window. For components that support the helpTopicId attribute it is recommended that helpTopicId is used as it is more flexible and is more accessibility-compliant.
startLandmark String Yes Valid Values: none, banner, complementary, contentinfo, main, navigation, search

Specifies the WAI-ARIA landmark role for the content of the start facet.
startWidth String Yes 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.
styleClass String Yes a CSS style class to use for this component. The style class can be defined in your jspx page or in a skinning CSS file, for example, or you can use one of our public style classes, like 'AFInstructionText'.
theme String Yes 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".
topHeight String Yes 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. If dimensionsFrom resolves to "children", percent units are not allowed and the default value will be used instead.
topLandmark String Yes Valid Values: none, banner, complementary, contentinfo, main, navigation, search

Specifies the WAI-ARIA landmark role for the content of the top facet.
unsecure java.util.Set Yes 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.
visible boolean Yes the visibility of the component. If it is "false", the component will be hidden on the client. Unlike "rendered", this does not affect the lifecycle on the server - the component may have its bindings executed, etc. - and the visibility of the component can be toggled on and off on the client, or toggled with PPR. When "rendered" is false, the component will not in any way be rendered, and cannot be made visible on the client. In most cases, use the "rendered" property instead of the "visible" property.
Not supported on the following renderkits: org.apache.myfaces.trinidad.core