IlvTimeScale (Rogue Wave JViews 9.2 API)

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - ilog.views.gantt.scale.IlvTimeScale

All Implemented Interfaces:

IlvTimeScrollable, ImageObserver, MenuContainer, Serializable

Direct Known Subclasses:

IlvGanttTimeScale
```
public class IlvTimeScale
extends JComponent
implements IlvTimeScrollable
```
IlvTimeScale is a time scale component that contains several IlvTimeScaleRow objects. Each row represents a particular time unit and is responsible for drawing itself. The rows are not true UI components, but behave like renderers.

To scroll through the scale or to zoom on it when changing the time value and the visible duration, a new IlvTimeConverter object must be set for the scale.
The default actions provided on this object are that it will:
- Performs an integer zoom when the user double-clicks an interval.
- Performs a zoom by selecting two points (start and end points).
- Performs translation when the mouse is dragged on the scale.
You can disable these actions to provide your own ones using event listeners.
To adjust the time scale rows visibility whenever the visible time interval of the time scale changes, a new IlvTimeScaleVisibilityPolicy object must be set for the scale. The default implementation does not set this visibility policy, and the visibility of the rows is based on their visible property. This means that users of this class must control row visibility using the hideRow(ilog.views.gantt.scale.IlvTimeScaleRow) and the showRow(ilog.views.gantt.scale.IlvTimeScaleRow) methods. Use this class to define a time scale using cascading style sheets (CSS).
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class IlvTimeScale.PaintContext
A PaintContext defines the context in which the time scale paints.
- 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

