ilog.views.gantt.graphic

Class IlvTimeIndicator

java.lang.Object

ilog.views.IlvGraphic

ilog.views.gantt.graphic.IlvTimeIndicator

All Implemented Interfaces:

VerticalScrollListener, IlvPersistentObject, IlvBlinkingObject, IlvBaseTextDirectionInterface, Transferable, Serializable, EventListener

Direct Known Subclasses:

IlvFixedTimeIndicator

public abstract class IlvTimeIndicator
extends IlvGraphic
implements VerticalScrollListener

The IlvTimeIndicator class is used to represent a time in an IlvGanttSheet. The time indicator uses an IlvGraphic as a renderer.

Since:

JViews 8.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected IlvGraphic	renderer The graphic representing this renderer.

Constructor Summary

Constructors

Constructor and Description
IlvTimeIndicator(Date time, IlvGraphic renderer) Deprecated. Beginning with Rogue Wave JViews 8.1, use the IlvTimeIndicator(Date, IlvGraphic, String) constructor that takes a description argument.
IlvTimeIndicator(Date time, IlvGraphic renderer, String description) Creates a new IlvTimeIndicator for indicating a time, with an associated renderer.

Method Summary

Modifier and Type	Method and Description
void	applyTransform(IlvTransformer t) Overrides the applyTransform method of the IlvGraphic class so that it does nothing.
IlvRect	boundingBox(IlvTransformer t) Returns the bounding rectangle of the time indicator renderer.
IlvGraphic	copy() Overrides the copy method of the IlvGraphic class.
void	draw(Graphics dst, IlvTransformer t) Draws the time indicator graphic objects.
float	getAlpha() Returns the current alpha value for the layer that holds this graphic object.
String	getDescription() Returns the description of the time indicator.
int	getMaxWidth() Gets the maximum width for this time indicator.
IlvGraphic	getRenderer() Returns the renderer used to draw this time indicator.
Date	getTime() Gets the time associated to this time indicator.
void	maxVerticalPositionChanged(VerticalScrollEvent evt) Deprecated. Beginning with Rogue Wave JViews 8.5, this method does nothing and is never invoked because time indicators no longer need to implement the VerticalScrollListener interface in order to redraw themselves properly.
protected IlvGraphic	prepareGraphic(IlvTransformer t) Deprecated. Beginning with Rogue Wave JViews 8.1, this method is not invoked internally anymore.
void	setAlpha(float alpha) Set the alpha value for the layer that holds this graphic object.
void	setBackground(Color c) Changes the background color of the time indicator graphic object.
void	setDescription(String description) Sets the description of the time indicator.
void	setFillOn(boolean value) Changes the fill status of the time indicator graphic object.
void	setForeground(Color c) Changes the foreground color of the time indicator graphic object.
void	setMaxWidth(int maxWidth) Sets the maximum width for this time indicator, so that the drawing does not exceed this width;
void	setRenderer(IlvGraphic renderer) Sets the renderer used to draw this time indicator.
void	setStrokeOn(boolean value) Changes the stroke status of the time indicator graphic object.
void	setTime(Date time) Sets the time this time indicator will represent.
void	setToolTipText(String text) Sets the text to display in the tooltip of this object.
protected IlvRect	timeIndicatorBBox() Deprecated. Beginning with Rogue Wave JViews 8.5 call boundingBox(IlvTransformer) instead.
void	update() Deprecated. Beginning with Rogue Wave JViews 8.5, this method is no longer used because the time indicator will redraw itself automatically whenever its time value or its renderer is changed.
void	verticalExtentChanged(VerticalScrollEvent evt) Deprecated. Beginning with Rogue Wave JViews 8.5, this method does nothing and is never invoked because time indicators no longer need to implement the VerticalScrollListener interface in order to redraw themselves properly.
void	verticalPositionChanged(VerticalScrollEvent evt) Deprecated. Beginning with Rogue Wave JViews 8.5, this method does nothing and is never invoked because time indicators no longer need to implement the VerticalScrollListener interface in order to redraw themselves properly.
boolean	zoomable() Returns false, indicating that time indicators are not zoomable graphics.

Methods inherited from class ilog.views.IlvGraphic

