ilog.views.schedule

Class IlvResourceDataChart

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

ilog.views.schedule.IlvScheduleDataChart

ilog.views.schedule.IlvResourceDataChart

All Implemented Interfaces:

IlvAcceptFunctions, IlvStylable, ImageObserver, MenuContainer, Serializable

public class IlvResourceDataChart
extends IlvScheduleDataChart

An IlvResourceDataChart displays time-based numerical data obtained from the reservations that are assigned to displayed resources. The IlvResourceDataChart uses an IlvReservationDataPolicy to compute the data values for each reservation. The default policy is an instance of IlvReservationLoadData that configures the chart to display resource loading.

Since:

JViews 6.0

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static int	AUTO_RESOURCE_DISPLAY_DISABLED Indicates that resources are not automatically displayed by the Resource Data chart.
static int	DISPLAY_ALL_LEAVES Indicates that all leaf resources in the data model are automatically displayed by the Resource Data chart.
static int	DISPLAY_ALL_RESOURCES Indicates that all resources in the data model are automatically displayed by the Resource Data chart.
static int	DISPLAY_SELECTED_LEAVES Indicates that when a leaf resource is selected in a synchronized Schedule chart, its data will be displayed in the Resource Data chart.
static int	DISPLAY_SELECTED_RESOURCES Indicates that when a resource is selected in a synchronized Schedule chart, its data will be displayed in the Resource Data chart.
static int	DISPLAY_SELECTED_SUBTREES The same as DISPLAY_SELECTED_RESOURCES with the addition that when a parent resource is selected in the synchronized Schedule chart, the data of all its descendant resources will also be displayed in the Resource Data chart.

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface ilog.views.util.styling.IlvStylable

APPLIED_RULE_MASK, BAD_CLASS_MASK, BAD_PROP_MASK, BAD_PROP_WITH_STACK_MASK, CREATED_MASK, DECL_MASK, DECL_VALUE_MASK, FAILED_CONVERSIONS_MASK, TIME_REPORT_MASK, WARNING_PROP_MASK

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
IlvResourceDataChart() Constructs a new IlvResourceDataChart with a default IlvReservationLoadData computation policy.
IlvResourceDataChart(IlvReservationDataPolicy dataPolicy) Constructs a new IlvResourceDataChart with the specified data value computation policy.

Method Summary

Modifier and Type	Method and Description
void	clearAllDisplayedResources() Deselects all resources from being displayed.
IlvResourceDataSet	createDataSet(IlvResource resource, IlvReservationDataPolicy dataPolicy) Creates a dataset for the specified resource.
Iterator<IlvResource>	displayedResourcesIterator() Returns an iterator over the currently displayed resources.
void	displayResource(IlvResource resource, boolean displayed) Selects or deselects the specified resource for display.
IlvReservationDataPolicy	getReservationDataPolicy() Returns the strategy that the chart uses to compute the data values for the reservations assigned to each displayed resource.
int	getResourceDisplayMode() Returns the current resource display mode.
boolean	isDisplayed(IlvResource resource) Returns whether the specified resource is displayed.
void	setReservationDataPolicy(IlvReservationDataPolicy dataPolicy) Sets the strategy that the chart uses to compute the data values for the reservations assigned to each displayed resource.
void	setResourceDisplayMode(int mode) Sets the resource display mode.
void	syncGanttModel(IlvScheduleChart scheduleChart) Synchronizes the Gantt data model of this chart to that of the specified Schedule chart.
void	syncGanttModel(IlvScheduleChart scheduleChart, int resourceDisplayMode) Synchronizes the Gantt data model of this chart to that of the specified Schedule chart.
void	unsyncGanttModel() Cancels the synchronization of the Gantt data model previously established by the syncGanttModel(ilog.views.gantt.IlvScheduleChart) method.

Methods inherited from class ilog.views.schedule.IlvScheduleDataChart

