ilog.views.gantt

Class IlvJScrollGanttSheet

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

ilog.views.gantt.IlvJScrollGanttSheet

All Implemented Interfaces:

IlvTimeScrollable, IlvVerticalScrollable, ImageObserver, MenuContainer, Serializable

public class IlvJScrollGanttSheet
extends JComponent
implements IlvTimeScrollable, IlvVerticalScrollable

An IlvJScrollGanttSheet is a user interface component that consists of an IlvGanttTimeScale positioned above an IlvGanttSheet. By default, an IlvTimeScrollBar is placed along the bottom and a vertical scroll bar is placed against the right margin.

The IlvJScrollGanttSheet class implements both the IlvTimeScrollable and IlvVerticalScrollable interfaces. A Gantt configuration is used to coordinate the horizontal scrolling of the time scale, the Gantt sheet, and the time scroll bar and the vertical scrolling of the Gantt sheet and the vertical scroll bar. The Gantt configuration can be provided when the sheet is constructed or by calling the setGanttConfiguration(ilog.views.gantt.IlvGanttConfiguration) method. However, it is important to note that the scrollable APIs cannot be used until the sheet is provided with a configuration.

Two horizontal time scrolling modes are supported:

• Bounded scrolling mode: in this mode, time scrolling is constrained by the minimum visible time and the maximum visible time. Both values must be valid and non-null.

  In bounded scrolling mode there are four interrelated time properties: minVisibleTime, maxVisibleTime, visibleTime, and visibleDuration. These four values define two nested ranges like this:

  
   minVisibleTime <= visibleTime <= visibleTime + visibleDuration <= maxVisibleTime
     

  The sheet enforces this relationship by correcting or trimming properties in the following way:

  • The setMinVisibleTime(java.util.Date) and setMaxVisibleTime(java.util.Date) methods first validate that:

    
     minVisibleTime <= maxVisibleTime
           

    If not, an IllegalArgumentException is thrown.
  • The visible time and visible duration properties may be trimmed (in that order), to fit within the new min-max interval.
  • The setVisibleTime(java.util.Date) and setVisibleDuration(ilog.views.gantt.IlvDuration) methods trim their argument to fit within the limits defined by the other three properties. For example, if maxVisibleTime.equals(visibleTime.add(IlvDuration.ONE_DAY)), then setVisibleDuration(IlvDuration.ONE_WEEK) would change the duration to IlvDuration.ONE_DAY.

  The sheet uses the IlvTimeScrollUtil.trimInterval(ilog.views.gantt.IlvTimeInterval, java.util.Date, java.util.Date, ilog.views.gantt.IlvDuration) method to perform consistent validation and trimming of the time value arguments.

• Unbounded scrolling mode: in this mode, the minimum visible time and the maximum visible time are undefined and are set to null.

  Even in unbounded scrolling mode, there is an inherent limitation on the minimum and maximum times that can be scrolled to. As in bounded scrolling mode, this is enforced by having the sheet use the IlvTimeScrollUtil.trimInterval(ilog.views.gantt.IlvTimeInterval, java.util.Date, java.util.Date, ilog.views.gantt.IlvDuration) method to perform validation and trimming of the time value arguments.

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	HORIZONTAL Horizontal orientation.
static int	VERTICAL Vertical orientation.
static int	VERTICAL_SCROLLBAR_ALWAYS The vertical scroll bar will always be displayed.
static int	VERTICAL_SCROLLBAR_AS_NEEDED The vertical scroll bar will be displayed as needed.
static int	VERTICAL_SCROLLBAR_NEVER The vertical scroll bar will never be displayed.

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.gantt.IlvTimeScrollable

DEFAULT_MINIMUM_DURATION

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
IlvJScrollGanttSheet() Creates an IlvJScrollGanttSheet with a default Gantt sheet, time scale, and horizontal time scroll bar.
IlvJScrollGanttSheet(IlvGanttConfiguration ganttConfig) Creates an IlvJScrollGanttSheet with a default Gantt sheet, time scale, and horizontal time scroll bar.
IlvJScrollGanttSheet(IlvGanttConfiguration ganttConfig, IlvGanttSheet sheet, IlvTimeScale timeScale, IlvTimeScrollBar scrollbar) Creates an IlvJScrollGanttSheet component that is composed of the specified Gantt sheet, time scale, and horizontal time scroll bar.
IlvJScrollGanttSheet(IlvGanttSheet sheet, IlvTimeScale timeScale, IlvTimeScrollBar scrollbar) Creates an IlvJScrollGanttSheet component that is composed of the specified Gantt sheet, time scale, and horizontal time scroll bar.

