Oracle Fusion Middleware Data Visualization Tools Tag Reference for Oracle ADF Faces
12c (12.2.1.2)
E76719-01

<dvt:schedulingGantt>

dvt:schedulingGantt schedulingGantt scheduling gantt

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

The SchedulingGantt is used to illustrate when resources are scheduled. Unlike the ProjectGantt, SchedulingGantt is more resource-oriented. It comprises of two major parts; the left side of the Scheduling Gantt shows information about the resources in the form of columns in the Table, while the right side of the Scheduling Gantt displays graphical representation of the start and finish dates of tasks associated with each resource.

This component can have the following children: ganttLegend, collectionDragSource, collectionDropTarget, dragSource, dropTarget

The SchedulingGantt provides a set of predefined styles out of the box. For a complete set of predefined styles, please consult the javadoc for oracle.adf.view.faces.bi.component.gantt.UISchedulingGantt for details. Applications can also define their own styles or make changes to predefined styles by registering their own TaskbarFormat object through the TaskbarFormatManager. For details, please see the javadoc for oracle.adf.view.faces.bi.component.gantt.TaskbarFormat and oracle.adf.view.faces.bi.component.gantt.TaskbarFormatManager classes.

The SchedulingGantt supports direct manipulation of tasks on the chart. For examples, users can change the start time, the duration of a task, and reassigning a task to another resource by dragging the task bar. User can split a task into multiple segments.

Gantt Model

The SchedulingGantt component uses a model to access the data in the underlying list. Like the TreeTable component, the SchedulingGantt supports hierarchical data. The specific model class is org.apache.myfaces.trinidad.model.TreeModel.

The collection of objects returned by TreeModel must have, at the minimal, the following properties:

resourceId - the id of the resource
tasks - a collection of task objects for this resource

Optionally, the object could implement the oracle.adf.view.faces.bi.model.Resource interface to ensure it provides the correct properties to the Gantt.

The collection of objects returned by the tasks property must also have the following properties:

taskId - the id of the task
startTime - the start time of the task
endTime - the end time of the task

Optionally, the object could implement the oracle.adf.view.faces.bi.model.ScheduleTask interface to ensure it provides the correct properties to the Gantt.

Columns

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 "Resource Name" Column might be used as the nodeStamp for the Scheduling Gantt.

Legend

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.

Drag And Drop

The SchedulingGantt can be made as a drop target for Table, TreeTable by using the dropTarget 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:dragSource>.

The SchedulingGantt can be made as a drag source for Table, TreeTable by using the dragSource tag. Note that the Table, TreeTable must first be specified as a drop target before their content can be drop onto the Gantt. Please see the documentation for <af:dropTarget>.

Geometry Management

This component can be stretched by a parent layout component that stretches its children, e.g. panelStretchLayout, panelSplitter
When stretching this component, the data treeTable and chart treeTable will be stretch both horizontally and vertically. The toolbar and legend of the Gantt will only be stretched horizontally.
This component is automatically stretched to fill up the browser's viewport when it is the "sole visual root component" in the component tree and if the document component is configured with maximized="true" (the default).
When NOT stretched, this component will be displayed in its default dimensions which are provided by the skin. This can be modified by applying a dimension using the inlineStyle or styleClass attributes.

Supported Client Events for Client Behaviors

blur
click
contextMenu
dblClick
focus

keyDown
keyPress
keyUp
mouseDown
mouseMove

mouseOut
mouseOver
mouseUp
propertyChange
selection (Default)

Examples

             
                <dvt:schedulingGantt id="gantt1"
                                     summary="gantt"
                                     startTime="2008-04-12 01:00" 
                                     endTime="2008-04-13 23:00" 
                                     value="#{schedulingGantt.model}" 
                                     var="res">
                  <f:facet name="major">
                    <dvt:timeAxis scale="days"/>
                  </f:facet>
                  <f:facet name="minor">
                    <dvt:timeAxis scale="hours"/>
                  </f:facet>
                  <f:facet name="nodeStamp">
                    <af:column id="c1" headerText="Employee Name">                        
                      <af:outputText id="ot1" value="#{res.resourceName}"/>
                    </af:column>
                  </f:facet>
                  <af:column id="c2" headerText="Department">                        
                    <af:outputText id="ot2" value="#{res.department}"/>
                  </af:column>
                </dvt:schedulingGantt>

Screen Shot(s)