addChartDrawListener, addChartListener, addChartRendererListener, addDecoration, addGanttModelListener, addInteractor, addInteractor, addLegend, addTimeScrollListener, createDefaultTimeScale, createDefaultXGrid, fireGanttModelAboutToChange, fireGanttModelChanged, getBaseTextDirection, getChartArea, getChartAreaBorder, getDataRangePolicy, getDecorations, getDefaultColors, getFontManager, getFooter, getFooterText, getGanttModel, getHeader, getHeaderText, getInteractors, getLegend, getLegendPosition, getMaxVisibleTime, getMinVisibleDuration, getMinVisibleTime, getPlotAreaBackground, getRenderer, getStyleSheet, getStyleSheetDebugMask, getStyleSheets, getStyleSheets, getTimeConverter, getTimeScale, getULocale, getVisibleDuration, getVisibleInterval, getVisibleTime, getXGrid, getYAxis, getYGrid, getYScale, getYScaleTitle, getYScaleTitleRotation, isAntiAliasing, isAntiAliasingText, isLegendVisible, isScalingFont, isYAxisReversed, isYGridVisible, isYScaleVisible, registerFunction, removeChartDrawListener, removeChartListener, removeChartRendererListener, removeDecoration, removeGanttModelListener, removeInteractor, removeTimeScrollListener, setAntiAliasing, setAntiAliasingText, setBackground, setBaseTextDirection, setChartAreaBorder, setDataRangePolicy, setDecorations, setDefaultColors, setFont, setFooter, setFooterText, setForeground, setGanttModel, setHeader, setHeaderText, setInteractors, setLegend, setLegendPosition, setLegendVisible, setLocale, setMaxVisibleTime, setMinVisibleDuration, setMinVisibleTime, setOpaque, setPlotAreaBackground, setRenderer, setScalingFont, setStyleSheet, setStyleSheetDebugMask, setStyleSheets, setStyleSheets, setTimeConverter, setTimeScale, setULocale, setVisibleDuration, setVisibleInterval, setVisibleTime, setXGrid, setYAxisReversed, setYGrid, setYGridVisible, setYScale, setYScaleTitle, setYScaleTitleRotation, setYScaleVisible, syncXAxis, unsyncXAxis

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface ilog.views.util.styling.IlvStylable

addPropertyChangeListener, removePropertyChangeListener

Field Detail

AUTO_RESOURCE_DISPLAY_DISABLED

public static final int AUTO_RESOURCE_DISPLAY_DISABLED

Indicates that resources are not automatically displayed by the Resource Data chart. In this mode, resources must be explicitly selected for display in the chart.

See Also:

setResourceDisplayMode(int), DISPLAY_SELECTED_RESOURCES, DISPLAY_SELECTED_SUBTREES, DISPLAY_SELECTED_LEAVES, DISPLAY_ALL_RESOURCES, DISPLAY_ALL_LEAVES, Constant Field Values

DISPLAY_SELECTED_RESOURCES

public static final int DISPLAY_SELECTED_RESOURCES

Indicates that when a resource is selected in a synchronized Schedule chart, its data will be displayed in the Resource Data chart.

See Also:

syncGanttModel(ilog.views.gantt.IlvScheduleChart), setResourceDisplayMode(int), AUTO_RESOURCE_DISPLAY_DISABLED, DISPLAY_SELECTED_SUBTREES, DISPLAY_SELECTED_LEAVES, DISPLAY_ALL_RESOURCES, DISPLAY_ALL_LEAVES, Constant Field Values

DISPLAY_SELECTED_SUBTREES

public static final int DISPLAY_SELECTED_SUBTREES

The same as DISPLAY_SELECTED_RESOURCES with the addition that when a parent resource is selected in the synchronized Schedule chart, the data of all its descendant resources will also be displayed in the Resource Data chart.

See Also:

syncGanttModel(ilog.views.gantt.IlvScheduleChart), setResourceDisplayMode(int), AUTO_RESOURCE_DISPLAY_DISABLED, DISPLAY_SELECTED_RESOURCES, DISPLAY_SELECTED_LEAVES, DISPLAY_ALL_RESOURCES, DISPLAY_ALL_LEAVES, Constant Field Values

DISPLAY_SELECTED_LEAVES

public static final int DISPLAY_SELECTED_LEAVES

