<dvt:schedulingGantt>

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

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 task
tasks - a collection of task objects for this resource

Optionally, the object could implement the oracle.adf.view.faces.bi.model.Resource Task 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 "Task Name" Column might be used as the nodeStamp for the Project 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 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>.

The SchedulingGantt can be made as a drag source for Table, TreeTable by using the collectionDragSource 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:collectionDropTarget>.

Examples

             
                <dvt:schedulingGantt startTime="2008-04-12 01:00" 
                                     endTime="2008-04-13 23:00" 
                                     value="#{schedulingGantt.model}" 
                                     var="resource">
                  <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 headerText="Employee Name">                        
                      <af:outputText value="#{resource.resourceName}"/>
                    </af:column>
                  </f:facet>
                  <af:column headerText="Department">                        
                    <af:outputText value="#{resource.department}"/>
                  </af:column>
                </dvt:schedulingGantt>

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 events 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 a Menu 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 Menu component.
toolbar	the component to use to specify additional controls to appear in the Gantt toolbar. It must be a Toolbar component.

Attributes

Name	Type	Supports EL?	Description
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. (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.
contentDelivery	String	Yes	Specifies 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	This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.
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 doubleClickListener that will be called when a double click is performed on the Gantt.
endTime	String	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 a list of default features to turn off for the schedulingGantt.
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. See the javadoc for oracle.adf.view.faces.bi.component.gantt.FilterManager for details.
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. 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	whether the horizontal gridlines are to be drawn in the chart portion of the Gantt.
iconPlacement	String	Yes	Specifies the alignment of the icon(s) relative to the taskbar.
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.
labelPlacement	String	Yes	Specifies the placement of the label relative to the taskbar.
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. (ex: #FF33FF)
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.
showCurrentDate	boolean	Yes	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	whether the menu bar should be shown in the Gantt. Note that if this is set to false, then any custom menu items specified in the menuBar facet will also be hidden.
showTasksAsDailyBar	boolean	Yes	whether to show task bars within the same day as one daily bar.
showToolbar	boolean	Yes	whether or not 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	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 between the data region and the chart region, in number of pixels.
startTime	String	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 Scheduling Gantt's purpose and structure for user agents rendering to non-visual media (e.g. screen readers).
taskSelectionListener	String	Yes	a method reference to a taskSelectionListener that will be called when a task bar is selected.
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. See the javadoc for oracle.adf.view.faces.bi.component.gantt.TaskbarFormatManager for details.
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. 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. See the javadoc for oracle.adf.view.faces.bi.component.gantt.UndoManager for details.
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).
workingTimeColor	String	Yes	the color used to highlight working hours. A hex string of the color is expected.