| Oracle Fusion Middleware Data Visualization Tools Tag Reference for Oracle ADF Faces 11g Release 2 (11.1.2.4.0) E17490-05 |
UIComponent class: oracle.adf.view.faces.bi.component.legend.UILegend
Component type: oracle.dss.adf.legend.Legend
The legend displays a panel which contains descriptive text for style information from its source components. It can display multiple sections of marker and label pairs, supporting custom title headers and declarative control over the ordering of such sections. The legend can contain <dvt:legendSection> or <dvt:showLegendGroup> tags. Use the <dvt:legendSection> tag to associate the legend with a source to generate its items.
Define the legend as a child of the thematic map component. Add <dvt:legendSection> children to the legend in order to enable integration with data on the thematic map. See the "Legend" section of <dvt:thematicMap> for specific examples.
Within its parent component, the legend uses the maxWidth property to determine its width. If the legend content is wider than the maxWidth specified, legend will be capped at its maxWidth. If the content is smaller than the maxWidth, the legend will shrink its width to fit its content. The legend height is determined by the height of its content. Use the noWrap property to enable and disable text wrapping. If noWrap is true, any text longer than the maxWidth will truncate.
The <dvt:legend> tag can have the following children:
| 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. |
| Name | Description |
|---|---|
| separator | Defining the "separator" facet with a child <af:separator> will add separators between child legend sections. |
| 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 | String | Only EL | Binding reference to store the UILegend component |
| disclosed | boolean | Yes | Determines if the legend is expanded or collapsed on initial display. This setting only applies when display="showHide". Valid values are:
|
| display | String | Yes | Valid Values: showHide, fixed Determines the display behavior of the legend. Valid values are:
|
| id | String | Yes | The identifier for the component |
| label | String | Yes | The optional title text for the legend. |
| maxWidth | String | Yes | Determines the maximum width in px or % that the legend can occupy. Percentages are based on the width of the parent component. If the legend content width is less than the maximum width, the legend will shrink to fit its content. |
| noWrap | boolean | Yes | Determines if text which goes beyond the legend width will truncate or wrap. Valid values are:
|
| rendered | boolean | Yes | Specifies whether the component is rendered. The default value is true. |