Indicates that when a leaf resource is selected in a synchronized Schedule chart, its data will be displayed in the Resource Data chart. When a parent resource is selected in the Schedule chart, only the data of its descendant leaf resources will be displayed in the Resource Data chart. The data of of the selected parent resource itself is not displayed.

See Also:

syncGanttModel(ilog.views.gantt.IlvScheduleChart), setResourceDisplayMode(int), AUTO_RESOURCE_DISPLAY_DISABLED, DISPLAY_SELECTED_RESOURCES, DISPLAY_SELECTED_SUBTREES, DISPLAY_ALL_RESOURCES, DISPLAY_ALL_LEAVES, Constant Field Values

DISPLAY_ALL_RESOURCES

public static final int DISPLAY_ALL_RESOURCES

Indicates that all resources in the data model are automatically displayed by the Resource Data chart.

See Also:

setResourceDisplayMode(int), DISPLAY_SELECTED_RESOURCES, DISPLAY_SELECTED_SUBTREES, DISPLAY_SELECTED_LEAVES, DISPLAY_ALL_LEAVES, Constant Field Values

DISPLAY_ALL_LEAVES

public static final int DISPLAY_ALL_LEAVES

Indicates that all leaf resources in the data model are automatically displayed by the Resource Data chart.

See Also:

setResourceDisplayMode(int), AUTO_RESOURCE_DISPLAY_DISABLED, DISPLAY_SELECTED_RESOURCES, DISPLAY_SELECTED_SUBTREES, DISPLAY_SELECTED_LEAVES, DISPLAY_ALL_RESOURCES, Constant Field Values

Constructor Detail

IlvResourceDataChart

public IlvResourceDataChart(IlvReservationDataPolicy dataPolicy)

Constructs a new IlvResourceDataChart with the specified data value computation policy.

Parameters:

dataPolicy - The strategy that the chart will use to compute the data values for the reservations assigned to each displayed resource.

IlvResourceDataChart

public IlvResourceDataChart()

Constructs a new IlvResourceDataChart with a default IlvReservationLoadData computation policy. This configures the chart to display the loading of each displayed resource.

Method Detail

getReservationDataPolicy

public IlvReservationDataPolicy getReservationDataPolicy()

Returns the strategy that the chart uses to compute the data values for the reservations assigned to each displayed resource.

See Also:

getReservationDataPolicy()

setReservationDataPolicy

public void setReservationDataPolicy(IlvReservationDataPolicy dataPolicy)

Sets the strategy that the chart uses to compute the data values for the reservations assigned to each displayed resource.

Parameters:

dataPolicy - The reservation computation policy.

See Also:

getReservationDataPolicy()

syncGanttModel

public void syncGanttModel(IlvScheduleChart scheduleChart)

Synchronizes the Gantt data model of this chart to that of the specified Schedule chart. The data model of this chart is initialized to be the same as that of the Schedule chart. Subsequently, any change to the data model of either chart will be synchronized to the other. After you have synchronized the chart data models, you can optionally synchronize the resources that are displayed by setting the resource display mode to one of DISPLAY_SELECTED_RESOURCES, DISPLAY_SELECTED_SUBTREES, or DISPLAY_SELECTED_LEAVES.

Parameters:

scheduleChart - The Schedule chart.

See Also:

unsyncGanttModel()

syncGanttModel

public void syncGanttModel(IlvScheduleChart scheduleChart,
                           int resourceDisplayMode)

Synchronizes the Gantt data model of this chart to that of the specified Schedule chart. The data model of this chart is initialized to be the same as that of the Schedule chart. Subsequently, any change to the data model of either chart will be synchronized to the other. The resourceDisplayMode allows for optional synchronization between the resources selected in the Schedule chart and the resources displayed in this chart.

Parameters:

scheduleChart - The Schedule chart.

resourceDisplayMode - Specifies how the resources selected in the Schedule chart should be synchronized to the resources displayed in this chart. The value must be one of:

• AUTO_RESOURCE_DISPLAY_DISABLED
• DISPLAY_SELECTED_RESOURCES
• DISPLAY_SELECTED_SUBTREES
• DISPLAY_SELECTED_LEAVES
• DISPLAY_ALL_RESOURCES
• DISPLAY_ALL_LEAVES

See Also:

unsyncGanttModel(), setResourceDisplayMode(int)

unsyncGanttModel

public void unsyncGanttModel()

Cancels the synchronization of the Gantt data model previously established by the syncGanttModel(ilog.views.gantt.IlvScheduleChart) method. If the resource display mode is one of DISPLAY_SELECTED_RESOURCES, DISPLAY_SELECTED_SUBTREES, or DISPLAY_SELECTED_LEAVES then the display mode will be reset to AUTO_RESOURCE_DISPLAY_DISABLED.

See Also:

syncGanttModel(ilog.views.gantt.IlvScheduleChart)

getResourceDisplayMode

public int getResourceDisplayMode()

Returns the current resource display mode. The value will be one of:

• AUTO_RESOURCE_DISPLAY_DISABLED
• DISPLAY_SELECTED_RESOURCES
• DISPLAY_SELECTED_SUBTREES
• DISPLAY_SELECTED_LEAVES
• DISPLAY_ALL_RESOURCES
• DISPLAY_ALL_LEAVES

The default value is DISPLAY_ALL_LEAVES, indicating that all leaf resources in the data model will be automatically displayed in the chart.

See Also:

setResourceDisplayMode(int), syncGanttModel(ilog.views.gantt.IlvScheduleChart)

setResourceDisplayMode

public void setResourceDisplayMode(int mode)

Sets the resource display mode.

Parameters:

mode - The display mode. The value must be one of:

• AUTO_RESOURCE_DISPLAY_DISABLED
• DISPLAY_SELECTED_RESOURCES : This value is only valid when the data model of the chart is synchronized to that of a Schedule chart.
• DISPLAY_SELECTED_SUBTREES : This value is only valid when the data model of the chart is synchronized to that of a Schedule chart.
• DISPLAY_SELECTED_LEAVES : This value is only valid when the data model of the chart is synchronized to that of a Schedule chart.
• DISPLAY_ALL_RESOURCES
• DISPLAY_ALL_LEAVES

Throws:

IllegalArgumentException - if mode is DISPLAY_SELECTED_RESOURCES, DISPLAY_SELECTED_SUBTREES, or DISPLAY_SELECTED_LEAVES and the data model is not currently synchronized to a Schedule chart.

See Also:

getResourceDisplayMode()

isDisplayed

public boolean isDisplayed(IlvResource resource)

Returns whether the specified resource is displayed.

Parameters:

resource - The resource.

Returns:

true if the resource is displayed, and code>false otherwise.

Throws:

IllegalArgumentException - if resource is null.

createDataSet

public IlvResourceDataSet createDataSet(IlvResource resource,
                                        IlvReservationDataPolicy dataPolicy)

Creates a dataset for the specified resource. The resource must be a member of the chart's Gantt data model. When you are no longer using the dataset, make sure to call dataset.setResource(null) so that the dataset is properly disconnected from the data model.

Parameters:

resource - The resource.

dataPolicy - The strategy that the data set will use to compute the data values for each reservation assigned to the resource.

Returns:

The data set representing the resource.

Since:

JViews 8.5

displayResource

public void displayResource(IlvResource resource,
                            boolean displayed)

Selects or deselects the specified resource for display. This method disables automatic resource display.

Parameters:

resource - The resource.

displayed - Indicates whether the specified resource should be displayed or not.

See Also:

clearAllDisplayedResources(), displayedResourcesIterator()

clearAllDisplayedResources

public void clearAllDisplayedResources()

Deselects all resources from being displayed. This method disables automatic resource display.

See Also:

displayResource(ilog.views.gantt.IlvResource, boolean), displayedResourcesIterator()

displayedResourcesIterator

public Iterator<IlvResource> displayedResourcesIterator()

Returns an iterator over the currently displayed resources.

Returns:

An iterator over the displayed resources.

See Also:

displayResource(ilog.views.gantt.IlvResource, boolean), clearAllDisplayedResources()