Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components
11g Release 1 (11.1.1.7.0)

E12063-08

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

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by org.apache.myfaces.trinidad.component.UIXComponent
          extended by org.apache.myfaces.trinidad.component.UIXComponentBase
              extended by org.apache.myfaces.trinidad.component.UIXCollection
                  extended by oracle.adf.view.faces.bi.component.gantt.UIGantt
                      extended by oracle.adf.view.faces.bi.component.gantt.UIProjectGantt
All Implemented Interfaces:
javax.faces.component.NamingContainer, javax.faces.component.StateHolder, oracle.adf.view.rich.dnd.DragSourceFactory

public class UIProjectGantt
extends UIGantt

The Project Gantt control is used to display data in a task-oriented Gantt chart. The Project 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 Project 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 Project 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 Project 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 Project 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 COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
static org.apache.myfaces.trinidad.bean.PropertyKey DOUBLE_CLICK_LISTENER_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey HORIZONTAL_GRID_VISIBLE_KEY
           
static java.lang.String MILESTONE_BASELINE_STYLE
           
static java.lang.String MILESTONE_CRITICAL_BASELINE_STYLE
           
static java.lang.String MILESTONE_CRITICAL_STYLE
           
static java.lang.String MILESTONE_STYLE
           
static java.lang.String NORMAL_ACTUAL_CRITICAL_PROGRESS_STYLE
           
static java.lang.String NORMAL_ACTUAL_CRITICAL_STYLE
           
static java.lang.String NORMAL_ACTUAL_PROGRESS_STYLE
           
static java.lang.String NORMAL_ACTUAL_STYLE
           
static java.lang.String NORMAL_BASELINE_STYLE
           
static java.lang.String NORMAL_CRITICAL_PROGRESS_STYLE
           
static java.lang.String NORMAL_CRITICAL_STYLE
           
static java.lang.String NORMAL_PROGRESS_STYLE
           
static java.lang.String NORMAL_STYLE
           
static java.lang.String PLACEMENT_END
           
static java.lang.String PLACEMENT_INNER_CENTER
           
static java.lang.String PLACEMENT_INNER_END
           
static java.lang.String PLACEMENT_INNER_LEFT
           
static java.lang.String PLACEMENT_INNER_RIGHT
           
static java.lang.String PLACEMENT_INNER_START
           
static java.lang.String PLACEMENT_INSIDE
           
static java.lang.String PLACEMENT_LEFT
           
static java.lang.String PLACEMENT_RIGHT
           
static java.lang.String PLACEMENT_START
           
static java.lang.String SUMMARY_CRITICAL_PROGRESS_STYLE
           
static java.lang.String SUMMARY_CRITICAL_STYLE
           
static java.lang.String SUMMARY_PROGRESS_STYLE
           
static java.lang.String SUMMARY_STYLE
           
static org.apache.myfaces.trinidad.bean.PropertyKey TASK_SELECTION_LISTENER_KEY
           
static org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
           
 
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_IMMEDIATE, CONTENT_DELIVERY_KEY, CONTENT_DELIVERY_LAZY, CURRENT_DATE_KEY, CUSTOM_CHART_CONTEXT_MENU_FACET, CUSTOM_PANEL_FACET, CUSTOM_TABLE_CONTEXT_MENU_FACET, CUSTOM_TIMESCALES_KEY, CUSTOMIZATION_ID_KEY, DATA_CHANGE_LISTENER_KEY, DATE_FORMATTER_KEY, DISCLOSED_ROW_KEYS_KEY, DISPLAY_ROW_FIRST, DISPLAY_ROW_KEY, DISPLAY_ROW_LAST, DISPLAY_ROW_SELECTED, DISPLAY_ROWKEY_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, INITIAL_DATE_FOCUS_KEY, INITIALLY_EXPAND_ALL_KEY, 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, SCROLL_POLICY_AUTO, SCROLL_POLICY_KEY, SCROLL_POLICY_PAGE, SCROLL_POLICY_SCROLL, SELECTED_ROW_KEYS_KEY, 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 oracle.adf.view.rich.dnd.DragSourceFactory
DEFAULT_DRAGSOURCE
 
Fields inherited from interface javax.faces.component.NamingContainer
SEPARATOR_CHAR
 
Constructor Summary
UIProjectGantt()
          Constructs an instance of the UIProjectGantt.
