Oracle Fusion Middleware Tag Reference for Oracle ADF Faces
12c (12.1.2)

E23188-01

<af:panelGridLayout>

af:panelGridLayout panelGridLayout panel grid layout

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

The panelGridLayout component is a layout container component that uses one or more gridRow components to describe the rows of a grid layout structure. Each row defines a height and margins. Each gridRow uses one or more gridCell components to describe the cells for columns in that row of the grid layout structure. Each cell defines width, margins, column span, row span, horizontal alignment, and vertical alignment. <p/> The panelGridLayout component is not meant to be used to display data table content. For more information about this, see the Accessibility Guidelines section. <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.

Rules of thumb:

  1. Never nest one scrolling container inside of another scrolling container 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.

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.

<p/> You may also alternatively place a facetRef, iterator, or switcher inside of the panelGridLayout and their resolved children will be treated as if they were direct children of the panelGridLayout--those children must resolve to gridRow components.

Geometry Management

Screen Shot(s)


panelGridLayout screenshot
The panelGridLayout component is a layout container component that uses one or more gridRow components to describe the rows of a grid layout structure. Each row defines a height and margins. Each gridRow uses one or more gridCell components to describe the cells for columns in that row of the grid layout structure. Each cell defines width, margins, column span, row span, horizontal alignment, and vertical alignment.

Code Example(s)

<af:panelGridLayout id="grid">
  <af:gridRow id="row" height="auto" marginTop="4px" marginBottom="4px">
    <af:gridCell id="logoCell" width="auto" valign="middle" marginStart="4px">
      <af:link id="logoLnk" action="index" shortDesc="Logo" styleClass="AFBrandingBarLogo"/>
    </af:gridCell>
    <af:gridCell id="flexibleSpace" width="100%"/>
    <af:gridCell id="searchCell" width="auto" valign="middle" marginEnd="4px">
      <af:inputText id="search" label="Search" contentStyle="width:10em"/>
    </af:gridCell>
    <af:gridCell id="statucCell" width="auto" valign="middle" marginEnd="4px">
      <af:statusIndicator id="status"/>
    </af:gridCell>
  </af:gridRow>
</af:panelGridLayout>
   

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.

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.RichPanelGridLayout 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.
clientComponent boolean Yes 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.
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
Default Value: auto

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

  • auto (the default) - either "children" or "parent", depending on the container the panelGridLayout is inside; if the panelGridLayout is being stretched by its ancestor then "parent" will be used, otherwise "children" will be used.
  • children - the panelGridLayout will get its dimensions from the children. This mode does not allow percent values for row heights because there is no such thing as "available" space to divide up in this mode.
  • parent - the panelGridLayout 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. This mode allows percent values for row heights.
id String No 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).
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. 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.
landmark String Yes Valid Values: none, banner, complementary, contentinfo, main, navigation, search
Default Value: none

Specifies the WAI-ARIA landmark role for this panelGridLayout.
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 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.
shortDesc String Yes 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.

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'.
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. 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.
visible boolean Yes 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