Nested Classes
Modifier and Type	Class and Description
`static class`	`IlvTimeScale.PaintContext` A `PaintContext` defines the context in which the time scale paints.

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 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
`IlvTimeScale()` Creates a new `IlvTimeScale` object that initially contains no `rows`.
`IlvTimeScale(IlvTimeScaleVisibilityPolicy visibilityPolicy)` Creates a new `IlvTimeScale` instance with the specified visibility policy.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addRow(IlvTimeScaleRow row)` Appends the specified row to the scale.
`void`	`addTimeScrollListener(TimeScrollListener listener)` Adds the specified listener to receive time scroll events from this scale.
`protected void`	`adjustRowsVisibility(Graphics dst, IlvTimeScale.PaintContext context)` Adjusts which rows are visible, based on the `visibility policy`.
`void`	`computeCalendar()` Deprecated. Beginning with Rogue Wave JViews 8.7, this method is called automatically and is considered part of the internal implementation. This method should not be called from user code.
`IlvTimeScale.PaintContext`	`createPaintContext(Date start, IlvDuration duration, Rectangle viewport)` Creates a `PaintContext` so that the time scale paints the specified time interval into the specified view port.
`Calendar`	`getCalendar()` This method returns a `Calendar` object.
`Calendar`	`getCalendar(Date time)` This utility method returns a `Calendar` object that points to the specified time.
`long`	`getLocation(Date time)` Returns the x position corresponding to the specified time.
`Date`	`getMaxVisibleTime()` Returns the maximum time that the scale can show in bounded scrolling mode.
`IlvDuration`	`getMinVisibleDuration()` Returns the minimum duration that the scale can show.
`Date`	`getMinVisibleTime()` Returns the minimum time that the scale can show in bounded scrolling mode.
`IlvTimeScale.PaintContext`	`getPaintContext()` Returns the cached `PaintContext` used to paint the time scale on the screen.
`Dimension`	`getPreferredSize()` This method overrides the `JComponent` one to take the preferred height of each row into account.
`IlvTimeScaleRow[]`	`getRow()` This method returns the entire array of `IlvTimeScaleRow` objects.
`IlvTimeScaleRow`	`getRow(int index)` This method returns the `IlvTimeScaleRow` at a specified index.
`Date`	`getTime(long x)` Returns the time that corresponds to the specified x position in the component.
`IlvTimeConverter`	`getTimeConverter()` Returns the `IlvTimeConverter` object of this scale.
`IlvTimeScaleRow`	`getTimeScaleRow(int y)` This method returns the row under a y position in the component.
`TimeZone`	`getTimeZone()` This method returns the time zone of this scale.
`int`	`getTotalRowSize()` Returns the size of the entire array of `IlvTimeScaleRow` objects.
`ULocale`	`getULocale()` Returns the locale of this scale.
`IlvTimeScaleVisibilityPolicy`	`getVisibilityPolicy()` Returns the visibility policy of the time scale.
`IlvDuration`	`getVisibleDuration()` Returns the duration of the time interval displayed by the scale.
`IlvTimeInterval`	`getVisibleInterval()` Returns the time interval displayed by the scale.
`Date`	`getVisibleTime()` Returns the beginning of the time interval displayed by the scale.
`void`	`hideRow(IlvTimeScaleRow row)` This method hides the specified row.
`boolean`	`isConstantZoomFactorOnWidthChange()` Returns whether the visible duration of the scale will be modified when its width changes in order to maintain a constant zoom factor.
`boolean`	`isIntegerZoomAllowed()` Tests if double-click zooming with the mouse is allowed.
`boolean`	`isOpaqueTranslation()` Returns the opaque translation mode.
`boolean`	`isTranslationAllowed()` Tests if drag panning with the mouse is allowed.
`boolean`	`isVisibilityAdjusted()` Returns the time scale visibility adjusted status.
`boolean`	`isZoomAllowed()` Tests if click-move-click zooming with the mouse is allowed.
`void`	`paint(Graphics dst, Rectangle viewport, IlvTimeScale.PaintContext context)` Paints the time scale to the given `Graphics` by using an external `IlvTimeScale.PaintContext`.
`protected void`	`paintComponent(Graphics dst)` Paints the time scale by calling the `paintRows` method.
`protected void`	`paintRows(Graphics dst)` Paints the time scale rows by calling the `paint(Graphics, Rectangle, PaintContext)` method.
`void`	`paintSeparator(Graphics dst, int x, int y, int width)` This method draws the separation between two rows.
`void`	`removeRow(IlvTimeScaleRow row)` This method removes a row from the `IlvTimeScale` object.
`void`	`removeTimeScrollListener(TimeScrollListener listener)` Removes the specified listener so that it will no longer receive time scroll events from this scale.
`void`	`repaint()` Request a repaint of this component.
`void`	`revalidate()` Request a call to `invalidate()` and a subsequent call to `validate()` on this component.
`void`	`setBounds(int x, int y, int w, int h)` Moves and resizes the time scale.
`void`	`setComponentOrientation(ComponentOrientation o)` Sets the language-sensitive orientation of this time scale.
`void`	`setConstantZoomFactorOnWidthChange(boolean enabled)` Sets if the visible duration for the scale will be modified in order to maintain a constant zoom factor when the width of the scale changes.
`void`	`setIntegerZoomAllowed(boolean value)` Set to `true` to enable double-click zooming with the mouse.
`void`	`setLocale(Locale locale)` Sets the locale of this component.
`void`	`setMaxVisibleTime(Date max)` Sets the maximum time that the scale can show in bounded scrolling mode.
`void`	`setMinVisibleDuration(IlvDuration duration)` Sets the minimum duration that the scale can show.
`void`	`setMinVisibleTime(Date min)` Sets the minimum time that the scale can show in bounded scrolling mode.
`void`	`setOpaqueTranslation(boolean value)` Changes the opaque translation mode.
`void`	`setRow(IlvTimeScaleRow[] rows)` This method replaces the existing `IlvTimeScaleRow` objects by those passed in the `row` argument.
`void`	`setRow(int index, IlvTimeScaleRow row)` Changes the `IlvTimeScaleRow` object at a specified index.
`void`	`setTimeConverter(IlvTimeConverter timeConverter)` This method can be used to change the `IlvTimeConverter` object of this scale.
`void`	`setTimeZone(TimeZone timezone)` The time zone set with this method will be used instead of the default time zone.
`void`	`setTranslationAllowed(boolean value)` Sets whether drag panning with the mouse is allowed.
`void`	`setULocale(ULocale locale)` Sets the locale of this component.
`void`	`setVisibilityAdjusted(boolean visibilityAdjusted)` Sets whether the rows visibility should be adjusted or not.
`void`	`setVisibilityPolicy(IlvTimeScaleVisibilityPolicy policy)` Sets the visibility policy of the time scale, and adjusts the rows if needed.
`void`	`setVisibleDuration(IlvDuration duration)` Sets the duration of the time interval displayed by the scale.
`void`	`setVisibleInterval(Date time, IlvDuration duration)` Sets the time interval displayed by the scale.
`void`	`setVisibleTime(Date time)` Sets the beginning of the time interval displayed by the scale.
`void`	`setZoomAllowed(boolean value)` Sets whether click-move-click zooming with the mouse is allowed.
`void`	`showRow(IlvTimeScaleRow row)` This method shows the specified row.
`void`	`updateUI()` This method is a notification that the L&F has changed.

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, 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, 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, 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, resize, resize, setBounds, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - IlvTimeScale
```
public IlvTimeScale()
```
    Creates a new IlvTimeScale object that initially contains no rows. By default, the time scale uses an IlvLinearTimeConverter, and no IlvTimeScaleVisibilityPolicy. The time scale time converter can be set by calling the setTimeConverter method. The time scale visibility policy can be set by calling setVisibilityPolicy(ilog.views.gantt.scale.IlvTimeScaleVisibilityPolicy).
  - IlvTimeScale
```
public IlvTimeScale(IlvTimeScaleVisibilityPolicy visibilityPolicy)
```
    Creates a new IlvTimeScale instance with the specified visibility policy. By default, the time scale uses an IlvLinearTimeConverter. The time scale time converter can be set by calling setTimeConverter.
    
    Parameters:
    
    visibilityPolicy - The row visibility policy.
    
    Since:
    
    JViews 6.0
- Method Detail
  - getPaintContext
```
public IlvTimeScale.PaintContext getPaintContext()
```
    Returns the cached PaintContext used to paint the time scale on the screen. The paint context is immutable and calling any of its setter methods will throw an UnsupportedOperationException.
    
    Returns:
    
    The cached paint context.
    
    Since:
    
    JViews 5.0
  - createPaintContext
```
public IlvTimeScale.PaintContext createPaintContext(Date start,
                                                    IlvDuration duration,
                                                    Rectangle viewport)