Method Summary

Modifier and Type	Method and Description
void	addTimeScrollListener(TimeScrollListener listener) Adds the specified listener to receive time scroll events from this sheet.
void	addVerticalScrollListener(VerticalScrollListener listener) Adds the specified listener to receive vertical scroll events from this scrolling Gantt sheet.
protected void	baseTextDirectionChanged() This method is invoked when the effective base text direction has changed.
protected IlvGanttSheet	createDefaultGanttSheet() Creates a default Gantt sheet to place in the center of this component.
protected IlvTimeScale	createDefaultTimeScale() Creates a default time scale to place along the top of this component.
protected IlvTimeScrollBar	createDefaultTimeScrollBar() Creates a default horizontal time scroll bar to place along the top of this component.
void	doLayout() Performs the Gantt sheet layout.
int	getBaseTextDirection() Returns the base text direction for this scrollable Gantt sheet.
IlvGanttSheet	getGanttSheet() Returns the child Gantt sheet component.
int	getMaxVerticalPosition() Returns the maximum vertical position that the scrolling Gantt sheet can display.
Date	getMaxVisibleTime() Returns the maximum time that the sheet can show in bounded scrolling mode.
IlvDuration	getMinVisibleDuration() Returns the minimum duration that the sheet can show.
Date	getMinVisibleTime() Returns the minimum time that the sheet can show in bounded scrolling mode.
int	getMouseWheelPreferredOrientation() Returns the preferred orientation of scrolling by the mouse wheel, either VERTICAL or HORIZONTAL.
int	getResolvedBaseTextDirection() Returns the resolved base text direction.
IlvTimeScale	getTimeScale() Returns the time scale that is displayed along the top of the Gantt sheet.
IlvTimeScrollBar	getTimeScrollBar() Returns the horizontal time scroll bar.
int	getVerticalExtent() Returns the extent of the vertical range displayed by the scrolling Gantt sheet.
int	getVerticalPosition() Returns the beginning of the vertical range displayed by the scrolling Gantt sheet.
IlvVerticalScrollBar	getVerticalScrollBar() Returns the vertical scroll bar.
int	getVerticalScrollBarPolicy() Returns the vertical scroll bar policy, which will be one of the values: VERTICAL_SCROLLBAR_AS_NEEDED, VERTICAL_SCROLLBAR_NEVER, or VERTICAL_SCROLLBAR_ALWAYS.
IlvDuration	getVisibleDuration() Returns the duration of the time interval displayed by the sheet.
IlvTimeInterval	getVisibleInterval() Returns the time interval displayed by the sheet.
Date	getVisibleTime() Returns the beginning of the time interval displayed by the sheet.
boolean	isMouseWheelEnabled() Indicates whether or not scrolling and zooming will take place in response to movement of the mouse wheel.
boolean	isTimeScrollBarVisible() Returns the visibility status of the time scroll bar.
void	processManagerViewKeyEvent(KeyEvent event) This method is invoked by this Swing container's IlvManagerView for any keystrokes that have not been consumed by the view's interactor or registered key listeners.
void	removeTimeScrollListener(TimeScrollListener listener) Removes the specified listener so that it will no longer receive time scroll events from this sheet.
void	removeVerticalScrollListener(VerticalScrollListener listener) Removes the specified listener so that it will no longer receive vertical scroll events from this scrolling Gantt sheet.
void	setBaseTextDirection(int btd) Sets the base text direction for this scrollable Gantt sheet.
void	setGanttConfiguration(IlvGanttConfiguration ganttConfig) Sets the Gantt configuration that will coordinate horizontal time scrolling, vertical scrolling, row visibility, and centralized event routing.
void	setMaxVerticalPosition(int max) Sets the maximum position that the scrolling Gantt sheet can display.
void	setMaxVisibleTime(Date max) Sets the maximum time that the sheet can show in bounded scrolling mode.
void	setMinVisibleDuration(IlvDuration duration) Sets the minimum duration that the sheet can show.
void	setMinVisibleTime(Date min) Sets the minimum time that the sheet can show in bounded scrolling mode.
void	setMouseWheelEnabled(boolean handleWheel) Enables/disables scrolling and zooming in response to movement of the mouse wheel.
void	setMouseWheelPreferredOrientation(int orientation) Sets the preferred orientation of scrolling by the mouse wheel, either VERTICAL or HORIZONTAL.
void	setTimeScale(IlvTimeScale timeScale) Sets the time scale that is displayed along the top of the Gantt sheet.
void	setTimeScrollBar(IlvTimeScrollBar scrollbar) Sets the horizontal time scroll bar.
void	setTimeScrollBarVisible(boolean visible) Sets the visibility status of the time scroll bar.
void	setVerticalExtent(int extent) Sets the extent of the vertical range displayed by the scrolling Gantt sheet.
void	setVerticalPosition(int position) Sets the beginning of the vertical range displayed by the scrolling Gantt sheet.
void	setVerticalScrollBar(IlvVerticalScrollBar scrollbar) Sets the vertical scroll bar.
void	setVerticalScrollBar(JScrollBar scrollbar) Deprecated. Beginning with Perforce JViews 7.5 use the setVerticalScrollBar(IlvVerticalScrollBar) method instead.
void	setVerticalScrollBarPolicy(int policy) Sets the vertical scroll bar policy.
void	setVisibleDuration(IlvDuration duration) Sets the duration of the time interval displayed by the sheet.
void	setVisibleInterval(Date time, IlvDuration duration) Sets the time interval displayed by the sheet.
void	setVisibleTime(Date time) Sets the beginning of the time interval displayed by the sheet.

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, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, 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, 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, setLocale, 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

