oracle.adf.view.faces.bi.component.gantt
Class UISchedulingGantt

java.lang.Object
  javax.faces.component.UIComponent
      org.apache.myfaces.trinidad.component.UIXComponent
          org.apache.myfaces.trinidad.component.UIXComponentBase
              org.apache.myfaces.trinidad.component.UIXCollection
                  oracle.adf.view.faces.bi.component.gantt.UIGantt
                      oracle.adf.view.faces.bi.component.gantt.UISchedulingGantt

All Implemented Interfaces:

javax.faces.component.NamingContainer, javax.faces.component.StateHolder

public class UISchedulingGantt
extends UIGantt

The Scheduling Gantt control is used to display data in a resource-oriented Gantt chart. The Scheduling Gantt control is consists of a menu bar, a tool bar, a TreeTable on the left that is capable of displaying hierarchical data, a chart on the right that displays task bars, and a legend.

Gantt Model

The Scheduling Gantt component uses a model to access the data in the underlying list. The specific model class is org.apache.myfaces.trinidad.model.TreeModel.

Column

The immediate children of a Scheduling Gantt component. Each visibleColumn component creates a separate column in the left hand side TreeTable. For more information see the documentation for

Time Axis

The Scheduling Gantt control requires a major and a minor time axis. You can specify them by adding a timeAxis component using a facet named "major" and a facet named "minor" as a child of the Gantt.

Sorting

The Scheduling Gantt component supports sorting columns in ascending or descending order in the exact same way as the Table and TreeTable components. Please refer to the documentation for these components for details on sorting.

Field Summary

static java.lang.String	BRICK_RED_FORMAT The pre-defined 'Brick Red' TaskbarFormat for the metric bar.
static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	DOUBLE_CLICK_LISTENER_KEY
static java.lang.String	GOLD_FORMAT The pre-defined 'Gold' TaskbarFormat for the metric bar.
static java.lang.String	GREEN_FORMAT The pre-defined 'Green' TaskbarFormat for the metric bar.
static org.apache.myfaces.trinidad.bean.PropertyKey	HORIZONTAL_GRID_VISIBLE_KEY
static java.lang.String	INDIGO_FORMAT The pre-defined 'Indigo' TaskbarFormat for the metric bar.
static java.lang.String	LAVENDER_FORMAT The pre-defined 'Lavender' TaskbarFormat for the metric bar.
static java.lang.String	LEMON_FORMAT The pre-defined 'Lemon' TaskbarFormat for the metric bar.
static java.lang.String	LIME_FORMAT The pre-defined 'Lime' TaskbarFormat for the metric bar.
static java.lang.String	MIDNIGHT_BLUE_FORMAT The pre-defined 'Midnight Blue' TaskbarFormat for the metric bar.
static java.lang.String	ORANGE_FORMAT The pre-defined 'Orange' TaskbarFormat for the metric bar.
static java.lang.String	PLACEMENT_INSIDE
static java.lang.String	PLACEMENT_LEFT
static java.lang.String	PLACEMENT_RIGHT
static java.lang.String	PLUM_FORMAT The pre-defined 'Plum' TaskbarFormat for the metric bar.
static org.apache.myfaces.trinidad.bean.PropertyKey	RESOURCE_SELECTION_LISTENER_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SHOWTASKS_AS_DAILYBAR_KEY
static java.lang.String	STEEL_BLUE_FORMAT The pre-defined 'Steel Blue' TaskbarFormat for the metric bar.
static org.apache.myfaces.trinidad.bean.PropertyKey	TASK_SELECTION_LISTENER_KEY
static java.lang.String	TEAL_FORMAT The pre-defined 'Teal' TaskbarFormat for the metric bar.
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	WORKINGTIME_COLOR_KEY

Fields inherited from class oracle.adf.view.faces.bi.component.gantt.UIGantt