```
    Creates a PaintContext so that the time scale paints the specified time interval into the specified view port.
    
    Parameters:
    
    start - The begin of the visible time interval.
    
    duration - The duration of the visible time interval.
    
    viewport - The rectangle defining the position the time scale to paint to.
    
    Returns:
    
    The paint context.
    
    Since:
    
    JViews 5.0
  - updateUI
```
public void updateUI()
```
    This method is a notification that the L&F has changed. This method is overridden to initialize the scale default font and color to be the same as a JTableHeader.
    
    Overrides:
    
    updateUI in class JComponent
    
    Since:
    
    JViews 3.5
  - addRow
```
public void addRow(IlvTimeScaleRow row)
```
    Appends the specified row to the scale. To see the modification, you must redraw the object.
    
    Parameters:
    
    row - The row to be added.
    
    See Also:
    
    removeRow(ilog.views.gantt.scale.IlvTimeScaleRow)
  - removeRow
```
public void removeRow(IlvTimeScaleRow row)
```
    This method removes a row from the IlvTimeScale object. To see the modification, you must redraw the object.
    
    Parameters:
    
    row - The row to be removed.
  - getRow
```
public IlvTimeScaleRow getRow(int index)
```
    This method returns the IlvTimeScaleRow at a specified index.
    
    Parameters:
    
    index - The index of the returned row.
  - setRow
```
public void setRow(int index,
                   IlvTimeScaleRow row)