UIProjectGantt(java.lang.String rendererType)
           
 
Method Summary
 void addDoubleClickListener(DoubleClickListener listener)
          Adds a double click 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()
           
 java.lang.String getRendererType()
           
 javax.el.MethodExpression getTaskSelectionListener()
          Gets a method reference to task selection listener
 TaskSelectionListener[] getTaskSelectionListeners()
          Returns an array of attached task selection listeners.
 boolean isHorizontalGridVisible()
          Gets whether horizontal gridlines should be drawn in the chart portion of the Gantt.
 void removeDoubleClickListener(DoubleClickListener listener)
          Removes a double click 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 setTaskSelectionListener(javax.el.MethodExpression taskSelectionListener)
          Sets a method reference to task selection listener
 
Methods inherited from class oracle.adf.view.faces.bi.component.gantt.UIGantt
addDataChangeListener, addFilterListener, addGanttActionListener, addSortListener, createCollectionModel, createDragSource, createDragSourceBehavior, decode, decodeChildrenImpl, getBackgroundColor, getCalendar, getClientListeners, getContentDelivery, getCurrentDate, getCustomizationId, getCustomTimeScales, getDataChangeListener, getDataChangeListeners, getDateFormat, getDisclosedRowKeys, getDisplayRow, getDisplayRowKey, getDontPersist, getEndTime, getFacetsAndChildren, getFeaturesOff, getFetchSize, getFilterListener, getFilterListeners, getFilterManager, getFirst, getGanttActionListener, getGanttActionListeners, getHighlightColor, getHighlightEndTime, getHighlightStartTime, getHorizontalFetchSize, getIconPlacement, getInitialDateFocus, getInlineStyle, getLabelPlacement, getLocale, getMajorAxis, getMinorAxis, getMinWidth, getMode, getNonWorkingDays, getNonWorkingDaysColor, getNonWorkingDaysOfWeek, getPartialTriggers, getPersist, getScrollPolicy, getSelectedRowKeys, getSortListener, getSortListeners, getSplitterPosition, getStartTime, getStyleClass, getSummary, getTaskbarFormatManager, getTimeZone, getTooltipKeyLabels, getTooltipKeys, getUndoManager, getValue, getVarStatus, getWidth, getZoomToFit, invokeOnComponent, isAutoScale, isInitiallyExpandAll, isShowCurrentDate, isShowMenuBar, isShowToolbar, isThaiCalendarGregorian, processFacetsAndChildren, queueEvent, removeDataChangeListener, removeFilterListener, removeGanttActionListener, removeSortListener, restoreState, setAutoScale, setBackgroundColor, setCalendar, setClientListeners, setContentDelivery, setCurrentDate, setCustomizationId, setCustomTimeScales, setDataChangeListener, setDateFormat, setDisclosedRowKeys, setDisplayRow, setDisplayRowKey, setDontPersist, setEndTime, setFeaturesOff, setFetchSize, setFilterListener, setFilterManager, setFirst, setGanttActionListener, setHighlightColor, setHighlightEndTime, setHighlightStartTime, setHorizontalFetchSize, setIconPlacement, setInitialDateFocus, setInitiallyExpandAll, setInlineStyle, setLabelPlacement, setLocale, setMinWidth, setMode, setNonWorkingDays, setNonWorkingDaysColor, setNonWorkingDaysOfWeek, setPartialTriggers, setPersist, setRowKey, setScrollPolicy, setSelectedRowKeys, 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
areRowsLocallyAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, clearCachedRow, clearCachedRow, clearCachedRows, clearCachedRows, clearCurrencyStringCache, clearLocalCache, createVarStatusMap, encodeBegin, encodeEnd, ensureRowsAvailable, getCachingStrategy, getClientRowKey, getClientRowKeyManager, getCollectionModel, getCollectionModel, getContainerClientId, getCurrencyString, getEstimatedRowCount, getEstimatedRowCountConfidence, getRowCount, getRowData, getRowData, getRowIndex, getRowKey, getSortCriteria, getStamps, getVar, isRowAvailable, isRowAvailable, isRowLocallyAvailable, isRowLocallyAvailable, isSortable, postCreateCollectionModel, postRowDataChange, preRowDataChange, processComponent, processDecodes, processSaveState, resetStampState, restoreStampState, saveStampState, saveState, setClientRowKey, setCurrencyString, setRowIndex, setVar, updateChildrenImpl, validateChildrenImpl
 
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decodeChildren, encodeChildren, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getComponentChangeFilters, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendersChildren, getValueBinding, getValueExpression, invokeOnChildrenComponents, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processRestoreState, processUpdates, processValidators, removeAttributeChangeListener, removeComponentChangeFilter, removeFacesListener, satisfiesPartialTrigger, 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, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setUpEncodingContext, setupVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitTree, visitTree
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll
 
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

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