ACTION_LISTENER_KEY, AUTO_SCALE_KEY, BACKGROUND_COLOR_KEY, CALENDAR_KEY, CHART_POPUP_MENU_FACET, CLIENT_LISTENERS_KEY, CLIPBOARD, CONTENT_DELIVERY_KEY, CURRENT_DATE_KEY, CUSTOM_PANEL_FACET, CUSTOMIZATION_ID_KEY, DATA_CHANGE_LISTENER_KEY, DATE_FORMATTER_KEY, DISCLOSED_ROW_KEYS_KEY, DISPLAY_ROW_KEY, DONT_PERSIST_KEY, EDIT, END_TIME_KEY, FEATURES_OFF, FETCHSIZE_KEY, FILTER, FILTER_LISTENER_KEY, FILTERMANAGER_KEY, FIRSTROW_KEY, HIGHLIGHT_COLOR_KEY, HIGHLIGHT_END_TIME_KEY, HIGHLIGHT_START_TIME_KEY, HORIZONTAL_FETCHSIZE_KEY, ICON_PLACEMENT_KEY, INDENTING, INLINE_STYLE_KEY, IS_THAI_GREGORIAN_KEY, LABEL_PLACEMENT_KEY, LEGEND, LINKING, LOCALE_KEY, MAJOR_AXIS_FACET, MENUBAR_FACET, MIN_WIDTH_KEY, MINOR_AXIS_FACET, MODE_KEY, NODESTAMP_FACET, NON_WORKING_DAYS_COLOR_KEY, NON_WORKING_DAYS_KEY, NON_WORKING_DAYS_OF_WEEK_KEY, PARTIAL_TRIGGERS_KEY, PERCENTCOMPLETE, PERSIST_KEY, PRINT, PROPERTIES, SHOW_CURRENT_DATE_KEY, SHOW_MENUBAR_KEY, SHOW_TOOLBAR_KEY, SORT_LISTENER_KEY, SPLIT, SPLITTER_POSITION_KEY, START_TIME_KEY, STYLE_CLASS_KEY, SUMMARY_KEY, TABLE_POPUP_MENU_FACET, TASKBAR_FORMAT_MANAGER_KEY, TIMEZONE_KEY, TOOLBAR_FACET, TOOLTIP_KEYS_KEY, TOOLTIP_LABELS_KEY, UNDO, UNDOMANAGER_KEY, VALUE_KEY, VIEW, WIDTH_KEY, ZOOM, ZOOM_TO_FIT_KEY

Fields inherited from class org.apache.myfaces.trinidad.component.UIXCollection

VAR_KEY

Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

Fields inherited from class javax.faces.component.UIComponent

bindings

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

UISchedulingGantt()
Constructor an instance of UISchedulingGantt.

UISchedulingGantt(java.lang.String rendererType)

Method Summary

void	addDoubleClickListener(DoubleClickListener listener) Adds a double click listener.
void	addResourceSelectionListener(ResourceSelectionListener listener) Adds a resource selection listener.
void	addTaskSelectionListener(TaskSelectionListener listener) Adds a task selection listener.
void	broadcast(javax.faces.event.FacesEvent evt) Internal.
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
protected java.text.DateFormat	getDefaultDateFormat()
protected Filter	getDefaultFilter()
protected java.lang.String	getDefaultIconPlacement()
protected java.lang.String	getDefaultLabelPlacement()
protected TaskbarFormatManager	getDefaultTaskbarFormatManager()
javax.el.MethodExpression	getDoubleClickListener() Gets a method reference to an action listener
DoubleClickListener[]	getDoubleClickListeners() Returns an array of attached double click listeners.
java.lang.String	getFamily()
javax.el.MethodExpression	getResourceSelectionListener() Gets a method reference to resource selection listener
ResourceSelectionListener[]	getResourceSelectionListeners() Returns an array of attached resource selection listeners.
javax.el.MethodExpression	getTaskSelectionListener() Gets a method reference to task selection listener
TaskSelectionListener[]	getTaskSelectionListeners() Returns an array of attached task selection listeners.
java.lang.String	getWorkingTimeColor() Retrieves the color used to highlight the working time period.
boolean	isHorizontalGridVisible() Gets whether horizontal gridlines should be drawn in the chart portion of the Gantt.
boolean	isShowTasksAsDailyBar() Whether all the task bars within the same day should be shown as one task bar.
void	removeDoubleClickListener(DoubleClickListener listener) Removes a double click listener.
void	removeResourceSelectionListener(ResourceSelectionListener listener) Removes a resource selection listener.
void	removeTaskSelectionListener(TaskSelectionListener listener) Removes a task selection listener.
void	setDoubleClickListener(javax.el.MethodExpression doubleClickListener) Sets a method reference to an action listener
void	setHorizontalGridVisible(boolean visible) Sets whether horizontal gridlines should be drawn in the chart portion of the Gantt.
void	setResourceSelectionListener(javax.el.MethodExpression ResourceSelectionListener) Sets a method reference to resource selection listener
void	setShowTasksAsDailyBar(boolean showTasksAsDailyBar) Specifies whether all the task bars within the same day should be shown as one task bar.
void	setTaskSelectionListener(javax.el.MethodExpression taskSelectionListener) Sets a method reference to task selection listener
void	setWorkingTimeColor(java.lang.String color) Specifies the color used to highlight the working time period.

