ilog.views.gantt.swing.calendarview

Class IlvVerticalHourScale

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

ilog.views.gantt.swing.calendarview.IlvVerticalHourScale

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Scrollable

public class IlvVerticalHourScale
extends JComponent
implements Scrollable

IlvVerticalHourScale is a Swing component that displays a vertical scale marked and labeled with the hours of the day.

Since:

JViews 7.5

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 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.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
IlvVerticalHourScale() Creates a new vertical hour scale.

Method Summary

Modifier and Type	Method and Description
Color	getBackground() Returns the background color of the scale.
Font	getHourFont() Returns the font of the hour labels.
int	getHourHeight() Returns the height of each hour interval.
float	getHourOfDay(int y) Returns the hour of the day that corresponds to the specified Y position.
Color	getLabelColor() Returns the color of the labels.
Dimension	getMaximumSize() Returns the maximum size of the scale.
Font	getMinuteFont() Returns the font of the minute labels.
Dimension	getPreferredScrollableViewportSize() Returns the preferred size of the viewport for this scale.
Dimension	getPreferredSize() Returns the preferred size of the scale.
int	getPreferredVisibleHours() Returns the preferred number of hours that will be displayed when the scale is placed in a scrollpane.
int	getScrollableBlockIncrement(Rectangle visibleRect, int orientation, int direction) Returns the distance to scroll to expose the next or previous block of hour rows for vertical scrolling, or the value of 10 pixels for horizontal scrolling.
boolean	getScrollableTracksViewportHeight() Returns false to indicate that a viewport should not force the height of the scale to match the height of the viewport.
boolean	getScrollableTracksViewportWidth() Returns true to indicate that a viewport should always force the width of the scale to match the width of the viewport.
int	getScrollableUnitIncrement(Rectangle visibleRect, int orientation, int direction) Returns the distance to scroll to expose the next or previous hour row for vertical scrolling, or the value of 1 pixel for horizontal scrolling.
Color	getTickColor() Returns the color of the hourly tick marks.
int	getTickMargin() Returns the margin of the hourly tick marks.
com.ibm.icu.util.ULocale	getULocale() Returns the locale used by the scale.
float	getY(Calendar calendar) Returns the vertical Y position within the scale that corresponds to the hour of the day of the specified calendar.
float	getY(float hourOfDay) Returns the vertical Y position within the scale that corresponds to the specified hour of the day.
void	paintComponent(Graphics g) Paints the time scale.
void	setHourFont(Font font) Sets the font of the hour labels.
void	setHourHeight(int height) Sets the height of each hour interval.
void	setLabelColor(Color color) Sets the color of the labels.
void	setMinuteFont(Font font) Sets the font of the minute labels.
void	setPreferredVisibleHours(int visibleHours) Sets the preferred number of hours that will be displayed when the scale is placed in a scrollpane.
void	setTickColor(Color color) Sets the color of the hourly tick marks.
void	setTickMargin(int margin) Sets the margin of the hourly tick marks.

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, getMinimumSize, getNextFocusableComponent, getPopupLocation, 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, 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, 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, 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

Constructor Detail

IlvVerticalHourScale

public IlvVerticalHourScale()

Creates a new vertical hour scale.

Method Detail

getULocale

public com.ibm.icu.util.ULocale getULocale()

Returns the locale used by the scale.

Since:

JViews 8.8

getBackground

public Color getBackground()

Returns the background color of the scale.

Overrides:

getBackground in class Component

Returns:

The scale's background color.

getHourHeight

public int getHourHeight()

Returns the height of each hour interval.

Returns:

The interval height.

See Also:

setHourHeight(int)

setHourHeight

public void setHourHeight(int height)

Sets the height of each hour interval.

Parameters:

height - The interval height.

See Also:

getHourHeight()

getHourFont

public Font getHourFont()

Returns the font of the hour labels.

Returns:

The hour label font.

See Also:

setHourFont(java.awt.Font)

setHourFont

public void setHourFont(Font font)

Sets the font of the hour labels.

Parameters:

font - The hour label font.

See Also:

getHourFont()

getMinuteFont

public Font getMinuteFont()

Returns the font of the minute labels.

Returns:

The minute label font.

See Also:

setMinuteFont(java.awt.Font)

setMinuteFont

public void setMinuteFont(Font font)

Sets the font of the minute labels.

Parameters:

font - The minute label font.

See Also:

getMinuteFont()

getLabelColor

public Color getLabelColor()

Returns the color of the labels.

Returns:

The label color.

See Also:

setLabelColor(java.awt.Color)

setLabelColor

public void setLabelColor(Color color)

Sets the color of the labels.

Parameters:

color - The label color.

See Also:

getLabelColor()

getTickColor

public Color getTickColor()

Returns the color of the hourly tick marks.

Returns:

The tick color.