NORMAL_STYLE

public static final java.lang.String NORMAL_STYLE
See Also:
Constant Field Values

NORMAL_PROGRESS_STYLE

public static final java.lang.String NORMAL_PROGRESS_STYLE
See Also:
Constant Field Values

NORMAL_CRITICAL_STYLE

public static final java.lang.String NORMAL_CRITICAL_STYLE
See Also:
Constant Field Values

NORMAL_BASELINE_STYLE

public static final java.lang.String NORMAL_BASELINE_STYLE
See Also:
Constant Field Values

NORMAL_ACTUAL_STYLE

public static final java.lang.String NORMAL_ACTUAL_STYLE
See Also:
Constant Field Values

NORMAL_ACTUAL_PROGRESS_STYLE

public static final java.lang.String NORMAL_ACTUAL_PROGRESS_STYLE
See Also:
Constant Field Values

NORMAL_ACTUAL_CRITICAL_STYLE

public static final java.lang.String NORMAL_ACTUAL_CRITICAL_STYLE
See Also:
Constant Field Values

NORMAL_CRITICAL_PROGRESS_STYLE

public static final java.lang.String NORMAL_CRITICAL_PROGRESS_STYLE
See Also:
Constant Field Values

NORMAL_ACTUAL_CRITICAL_PROGRESS_STYLE

public static final java.lang.String NORMAL_ACTUAL_CRITICAL_PROGRESS_STYLE
See Also:
Constant Field Values

MILESTONE_STYLE

public static final java.lang.String MILESTONE_STYLE
See Also:
Constant Field Values

MILESTONE_BASELINE_STYLE

public static final java.lang.String MILESTONE_BASELINE_STYLE
See Also:
Constant Field Values

MILESTONE_CRITICAL_STYLE

public static final java.lang.String MILESTONE_CRITICAL_STYLE
See Also:
Constant Field Values

MILESTONE_CRITICAL_BASELINE_STYLE

public static final java.lang.String MILESTONE_CRITICAL_BASELINE_STYLE
See Also:
Constant Field Values

SUMMARY_STYLE

public static final java.lang.String SUMMARY_STYLE
See Also:
Constant Field Values

SUMMARY_PROGRESS_STYLE

public static final java.lang.String SUMMARY_PROGRESS_STYLE
See Also:
Constant Field Values

SUMMARY_CRITICAL_STYLE

public static final java.lang.String SUMMARY_CRITICAL_STYLE
See Also:
Constant Field Values

SUMMARY_CRITICAL_PROGRESS_STYLE

public static final java.lang.String SUMMARY_CRITICAL_PROGRESS_STYLE
See Also:
Constant Field Values

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

PLACEMENT_INNER_CENTER

public static final java.lang.String PLACEMENT_INNER_CENTER
See Also:
Constant Field Values

PLACEMENT_INNER_LEFT

public static final java.lang.String PLACEMENT_INNER_LEFT
See Also:
Constant Field Values

PLACEMENT_INNER_RIGHT

public static final java.lang.String PLACEMENT_INNER_RIGHT
See Also:
Constant Field Values

PLACEMENT_START

public static final java.lang.String PLACEMENT_START
See Also:
Constant Field Values

PLACEMENT_END

public static final java.lang.String PLACEMENT_END
See Also:
Constant Field Values

PLACEMENT_INNER_START

public static final java.lang.String PLACEMENT_INNER_START
See Also:
Constant Field Values

PLACEMENT_INNER_END

public static final java.lang.String PLACEMENT_INNER_END
See Also:
Constant Field Values
Constructor Detail

UIProjectGantt

public UIProjectGantt()
Constructs an instance of the UIProjectGantt.


UIProjectGantt

public UIProjectGantt(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

getRendererType

public java.lang.String getRendererType()
Overrides:
getRendererType 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.

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 -

Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components
11g Release 1 (11.1.1.7.0)

E12063-08

Copyright © 1997, 2013, Oracle. All rights reserved.