Events

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.DoubleClickEvent	Apply Request Values	The double click event is delivered when a double click is performed on the Gantt.
oracle.adf.view.faces.bi.event.TaskSelectionEvent	Apply Request Values	The task selection event is delivered when a task bar is selected in the Gantt.
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.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 event might include the width of a column that supported client-side resizing.

Supported Facets

Name	Description
chartPopupMenu	the component to use to specify additional controls to appear in the context menu of the chart table. It must be a Popup component. Multiple components are not allowed in this facet.
customChartContextMenu	the component to use to specify a custom context menu to appear instead of the default context menu of the chart table. It must be a Popup component. Multiple components are not allowed in this facet.
customChartRowContextMenu	the component to use to specify a custom context menu for empty areas of a row in the chart table. It must be a Popup component. Multiple components are not allowed in this facet.
customPanel	the component to use to specify controls to appear in the custom tab of the task properties dialog. In JSP pages only one component is allowed. When using Facelets mutiple components are allowed.
customTableContextMenu	the component to use to specify a custom context menu to appear instead of the default context menu of the list table. It must be a Popup component. Multiple components are not allowed in this facet.
major	the component to use to specify the major time axis. This must be a TimeAxis component. Multiple components are not allowed in this facet.
menuBar	the component to use to specify additional controls to appear in the Gantt menu bar. It must be a MenuBar component. Multiple components are not allowed in this facet.
minor	the component to use to specify the minor time axis. This must be a TimeAxis component. Multiple components are not allowed in this facet.
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. Multiple components are not allowed in this facet.
tablePopupMenu	the component to use to specify additional controls to appear in the context menu of the list table. It must be a Popup component. Multiple components are not allowed in this facet.
toolbar	the component to use to specify additional controls to appear in the Gantt toolbar. It must be a Toolbar component. Multiple components are not allowed in this facet.

Attributes