Field Detail

VERTICAL_SCROLLBAR_AS_NEEDED

public static final int VERTICAL_SCROLLBAR_AS_NEEDED

The vertical scroll bar will be displayed as needed.

See Also:

Constant Field Values

VERTICAL_SCROLLBAR_NEVER

public static final int VERTICAL_SCROLLBAR_NEVER

The vertical scroll bar will never be displayed.

See Also:

Constant Field Values

VERTICAL_SCROLLBAR_ALWAYS

public static final int VERTICAL_SCROLLBAR_ALWAYS

The vertical scroll bar will always be displayed.

See Also:

Constant Field Values

HORIZONTAL

public static final int HORIZONTAL

Horizontal orientation.

Since:

JViews 7.5

See Also:

Constant Field Values

VERTICAL

public static final int VERTICAL

Vertical orientation.

Since:

JViews 7.5

See Also:

Constant Field Values

Constructor Detail

IlvJScrollGanttSheet

public IlvJScrollGanttSheet()

Creates an IlvJScrollGanttSheet with a default Gantt sheet, time scale, and horizontal time scroll bar. The child components will not be coordinated until a Gantt configuration is set by calling the setGanttConfiguration(ilog.views.gantt.IlvGanttConfiguration) method.

IlvJScrollGanttSheet

public IlvJScrollGanttSheet(IlvGanttSheet sheet,
                            IlvTimeScale timeScale,
                            IlvTimeScrollBar scrollbar)

Creates an IlvJScrollGanttSheet component that is composed of the specified Gantt sheet, time scale, and horizontal time scroll bar. The child components will not be coordinated until a Gantt configuration is set by calling the setGanttConfiguration(ilog.views.gantt.IlvGanttConfiguration) method.

Parameters:

sheet - The Gantt sheet. If null, a default sheet will be created by calling createDefaultGanttSheet().

timeScale - The time scale. If null, a default time scale will be created by calling createDefaultTimeScale().

scrollbar - The time scroll bar. If null, a default scroll bar will be created by calling createDefaultTimeScrollBar().

IlvJScrollGanttSheet

public IlvJScrollGanttSheet(IlvGanttConfiguration ganttConfig)

