UIComponent class: oracle.adf.view.faces.bi.component.gantt.UIResourceUtilizationGantt
Component type: oracle.dss.adf.gantt.ResourceUtilizationGantt
The ResourceUtilizationGantt is typically used to illustrate how many unit (ex. hours) is allocated and utilized for a particular resource in a given time period. It comprises of two major parts; the left side of the Resource Utilization Gantt shows information about the resources in the form of columns in the Table, while the right side of the Resource Utilization Gantt displays graphical representation of the resource utilized for the resource at a specific time.
The ResourceUtilizationGantt component uses a model to access the data in the underlying list. Like the TreeTable component, the ResourceUtilizationGantt supports hierarchical data. The specific model class is org.apache.myfaces.trinidad.model.TreeModel.
A user would specify what columns to display in the left side of the Gantt by adding the Column components as its children. For more information see the documentation for <af:column>.
Like the TreeTable, a "nodeStamp" facet is used to specify the primary identifier of an element in the hiearchy. For example, the "Task Name" Column might be used as the nodeStamp for the Project Gantt.
A legend can be attached to the Gantt by adding the ganttLegend component. The legend toggle button in the toolbar would only be available if a legend is attached and is visible.
The ResourceUtilizationGantt can be made as a drop target for Table, TreeTable by using the collectionDropTarget tag. Note that the Table, TreeTable must first be specified as a drag source before their content can be drop onto the Gantt. Please see the documentation for <af:collectionDragSource>.
| Type | Phases | Description |
|---|---|---|
| oracle.adf.view.faces.bi.event.FilterEvent | Apply Request Values | The filter event is delivered when the filter is changed. |
| oracle.adf.view.faces.bi.event.DataChangeEvent | Apply Request Values | The data change event is delivered when an action that would change the data is performed on the Gantt. An example would be updating the start time of a particular task by dragging the task bar to a different time. |
| oracle.adf.view.faces.bi.event.TimeBucketDoubleClickEvent | Apply Request Values | The time bucket double click event is delivered when a double click is performed on a time bucket. |
| oracle.adf.view.faces.bi.event.ResourceSelectionEvent | Apply Request Values | The resource selection event is delivered when a resource is selected in the Gantt. |
| oracle.adf.view.faces.bi.event.TimeBucketSelectionEvent | Apply Request Values | The resource selection event is delivered when a time bucket is selected in the Gantt. |
| oracle.adf.view.faces.bi.event.GanttActionEvent | Apply Request Values | The action event is delivered when an action that would not change the data is performed on the Gantt. An example would be printing the Gantt. |
| org.apache.myfaces.trinidad.event.SortEvent | Apply Request Values | The sort event is delivered when a sort action is performed on one of the columns on the Gantt. |
| 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 |
|---|---|
| chartPopupMenu | the component to use to specify additional controls to appear in the context menu of the chart table. It must a Popup component. |
| customPanel | the component to use to specify controls to appear in the custom tab of the task properties dialog. |
| major | the component to use to specify the major time axis. This must be a TimeAxis component. |
| menuBar | the component to use to specify additional controls to appear in the Gantt menu bar. It must be a MenuBar component. |
| minor | the component to use to specify the minor time axis. This must be a TimeAxis component. |
| nodeStamp | the component to use to stamp each element in the Gantt. Only certain types of components are supported, including all components with no behavior and most components that implement the EditableValueHolder or ActionSource interfaces. In a Gantt, this must be a column. |
| tablePopupMenu | the component to use to specify additional controls to appear in the context menu of the list table. It must a Popup component. |
| toolbar | the component to use to specify additional controls to appear in the Gantt toolbar. It must be a Toolbar component. |
| Name | Type | Supports EL? | Description |
|---|---|---|---|
| YAxisHeight | int | Yes | the height of the Y-Axis in pixels. |
| YAxisMaxValue | int | Yes | the maximum value of the Y-Axis. This is used to calculate the height of the bars. If this is not specified, the value will be calculated automatically based on the data. |
| actionListener | String | Yes | a method reference to an actionListener that will be called when an action is performed on the Gantt. |
| 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. |
| backgroundColor | String | Yes | the background color for the Gantt. A hex string is expected. |
| 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. |
| contentDelivery | String | Yes | whether data should be fetched when the component is rendered initially. When contentDelivery is "immediate", data is fetched and inlined into the component chrome. If contentDelivery is "lazy", data will be fetched and delivered to the client during a subsequent request. |
| currentDate | java.util.Date | Yes | the current date that should be highlighted in the Gantt. |
| customizationId | String | Yes | The id used to locate this component when applying persistent customizations. Components without a customizationId set can not save customizations to the persistent store. Instead, any customizations will at most only apply to the current Session. Each customizationId must be unique in the document. |
| dataChangeListener | String | Yes | a method reference to a dataChangeListener that will be called when an action that would change the data is performed on the Gantt. |
| 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. |
| doubleClickListener | String | Yes | a method reference to a timeBucketDoubleClickListener that will be called when a double click is performed on a time bucket. |
| endTime | String | Yes | the end time of the Gantt. |
| featuresOff | String | Yes | Valid Values: edit, clipboard, print, undo, legend, zoom, view a list of default features to turn off for the resourceUtilizationGantt. |
| fetchSize | int | Yes | The number of rows in the data fetch block. |
| filterListener | String | Yes | a method reference to a filterListener that will be called when a different filter is selected. |
| filterManager | String | Yes | overrides the default FilterManager with an application defined FilterManager. The FilterManager contains a list of application defined filters which limit the tasks to display in the Gantt. |
| first | int | Yes | the index of the first row in the currently range of rows. This index is zero-based. This attribute is used to control which range of rows to display to the user. |
| highlightColor | String | Yes | the color used for the highlighted time period. |
| highlightEndTime | java.util.Date | Yes | the end time of the highlighted time period. |
| highlightStartTime | java.util.Date | Yes | the start time of the highlighted time period. |
| horizontalFetchSize | int | Yes | the size of the horizontal data window in number of pixels in which the data are fetched. Only task bars within this data window would be rendered. In contrast with fetchSize, which provides vertical virtualization, horizontalFetchSize provides horizontal virtualization. |
| id | String | No | the identifier for the component. The identifier must follow a subset of the syntax allowed in HTML:
|
| 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. |
| metrics | String | Yes | a list of metrics used in the Resource Utilization Gantt. Note that the values are also used to identify the TaskbarFormat from TaskbarFormatManager. |
| nonWorkingDays | String | Yes | a whitespace delimited list of dates that should be highlighted as non-working days in the Gantt. |
| nonWorkingDaysColor | String | Yes | the color used to highlight the non-working days or non-working days of the week. A hex string of the color is expected. |
| nonWorkingDaysOfWeek | String | Yes | a whitespace delimited list of weekdays that should be highlighted as non-working days in every week. The list should consist of one or more of the following abbreviations: sun, mon, tue, wed, thu, fri, sat. |
| 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, 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, or multiple colons to move up through the NamingContainers - "::" will search from the parent naming container, ":::" will search from the grandparent naming container, etc. |
| 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. |
| resourceSelectionListener | String | Yes | a method reference to a resourceSelectionListener that will be called when a resource is selected. |
| rowResizable | boolean | Yes | whether the row can be resize. |
| showCurrentDate | boolean | Yes | whether the current date should be highlighted in the Gantt. |
| showMenuBar | boolean | Yes | whether the menu bar should be shown in the Gantt. |
| showToolbar | boolean | Yes | whether the toolbar should be shown in the Gantt. |
| sortListener | String | Yes | a method reference to a sortListener that will be called when a column in the Gantt is sorted (using the arrow buttons in the column header). |
| splitterPosition | int | Yes | the initial location of the splitter in number of pixels. |
| startTime | String | Yes | the start time of the Gantt. |
| styleClass | String | Yes | Sets a CSS style class to use for this component. |
| summary | String | Yes | Sets a summary of this Project Gantt's purpose and structure for user agents rendering to non-visual media (e.g. screen readers). |
| taskbarFormatManager | String | Yes | overrides the default TaskbarFormatManager with an application defined TaskbarFormatManager. The TaskbarFormatManager contains a registry of the types of task bar that are displayed in the Gantt and the visual representation of each of these type of task bars. |
| timeBucketSelectionListener | String | Yes | a method reference to a timeBucketSelectionListener that will be called when a time bucket is selected. |
| tooltipKeyLabels | String | Yes | the labels for the corresponding data object keys specified in tooltipKeys attribute. This attribute is always used in conjunction with tooltipKey, and the number of keys should match the number of labels. |
| tooltipKeys | String | Yes | the data object keys used to retrieve values to populate the tooltip. This attribute is always used in conjunction with tooltipKeyLabels, and the number of keys should match the number of labels. |
| undoManager | String | Yes | overrides the default UndoManager with an application defined UndoManager. The UndoManager manages undoable entries as a result of certain actions performed on the Gantt. |
| value | String | Yes | the Gantt data - must be of type org.apache.myfaces.trinidad.model.TreeModel. |
| var | String | Yes | Name of the EL variable used to reference each element of this collection. Once this component has completed rendering, this variable is removed (or reverted back to its previous value). |