Oracle Fusion Middleware Data Visualization Tools Tag Reference for Oracle ADF Faces
11g Release 1 (11.1.1.7.0)
E12418-09

<dvt:ganttLegend>

dvt:ganttLegend ganttLegend gantt legend

UIComponent class: oracle.adf.view.faces.bi.component.gantt.Legend
Component type: oracle.dss.adf.gantt.Legend

The Legend must be used as a child of the ProjectGantt or SchedulingGantt component. When it is added to the Project Gantt or Scheduling Gantt component, it will show up right below the Gantt. Note that some menu bar and toolbar functionalites would be available/unavailable depending on whether the Legend component is specified.

Examples

             
                <dvt:projectGantt id="mygantt" startTime="2008-04-12" endTime="2009-04-12" value="#{project.model}" var="task">
                    <f:facet name="major">
                        <dvt:timeAxis scale="months"/>
                    </f:facet>
                    <f:facet name="minor">
                        <dvt:timeAxis scale="weeks"/>
                    </f:facet>
                    <f:facet name="nodeStamp">
                        <af:column headerText="Task Name">                        
                            <af:outputText value="#{task.taskName}"/>
                        </af:column>
                    </f:facet>
                    <af:column headerText="Resource">
                        <af:outputText value="#{task.resourceName}"/>
                    </af:column>
                    <af:column headerText="Start Date">
                        <af:outputText value="#{task.startTime}"/>
                    </af:column>
                    <af:column headerText="End Date">
                        <af:outputText value="#{task.endTime}"/>
                    </af:column>
                    <dvt:ganttLegend keys="#{project.legendKeys}" labels="#{project.legendLabels}" />
                </dvt:projectGantt>

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 events 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 String 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.
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.
dontPersist String Yes a list of persistent attributes that are restricted from persisting to a registered "Persistent Change Manager". Persistent attributes would still persist to a session.
iconLabels String Yes the labels for the additional icons shown in the legend.
icons String Yes additional icons to show in the legend.
id String No the identifier for the component. The identifier must follow a subset of the syntax allowed in HTML:
  • Must not be a zero-length String.
  • First character must be an ASCII letter (A-Za-z) or an underscore ('_').
  • Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').
inlineStyle String Yes Specifies CSS styles to use for this component. This is intended for basic style changes; you should use the skinning mechanism if you require any complex style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. Many components are composed of several DOM elements which may have their own styles applied to them. Defining a style in the inlineStyle may not always give you what you want. For example, if one of the inner DOM elements for this component has a background color specified for it in the skin, setting a background color in the inlineStyle may not provide any visible change (at least for where that inner DOM element exists) because the inner DOM element's background color will win (since that DOM element is essentially layered on top of the root element). In cases like this, you can use a different skin (or define your own) that defines a skinning key for that inner DOM element where its background color is inhibited (e.g. with -tr-inhibit: background-color) or otherwise set to the color you want.
keys String Yes the data object keys used to retrieve values to populate the legend. These values are basically the properties associated with the task object returned by the GanttModelThis attribute is always used in conjunction with labels, and the number of keys should match the number of labels.
labels String Yes the labels for the corresponding data object keys specified in keys attribute. This attribute is always used in conjunction with keys, and the number of keys should match the number of labels.
persist String Yes a list of persistent attributes that are persisting to a registered "Persistent Change Manager". Persistent attributes, by default, always persist to a session.
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.
rows int Yes The maximum number of rows to show in the legend area.
styleClass String Yes Sets a CSS style class to use for this component.
value String Yes the value of the Legend, which is the selected task (or time bucket) object in the Gantt.
visible boolean Yes whether the legend is visible.