Creates an IlvJScrollGanttSheet with a default Gantt sheet, time scale, and horizontal time scroll bar. The internal components will be coordinated by the specified Gantt configuration.

Parameters:

ganttConfig - The Gantt configuration.

Since:

JViews 3.5

IlvJScrollGanttSheet

public IlvJScrollGanttSheet(IlvGanttConfiguration ganttConfig,
                            IlvGanttSheet sheet,
                            IlvTimeScale timeScale,
                            IlvTimeScrollBar scrollbar)

Creates an IlvJScrollGanttSheet component that is composed of the specified Gantt sheet, time scale, and horizontal time scroll bar. The internal components will be coordinated by the specified Gantt configuration.

Parameters:

ganttConfig - The Gantt configuration.

sheet - The Gantt sheet. If null, a default sheet will be created by calling createDefaultGanttSheet().

timeScale - The time scale. If null, a default time scale will be created by calling createDefaultTimeScale().

scrollbar - The time scroll bar. If null, a default scroll bar will be created by calling createDefaultTimeScrollBar().

Since:

JViews 3.5

Method Detail

createDefaultGanttSheet

protected IlvGanttSheet createDefaultGanttSheet()

Creates a default Gantt sheet to place in the center of this component.

Returns:

The default Gantt sheet.

Since:

JViews 3.5

createDefaultTimeScale

protected IlvTimeScale createDefaultTimeScale()

Creates a default time scale to place along the top of this component.

Returns:

The default time scale.

Since:

JViews 3.5

createDefaultTimeScrollBar

protected IlvTimeScrollBar createDefaultTimeScrollBar()

Creates a default horizontal time scroll bar to place along the top of this component.

Returns:

The default time scroll bar.

Since:

JViews 3.5

setGanttConfiguration

public void setGanttConfiguration(IlvGanttConfiguration ganttConfig)

Sets the Gantt configuration that will coordinate horizontal time scrolling, vertical scrolling, row visibility, and centralized event routing.

Parameters:

ganttConfig - The Gantt configuration.

Since:

JViews 3.5

getVerticalScrollBar

public IlvVerticalScrollBar getVerticalScrollBar()

Returns the vertical scroll bar.

Returns:

The vertical scroll bar.

Since:

JViews 7.5

See Also:

setVerticalScrollBar(IlvVerticalScrollBar)

setVerticalScrollBar

@Deprecated
public void setVerticalScrollBar(JScrollBar scrollbar)

Deprecated. Beginning with Perforce JViews 7.5 use the setVerticalScrollBar(IlvVerticalScrollBar) method instead.

Sets the vertical scroll bar.

Parameters:

scrollbar - The vertical scroll bar, which must be an instance of IlvVerticalScrollBar.

setVerticalScrollBar

public void setVerticalScrollBar(IlvVerticalScrollBar scrollbar)

Sets the vertical scroll bar.

Parameters:

scrollbar - The vertical scroll bar.

Since:

JViews 7.5

See Also:

getVerticalScrollBar()

getVerticalScrollBarPolicy

public int getVerticalScrollBarPolicy()

Returns the vertical scroll bar policy, which will be one of the values: VERTICAL_SCROLLBAR_AS_NEEDED, VERTICAL_SCROLLBAR_NEVER, or VERTICAL_SCROLLBAR_ALWAYS.

Returns:

The vertical scroll bar policy.

See Also:

setVerticalScrollBarPolicy(int)

setVerticalScrollBarPolicy

public void setVerticalScrollBarPolicy(int policy)

Sets the vertical scroll bar policy.

Parameters:

policy - The new scroll bar policy. Must be one of the following constants: VERTICAL_SCROLLBAR_AS_NEEDED, VERTICAL_SCROLLBAR_NEVER, or VERTICAL_SCROLLBAR_ALWAYS.

See Also:

setVerticalScrollBarPolicy(int)

getTimeScrollBar

public IlvTimeScrollBar getTimeScrollBar()

Returns the horizontal time scroll bar.

Returns:

The time scroll bar.

setTimeScrollBar

public void setTimeScrollBar(IlvTimeScrollBar scrollbar)

Sets the horizontal time scroll bar.

