ilog.views.gantt

Class IlvJScrollPane

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JScrollPane

ilog.views.gantt.IlvJScrollPane

All Implemented Interfaces:

IlvVerticalScrollable, ImageObserver, MenuContainer, Serializable, Accessible, ScrollPaneConstants

public class IlvJScrollPane
extends JScrollPane
implements IlvVerticalScrollable

The IlvJScrollPane class implements the IlvVerticalScrollable interface for a standard Swing JScrollPane. As such, it can be used inside a Gantt configuration to contain and scroll the table. When scrolled vertically, the IlvJScrollPane will notify the configuration to which it belongs. It will also be notified by the configuration when some other UI component scrolls vertically, and it will then scroll accordingly.

See Also:

Serialized Form

Nested Class Summary

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

JScrollPane.AccessibleJScrollPane, JScrollPane.ScrollBar

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 inherited from class javax.swing.JScrollPane

columnHeader, horizontalScrollBar, horizontalScrollBarPolicy, lowerLeft, lowerRight, rowHeader, upperLeft, upperRight, verticalScrollBar, verticalScrollBarPolicy, viewport

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 javax.swing.ScrollPaneConstants

COLUMN_HEADER, HORIZONTAL_SCROLLBAR, HORIZONTAL_SCROLLBAR_ALWAYS, HORIZONTAL_SCROLLBAR_AS_NEEDED, HORIZONTAL_SCROLLBAR_NEVER, HORIZONTAL_SCROLLBAR_POLICY, LOWER_LEADING_CORNER, LOWER_LEFT_CORNER, LOWER_RIGHT_CORNER, LOWER_TRAILING_CORNER, ROW_HEADER, UPPER_LEADING_CORNER, UPPER_LEFT_CORNER, UPPER_RIGHT_CORNER, UPPER_TRAILING_CORNER, VERTICAL_SCROLLBAR, VERTICAL_SCROLLBAR_ALWAYS, VERTICAL_SCROLLBAR_AS_NEEDED, VERTICAL_SCROLLBAR_NEVER, VERTICAL_SCROLLBAR_POLICY, VIEWPORT

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
IlvJScrollPane(Component view) Creates an IlvJScrollPane that displays the contents of the specified component, where both horizontal and vertical scroll bars appear whenever the contents of the component are larger than the view.
IlvJScrollPane(Component view, int vsbPolicy, int hsbPolicy) Creates an IlvJScrollPane that displays the contents of the specified component in a viewport whose view position can be controlled with a pair of scroll bars.

Method Summary

Modifier and Type	Method and Description
void	addVerticalScrollListener(VerticalScrollListener listener) Adds the specified listener to receive vertical scroll events from this scroll pane.
protected JViewport	createViewport() Creates and returns a new JViewport for use by this scroll pane.
protected void	fireMaxVerticalPositionChanged() Call this method to fire a maxVerticalPositionChanged event to all registered listeners.
protected void	fireVerticalExtentChanged() Call this method to fire a verticalExtentChanged event to all registered listeners.
protected void	fireVerticalPositionChanged() Call this method to fire a verticalPositionChanged event to all registered listeners.
int	getMaxVerticalPosition() Returns the maximum vertical position that the scroll pane can display.
int	getVerticalExtent() Returns the extent of the vertical range displayed by the scroll pane.
int	getVerticalPosition() Returns the beginning of the vertical range displayed by the scroll pane.
Color	getViewportBackground() Returns the background color of the main JViewPort.
boolean	isOpaque() Returns true if this component is completely opaque.
void	removeVerticalScrollListener(VerticalScrollListener listener) Removes the specified listener so that it will no longer receive vertical scroll events from this scroll pane.
void	setMaxVerticalPosition(int max) Sets the maximum vertical position that the scroll pane can display.
void	setVerticalExtent(int extent) Sets the extent of the vertical range displayed by the scroll pane.
void	setVerticalPosition(int position) Sets the beginning of the vertical range displayed by the scroll pane.
void	setViewportBackground(Color color) Sets the background color of the main JViewPort.

Methods inherited from class javax.swing.JScrollPane

createHorizontalScrollBar, createVerticalScrollBar, getAccessibleContext, getColumnHeader, getCorner, getHorizontalScrollBar, getHorizontalScrollBarPolicy, getRowHeader, getUI, getUIClassID, getVerticalScrollBar, getVerticalScrollBarPolicy, getViewport, getViewportBorder, getViewportBorderBounds, isValidateRoot, isWheelScrollingEnabled, paramString, setColumnHeader, setColumnHeaderView, setComponentOrientation, setCorner, setHorizontalScrollBar, setHorizontalScrollBarPolicy, setLayout, setRowHeader, setRowHeaderView, setUI, setVerticalScrollBar, setVerticalScrollBarPolicy, setViewport, setViewportBorder, setViewportView, setWheelScrollingEnabled, 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, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, 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, setEnabled, 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, 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, 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

Constructor Detail

IlvJScrollPane