```
    Changes the IlvTimeScaleRow object at a specified index. The old row at this position will be removed. If the index is greater than the last row index, fake invisible rows are created between the two rows.
    
    Parameters:
    
    index - The index of the row to be changed.
    
    row - The new IlvTimeScaleRow.
  - getRow
```
public IlvTimeScaleRow[] getRow()
```
    This method returns the entire array of IlvTimeScaleRow objects.
  - getTotalRowSize
```
public int getTotalRowSize()
```
    Returns the size of the entire array of IlvTimeScaleRow objects.
    
    Returns:
    
    The size of the entire array of IlvTimeScaleRow objects.
    
    Since:
    
    JViews 6.0
  - setRow
```
public void setRow(IlvTimeScaleRow[] rows)
```
    This method replaces the existing IlvTimeScaleRow objects by those passed in the row argument.
    
    Parameters:
    
    rows - The new array of IlvTimeScaleRow.
  - getTimeScaleRow
```
public IlvTimeScaleRow getTimeScaleRow(int y)
```
    This method returns the row under a y position in the component.
    
    Parameters:
    
    y - The y position in the component.
  - getTime
```
public Date getTime(long x)
```
    Returns the time that corresponds to the specified x position in the component.
    
    Parameters:
    
    x - The x position in the component.
  - getLocation
```
public long getLocation(Date time)
```
    Returns the x position corresponding to the specified time.
    
    Parameters:
    
    time - The time.
    
    Returns:
    
    The x position.
  - showRow
```
public void showRow(IlvTimeScaleRow row)
```
    This method shows the specified row.
    
    Parameters:
    
    row - The row to be shown.
  - hideRow
```
public void hideRow(IlvTimeScaleRow row)
```
    This method hides the specified row.
    
    Parameters:
    
    row - The row to be hidden.
  - revalidate
```
public void revalidate()
```
    Request a call to invalidate() and a subsequent call to validate() on this component. Usually, the invalidate() call is done immediately, and the validate() call is delayed.
    
    Overrides:
    
    revalidate in class JComponent
    
    Since:
    
    JViews 8.7
  - repaint
```
public void repaint()
```
    Request a repaint of this component. Usually, the paint call is delayed.
    
    Overrides:
    
    repaint in class Component
    
    Since:
    
    JViews 8.7
  - paintComponent
```
protected void paintComponent(Graphics dst)
```
    Paints the time scale by calling the paintRows method.
    
    Overrides:
    
    paintComponent in class JComponent
    
    Parameters:
    
    dst - The destination graphics.
  - paintRows
```
protected void paintRows(Graphics dst)
```
    Paints the time scale rows by calling the paint(Graphics, Rectangle, PaintContext) method. The cached PaintContext is used.
    If a visibility policy exists, the rows will be adjusted if necessary.
    
    Parameters:
    
    dst - The destination graphics.
    
    Since:
    
    JViews 3.5
  - paint
```
public void paint(Graphics dst,
                  Rectangle viewport,
                  IlvTimeScale.PaintContext context)
```
    Paints the time scale to the given Graphics by using an external IlvTimeScale.PaintContext. This method paints each visible IlvTimeScaleRow object of this scale by calling the row's paint method. Separation lines are drawn between each row by calling the paintSeparator method.
    This method is usually called by paintRows(). In this case the cached PaintContext is used.
    This method can also be called to print the time scale. In this case an external PaintContext must be provided in order to print the portion specified by the programmer.
    
    Parameters:
    
    dst - The destination graphics.
    
    viewport - The viewport. It defines the potion of the time scale to be painted.
    
    context - The paint context.
    
    Since:
    
    JViews 5.0
  - setBounds
```
public void setBounds(int x,
                      int y,
                      int w,
                      int h)
```
    Moves and resizes the time scale. The new location of the top-left corner is specified by x and y, and the new size is specified by width and height.
    
    Overrides:
    
    setBounds in class Component
    
    Parameters:
    
    x - The new x-coordinate of this component.
    
    y - The new y-coordinate of this component.
    
    w - The new width of this component.
    
    h - The new height of this component.
  - setIntegerZoomAllowed
```
public void setIntegerZoomAllowed(boolean value)
```
    Set to true to enable double-click zooming with the mouse. The default value is true.
    
    Parameters:
    
    value - If true, double-click zooming with the mouse is enabled.
    
    See Also:
    
    isIntegerZoomAllowed(), setZoomAllowed(boolean)
  - isIntegerZoomAllowed
```
public boolean isIntegerZoomAllowed()
```
    Tests if double-click zooming with the mouse is allowed.
    
    Returns:
    
    If double-click zooming with the mouse is enabled, true is returned.
    
    See Also:
    
    setIntegerZoomAllowed(boolean), isZoomAllowed()
  - setZoomAllowed
```
public void setZoomAllowed(boolean value)
```
    Sets whether click-move-click zooming with the mouse is allowed. The default value is true.
    
    Parameters:
    
    value - Set to true to enable click-move-click zooming with the mouse.
    
    See Also:
    
    isZoomAllowed(), setIntegerZoomAllowed(boolean)
  - isZoomAllowed
```
public boolean isZoomAllowed()
```
    Tests if click-move-click zooming with the mouse is allowed.
    
    Returns:
    
    If click-move-click zooming with the mouse is enabled true is returned.
    
    See Also:
    
    setZoomAllowed(boolean), isIntegerZoomAllowed()
  - setTranslationAllowed
```
public void setTranslationAllowed(boolean value)
```
    Sets whether drag panning with the mouse is allowed. The default value is true.
    
    Parameters:
    
    value - Set to true to enable drag panning with the mouse.
    
    See Also:
    
    isTranslationAllowed()
  - isTranslationAllowed
```
public boolean isTranslationAllowed()
```
    Tests if drag panning with the mouse is allowed.
    
    Returns:
    
    If drag panning with the mouse is enabled, true is returned.
    
    See Also:
    
    setTranslationAllowed(boolean)
  - setOpaqueTranslation
```
public void setOpaqueTranslation(boolean value)
```
    Changes the opaque translation mode.
    
    Parameters:
    
    value - If false, the scale will not be drawn during translation.
  - isOpaqueTranslation
```
public boolean isOpaqueTranslation()
```
    Returns the opaque translation mode. The default is true.
    
    See Also:
    
    setOpaqueTranslation(boolean)
  - getPreferredSize
```
public Dimension getPreferredSize()
```
    This method overrides the JComponent one to take the preferred height of each row into account.
    
    Overrides:
    
    getPreferredSize in class JComponent
  - paintSeparator
```
public void paintSeparator(Graphics dst,
                           int x,
                           int y,
                           int width)