See Also:

setTickColor(java.awt.Color)

setTickColor

public void setTickColor(Color color)

Sets the color of the hourly tick marks.

Parameters:

color - The tick color.

See Also:

getTickColor()

getTickMargin

public int getTickMargin()

Returns the margin of the hourly tick marks.

Returns:

The tick margin.

See Also:

setTickMargin(int)

setTickMargin

public void setTickMargin(int margin)

Sets the margin of the hourly tick marks.

Parameters:

margin - The tick margin.

See Also:

getTickMargin()

getHourOfDay

public float getHourOfDay(int y)

Returns the hour of the day that corresponds to the specified Y position.

Parameters:

y - The vertical Y position.

Returns:

The hour of the day.

getY

public float getY(float hourOfDay)

Returns the vertical Y position within the scale that corresponds to the specified hour of the day.

Parameters:

hourOfDay - The hour of the day, which should be a value from 0 to 24.

Returns:

The Y position.

getY

public float getY(Calendar calendar)

Returns the vertical Y position within the scale that corresponds to the hour of the day of the specified calendar.

Parameters:

calendar - The calendar.

Returns:

The Y position.

getPreferredSize

public Dimension getPreferredSize()

Returns the preferred size of the scale.

Overrides:

getPreferredSize in class JComponent

Returns:

The preferred size of the scale, as a Dimension.

getMaximumSize

public Dimension getMaximumSize()

Returns the maximum size of the scale.

Overrides:

getMaximumSize in class JComponent

Returns:

The maximum size of the scale, as a Dimension.

getPreferredVisibleHours

public int getPreferredVisibleHours()

Returns the preferred number of hours that will be displayed when the scale is placed in a scrollpane. The default value is 8.

Returns:

The preferred number of hours to display.

See Also:

setPreferredVisibleHours(int)

setPreferredVisibleHours

public void setPreferredVisibleHours(int visibleHours)

Sets the preferred number of hours that will be displayed when the scale is placed in a scrollpane. The value of this property only affects the value of the the scale's getPreferredScrollableViewportSize() property.

Parameters:

visibleHours - The preferred number of visible hours.

See Also:

getPreferredVisibleHours()

getPreferredScrollableViewportSize

public Dimension getPreferredScrollableViewportSize()

Returns the preferred size of the viewport for this scale.

Specified by:

getPreferredScrollableViewportSize in interface Scrollable

Returns:

The preferredSize of a JViewport whose view is this scale.

See Also:

getPreferredVisibleHours()

getScrollableUnitIncrement

public int getScrollableUnitIncrement(Rectangle visibleRect,
                                      int orientation,
                                      int direction)

Returns the distance to scroll to expose the next or previous hour row for vertical scrolling, or the value of 1 pixel for horizontal scrolling.

Specified by:

getScrollableUnitIncrement in interface Scrollable

Parameters:

visibleRect - The visible rectangle

orientation - The scroll orientation, which must be either SwingConstants.VERTICAL or SwingConstants.HORIZONTAL.

direction - The scroll direction, which will be less than zero to scroll up/left or greater than zero for down/right.

Returns:

The distance, in pixels, to scroll to expose the next or previous unit.

getScrollableBlockIncrement

public int getScrollableBlockIncrement(Rectangle visibleRect,
                                       int orientation,
                                       int direction)

Returns the distance to scroll to expose the next or previous block of hour rows for vertical scrolling, or the value of 10 pixels for horizontal scrolling.

Specified by:

getScrollableBlockIncrement in interface Scrollable

Parameters:

visibleRect - The visible rectangle

orientation - The scroll orientation, which must be either SwingConstants.VERTICAL or SwingConstants.HORIZONTAL.

direction - The scroll direction, which will be less than zero to scroll up/left or greater than zero for down/right.

Returns:

The distance, in pixels, to scroll to expose the next or previous block.

getScrollableTracksViewportWidth

public boolean getScrollableTracksViewportWidth()

Returns true to indicate that a viewport should always force the width of the scale to match the width of the viewport. Note, that this effectively disables horizontal scrolling when the scale is placed in a JScrollPane.

Specified by:

getScrollableTracksViewportWidth in interface Scrollable

Returns:

true, which indicates that a viewport should force the scale's width to match its own.

getScrollableTracksViewportHeight

public boolean getScrollableTracksViewportHeight()

Returns false to indicate that a viewport should not force the height of the scale to match the height of the viewport. Note, that this effectively enables vertical scrolling when the scale is placed in a JScrollPane.

Specified by:

getScrollableTracksViewportHeight in interface Scrollable

Returns:

false, which indicates that a viewport should not force the scale's height to match its own.

paintComponent

public void paintComponent(Graphics g)

Paints the time scale.

Overrides:

paintComponent in class JComponent

Parameters:

g - The graphics context.