ilog.views.gantt.swing

Class IlvVerticalScrollBar

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JScrollBar

ilog.views.gantt.swing.IlvVerticalScrollBar

All Implemented Interfaces:

Adjustable, ImageObserver, MenuContainer, Serializable, Accessible

public class IlvVerticalScrollBar
extends JScrollBar

IlvVerticalScrollBar is a JScrollBar extension that coordinates vertical scrolling with other Gantt components via connection to an IlvGanttConfiguration.

Since:

JViews 7.5

See Also:

Serialized Form

Nested Class Summary

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

JScrollBar.AccessibleJScrollBar

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	BLOCK_PAGE_PIXELS The block increment scrolling mode that indicates that block up/down requests will result in scrolling by vertical pages.
static int	BLOCK_PAGE_ROWS The block increment scrolling mode that indicates that block up/down requests will result in scrolling by vertical pages, truncated to the nearest row.
static int	BLOCK_PIXELS The block increment scrolling mode that indicates that block up/down requests will result in scrolling by the value of the blockIncrement property.
static int	BLOCK_ROWS The block increment scrolling mode that indicates that block up/down requests will result in scrolling to the next row, up or down.
static int	UNIT_PIXELS The unit increment scrolling mode that indicates that unit up/down requests will result in scrolling by the value of the unitIncrement property.
static int	UNIT_ROWS The unit increment scrolling mode that indicates that unit up/down requests will result in scrolling to the next row, up or down.

Fields inherited from class javax.swing.JScrollBar

blockIncrement, orientation, unitIncrement

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 java.awt.Adjustable

HORIZONTAL, NO_ORIENTATION, VERTICAL

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
IlvVerticalScrollBar() Creates a new vertical scroll bar.

Method Summary

Modifier and Type	Method and Description
int	getBlockIncrement(int direction) Returns the amount to change the scroll bar's value by, given a block (usually "page") up/down request.
int	getBlockIncrementMode() Returns the block increment scrolling mode, which can be one of: BLOCK_PAGE_ROWS: Indicates that block up/down requests will result in scrolling by pages, truncated to the nearest row, up or down.
IlvGanttConfiguration	getGanttConfiguration() Returns the Gantt configuration that is coordinating vertical scrolling, row visibility, and centralized event routing.
int	getUnitIncrement(int direction) Returns the amount to change the scroll bar's value by, given a unit up/down request.
int	getUnitIncrementMode() Returns the unit increment scrolling mode.
void	setBlockIncrementMode(int mode) Sets the block increment scrolling mode, which must be one of: BLOCK_PAGE_ROWS: Indicates that block up/down requests will result in scrolling by pages, truncated to the nearest row, up or down.
void	setGanttConfiguration(IlvGanttConfiguration ganttConfig) Sets the Gantt configuration that will coordinate vertical scrolling, row visibility, and centralized event routing.
void	setUnitIncrementMode(int mode) Sets the unit increment scrolling mode.
void	setValue(int value) Sets the scroll bar's value.

Methods inherited from class javax.swing.JScrollBar

addAdjustmentListener, fireAdjustmentValueChanged, getAccessibleContext, getAdjustmentListeners, getBlockIncrement, getMaximum, getMaximumSize, getMinimum, getMinimumSize, getModel, getOrientation, getUI, getUIClassID, getUnitIncrement, getValue, getValueIsAdjusting, getVisibleAmount, paramString, removeAdjustmentListener, setBlockIncrement, setEnabled, setMaximum, setMinimum, setModel, setOrientation, setUI, setUnitIncrement, setValueIsAdjusting, setValues, setVisibleAmount, updateUI

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, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, 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, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

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, 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

UNIT_PIXELS

public static final int UNIT_PIXELS

The unit increment scrolling mode that indicates that unit up/down requests will result in scrolling by the value of the unitIncrement property.

See Also:

getUnitIncrementMode(), getUnitIncrement(int), Constant Field Values

UNIT_ROWS

public static final int UNIT_ROWS

The unit increment scrolling mode that indicates that unit up/down requests will result in scrolling to the next row, up or down.

See Also:

getUnitIncrementMode(), getUnitIncrement(int), Constant Field Values

BLOCK_PIXELS

public static final int BLOCK_PIXELS

The block increment scrolling mode that indicates that block up/down requests will result in scrolling by the value of the blockIncrement property.

See Also:

getBlockIncrementMode(), getBlockIncrement(int), Constant Field Values

BLOCK_PAGE_PIXELS

public static final int BLOCK_PAGE_PIXELS

The block increment scrolling mode that indicates that block up/down requests will result in scrolling by vertical pages.

See Also:

getBlockIncrementMode(), getBlockIncrement(int), Constant Field Values

BLOCK_ROWS

public static final int BLOCK_ROWS

The block increment scrolling mode that indicates that block up/down requests will result in scrolling to the next row, up or down.

See Also:

getBlockIncrementMode(), getBlockIncrement(int), Constant Field Values

BLOCK_PAGE_ROWS

public static final int BLOCK_PAGE_ROWS

The block increment scrolling mode that indicates that block up/down requests will result in scrolling by vertical pages, truncated to the nearest row.