Methods inherited from class oracle.adf.view.faces.bi.component.gantt.UIGantt

addDataChangeListener, addFilterListener, addGanttActionListener, addSortListener, createCollectionModel, decode, decodeChildrenImpl, getBackgroundColor, getCalendar, getClientListeners, getContentDelivery, getCurrentDate, getCustomizationId, getDataChangeListener, getDataChangeListeners, getDateFormat, getDisclosedRowKeys, getDisplayRowKey, getDontPersist, getEndTime, getFeaturesOff, getFetchSize, getFilterListener, getFilterListeners, getFilterManager, getFirst, getGanttActionListener, getGanttActionListeners, getHighlightColor, getHighlightEndTime, getHighlightStartTime, getHorizontalFetchSize, getIconPlacement, getInlineStyle, getLabelPlacement, getLocale, getMajorAxis, getMinorAxis, getMinWidth, getMode, getNonWorkingDays, getNonWorkingDaysColor, getNonWorkingDaysOfWeek, getPartialTriggers, getPersist, getSortListener, getSortListeners, getSplitterPosition, getStartTime, getStyleClass, getSummary, getTaskbarFormatManager, getTimeZone, getTooltipKeyLabels, getTooltipKeys, getUndoManager, getValue, getVarStatus, getWidth, getZoomToFit, invokeOnComponent, isAutoScale, isShowCurrentDate, isShowMenuBar, isShowToolbar, isThaiCalendarGregorian, processFacetsAndChildren, queueEvent, removeDataChangeListener, removeFilterListener, removeGanttActionListener, removeSortListener, setAutoScale, setBackgroundColor, setCalendar, setClientListeners, setContentDelivery, setCurrentDate, setCustomizationId, setDataChangeListener, setDateFormat, setDisclosedRowKeys, setDisplayRowKey, setDontPersist, setEndTime, setFeaturesOff, setFetchSize, setFilterListener, setFilterManager, setFirst, setGanttActionListener, setHighlightColor, setHighlightEndTime, setHighlightStartTime, setHorizontalFetchSize, setIconPlacement, setInlineStyle, setLabelPlacement, setLocale, setMinWidth, setMode, setNonWorkingDays, setNonWorkingDaysColor, setNonWorkingDaysOfWeek, setPartialTriggers, setPersist, setRowKey, setShowCurrentDate, setShowMenuBar, setShowToolbar, setSortCriteria, setSortListener, setSplitterPosition, setStartTime, setStyleClass, setSummary, setTaskbarFormatManager, setThaiCalendarGregorian, setTimeZone, setTooltipKeyLabels, setTooltipKeys, setUndoManager, setValue, setWidth, setZoomToFit

Methods inherited from class org.apache.myfaces.trinidad.component.UIXCollection

clearCurrencyStringCache, createVarStatusMap, encodeBegin, encodeEnd, getClientRowKey, getClientRowKeyManager, getCollectionModel, getCollectionModel, getContainerClientId, getCurrencyString, getRowCount, getRowData, getRowData, getRowIndex, getRowKey, getSortCriteria, getStamps, getVar, isRowAvailable, isRowAvailable, isSortable, postRowDataChange, preRowDataChange, processComponent, processDecodes, processSaveState, resetStampState, restoreStampState, restoreState, saveStampState, saveState, setClientRowKey, setCurrencyString, setRowIndex, setVar, updateChildrenImpl, validateChildrenImpl

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decodeChildren, encodeAll, encodeChildren, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnChildrenComponents, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processRestoreState, processUpdates, processValidators, removeAttributeChangeListener, removeFacesListener, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, toString, updateChildren, validateChildren

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent

addPartialTarget, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setUpEncodingContext, setupVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitTree, visitTree

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TYPE

public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