Name	Type	Supports EL?	Description
actionListener	javax.el.MethodExpression	Only EL	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.
attributeConverterFactory	oracle.adf.view.faces.bi.component.gantt.AttributeConverterFactory	Yes	Specifies an AttributeConverterFactory that provides Converters for various task attributes rendered within tooltips, context menus, and the information panel of the legend. (In order for the "startTime", "endTime", and "completedThrough" attributes to be properly formatted within the tooltips rendered during task resizes and moves, the Converter returned by the AttributeConverterFactory must implement the org.apache.myfaces.trinidad.convert.ClientConverter interface.
backgroundColor	String	Yes	the background color for the Gantt. A hex string is expected. (ex: #FF33FF)
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.
chartPopupMenuLayout	String[]	Yes	Valid Values: all, separator, edit, properties, updateTask, delete, clipboard, cut, copy, paste, linkGroup, link, unlink, snapTo Customize the chart popup menu.
contentDelivery	String	Yes	Valid Values: lazy, immediate, whenAvailable Default Value: whenAvailable 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. If contentDelivery is "whenAvailable", the model is queried for available data during initial rendering: If data is available, it will render as if contentDelivery="immediate", else it will render as if contentDelivery="lazy".
currentDate	java.util.Date	Yes	the current date that should be highlighted in the Gantt.
customTimeScales	java.util.Map	Yes	Specifies custom time scales for this gantt. The type is Map<String, CustomTimeScale>. The String being used for the map key is the custom time scale name. The value is the implementation of the CustomTimeScale interface. Gantt will use this map to render custom time scales.
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.
dataChangeListener	javax.el.MethodExpression	Only EL	a method reference to a dataChangeListener that will be called when an action that would change the data is performed on the Gantt.
dependencyLinesVisible	String	Yes	Valid Values: all, none Default Value: all whether the dependency lines are to be drawn in the chart portion of the Gantt.
disclosedRowKeys	org.apache.myfaces.trinidad.model.RowKeySet	Yes	The set of disclosed rows for this component. Each entry in the set is a rowKey.
displayRow	String	Yes	Valid Values: first, last, selected The row to display during initial display. The possible values are "first" to display the first row, "last" to display the last row and "selected" to display the first selected row. The default value for this is null which means that the first row is displayed. Please note that this API will have no effect if the total number of rows are not known from the table model (model.getRowCount()==-1).
displayRowKey	Object	Yes	The rowKey to display during initial display. Specifying this attribute will override the displayRow attribute. Please note that this API will have no effect if the total number of rows are not known from the table model (model.getRowCount()==-1).
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	javax.el.MethodExpression	Only EL	a method reference to a doubleClickListener that will be called when a double click is performed on the chart side of the Gantt.
endTime	java.util.Date	Yes	the end time that is used to render the time period of the Gantt.
featuresOff	String[]	Yes	Valid Values: edit, clipboard, indenting, linking, print, undo, legend, zoom, view, dependencyLines, filter, properties, taskMenu, createTaskMenu, updateTaskMenu, updateTaskRightMenu, createTaskToolbar, updateTaskToolbar, createTaskMT, updateTaskMT, indentingMenu, indentingToolbar, indentingRightMenu, indentingMenus, linkingMenu, linkingRightMenu, linkingToolbar, linkingMenus, snaptoMenu, snaptoRightMenu, propertiesMenu, propertiesRightMenu, editMenu, undoMenu, undoToolbar, clipboardMenu, clipboardToolbar, clipboardRightMenu, deleteMenu, deleteToolbar, deleteRightMenu, deleteMenus, viewMenu, listPaneMenu, asListMenu, asHierMenu, columnsMenu, expandMenu, explandAllBelowMenu, collapseAllBelowMenu, explandAllMenu, collapseAllMenu, legendMenu, legendToolbar, goToDateMenu, timeAxisMenu, printMenu, printToolbar, resourceMenu, createResourceMenu, createResourceToolbar, createResourceMT, updateResourceMenu, zoomToolbar, zoomToToolbar a list of default features to turn off for the schedulingGantt.
fetchSize	int	Yes	Default Value: 25 The number of rows in the data fetch block.
filterListener	javax.el.MethodExpression	Only EL	a method reference to a filterListener that will be called when a different filter is selected.
filterManager	oracle.adf.view.faces.bi.component.gantt.FilterManager	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. See the javadoc for oracle.adf.view.faces.bi.component.gantt.FilterManager for details.
first	int	Yes	This attribute is deprecated. The 'displayRow' or 'displayRowKey' attributes should be used instead. This attribute will be removed in the next release.
goToDateConverter	javax.faces.convert.Converter	Yes	Specifies a Converter to be used for the dates displayed in the "Go To Date" dialog of the gantt.
highlightColor	String	Yes	the color used for the highlighted time period. A hex string is expected. (ex: #FF33FF)
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.
horizontalGridVisible	boolean	Yes	Default Value: false whether the horizontal gridlines are to be drawn in the chart portion of the Gantt.
iconPlacement	String	Yes	Valid Values: left, right, start, end, inside, innerCenter, innerLeft, innerRight, innerStart, innerEnd Default Value: left Specifies the alignment of the icon(s) relative to the taskbar.
id	String	No	the identifier for the component
initialDateFocus	java.util.Date	Yes	Specifies the initial date displayed when the the gantt comes up.
initiallyExpandAll	boolean	Yes	Default Value: false Specifies whether the rows should be initially expanded.
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.
labelPlacement	String	Yes	Valid Values: left, right, start, end, inside, innerCenter, innerLeft, innerRight, innerStart, innerEnd Default Value: left Specifies the placement of the label relative to the taskbar.
menuBarLayout	String[]	Yes	Valid Values: all, separator, edit, print, undoGroup, undo, redo, filter, indentGroup, indent, outdent, legend, properties, viewMenu, listPaneMenu, asList, asHier, columnsMenu, expand, expandAllBelow, collapseAllBelow, expandAll, collapseAll, goToDate, timeScale, createTask, updateTask, delete, clipboard, cut, copy, paste, linkGroup, link, unlink, snapTo, taskMenu, resourceMenu, dependencyLines";, //menu Customize the menu bar.
nonWorkingDays	java.util.Date[]	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. (ex: #FF33FF)
nonWorkingDaysOfWeek	String[]	Yes	Valid Values: sun, mon, tue, wed, thu, fri, sat 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	Default Value: true whether the component is rendered. When set to false, no output will be delivered for this component.
resourceSelectionListener	javax.el.MethodExpression	Only EL	a method reference to a resourceSelectionListener that will be called when a resource is selected.
rowBandingInterval	int	Yes	Default Value: 0 the interval between which the row banding occurs. This value controls the display of the row banding in the Gantt. For e.g, rowBandingInterval=1 would display alternately banded rows in the Grid.
rowSelection	String	Yes
scrollPolicy	String	Yes	Valid Values: auto, page, scroll Default Value: auto specifies the mechanism used to scroll data within the Gantt. possible values are: auto (depends on your device), page, and scroll.
selectedRowKeys	org.apache.myfaces.trinidad.model.RowKeySet	Yes	The set of selected resources. Each entry in the set is a rowKey.
selectedTaskRowKeys	org.apache.myfaces.trinidad.model.RowKeySet	Yes	The set of selected tasks. Each entry in the set is a rowKey.
showCurrentDate	boolean	Yes	Default Value: true whether a line should be drawn in the Gantt at the date marked as current by the application. The currentDate attribute must also be set for this to become visible
showMenuBar	boolean	Yes	Default Value: true whether the menu bar should be shown in the Gantt. Note that if this is set to false, then any custom menu bar items specified in the menuBar facet will also be hidden.
showTasksAsDailyBar	boolean	Yes	Default Value: false whether to show task bars within the same day as one daily bar.
showToolbar	boolean	Yes	Default Value: true whether the toolbar should be shown in the Gantt. Note that if this is set to false, then any custom toolbar buttons specified in the toolbar facet will also be hidden.
sortListener	javax.el.MethodExpression	Only EL	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 between the data region and the chart region, in number of pixels.
startTime	java.util.Date	Yes	the start time that is used to render the time period of the Gantt.
styleClass	String	Yes	Sets a CSS style class to use for this component.
summary	String	Yes	Sets a summary of this Gantt's purpose and structure for user agents rendering to non-visual media (e.g. screen readers).
tableActiveRowKey	Object	Yes	the row that is currently active on the client. The active row will be made editable and is brought into view (if not already visible). Upon initial display, the component defaults the active row to the first visible row.
tableColumnStretching	String	Yes	Valid Values: none, last, blank, multiple Default Value: last Indicates what kind of stretching you want applied to the columns. For optimal performance, use the "none" (default) option. If you want the last column to stretch to fill up any unused space inside of the viewport, use the "last" option. If you want to have an empty blank column be automatically inserted and have it stretch (so the row background colors will span the entire width of the table), use the "blank" option. If you want to have a specific leaf (non-group) column stretch to fill up any unused space inside of the viewport, use the option where you specify "column:" followed by the ID of the column that you want to have stretched, e.g. "column:myColId". If you want more than one column stretched, use the "multiple" option. When the "multiple" option is used you can set the widths in the columns (non-group) to be percentages. See the column documentation for how percentages are handled. Note that row headers and frozen columns will not be stretched because doing so could easily leave the user unable to access the scrollable data body of the table.
tablePopupMenuLayout	String[]	Yes	Valid Values: all, separator, edit, indentGroup, indent, outdent, updateTask, delete, clipboard, cut, copy, paste Customize the table popup menu.
taskSelectionListener	javax.el.MethodExpression	Only EL	a method reference to a taskSelectionListener that will be called when a task bar is selected.
taskbarFormatManager	oracle.adf.view.faces.bi.component.gantt.TaskbarFormatManager	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. See the javadoc for oracle.adf.view.faces.bi.component.gantt.TaskbarFormatManager for details.
timeZone	java.util.TimeZone	Yes	Specifies a global TimeZone for the gantt. If not set, the timezone is pulled from the AdfFacesContext.
toolBarLayout	String[]	Yes	Valid Values: all, separator, edit, print, undoFilterGroup, undoGroup, undo, redo, filter, indentGroup, indent, outdent, legend, zoomInOutGroup, zoomToGroup, zoomIn, zoomOut, zoomTo, properties, createResource, createTask, updateTask, delete, clipboard, tablePopupMenu,, chartPopupMenu,, menu, cut, copy, paste, indentLinkGroup, linkGroup, link, unlinK Customize the toolbar.
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. These values are basically the properties associated with the task object returned by the GanttModel. Note this attribute is always used in conjunction with tooltipKeyLabels, and the number of keys should match the number of labels.
undoManager	oracle.adf.view.faces.bi.component.gantt.UndoManager	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. See the javadoc for oracle.adf.view.faces.bi.component.gantt.UndoManager for details.
value	org.apache.myfaces.trinidad.model.TreeModel	Yes	the Gantt data - must be of type org.apache.myfaces.trinidad.model.TreeModel.
var	String	No	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).
workingTimeColor	String	Yes	the color used to highlight working hours. A hex string of the color is expected.