Oracle Fusion Middleware Tag Reference for Oracle ADF Faces 11g Release 1 (11.1.1.9.1) E67672-01 |
UIComponent class: oracle.adf.view.rich.component.rich.output.RichPanelCollection
Component type: oracle.adf.RichPanelCollection
Naming container: Yes. When referring to children of this component ("partialTriggers", findComponent()
, etc.), you must prefix the child's ID with this component's ID and a colon (':')
Unsupported agents: pda
A panel component that aggregates collection components like table, treeTable and tree to display standard/application menus, toolbars and statusbar items.
The default top level menu and toolbar items vary depending on the component used as the child of the panelCollection.
Table, treeTable and tree must be a direct child of this component. For example, a switcher holding tables, treeTables or trees is not accepted as a valid child component.
Context menus and other popups can be displayed for the encapsulated table, treeTable and tree by placing an "af:popup" component inside this component.
Please note that panelCollection is a naming container so if you want to add its contained components as partialTriggers (for e.g. table), you need to make them a fully qualified name. For e.g. if you have a panelCollection with id="entriesCollection"
and a table inside it with id="deptTable"
and if you want to update a panelForm on the selection change of the table, you need to declare it as follows:
<panelForm partialTriggers="entriesCollection:deptTable">
The default top level menu items View and Format are disabled. For table filtering is disabled and toolbar buttons related to this feature are disabled. For tree and treeTable the toolbar buttons Go Up, Go To Top, Show as Top are disabled.
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. |
Name | Description |
---|---|
afterToolbar | Insert an "af:toolbar" or "af:groups" of "af:toolbars" in this facet to have these toolbar(s) appear in a separate row below the normal group of toolbars. |
menus | An "af:menu" element containing menu items. These menu items are merged into the menu bar with default menus provided by the panelCollection. This menu is the first menu in the menubar and is followed by the "View" and "Format" menus that are provided by the panelCollection component. You can not add more than one top level menu item. This menu item can have as many nested children as you want. The menubar is the first child compoent of the toolbox. The toolbox manages two types of elements menubars and toolbars. In the panel collection we create one menu bar and one toolbar. There are three more facets that allow deveopers to add toolbars of their choosing. These are called the "toolbar", "secondaryToolbar" and "afterToolbar" facets. You must attach "af:toolbar" to "toolbar" and "secondaryToolbar" facets. The "afterToolbar" is displayed in a separate row inside the toolbox. This facet can contain either an "af:toolbar" or an "af:group" containing "af:toolbar" components. |
secondaryToolbar | Insert an "af:toolbar" element in this facet to contain additional toolbar items. This toolbar and it contained items items are displayed after the default toolbar provided by the panelCollection. This makes them the right most toolbar in this toolbox row. |
statusbar | Insert an "af:toolbar" in this facet to include extra statusbar item(s). These statusbar items are merged with standard items provided by the panelCollection. |
toolbar | Insert an "af:toolbar" element in this facet to contain additional toolbar items. This toolbar is displayed after the menubar and before the standard toolbar inserted by the panelCollection. |
viewMenu | Menu Item(s) to added to the component defined "View" menu of the panelCollection. To add multiple menuItems into the view menu please add "af:group" component containing "af:menuItems". |
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.output.RichPanelCollection | 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 | 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. | ||||||||||||||||||||||||||||||||||||||||||||
defaultToolbarItemDisplay | String | Yes | Valid Values: iconAndText, icon Attribute used to hide the text for the default toolbar items. Use "icon" to hide the text or "iconAndText" to display the text with the icon |
||||||||||||||||||||||||||||||||||||||||||||
featuresOff | java.util.Set | Yes | a space-separated list of default features to turn off for the panelCollection. Supported values are:
|
||||||||||||||||||||||||||||||||||||||||||||
id | String | No | the identifier for the component. The identifier must follow a subset of the syntax allowed in HTML:
|
||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||
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 |