Parameters:

scrollbar - The time scroll bar.

Since:

JViews 3.5

isTimeScrollBarVisible

public boolean isTimeScrollBarVisible()

Returns the visibility status of the time scroll bar.

Returns:

Whether the time scroll bar is visible.

setTimeScrollBarVisible

public void setTimeScrollBarVisible(boolean visible)

Sets the visibility status of the time scroll bar.

Parameters:

visible - true to make the time scroll bar visible, or false to make it invisible.

getTimeScale

public IlvTimeScale getTimeScale()

Returns the time scale that is displayed along the top of the Gantt sheet.

Returns:

The time scale.

setTimeScale

public void setTimeScale(IlvTimeScale timeScale)

Sets the time scale that is displayed along the top of the Gantt sheet. The constantZoomFactorOnWidthChange property of the time scale is set to match that of the Gantt sheet.

Parameters:

timeScale - The time scale.

Since:

JViews 3.5

getGanttSheet

public IlvGanttSheet getGanttSheet()

Returns the child Gantt sheet component.

Returns:

The Gantt sheet.

doLayout

public void doLayout()

Performs the Gantt sheet layout.

Overrides:

doLayout in class Container

processManagerViewKeyEvent

public void processManagerViewKeyEvent(KeyEvent event)

This method is invoked by this Swing container's IlvManagerView for any keystrokes that have not been consumed by the view's interactor or registered key listeners. This container simply invokes its own processKeyEvent method so that the keystrokes are routed up the Swing container hierarchy and any registered keyboard actions and/or menu accelerators are properly handled.

Parameters:

event - The keyboard event.

Since:

JViews 3.5

getMinVisibleTime

public Date getMinVisibleTime()

Returns the minimum time that the sheet can show in bounded scrolling mode.

Specified by:

getMinVisibleTime in interface IlvTimeScrollable

Returns:

The minimum visible time or null if the sheet is in unbounded scrolling mode.

See Also:

setMinVisibleTime(java.util.Date)

setMinVisibleTime

public void setMinVisibleTime(Date min)

Sets the minimum time that the sheet can show in bounded scrolling mode. The current visible time and duration are trimmed to fit the new min-max interval by calling the IlvTimeScrollUtil.trimInterval(ilog.views.gantt.IlvTimeInterval, java.util.Date, java.util.Date, ilog.views.gantt.IlvDuration) method. A minVisibleTimeChanged event is then fired to all registered listeners. If min > maxVisibleTime an IllegalArgumentException will be thrown.

Specified by:

setMinVisibleTime in interface IlvTimeScrollable

Parameters:

min - The minimum visible time or null to set the sheet to unbounded scrolling mode.

See Also:

getMinVisibleTime()

getMaxVisibleTime

public Date getMaxVisibleTime()

Returns the maximum time that the sheet can show in bounded scrolling mode.

Specified by:

getMaxVisibleTime in interface IlvTimeScrollable

Returns:

The maximum visible time or null if the sheet is in unbounded scrolling mode.

See Also:

setMaxVisibleTime(java.util.Date)

setMaxVisibleTime

public void setMaxVisibleTime(Date max)

Sets the maximum time that the sheet can show in bounded scrolling mode. The current visible time and duration are trimmed to fit the new min-max interval by calling the IlvTimeScrollUtil.trimInterval(ilog.views.gantt.IlvTimeInterval, java.util.Date, java.util.Date, ilog.views.gantt.IlvDuration) method. A maxVisibleTimeChanged event is then fired to all registered listeners. If max < minVisibleTime an IllegalArgumentException will be thrown.

Specified by:

setMaxVisibleTime in interface IlvTimeScrollable

Parameters:

max - The maximum visible time or null to set the sheet to unbounded scrolling mode.

See Also:

getMaxVisibleTime()

getMinVisibleDuration

public IlvDuration getMinVisibleDuration()

Returns the minimum duration that the sheet can show. This value indicates the maximum zoom level that the sheet can display. The default value is 1 minute.

Specified by:

getMinVisibleDuration in interface IlvTimeScrollable

Returns:

The minimum visible duration.

Since:

JViews 8.5

See Also:

setMinVisibleDuration(ilog.views.gantt.IlvDuration)

setMinVisibleDuration

public void setMinVisibleDuration(IlvDuration duration)

Sets the minimum duration that the sheet can show. This specifies the maximum zoom level that the sheet can display. A minVisibleDurationChanged event is fired to all registered listeners.

Specified by:

setMinVisibleDuration in interface IlvTimeScrollable

Parameters:

duration - The minimum visible duration.

Since:

JViews 8.5

See Also:

getMinVisibleDuration()

getVisibleTime

public Date getVisibleTime()

Returns the beginning of the time interval displayed by the sheet.

Specified by:

getVisibleTime in interface IlvTimeScrollable

Returns:

The beginning of the displayed time interval.

See Also:

setVisibleTime(java.util.Date)

setVisibleTime

public void setVisibleTime(Date time)

Sets the beginning of the time interval displayed by the sheet. The specified time value is compared against the min and max visible times and is trimmed if necessary by calling the IlvTimeScrollUtil.trimInterval(ilog.views.gantt.IlvTimeInterval, java.util.Date, java.util.Date, ilog.views.gantt.IlvDuration) method. A VisibleTimeChangedEvent is then fired to all registered listeners. If you are changing both the visible time and duration, it is preferable to use the setVisibleInterval(java.util.Date, ilog.views.gantt.IlvDuration) method instead.

Specified by:

setVisibleTime in interface IlvTimeScrollable

Parameters:

time - The new time value.

See Also:

getVisibleTime()

getVisibleDuration

public IlvDuration getVisibleDuration()

Returns the duration of the time interval displayed by the sheet.

Specified by:

getVisibleDuration in interface IlvTimeScrollable

Returns:

The duration.

See Also:

setVisibleDuration(ilog.views.gantt.IlvDuration)

setVisibleDuration

public void setVisibleDuration(IlvDuration duration)

Sets the duration of the time interval displayed by the sheet. The specified duration is compared against the min and max visible times and is trimmed if necessary by calling the IlvTimeScrollUtil.trimInterval(ilog.views.gantt.IlvTimeInterval, java.util.Date, java.util.Date, ilog.views.gantt.IlvDuration) method. A VisibleDurationChangedEvent is then fired to all registered listeners. If you are changing both the visible time and duration, it is preferable to use the setVisibleInterval(java.util.Date, ilog.views.gantt.IlvDuration) method instead.

Specified by:

setVisibleDuration in interface IlvTimeScrollable

Parameters:

duration - The new duration value.

See Also:

getVisibleDuration()

getVisibleInterval

public IlvTimeInterval getVisibleInterval()

Returns the time interval displayed by the sheet.

Specified by:

getVisibleInterval in interface IlvTimeScrollable

Returns:

The time interval.

Since:

JViews 3.5

See Also:

setVisibleInterval(java.util.Date, ilog.views.gantt.IlvDuration)

setVisibleInterval

public void setVisibleInterval(Date time,
                               IlvDuration duration)

Sets the time interval displayed by the sheet. The specified interval is compared against the min and max visible times and is trimmed if necessary by calling the IlvTimeScrollUtil.trimInterval(ilog.views.gantt.IlvTimeInterval, java.util.Date, java.util.Date, ilog.views.gantt.IlvDuration) method. This method then fires an adjusting VisibleTimeChangedEvent followed by a VisibleDurationChangedEvent to all registered listeners.

Specified by:

setVisibleInterval in interface IlvTimeScrollable

Parameters:

time - The new time value.

duration - The new duration value.

addTimeScrollListener

public void addTimeScrollListener(TimeScrollListener listener)

Adds the specified listener to receive time scroll events from this sheet.

Specified by:

addTimeScrollListener in interface IlvTimeScrollable

Parameters:

listener - The listener that will be subscribed to subsequent time scroll events.

See Also:

removeTimeScrollListener(ilog.views.gantt.event.TimeScrollListener)

removeTimeScrollListener

public void removeTimeScrollListener(TimeScrollListener listener)

Removes the specified listener so that it will no longer receive time scroll events from this sheet.

Specified by:

removeTimeScrollListener in interface IlvTimeScrollable