public IlvJScrollPane(Component view,
                      int vsbPolicy,
                      int hsbPolicy)

Creates an IlvJScrollPane that displays the contents of the specified component in a viewport whose view position can be controlled with a pair of scroll bars. The scroll bar policies specify when the scroll bars are displayed, for example, if vsbPolicy is VERTICAL_SCROLLBAR_AS_NEEDED then the vertical scroll bar only appears if the view does not fit vertically.

Parameters:

view - The component to display in the scroll pane viewport.

vsbPolicy - The vertical scroll bar policy.

hsbPolicy - The horizontal scroll bar policy.

Since:

JViews 3.5

IlvJScrollPane

public IlvJScrollPane(Component view)

Creates an IlvJScrollPane that displays the contents of the specified component, where both horizontal and vertical scroll bars appear whenever the contents of the component are larger than the view.

Parameters:

view - The component to display in the scroll pane viewport.

Method Detail

isOpaque

public boolean isOpaque()

Returns true if this component is completely opaque. This method is overridden to always return true. This mimics the default JScrollPane behavior as of JDK 1.3. Prior to JDK 1.3, JScrollPane.isOpaque() returned false if the view component in the primary viewport did not completely occupy the full bounds of the viewport.

Overrides:

isOpaque in class JComponent

Since:

JViews 3.5

getViewportBackground

public Color getViewportBackground()

Returns the background color of the main JViewPort. If the component or view contained within the viewport does not completely occupy the viewport, the color returned is the color around its border.

Since:

JViews 3.5

See Also:

setViewportBackground(java.awt.Color)

setViewportBackground

public void setViewportBackground(Color color)

Sets the background color of the main JViewPort. If the component or view contained within the viewport does not completely occupy the viewport, the color set will be the color around its border.

Since:

JViews 3.5

See Also:

getViewportBackground()

createViewport

protected JViewport createViewport()

Creates and returns a new JViewport for use by this scroll pane. This method is overridden to return a viewport that is opaque by default. This mimics the JViewport behavior as of JDK 1.3. Prior to JDK 1.3, JViewport.isOpaque() returned false by default.

Overrides:

createViewport in class JScrollPane

Since:

JViews 3.5

getMaxVerticalPosition

public int getMaxVerticalPosition()

Returns the maximum vertical position that the scroll pane can display. This value is the height of the viewport's view component.

Specified by:

getMaxVerticalPosition in interface IlvVerticalScrollable

Returns:

The maximum position.

Since:

JViews 3.5

See Also:

setMaxVerticalPosition(int)

setMaxVerticalPosition

public void setMaxVerticalPosition(int max)

Sets the maximum vertical position that the scroll pane can display. Logically, this is the height of the viewport's view component. However, this method does nothing because we rely on the view component to size itself correctly based on the number of currently visible rows in the configuration and their row heights.

Specified by:

setMaxVerticalPosition in interface IlvVerticalScrollable

Parameters:

max - The maximum position.

Since:

JViews 3.5

See Also:

getMaxVerticalPosition()

getVerticalPosition

public int getVerticalPosition()

Returns the beginning of the vertical range displayed by the scroll pane. This value is the viewPosition of the scroll pane viewport.

Specified by:

getVerticalPosition in interface IlvVerticalScrollable

Since:

JViews 3.5

See Also:

setVerticalPosition(int)

setVerticalPosition

public void setVerticalPosition(int position)

Sets the beginning of the vertical range displayed by the scroll pane. This will be the viewPosition of the scroll pane viewport. 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 position.

Since:

JViews 3.5

See Also:

getVerticalPosition()

getVerticalExtent

public int getVerticalExtent()

Returns the extent of the vertical range displayed by the scroll pane. This value is the height of the scroll pane viewport.

Specified by:

getVerticalExtent in interface IlvVerticalScrollable

Since:

JViews 3.5

See Also:

setVerticalExtent(int)

setVerticalExtent

public void setVerticalExtent(int extent)

Sets the extent of the vertical range displayed by the scroll pane. Logically, this is the height of the scroll pane viewport. However, this method does nothing because we rely on layout managers to set the height of both the scroll pane and its viewport.

Specified by:

setVerticalExtent in interface IlvVerticalScrollable

Parameters:

extent - The new 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 scroll pane.

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 scroll pane.

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)

fireMaxVerticalPositionChanged

protected void fireMaxVerticalPositionChanged()

Call this method to fire a maxVerticalPositionChanged event to all registered listeners.

Since:

JViews 3.5

See Also:

setMaxVerticalPosition(int)

fireVerticalPositionChanged

protected void fireVerticalPositionChanged()

Call this method to fire a verticalPositionChanged event to all registered listeners.

Since:

JViews 3.5

See Also:

setVerticalPosition(int)

fireVerticalExtentChanged

protected void fireVerticalExtentChanged()

Call this method to fire a verticalExtentChanged event to all registered listeners.

Since:

JViews 3.5

See Also:

setVerticalExtent(int)