MIDNIGHT_BLUE_FORMAT

public static final java.lang.String MIDNIGHT_BLUE_FORMAT

The pre-defined 'Midnight Blue' TaskbarFormat for the metric bar.

See Also:

Constant Field Values

BRICK_RED_FORMAT

public static final java.lang.String BRICK_RED_FORMAT

The pre-defined 'Brick Red' TaskbarFormat for the metric bar.

See Also:

Constant Field Values

LAVENDER_FORMAT

public static final java.lang.String LAVENDER_FORMAT

The pre-defined 'Lavender' TaskbarFormat for the metric bar.

See Also:

Constant Field Values

TEAL_FORMAT

public static final java.lang.String TEAL_FORMAT

The pre-defined 'Teal' TaskbarFormat for the metric bar.

See Also:

Constant Field Values

ORANGE_FORMAT

public static final java.lang.String ORANGE_FORMAT

The pre-defined 'Orange' TaskbarFormat for the metric bar.

See Also:

Constant Field Values

PLUM_FORMAT

public static final java.lang.String PLUM_FORMAT

The pre-defined 'Plum' TaskbarFormat for the metric bar.

See Also:

Constant Field Values

LIME_FORMAT

public static final java.lang.String LIME_FORMAT

The pre-defined 'Lime' TaskbarFormat for the metric bar.

See Also:

Constant Field Values

INDIGO_FORMAT

public static final java.lang.String INDIGO_FORMAT

The pre-defined 'Indigo' TaskbarFormat for the metric bar.

See Also:

Constant Field Values

GREEN_FORMAT

public static final java.lang.String GREEN_FORMAT

The pre-defined 'Green' TaskbarFormat for the metric bar.

See Also:

Constant Field Values

GOLD_FORMAT

public static final java.lang.String GOLD_FORMAT

The pre-defined 'Gold' TaskbarFormat for the metric bar.

See Also:

Constant Field Values

STEEL_BLUE_FORMAT

public static final java.lang.String STEEL_BLUE_FORMAT

The pre-defined 'Steel Blue' TaskbarFormat for the metric bar.

See Also:

Constant Field Values

LEMON_FORMAT

public static final java.lang.String LEMON_FORMAT

The pre-defined 'Lemon' TaskbarFormat for the metric bar.

See Also:

Constant Field Values

WORKINGTIME_COLOR_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey WORKINGTIME_COLOR_KEY

SHOWTASKS_AS_DAILYBAR_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SHOWTASKS_AS_DAILYBAR_KEY

RESOURCE_SELECTION_LISTENER_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey RESOURCE_SELECTION_LISTENER_KEY

TASK_SELECTION_LISTENER_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey TASK_SELECTION_LISTENER_KEY

DOUBLE_CLICK_LISTENER_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey DOUBLE_CLICK_LISTENER_KEY

HORIZONTAL_GRID_VISIBLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey HORIZONTAL_GRID_VISIBLE_KEY

PLACEMENT_LEFT

public static final java.lang.String PLACEMENT_LEFT

See Also:

Constant Field Values

PLACEMENT_RIGHT

public static final java.lang.String PLACEMENT_RIGHT

See Also:

Constant Field Values

PLACEMENT_INSIDE

public static final java.lang.String PLACEMENT_INSIDE

See Also:

Constant Field Values

Constructor Detail

UISchedulingGantt

public UISchedulingGantt()

Constructor an instance of UISchedulingGantt.

UISchedulingGantt

public UISchedulingGantt(java.lang.String rendererType)

Method Detail

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()

Overrides:

getBeanType in class UIGantt

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class org.apache.myfaces.trinidad.component.UIXComponentBase

isHorizontalGridVisible

public final boolean isHorizontalGridVisible()

Gets whether horizontal gridlines should be drawn in the chart portion of the Gantt. Default value is false.

Returns:

true if horizontal gridlines should be drawn in the chart portion of the Gantt. false Otherwise.

setHorizontalGridVisible

public final void setHorizontalGridVisible(boolean visible)

Sets whether horizontal gridlines should be drawn in the chart portion of the Gantt.

Parameters:

visible - whether horizontal gridlines should be drawn in the chart portion of the Gantt. Default value is false.

getTaskSelectionListener

public final javax.el.MethodExpression getTaskSelectionListener()