Parameters:

listener - The listener that will be unsubscribed from receiving time scroll events.

See Also:

addTimeScrollListener(ilog.views.gantt.event.TimeScrollListener)

getMaxVerticalPosition

public int getMaxVerticalPosition()

Returns the maximum vertical position that the scrolling Gantt sheet can display. This value is the bottom of the last visible row or the height of the child Gantt sheet, whichever is larger.

Specified by:

getMaxVerticalPosition in interface IlvVerticalScrollable

Returns:

The maximum vertical position.

Since:

JViews 3.5

See Also:

setMaxVerticalPosition(int)

setMaxVerticalPosition

public void setMaxVerticalPosition(int max)

Sets the maximum position that the scrolling Gantt sheet can display. Logically, this is the location of the last visible row in the child Gantt sheet component. However, this method does nothing because we rely on the Gantt sheet to size and position the currently visible rows correctly by itself.

Specified by:

setMaxVerticalPosition in interface IlvVerticalScrollable

Parameters:

max - The maximum vertical position.

Since:

JViews 3.5

See Also:

getMaxVerticalPosition()

getVerticalPosition

public int getVerticalPosition()

Returns the beginning of the vertical range displayed by the scrolling Gantt sheet.

Specified by:

getVerticalPosition in interface IlvVerticalScrollable

Returns:

The vertical position of the Gantt sheet.

Since:

JViews 3.5

See Also:

setVerticalPosition(int)

setVerticalPosition

public void setVerticalPosition(int position)

Sets the beginning of the vertical range displayed by the scrolling Gantt sheet. The specified value is compared against the max displayable value and is trimmed if necessary. A verticalPositionChanged event is then fired to all registered listeners.

Specified by:

setVerticalPosition in interface IlvVerticalScrollable

Parameters:

position - The new vertical position.

Since:

JViews 3.5

See Also:

getVerticalPosition()

getVerticalExtent

public int getVerticalExtent()

Returns the extent of the vertical range displayed by the scrolling Gantt sheet. This value is the height of the child Gantt sheet component.

Specified by:

getVerticalExtent in interface IlvVerticalScrollable

Returns:

The height of the Gantt sheet.

Since:

JViews 3.5

See Also:

setVerticalExtent(int)

setVerticalExtent

public void setVerticalExtent(int extent)

Sets the extent of the vertical range displayed by the scrolling Gantt sheet. Logically, this is the height of the child Gantt sheet component. However, we set the Gantt sheet's preferred height, not its actual height, because we rely on this component's layout algorithm to arrange and position all of the child components.

Specified by:

setVerticalExtent in interface IlvVerticalScrollable

Parameters:

extent - The new vertical extent.

Since:

JViews 3.5

See Also:

getVerticalExtent()

addVerticalScrollListener

public void addVerticalScrollListener(VerticalScrollListener listener)

Adds the specified listener to receive vertical scroll events from this scrolling Gantt sheet.

Specified by:

addVerticalScrollListener in interface IlvVerticalScrollable

Parameters:

listener - The listener that will be subscribed to subsequent scroll events.

Since:

JViews 3.5

See Also:

removeVerticalScrollListener(ilog.views.gantt.event.VerticalScrollListener)

removeVerticalScrollListener

public void removeVerticalScrollListener(VerticalScrollListener listener)

Removes the specified listener so that it will no longer receive vertical scroll events from this scrolling Gantt sheet.

Specified by:

removeVerticalScrollListener in interface IlvVerticalScrollable

Parameters:

listener - The listener that will be unsubscribed from receiving vertical scroll events.

Since:

JViews 3.5

See Also:

addVerticalScrollListener(ilog.views.gantt.event.VerticalScrollListener)

isMouseWheelEnabled

public boolean isMouseWheelEnabled()

Indicates whether or not scrolling and zooming will take place in response to movement of the mouse wheel. Wheel scrolling and zooming is enabled by default.

Returns:

Whether mouse wheel scrolling and zooming is enabled.

Since:

JViews 6.5

See Also:

setMouseWheelEnabled(boolean)

setMouseWheelEnabled

public void setMouseWheelEnabled(boolean handleWheel)

