Summary

Tag Name:<af:panelStretchLayout>
Java 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

  • This component can be stretched by a parent layout component that stretches its children. e.g. panelSplitter if the dimensionsFrom attribute of this panelStretchLayout is set to "parent".
  • 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:
    • <af:decorativeBox>
    • <af:panelAccordion>
    • <af:panelBox>
    • <af:panelCollection>
    • <af:panelGroupLayout layout="scroll">
    • <af:panelGroupLayout layout="vertical">
    • <af:panelHeader>
    • <af:panelSplitter>
    • <af:panelStretchLayout>
    • <af:panelTabbed>
    • <af:region>
    • <af:table>
    • <af:tree>
    • <af:treeTable>
    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:
    • <af:panelBorderLayout>
    • <af:panelFormLayout>
    • <af:panelGroupLayout layout="default">
    • <af:panelGroupLayout layout="horizontal">
    • <af:panelLabelAndMessage>
    • <af:panelList>
    • <trh:tableLayout>
There are other ways in which you can control the geometry of this component when it is not being stretched by its ancestor:
  • You can specify dimensionsFrom="children" for the panelStretchLayout to be as tall as the children. When using this "children" setting, the topHeight and bottomHeight attributes will still be honored (unless percent units are specified) but 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.
  • You can also specify dimensionsFrom="parent" to make the panelStretchLayout get its dimensions from the inlineStyle and if not provided from there then from its parent component or if not provided from the parent then from the skin (stretchChildren, flex, inflexibleHeight on af:showDetailItem will be honored).
  • Using dimensionsFrom="auto" will choose either "children" or "parent" depending on whether the panelStretchLayout is being stretched by its parent.

Screenshot(s)

panelStretchLayout screenshot
A panelStretchLayout component showing the various facets.

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>

Accessibility Guideline(s)

  • When implementing geometry managed layouts, favor panelSplitter over panelStretchLayout where possible. PanelSplitter allows end users to:
    1. Redistribute space to meet their needs
    2. Hide/collapse content which is not of immediate interest
    These qualities are useful to all users, and are particularly helpful for low vision users. (#2 should also be helpful for screen reader users.) As an example, chrome navigation content at the top of the page should be placed within the "first" facet of a vertical panelSplitter rather than the "top" facet of a panelStretchLayout. This allows the end user to decrease the amount of space used by the chrome, or to hide it altogether. Similarly, in layouts which contain left/center/right panes, use horizontal splitters to lay out the panes.
  • When using panelStretchLayout, favor "scalable" CSS units (ex/em) over non-scalable units (px) when specifying facet heights. For panelStretchLayouts where the top/bottomHeights are not known by the page author, consider setting the top/bottomHeight to "auto" to allow the panelStretchLayout to dynamically determine the proper height. (Note, however, that the panelStretchLayout auto-sizing mechanism incurs performance overhead, so use this carefully.)
  • topLandmark, startLandmark, centerLandmark, endLandmark, bottomLandmark: Landmark attributes should be used when the corresponding facet provides functionality that matches an available landmark value.
    In order to help assistive technology users (such as screen reader users) determine the overall structure of complex pages, WAI-ARIA allows the page author to explicitly identify significant portions of the page via special "landmark" roles. The various landmark attributes specify the WAI-ARIA landmark role for the content of the corresponding facet.

Supported Client Events for Client Behaviors

  • click (default)
  • contextMenu
  • dblClick
  • mouseDown
  • mouseMove
  • mouseOut
  • mouseOver
  • mouseUp
  • propertyChange

Events

Type Phases Description
org.apache.myfaces.trinidad.event.AttributeChangeEventInvoke 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.

Supported Facets

Name Description
bottomContent to be rendered below the center facet. If present and bottomHeight not specified, the height will be 50px. As with JSP pages, when using Facelets, multiple components are not allowed in this facet.
centerContent to be stretched in the center of the layout. As with JSP pages, when using Facelets, multiple components are not allowed in this facet.
endContent 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. As with JSP pages, when using Facelets, multiple components are not allowed in this facet.
startContent 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. As with JSP pages, when using Facelets, multiple components are not allowed in this facet.
topContent to be rendered above the center facet. If present and topHeight not specified, the height will be 50px. As with JSP pages, when using Facelets, multiple components are not allowed in this facet.

Attributes

Name Type Supports EL? Description
attributeChangeListenerjavax.el.MethodExpressionOnly 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.
bindingoracle.adf.view.rich.component.rich.layout.RichPanelStretchLayoutOnly 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.
bottomHeightStringYes Default Value: 50px

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.
bottomLandmarkStringYes Valid Values: none, banner, complementary, contentinfo, main, navigation, search
Default Value: none

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

Specifies the WAI-ARIA landmark role for the content of the center facet.
clientComponentbooleanYes Default Value: false

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.
customizationIdStringYes This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.

This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.
dimensionsFromStringYes Valid Values: auto, children, parent
Default Value: parent

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

  • auto - either "children" or "parent", depending on the container the decorativeBox is inside; if the decorativeBox is being stretched by its ancestor then "parent" will be used, otherwise "children" will be used
  • children - the decorativeBox will get its dimensions from the children (topHeight will still be honored so the contents of this facet will be constrained to those dimensions unless percent units are specified and then the default value will be used instead). Note that any height assignment (e.g. inlineStyle or styleClass) on the decorativeBox must be omitted or else there would be a competing assignment for how tall the component will be.
  • parent - the decorativeBox 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

If the oracle.adf.view.rich.geometry.DEFAULT_DIMENSIONS context-param is set to "auto" in the project's web.xml, the default value for this attribute will be "auto". Otherwise, the default value will be "parent".

endLandmarkStringYes Valid Values: none, banner, complementary, contentinfo, main, navigation, search
Default Value: none

Specifies the WAI-ARIA landmark role for the content of the end facet.
endWidthStringYes Default Value: 50px

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.
idStringNo the identifier for the component. Every component may be named by a component identifier that must conform to the following rules:
  • They must start with a letter (as defined by the Character.isLetter() method) or underscore ( _ ).
  • Subsequent characters must be letters (as defined by the Character.isLetter() method), digits as defined by the Character.isDigit() method, dashes ( - ), or underscores ( _ ). To minimize the size of responses generated by JavaServer Faces, it is recommended that component identifiers be as short as possible. If a component has been given an identifier, it must be unique in the namespace of the closest ancestor to that component that is a NamingContainer (if any).
inlineStyleStringYes 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.
partialTriggersString[]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.
renderedbooleanYes Default Value: true

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

startLandmarkStringYes Valid Values: none, banner, complementary, contentinfo, main, navigation, search
Default Value: none

Specifies the WAI-ARIA landmark role for the content of the start facet.
startWidthStringYes Default Value: 50px

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.
styleClassStringYes 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'.
themeStringYes 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.

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".
topHeightStringYes Default Value: 50px

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.
topLandmarkStringYes Valid Values: none, banner, complementary, contentinfo, main, navigation, search
Default Value: none

Specifies the WAI-ARIA landmark role for the content of the top facet.
unsecurejava.util.SetYes 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.
visiblebooleanYes Default Value: true

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