ilog.views.gantt.graphic.renderer

Class IlvActivitySymbol

java.lang.Object

ilog.views.gantt.graphic.renderer.IlvActivityGraphicRenderer

ilog.views.gantt.graphic.renderer.IlvBasicActivitySymbol

ilog.views.gantt.graphic.renderer.IlvActivitySymbol

All Implemented Interfaces:

IlvActivityRenderer

public class IlvActivitySymbol
extends IlvBasicActivitySymbol

The class IlvActivitySymbol is an extension of IlvBasicActivitySymbol used to render the symbols at the start and end of an activity, whose tooltip text is dynamically updated from the activity.

Field Summary

Fields inherited from class ilog.views.gantt.graphic.renderer.IlvBasicActivitySymbol

CIRCLE, DIAMOND, DOWN_PENTAGON, END, FILLED_CIRCLE, START, UP_PENTAGON

Constructor Summary

Constructors

Constructor and Description
IlvActivitySymbol() Creates a symbol renderer.

Method Summary

Modifier and Type	Method and Description
DateFormat	getToolTipDateFormat() Returns the format used to display the symbol's alignment time in the tooltip.
String	getToolTipText(IlvActivityGraphic ag, IlvPoint p, IlvTransformer t) This method is called by an activity graphic to return tooltip text for itself.
protected String	getToolTipTextDescriptionPart(IlvActivityGraphic ag) Returns the tooltip text for the specified activity graphic when the mouse is over the drawing of this renderer.
void	setToolTipDateFormat(DateFormat format) Sets the format used to display the symbol's alignment time in the tooltip.

Methods inherited from class ilog.views.gantt.graphic.renderer.IlvBasicActivitySymbol

getAlignment, getBackground, getBounds, getForeground, getShape, setAlignment, setGraphic, setShape

Methods inherited from class ilog.views.gantt.graphic.renderer.IlvActivityGraphicRenderer

contains, createSelection, draw, endProcessing, getBaseTextDirection, getBottomMargin, getDefinitionRect, getEndTime, getEndTimeProperty, getGraphic, getPopupMenu, getPopupMenuName, getStartTime, getStartTimeProperty, getToolTipText, getTopMargin, getVisibilityProperty, isPropertyEditable, isRedrawNeeded, isRedrawNeeded, isRelayoutNeeded, makeSelection, prepareGraphic, prepareGraphicVisibility, setBackground, setBaseTextDirection, setBottomMargin, setEndTimeProperty, setForeground, setPopupMenu, setPopupMenuName, setStartTimeProperty, setToolTipText, setTopMargin, setVisibilityProperty, startProcessing

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvActivitySymbol

public IlvActivitySymbol()

Creates a symbol renderer. The default shape is a pentagon pointing down.

Method Detail

getToolTipDateFormat

public DateFormat getToolTipDateFormat()

Returns the format used to display the symbol's alignment time in the tooltip. The default is the default date/time style for the default locale.

Returns:

The tooltip date format.

Since:

JViews 3.5

See Also:

setToolTipDateFormat(java.text.DateFormat)

setToolTipDateFormat

public void setToolTipDateFormat(DateFormat format)

Sets the format used to display the symbol's alignment time in the tooltip.

Parameters:

format - The tooltip date format.

Since:

JViews 3.5

See Also:

getToolTipDateFormat()

getToolTipTextDescriptionPart

protected String getToolTipTextDescriptionPart(IlvActivityGraphic ag)

Returns the tooltip text for the specified activity graphic when the mouse is over the drawing of this renderer.

The default implementation of this method returns the name of the activity.

Parameters:

ag - The activity graphic.

Returns:

The tooltip text over the drawing of this renderer.

Since:

JViews 8.5

See Also:

getToolTipText(IlvActivityGraphic, IlvPoint, IlvTransformer)

getToolTipText

public String getToolTipText(IlvActivityGraphic ag,
                             IlvPoint p,
                             IlvTransformer t)

This method is called by an activity graphic to return tooltip text for itself. This implementation returns a description part and a value (time) part. The description part is taken from the method getToolTipTextDescriptionPart(ilog.views.gantt.graphic.IlvActivityGraphic). The value part is the symbol's alignment time, formatted according to the tooltip date format. If this previous method returns null, then the text set by calling IlvActivityGraphicRenderer.setToolTipText(java.lang.String) will be used.

Specified by:

getToolTipText in interface IlvActivityRenderer

Overrides:

getToolTipText in class IlvActivityGraphicRenderer

Parameters:

ag - The activity graphic.

p - The location of the mouse (in view coordinates).

t - The transformer.

Returns:

The tooltip text.

Since:

JViews 3.5

See Also:

getToolTipTextDescriptionPart(ilog.views.gantt.graphic.IlvActivityGraphic)