addActionListener, addNamedPropertyListener, allViewsRemoved, baseTextDirectionChanged, blinkingStateOn, boundingBox, callDraw, componentOrientationChanged, contains, getAndAssociateObjectInteractor, getBaseTextDirection, getBlinkingAction, getBlinkingObjectOwner, getBlinkingOffPeriod, getBlinkingOnPeriod, getCenter, getComponentOrientation, getDefaultInteractor, getGraphicBag, GetGraphicObject, getIntersectionWithOutline, getLocale, getName, getNamedProperty, getObjectInteractor, getPopupMenu, getPopupMenu, getPopupMenuName, getProperty, getResolvedBaseTextDirection, getToolTipBaseTextDirection, getToolTipText, getToolTipText, getTopLevelGraphicBag, getTransferData, getTransferDataFlavors, getULocale, getZOrderIndex, hasProperty, inside, intersects, invalidateBBoxCache, invalidateBidiCache, isBaseTextDirectionSensitive, isComponentOrientationSensitive, isDataFlavorSupported, isEditable, isInApplyToObject, isLocaleSensitive, isMovable, isPersistent, isSelectable, isVisible, localeChanged, makeSelection, move, move, moveResize, needsViewNotification, notifyObjectInteractorToManager, processActionEvent, reDraw, registerBlinkingResource, removeActionListener, removeNamedProperty, removeNamedPropertyListener, removeProperty, replaceProperty, resize, rotate, scale, setBaseTextDirection, setBaseTextDirectionDuringConstruction, setBlinkingAction, setBlinkingOffPeriod, setBlinkingOnPeriod, setEditable, setGraphicBag, setInApplyToObject, setMovable, setName, setNamedProperty, setNameImpl, setObjectInteractor, setPopupMenu, setPopupMenuName, setProperty, setSelectable, setToolTipBaseTextDirection, setVisible, setZOrderIndex, toString, translate, updateNeedsViewNotification, usesBidiMarkers, viewAddedOrRemoved, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

renderer

protected IlvGraphic renderer

The graphic representing this renderer.

Constructor Detail

IlvTimeIndicator

@Deprecated
public IlvTimeIndicator(Date time,
                                    IlvGraphic renderer)

Deprecated. Beginning with Rogue Wave JViews 8.1, use the IlvTimeIndicator(Date, IlvGraphic, String) constructor that takes a description argument.

Creates a new IlvTimeIndicator for indicating a time, with an associated renderer. By default, the time indicator is not selectable.

Parameters:

time - The associated time.

renderer - The renderer used to display the time indicator.

IlvTimeIndicator

public IlvTimeIndicator(Date time,
                        IlvGraphic renderer,
                        String description)

Creates a new IlvTimeIndicator for indicating a time, with an associated renderer. By default, the time indicator is not selectable.

Parameters:

time - The associated time.

renderer - The renderer used to render the time indicator.

description - A description string.

Since:

JViews 8.1

Method Detail

getDescription

public String getDescription()

Returns the description of the time indicator.

Returns:

The time indicator description.

Since:

JViews 8.1

See Also:

setDescription(String)

setDescription

public void setDescription(String description)

Sets the description of the time indicator.

Parameters:

description - The description.

Since:

JViews 8.1

See Also:

getDescription()

getRenderer

public IlvGraphic getRenderer()

Returns the renderer used to draw this time indicator. This method must not return null.

Returns:

The IlvGraphic used to draw this time indicator.

setRenderer

public void setRenderer(IlvGraphic renderer)

Sets the renderer used to draw this time indicator.

Parameters:

renderer - An IlvGraphic to draw the time indicator. Can not be null.

getTime

public Date getTime()

Gets the time associated to this time indicator.

Returns:

A Date representing the time associated to this time indicator, or null.

setTime

public void setTime(Date time)

Sets the time this time indicator will represent.

Parameters:

time - A Date representing the time associated to this time indicator..

getMaxWidth

public int getMaxWidth()

Gets the maximum width for this time indicator. The drawing will be clipped to this width. The default width is 2;

Returns:

The maximum width for this time indicator.

setMaxWidth

public void setMaxWidth(int maxWidth)

Sets the maximum width for this time indicator, so that the drawing does not exceed this width;

Parameters:

maxWidth - the maximum width for this time indicator.

getAlpha

public float getAlpha()

Returns the current alpha value for the layer that holds this graphic object. The default value is 0.5.

Returns:

float value equal to current alpha value setting for the layer containing this object.

See Also:

setAlpha(float)

setAlpha

public void setAlpha(float alpha)

Set the alpha value for the layer that holds this graphic object. Making this less than 1.0 causes the line to appear see-through.

Note: Alpha values less than 1.0 are slower to draw, especially on X11 platforms when the system property sun.java2d.pmoffscreen is not set to false.

Parameters:

alpha - float value for new alpha value setting for the layer containing this object.

See Also:

getAlpha()

setForeground

public void setForeground(Color c)

Changes the foreground color of the time indicator graphic object. The default implementation changes the foreground color of the renderer.

Note that not all graphic objects have a foreground color. Therefore, a call to this method may not do anything.

Overrides:

setForeground in class IlvGraphic

Parameters:

c - The new color.

See Also:

IlvGraphic.draw(Graphics, IlvTransformer), IlvGraphic.setBackground(Color), IlvGraphic.setFillOn(boolean), IlvGraphic.setStrokeOn(boolean), IlvGraphic

setFillOn

public void setFillOn(boolean value)

Changes the fill status of the time indicator graphic object. The default implementation changes the fill status of the renderer.

Note that not all graphic objects may be filled. Therefore, a call to this method may not do anything.

Overrides:

setFillOn in class IlvGraphic

Parameters:

value - true if fill is on.

See Also:

IlvGraphic.draw(Graphics, IlvTransformer), IlvGraphic.setBackground(Color), IlvGraphic.setForeground(Color), IlvGraphic.setStrokeOn(boolean), IlvGraphic

setBackground

public void setBackground(Color c)

Changes the background color of the time indicator graphic object. The default implementation changes the background color of the renderer.

Note that not all graphic objects have a background color. Therefore, a call to this method may not do anything.

Overrides:

setBackground in class IlvGraphic

Parameters:

c - The new color.

See Also:

IlvGraphic.draw(Graphics, IlvTransformer), IlvGraphic.setForeground(Color), IlvGraphic.setFillOn(boolean), IlvGraphic.setStrokeOn(boolean), IlvGraphic

setStrokeOn

public void setStrokeOn(boolean value)

Changes the stroke status of the time indicator graphic object. The default implementation changes the stroke status of the renderer.

Note that not all graphic objects may be stroked. Therefore, a call to this method may not do anything.

Overrides:

setStrokeOn in class IlvGraphic

Parameters:

value - true if stroke is on.

See Also:

IlvGraphic.draw(Graphics, IlvTransformer), IlvGraphic.setBackground(Color), IlvGraphic.setForeground(Color), IlvGraphic.setFillOn(boolean), IlvGraphic

setToolTipText

public void setToolTipText(String text)

Sets the text to display in the tooltip of this object.

Tooltips for Rogue Wave JViews graphic objects will work only if your manager view is contained in a hierarchy of Swing components. In addition, you must enable the tooltip mechanism for the manager view by calling the static method IlvToolTipManager.registerView(ilog.views.IlvManagerView).

Tooltip formatting is supported by the underlying Swing tooltip mechanism (see JToolTip). For instance, the following string is a multiline tooltip: "<html>This is a<br>multiline<br>tooltip</html>". An easy way to create formatted multiline tooltips is the method IlvSwingUtil.createMultiLineToolTipText(java.lang.String[], int). See also the method IlvSwingUtil.escapeForHTMLElement(java.lang.String, boolean).

Overrides:

setToolTipText in class IlvGraphic

Parameters:

text - The tooltip string to display. Set text to null to turn off the tooltip for this graphic object.

Since:

JViews 8.1

See Also:

IlvToolTipManager, IlvToolTipManager.registerView(ilog.views.IlvManagerView), IlvGraphic.getToolTipText(), IlvGraphic.getToolTipText(IlvPoint, IlvTransformer), IlvGraphic

applyTransform

public void applyTransform(IlvTransformer t)

Overrides the applyTransform method of the IlvGraphic class so that it does nothing. This means that all methods of IlvGraphic that are using this method will do nothing. You cannot directly change the shape of an IlvTimeIndicator.