Gets a method reference to task selection listener

setTaskSelectionListener

public final void setTaskSelectionListener(javax.el.MethodExpression taskSelectionListener)

Sets a method reference to task selection listener

addTaskSelectionListener

public final void addTaskSelectionListener(TaskSelectionListener listener)

Adds a task selection listener.

Parameters:

listener - the task selection listener to add

removeTaskSelectionListener

public final void removeTaskSelectionListener(TaskSelectionListener listener)

Removes a task selection listener.

Parameters:

listener - the task selection listener to remove

getTaskSelectionListeners

public final TaskSelectionListener[] getTaskSelectionListeners()

Returns an array of attached task selection listeners.

Returns:

an array of attached task selection listeners.

getWorkingTimeColor

public final java.lang.String getWorkingTimeColor()

Retrieves the color used to highlight the working time period.

Returns:

The color used to highlight the working time period.

See Also:

setWorkingTimeColor(java.lang.String)

setWorkingTimeColor

public final void setWorkingTimeColor(java.lang.String color)

Specifies the color used to highlight the working time period.

Parameters:

color - The color used to highlight the working time period.

See Also:

getWorkingTimeColor()

isShowTasksAsDailyBar

public final boolean isShowTasksAsDailyBar()

Whether all the task bars within the same day should be shown as one task bar.

Returns:

true if all the task bars within the same day should be shown as one task bar, false otherwise.

setShowTasksAsDailyBar

public final void setShowTasksAsDailyBar(boolean showTasksAsDailyBar)

Specifies whether all the task bars within the same day should be shown as one task bar.

Parameters:

showTasksAsDailyBar - true if all the task bars within the same day should be shown as one task bar, false otherwise.

getResourceSelectionListener

public final javax.el.MethodExpression getResourceSelectionListener()

Gets a method reference to resource selection listener

setResourceSelectionListener

public final void setResourceSelectionListener(javax.el.MethodExpression ResourceSelectionListener)

Sets a method reference to resource selection listener

addResourceSelectionListener

public final void addResourceSelectionListener(ResourceSelectionListener listener)

Adds a resource selection listener.

Parameters:

listener - the resource selection listener to add

removeResourceSelectionListener

public final void removeResourceSelectionListener(ResourceSelectionListener listener)

Removes a resource selection listener.

Parameters:

listener - the resource selection listener to remove

getResourceSelectionListeners

public final ResourceSelectionListener[] getResourceSelectionListeners()

Returns an array of attached resource selection listeners.

Returns:

an array of attached resource selection listeners.

setDoubleClickListener

public final void setDoubleClickListener(javax.el.MethodExpression doubleClickListener)

Sets a method reference to an action listener

getDoubleClickListeners

public final DoubleClickListener[] getDoubleClickListeners()

Returns an array of attached double click listeners.

Returns:

an array of attached double click listeners.

getDoubleClickListener

public final javax.el.MethodExpression getDoubleClickListener()

Gets a method reference to an action listener

addDoubleClickListener

public final void addDoubleClickListener(DoubleClickListener listener)

Adds a double click listener.

Parameters:

listener - the double click listener to add

removeDoubleClickListener

public final void removeDoubleClickListener(DoubleClickListener listener)

Removes a double click listener.

Parameters:

listener - the double click listener to remove

getDefaultFilter

protected Filter getDefaultFilter()

Specified by:

getDefaultFilter in class UIGantt

For internal use only. Application developers should not use this

getDefaultDateFormat

protected java.text.DateFormat getDefaultDateFormat()

Specified by:

getDefaultDateFormat in class UIGantt

For internal use only. Application developers should not use this

getDefaultTaskbarFormatManager

protected TaskbarFormatManager getDefaultTaskbarFormatManager()

Specified by:

getDefaultTaskbarFormatManager in class UIGantt

For internal use only. Application developers should not use this

getDefaultLabelPlacement

protected java.lang.String getDefaultLabelPlacement()

Specified by:

getDefaultLabelPlacement in class UIGantt

getDefaultIconPlacement

protected java.lang.String getDefaultIconPlacement()

Specified by:

getDefaultIconPlacement in class UIGantt

broadcast

public void broadcast(javax.faces.event.FacesEvent evt)

Internal. Application should never call this method directly.

Overrides:

broadcast in class UIGantt

Parameters:

evt -