```
    This method draws the separation between two rows.
    
    Parameters:
    
    dst - The destination Graphics.
    
    x - The x coordinate of the separation origin.
    
    y - The y coordinate of the separation origin.
    
    width - The width of the separation.
  - getTimeConverter
```
public IlvTimeConverter getTimeConverter()
```
    Returns the IlvTimeConverter object of this scale.
  - setTimeConverter
```
public void setTimeConverter(IlvTimeConverter timeConverter)
```
    This method can be used to change the IlvTimeConverter object of this scale. This object allows you to draw the scale correctly by converting time value to units on the screen.
    
    Parameters:
    
    timeConverter - The new IlvTimeConverter object.
  - getVisibilityPolicy
```
public IlvTimeScaleVisibilityPolicy getVisibilityPolicy()
```
    Returns the visibility policy of the time scale.
    
    Returns:
    
    The visibility policy.
    
    Since:
    
    JViews 6.0
    
    See Also:
    
    setVisibilityPolicy(ilog.views.gantt.scale.IlvTimeScaleVisibilityPolicy)
  - setVisibilityPolicy
```
public void setVisibilityPolicy(IlvTimeScaleVisibilityPolicy policy)
```
    Sets the visibility policy of the time scale, and adjusts the rows if needed.
    A visibility policy determines which rows are visible when the time scale visible time interval changed.
    
    Parameters:
    
    policy - The visibility policy. If the policy is set to the default value of null, row visibility is based on their visible property. If the policy is not null, the visibility of the rows is adjusted by calling adjustRows.
    
    Since:
    
    JViews 6.0
    
    See Also:
    
    setVisibleDuration(ilog.views.gantt.IlvDuration), setVisibleInterval(java.util.Date, ilog.views.gantt.IlvDuration)
  - isVisibilityAdjusted
```
public boolean isVisibilityAdjusted()
```
    Returns the time scale visibility adjusted status. This only has meaning when there is a visibility policy associated to the time scale.
    
    Returns:
    
    When the rows need to be adjusted, false is returned. The default value is false.
    
    Since:
    
    JViews 6.0
  - setVisibilityAdjusted
```
public void setVisibilityAdjusted(boolean visibilityAdjusted)
```
    Sets whether the rows visibility should be adjusted or not. This only has meaning when there is a visibility policy associated to the time scale.
    
    Parameters:
    
    visibilityAdjusted - Set to false so that at the next paint request, the time scale will take any existing visibility policy into account for row adjustment.
    
    Since:
    
    JViews 6.0
  - adjustRowsVisibility
```
protected void adjustRowsVisibility(Graphics dst,
                                    IlvTimeScale.PaintContext context)