Specified by:

applyTransform in class IlvGraphic

Parameters:

t - the transformer to be applied.

See Also:

IlvGraphic

zoomable

public boolean zoomable()

Returns false, indicating that time indicators are not zoomable graphics.

Overrides:

zoomable in class IlvGraphic

Since:

JViews 8.5

See Also:

IlvGraphic, IlvGraphic.draw(java.awt.Graphics, ilog.views.IlvTransformer), IlvGraphic.boundingBox(IlvTransformer), IlvManager

update

@Deprecated
public void update()

Deprecated. Beginning with Rogue Wave JViews 8.5, this method is no longer used because the time indicator will redraw itself automatically whenever its time value or its renderer is changed.

Recalculate and redraw when scrolling, or the time change.

boundingBox

public IlvRect boundingBox(IlvTransformer t)

Returns the bounding rectangle of the time indicator renderer.

Specified by:

boundingBox in class IlvGraphic

Parameters:

t - The transformer used to draw the object. The value null can be used for the identity transformer.

See Also:

draw(java.awt.Graphics, ilog.views.IlvTransformer), zoomable()

timeIndicatorBBox

@Deprecated
protected IlvRect timeIndicatorBBox()

Deprecated. Beginning with Rogue Wave JViews 8.5 call boundingBox(IlvTransformer) instead.

Returns the bounding rectangle of the time indicator renderer.

Returns:

The bounding rectangle of the time indicator renderer.

prepareGraphic

@Deprecated
protected IlvGraphic prepareGraphic(IlvTransformer t)

Deprecated. Beginning with Rogue Wave JViews 8.1, this method is not invoked internally anymore.

Prepares the underlying graphic for drawing by resizing and positioning it according to the renderer's bounds.

Parameters:

t - The transformer.

Returns:

The prepared underlying graphic.

copy

public IlvGraphic copy()

Overrides the copy method of the IlvGraphic class. This method always returns null. You should not use it.

Specified by:

copy in class IlvGraphic

Returns:

null.

See Also:

IlvGraphic

draw

public void draw(Graphics dst,
                 IlvTransformer t)

Draws the time indicator graphic objects.

If you need to change the way the time indicator is rendered, you should change the renderer.

Specified by:

draw in class IlvGraphic

Parameters:

dst - The destination where the time indicator will be drawn.

t - The transformer.

See Also:

IlvGraphic.callDraw(Graphics,IlvTransformer), IlvGraphic.boundingBox(IlvTransformer), IlvGraphic.zoomable(), IlvGraphic

maxVerticalPositionChanged

@Deprecated
public void maxVerticalPositionChanged(VerticalScrollEvent evt)

Deprecated. Beginning with Rogue Wave JViews 8.5, this method does nothing and is never invoked because time indicators no longer need to implement the VerticalScrollListener interface in order to redraw themselves properly.

This method is called when the maximum value of an IlvVerticalScrollable object is changed.

Specified by:

maxVerticalPositionChanged in interface VerticalScrollListener

Parameters:

evt - The event.

See Also:

IlvVerticalScrollable.setMaxVerticalPosition(int)

verticalExtentChanged

@Deprecated
public void verticalExtentChanged(VerticalScrollEvent evt)

Deprecated. Beginning with Rogue Wave JViews 8.5, this method does nothing and is never invoked because time indicators no longer need to implement the VerticalScrollListener interface in order to redraw themselves properly.

This method is called when the extent of an IlvVerticalScrollable object is changed.

Specified by:

verticalExtentChanged in interface VerticalScrollListener

Parameters:

evt - The event.

See Also:

IlvVerticalScrollable.setVerticalExtent(int)

verticalPositionChanged

@Deprecated
public void verticalPositionChanged(VerticalScrollEvent evt)

Deprecated. Beginning with Rogue Wave JViews 8.5, this method does nothing and is never invoked because time indicators no longer need to implement the VerticalScrollListener interface in order to redraw themselves properly.

This method is called when the position of an IlvVerticalScrollable object is changed.

Specified by:

verticalPositionChanged in interface VerticalScrollListener

Parameters:

evt - The event.

See Also:

IlvVerticalScrollable.setVerticalPosition(int)