|Oracle Fusion Middleware Tag Reference for Oracle ADF Faces
11g Release 2 (188.8.131.52.0)
UIComponent class: oracle.adf.view.rich.component.rich.layout.RichToolbox
Component type: oracle.adf.RichToolbox
Unsupported agents: pda
Toolbox is a multi-row container for toolbars and menuBars. Toolboxes ars are not rendered on printable pages.
The display of toolbars and menuBars inside a toolbox is highly customizable, due to the flex and stretchId values of the child toolbars and menuBars. Because toolbars and menuBars are both overflow components, they do not have a set width size. A toolbox should be placed in a section of the page where it can horizontally stretch to the available size for proper rendering. Putting a toolbox inside a section of the page where it is horizontally constrained to a minimum size (like a panelStretchLayout end facet) will be error-prone, due to the fact that the contents of the toolbox (toolbars and menubars) as overflow components do not have a set width.
By default, each toolbar or menuBar placed inside a toolbox will be displayed on its own row. To have several toolbars or menuBars appear on the same row, you can surround these elements with an
<af:group> component. Please note that while setting up your toolbars and menuBars, you should not nest toolbars or menuBars inside other toolbars or menuBars. This is incompatible with toolbar and menuBar overflow and not supported. Instead, you should use the a toolbox group to arrange the toolbars and menuBars in a row in the desired order.
By default all toolbars and menuBars in a toolbox row are left (start side) justified. In order to make some or all of the toolbar or menuBar items right (end side) justified, you can use the stretchId attibute that is available on toolbar and menuBar. StretchId is usually set to the id of a spacer on the toolbar or menuBar that you want to stretch to take up any available extra horizontal space. Only one stretchId should be specified per toolbox row.
You can use flex values on the toolbars and menuBars to control what percentage of the available horizontal space each toolbar and menuBar should receive. For example, if your toolbox row has 3 toolbars, each with a flex value of "1", then they receive their flex value (1) of the total space available (3). This means that each of the three toolbars would be given one third of the available horizontal space.
When a toolbar or menuBar does not have enough space to display all items, the children are put into overflow and an overflow button is displayed. When toolbox row children have flex values, these flex values are strictly followed, even in regards to overflow. When a toolbox row does not have flex values, then the right most (end side) toolbars or menuBars would be forced into overflow before left side toolbars or menuBars. Spacer and image children on toolbars or menuBars that have client components are not put into overflow.
<af:toolbox id="tbx1"> <af:menuBar id="mb1"> <af:menu text="File" id="m1" /> </af:menuBar> <af:toolbar id="tb1"/> <af:group id="g1"> <af:toolbar ... /> <af:toolbar ... /> </af:group> </af:toolbox>
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.|
|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.RichToolbox||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
|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.|
|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. 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.|
|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. 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'.|
|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