```
    Adjusts which rows are visible, based on the visibility policy.
    
    Parameters:
    
    dst - The destination graphics.
    
    context - The paint context.
    
    Since:
    
    JViews 6.0
  - getULocale
```
public ULocale getULocale()
```
    Returns the locale of this scale.
    
    Returns:
    
    An ICU ULocale.
    
    Since:
    
    JViews 8.8
    
    See Also:
    
    setULocale(ULocale)
  - setULocale
```
public void setULocale(ULocale locale)
```
    Sets the locale of this component.
    
    Parameters:
    
    locale - An ICU ULocale, or null if this component shall inherit its locale from the parent component.
    
    Since:
    
    JViews 8.8
    
    See Also:
    
    getULocale(), setLocale(Locale)
  - setLocale
```
public void setLocale(Locale locale)
```
    Sets the locale of this component.
    
    Overrides:
    
    setLocale in class Component
    
    Parameters:
    
    locale - An Locale, or null if this component shall inherit its locale from the parent component.
    
    See Also:
    
    setULocale(ULocale)
  - setComponentOrientation
```
public void setComponentOrientation(ComponentOrientation o)
```
    Sets the language-sensitive orientation of this time scale.
    
    Overrides:
    
    setComponentOrientation in class Component
    
    Parameters:
    
    o - The orientation for this time scale.
    
    Since:
    
    JVIews 8.7
  - computeCalendar
```
@Deprecated
public void computeCalendar()
```
    Deprecated. Beginning with Rogue Wave JViews 8.7, this method is called automatically and is considered part of the internal implementation. This method should not be called from user code.
    
    Updates this scale's calendar to match the locale and timezone. This method is automatically called whenever the scale paints itself or when the timezone is changed.
    
    See Also:
    
    getCalendar(), getCalendar(Date), setTimeZone(TimeZone), setLocale(Locale)
  - getCalendar
```
public Calendar getCalendar()
```
    This method returns a Calendar object. By default, it returns the result of the method Calendar.getInstance() (default locale and default time zone). If a Locale or a TimeZone has been specified with one of the methods setLocale or setTimeZone, the method constructs the calendar with these values. When deriving the class IlvTimeScaleRow, you should use this method to get a Calendar object to compute or display time values. However, be careful, this method always returns the same Calendar object constructed in computeCalendar. Therefore, you should clone it if you need more than one Calendar objects.
    
    See Also:
    
    setLocale(java.util.Locale), setTimeZone(java.util.TimeZone), getCalendar(Date), IlvBasicTimeScaleRow.getDateFormat()
  - getCalendar
```
public Calendar getCalendar(Date time)
```
    This utility method returns a Calendar object that points to the specified time. Be careful, this method always returns the same Calendar object constructed in computeCalendar. You should therefore clone it if you need more than one object.
    
    Parameters:
    
    time - The current day on the calendar.
  - setTimeZone
```
public void setTimeZone(TimeZone timezone)
```
    The time zone set with this method will be used instead of the default time zone. To revert to the default time zone, set the timezone argument to null.
    
    Parameters:
    
    timezone - The new time zone.
    
    See Also:
    
    getCalendar()
  - getTimeZone
```
public TimeZone getTimeZone()
```
    This method returns the time zone of this scale.
  - isConstantZoomFactorOnWidthChange
```
public boolean isConstantZoomFactorOnWidthChange()
```
    Returns whether the visible duration of the scale will be modified when its width changes in order to maintain a constant zoom factor. If false, the visible duration of the scale stays the same and its zoom factor is modified when the width of the scale changes. The default value is true.
    When multiple IlvTimeScrollable user interface components have their time scrolling synchronized through an IlvBasicTimeScrollController or one of its subclasses, all of the scrollable components should be placed in a container that ensures that they maintain equal widths. Their constantZoomFactorOnWidthChange properties must also be set to the same value. When the GUI resizes, each scrollable component is responsible for computing its own duration change. When a time scale is added to an IlvHierarchyChart, its constantZoomFactorOnWidthChange property is set to match that of the chart.
    
    Since:
    
    JViews 6.0
    
    See Also:
    
    setConstantZoomFactorOnWidthChange(boolean)
  - setConstantZoomFactorOnWidthChange
```
public void setConstantZoomFactorOnWidthChange(boolean enabled)
```
    Sets if the visible duration for the scale will be modified in order to maintain a constant zoom factor when the width of the scale changes. If disabled, the visible duration of the scale stays the same and the zoom factor is modified when the width of the scale changes. The default value is true.
    When multiple IlvTimeScrollable user interface components have their time scrolling synchronized through an IlvBasicTimeScrollController or one of its subclasses, all of the scrollable components should be placed in a container that ensures that they maintain equal widths. Their constantZoomFactorOnWidthChange properties must also be set to the same value. When the GUI resizes, each scrollable component is responsible for computing its own duration change. When a time scale is added to an IlvHierarchyChart, its constantZoomFactorOnWidthChange property is set to match that of the chart.
    
    Parameters:
    
    enabled - Set to true so the zoom factor stays the same and the visible duration changes when the scale resizes. Set to false so the visible duration stays the same and the zoom factor changes.
    
    Since:
    
    JViews 6.0
    
    See Also:
    
    isConstantZoomFactorOnWidthChange()
  - getMinVisibleTime
```
public Date getMinVisibleTime()
```
    Returns the minimum time that the scale can show in bounded scrolling mode.
    
    Specified by:
    
    getMinVisibleTime in interface IlvTimeScrollable
    
    Returns:
    
    The minimum visible time or null if the scale is in unbounded scrolling mode.
    
    See Also:
    
    setMinVisibleTime(java.util.Date)
  - setMinVisibleTime
```
public void setMinVisibleTime(Date min)
```
    Sets the minimum time that the scale 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 scale to unbounded scrolling mode.
    
    See Also:
    
    getMinVisibleTime()
  - getMaxVisibleTime
```
public Date getMaxVisibleTime()
```
    Returns the maximum time that the scale can show in bounded scrolling mode.
    
    Specified by:
    
    getMaxVisibleTime in interface IlvTimeScrollable
    
    Returns:
    
    The maximum visible time or null if the scale is in unbounded scrolling mode.
    
    See Also:
    
    setMaxVisibleTime(java.util.Date)
  - setMaxVisibleTime
```
public void setMaxVisibleTime(Date max)
```
    Sets the maximum time that the scale 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 scale to unbounded scrolling mode.
    
    See Also:
    
    getMaxVisibleTime()
  - getMinVisibleDuration
```
public IlvDuration getMinVisibleDuration()
```
    Returns the minimum duration that the scale can show. This value indicates the maximum zoom level that the scale 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 scale can show. This specifies the maximum zoom level that the scale 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 scale.
    
    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 scale. 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. The time scale then adjusts its internal zoom and scroll parameters so that the specified time value is drawn at the beginning of the time scale. 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 scale.
    
    Specified by:
    
    getVisibleDuration in interface IlvTimeScrollable
    
    Returns:
    
    The duration of the displayed time interval.
    
    See Also:
    
    setVisibleDuration(ilog.views.gantt.IlvDuration)
  - setVisibleDuration
```
public void setVisibleDuration(IlvDuration duration)
```
    Sets the duration of the time interval displayed by the scale. 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. The time scale then adjusts its internal zoom and scroll parameters so that the specified duration is visible. 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 scale.
    
    Specified by:
    
    getVisibleInterval in interface IlvTimeScrollable
    
    Returns:
    
    The displayed 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 scale. 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 scale.
    
    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 scale.
    
    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)

Class IlvTimeScale

Nested Class Summary

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

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

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

Field Summary

Fields inherited from class javax.swing.JComponent

Fields inherited from class java.awt.Component

Fields inherited from interface ilog.views.gantt.IlvTimeScrollable

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class javax.swing.JComponent

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Constructor Detail

IlvTimeScale

IlvTimeScale

Method Detail

getPaintContext

createPaintContext

updateUI

addRow

removeRow

getRow

setRow

getRow

getTotalRowSize

setRow

getTimeScaleRow

getTime

getLocation

showRow

hideRow

revalidate

repaint

paintComponent

paintRows

paint

setBounds

setIntegerZoomAllowed

isIntegerZoomAllowed

setZoomAllowed

isZoomAllowed

setTranslationAllowed

isTranslationAllowed

setOpaqueTranslation

isOpaqueTranslation

getPreferredSize

paintSeparator

getTimeConverter

setTimeConverter

getVisibilityPolicy

setVisibilityPolicy

isVisibilityAdjusted

setVisibilityAdjusted

adjustRowsVisibility

getULocale

setULocale

setLocale

setComponentOrientation

computeCalendar

getCalendar

getCalendar

setTimeZone

getTimeZone

isConstantZoomFactorOnWidthChange

setConstantZoomFactorOnWidthChange

getMinVisibleTime

setMinVisibleTime

getMaxVisibleTime

setMaxVisibleTime

getMinVisibleDuration

setMinVisibleDuration

getVisibleTime

setVisibleTime

getVisibleDuration

setVisibleDuration

getVisibleInterval