Enables/disables scrolling and zooming in response to movement of the mouse wheel. When enabled, mouse wheel scrolling will be along the preferred orientation, SHIFT-scrolling will be along the opposite axis, and CTRL-scrolling will zoom the displayed time interval in and out. Mouse wheel scrolling and zooming is enabled by default.

Parameters:

handleWheel - true if scrolling should be done automatically for a MouseWheelEvent, and zooming should be performed on CTRL+MouseWheelEvent false otherwise.

Since:

JViews 6.5

See Also:

isMouseWheelEnabled()

getMouseWheelPreferredOrientation

public int getMouseWheelPreferredOrientation()

Returns the preferred orientation of scrolling by the mouse wheel, either VERTICAL or HORIZONTAL. If scrolling in the preferred orientation is disabled or the user presses the SHIFT key while using the mouse wheel, then scrolling will occur along the opposite axis. The default value is VERTICAL.

Returns:

VERTICAL or HORIZONTAL.

Since:

JViews 7.5

See Also:

setMouseWheelPreferredOrientation(int)

setMouseWheelPreferredOrientation

public void setMouseWheelPreferredOrientation(int orientation)

Sets the preferred orientation of scrolling by the mouse wheel, either VERTICAL or HORIZONTAL. If scrolling in the preferred orientation is disabled or the user presses the SHIFT key while using the mouse wheel, then scrolling will occur along the opposite axis.

Parameters:

orientation - The preferred scrolling orientation, which must be VERTICAL or HORIZONTAL.

Since:

JViews 7.5

See Also:

getMouseWheelPreferredOrientation()

getBaseTextDirection

public final int getBaseTextDirection()

Returns the base text direction for this scrollable Gantt sheet.

The base text direction influences the display of text strings that are composed of segments that are read from left to right as well as of segments that are read from right to left. It determines the order of these segments.

Returns:

One of IlvBidiUtil.COMPONENT_DIRECTION, IlvBidiUtil.CONTEXTUAL_DIRECTION, IlvBidiUtil.LEFT_TO_RIGHT, IlvBidiUtil.RIGHT_TO_LEFT, IlvBidiUtil.INHERITED_DIRECTION.

Since:

JViews 8.8

See Also:

setBaseTextDirection(int), getResolvedBaseTextDirection()

setBaseTextDirection

public void setBaseTextDirection(int btd)

Sets the base text direction for this scrollable Gantt sheet.

The base text direction influences the display of text strings that are composed of segments that are read from left to right as well as of segments that are read from right to left. It determines the order of these segments.

Possible values are: IlvBidiUtil.COMPONENT_DIRECTION, IlvBidiUtil.CONTEXTUAL_DIRECTION, IlvBidiUtil.LEFT_TO_RIGHT, IlvBidiUtil.RIGHT_TO_LEFT, and IlvBidiUtil.INHERITED_DIRECTION.

The base text direction affects, in particular:

• the time scale,
• activities,
• tooltips.

Parameters:

btd - The base text direction.

Since:

JViews 8.8

See Also:

getBaseTextDirection()

getResolvedBaseTextDirection

public int getResolvedBaseTextDirection()

Returns the resolved base text direction.

The base text direction influences the display of text strings that are composed of segments that are read from left to right as well as of segments that are read from right to left. It determines the order of these segments.

This method is based on getBaseTextDirection() but determines the value when it is inherited from a parent component (IlvBidiUtil.INHERITED_DIRECTION) or dependent on the component orientation (IlvBidiUtil.COMPONENT_DIRECTION).

Returns:

One of IlvBidiUtil.CONTEXTUAL_DIRECTION, IlvBidiUtil.LEFT_TO_RIGHT, IlvBidiUtil.RIGHT_TO_LEFT.

Since:

JViews 8.8

baseTextDirectionChanged

protected void baseTextDirectionChanged()

This method is invoked when the effective base text direction has changed. That is, it is invoked

1. when the value of getResolvedBaseTextDirection() has changed, or
2. when the value of getComponentOrientation() has changed and the value of getResolvedBaseTextDirection() is IlvBidiUtil.CONTEXTUAL_DIRECTION.

Since:

JViews 8.8