See Also:

getBlockIncrementMode(), getBlockIncrement(int), Constant Field Values

Constructor Detail

IlvVerticalScrollBar

public IlvVerticalScrollBar()

Creates a new vertical scroll bar.

Method Detail

getGanttConfiguration

public IlvGanttConfiguration getGanttConfiguration()

Returns the Gantt configuration that is coordinating vertical scrolling, row visibility, and centralized event routing.

Returns:

The Gantt configuration.

See Also:

setGanttConfiguration(ilog.views.gantt.IlvGanttConfiguration)

setGanttConfiguration

public void setGanttConfiguration(IlvGanttConfiguration ganttConfig)

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

Parameters:

ganttConfig - The Gantt configuration.

See Also:

getGanttConfiguration()

getUnitIncrementMode

public int getUnitIncrementMode()

Returns the unit increment scrolling mode. The default value of UNIT_ROWS indicates that unit up/down requests will result in scrolling to the next row, up or down. The value UNIT_PIXELS indicates that unit up/down requests will result in scrolling by the value of the unitIncrement property.

Returns:

The unit increment scrolling mode.

See Also:

setUnitIncrementMode(int), getUnitIncrement(int)

setUnitIncrementMode

public void setUnitIncrementMode(int mode)

Sets the unit increment scrolling mode. The value of UNIT_ROWS indicates that unit up/down requests will result in scrolling to the next row, up or down. The value UNIT_PIXELS indicates that unit up/down requests will result in scrolling by the value of the unitIncrement property.

Parameters:

mode - The unit increment scrolling mode that must be either UNIT_ROWS or UNIT_PIXELS.

See Also:

getUnitIncrementMode(), getUnitIncrement(int)

getUnitIncrement

public int getUnitIncrement(int direction)

Returns the amount to change the scroll bar's value by, given a unit up/down request. Typically, this occurs when the user clicks on the scroll bar's up/down arrows. The value returned by this method depends on the current unit increment mode. If the mode is the default UNIT_ROWS, then this method returns a value that will result in scrolling to the next row, up or down. If the unit increment mode is set to UNIT_PIXELS, then this method returns the value of the unitIncrement property.

Overrides:

getUnitIncrement in class JScrollBar

Parameters:

direction - The direction which is -1 or 1 for up/down respectively.

Returns:

The value of a unit increment.

See Also:

getUnitIncrementMode()

getBlockIncrementMode

public int getBlockIncrementMode()

Returns the block increment scrolling mode, which can be one of:

• BLOCK_PAGE_ROWS: Indicates that block up/down requests will result in scrolling by pages, truncated to the nearest row, up or down.
• BLOCK_ROWS: Indicates that block up/down requests will result in scrolling to the next row, up or down.
• BLOCK_PAGE_PIXELS: Indicates that block up/down requests will result in scrolling by vertical pages.
• BLOCK_PIXELS: Indicates that block up/down requests will result in scrolling by the value of the blockIncrement property.

The default value is BLOCK_PAGE_ROWS

Returns:

The block increment scrolling mode.

See Also:

setBlockIncrementMode(int), getBlockIncrement(int)

setBlockIncrementMode

public void setBlockIncrementMode(int mode)

Sets the block increment scrolling mode, which must be one of:

• BLOCK_PAGE_ROWS: Indicates that block up/down requests will result in scrolling by pages, truncated to the nearest row, up or down.
• BLOCK_ROWS: Indicates that block up/down requests will result in scrolling to the next row, up or down.
• BLOCK_PAGE_PIXELS: Indicates that block up/down requests will result in scrolling by vertical pages.
• BLOCK_PIXELS: Indicates that block up/down requests will result in scrolling by the value of the blockIncrement property.

Parameters:

mode - The block increment scrolling mode, which must be one of BLOCK_PAGE_ROWS, BLOCK_ROWS, BLOCK_PAGE_PIXELS, or UNIT_PIXELS.

See Also:

getBlockIncrementMode(), getBlockIncrement(int)

getBlockIncrement

public int getBlockIncrement(int direction)

Returns the amount to change the scroll bar's value by, given a block (usually "page") up/down request. Typically this occurs when the user clicks above or below the scroll bar "knob" to change the value up or down by a large amount. The value returned by this method depends on the current block increment mode:

• BLOCK_PAGE_ROWS (default): This method returns a value that will result in scrolling by a page, truncated to the nearest row, up or down.
• BLOCK_ROWS: This method returns a value that will result in scrolling to the next row, up or down.
• BLOCK_PAGE_PIXELS: This method returns the a value that will result in scrolling by vertical pages.
• BLOCK_PIXELS: This method returns the value of the blockIncrement property.

Overrides:

getBlockIncrement in class JScrollBar

Parameters:

direction - The direction which is -1 or 1 for up/down respectively.

Returns:

The value of a block increment.

See Also:

getBlockIncrementMode()

setValue

public void setValue(int value)

Sets the scroll bar's value. This method is overridden to support interactive scrolling by rows when the unit increment mode is set to UNIT_ROWS.

Specified by:

setValue in interface Adjustable

Overrides:

setValue in class JScrollBar

Parameters:

value - The value.