ilog.views.gantt.graphic.renderer

Interface IlvActivityRenderer

All Known Implementing Classes:

IlvActivityBar, IlvActivityCompositeGraphicRenderer, IlvActivityCompositeRenderer, IlvActivityGraphicRenderer, IlvActivityLabel, IlvActivitySummary, IlvActivitySymbol, IlvBasicActivityBar, IlvBasicActivityLabel, IlvBasicActivitySymbol

public interface IlvActivityRenderer

An IlvActivityRenderer object defines the graphic presentation of a given activity and its activity graphic.

Method Summary

Modifier and Type	Method and Description
boolean	contains(IlvActivityGraphic ag, IlvPoint p, IlvPoint tp, IlvTransformer t) This method is called by an activity graphic to test whether a point lies within its boundaries.
void	draw(Graphics dst, IlvActivityGraphic ag, IlvTransformer t) This method is called by an activity graphic to render itself.
IlvRect	getBounds(IlvActivityGraphic ag, IlvTransformer t) Returns the bounding rectangle of the activity graphic.
JPopupMenu	getPopupMenu(IlvActivityGraphic ag, IlvPoint p, IlvTransformer t, IlvManagerView view, IlvPopupMenuManager popupManager) This method is called by an activity graphic to return the Swing pop-up menu to display when the pop-up is triggered while the mouse pointer is at a specified location inside the activity graphic object.
String	getPopupMenuName() This method is called by an activity graphic to return the name of the Swing pop-up menu.
String	getToolTipText(IlvActivityGraphic ag, IlvPoint p, IlvTransformer t) This method is called by an activity graphic to return tooltip text for itself.
boolean	isRedrawNeeded(IlvActivityGraphic ag, ActivityEvent evt) This method is called by an activity graphic to determine if the graphic should redraw itself as a result of the specified activity event, that is, in situations when isRelayoutNeeded(ilog.views.gantt.graphic.IlvActivityGraphic, ilog.views.gantt.event.ActivityEvent) returned false.
boolean	isRelayoutNeeded(IlvActivityGraphic ag, ActivityEvent evt) This method is called by an activity graphic to determine if the layout of the activities in its row needs to be redone as a result of the specified activity event.
IlvSelection	makeSelection(IlvActivityGraphic ag) This method is called by an activity graphic to create and return a selection object for itself.

Method Detail

getBounds

IlvRect getBounds(IlvActivityGraphic ag,
                  IlvTransformer t)

Returns the bounding rectangle of the activity graphic.

This method is called when the renderer needs to assign a bounding rectangle to the activity graphic.

In the typical case, the implementation of this method should apply the transformer to the definitionRect of the activity graphic. This is shown in the following code example:

 return ag.getDefinitionRect(t);
 

This defines a bounding box whose x dimensions are specified by the time interval of the activity, and whose y dimensions are specified by the activity layout algorithm

Note: when printing, a different transformer than the one set on the Gantt sheet is supplied. Therefore, you should always use the transformer argument supplied to this method and avoid using the Gantt sheet transformer.

Parameters:

ag - The activity graphic.

t - The transformer.

Returns:

The bounding rectangle of the activity graphic.

contains

boolean contains(IlvActivityGraphic ag,
                 IlvPoint p,
                 IlvPoint tp,
                 IlvTransformer t)

This method is called by an activity graphic to test whether a point lies within its boundaries.

Parameters:

ag - The activity graphic.

p - The point to be tested.

tp - The point p transformed by the transformer t.

t - The transformation used to draw the object.

Returns:

true if the point lies inside this activity graphic.

Since:

JViews 8.1

draw

void draw(Graphics dst,
          IlvActivityGraphic ag,
          IlvTransformer t)

This method is called by an activity graphic to render itself.

Parameters:

dst - The destination into which the presentation will be drawn.

ag - The activity graphic holding the position where the presentation should be drawn.

t - The transformer.

isRelayoutNeeded

boolean isRelayoutNeeded(IlvActivityGraphic ag,
                         ActivityEvent evt)

This method is called by an activity graphic to determine if the layout of the activities in its row needs to be redone as a result of the specified activity event. This method should return true if the event indicates that a property has changed which has an influence on this renderer's getBounds(ilog.views.gantt.graphic.IlvActivityGraphic, ilog.views.IlvTransformer) method.

Parameters:

ag - The activity graphic which is affected by the event.

evt - The activity event. Instances of ActivityTimeIntervalEvent are already handled without calling this method.

Returns:

If evt indicates that a property has changed which has an influence on the getBounds(ilog.views.gantt.graphic.IlvActivityGraphic, ilog.views.IlvTransformer) method for this renderer, true is returned.

Since:

JViews 8.5

isRedrawNeeded

boolean isRedrawNeeded(IlvActivityGraphic ag,
                       ActivityEvent evt)

This method is called by an activity graphic to determine if the graphic should redraw itself as a result of the specified activity event, that is, in situations when isRelayoutNeeded(ilog.views.gantt.graphic.IlvActivityGraphic, ilog.views.gantt.event.ActivityEvent) returned false.

Parameters:

ag - The activity graphic which is affected by the event.

evt - The activity event. Instances of ActivityTimeIntervalEvent are already handled without calling this method.

Returns:

If evt indicates that a property has changed which has an influence on the draw(java.awt.Graphics, ilog.views.gantt.graphic.IlvActivityGraphic, ilog.views.IlvTransformer) method for this renderer, but not on the getBounds(ilog.views.gantt.graphic.IlvActivityGraphic, ilog.views.IlvTransformer) method, true is returned.

Since:

JViews 8.5

makeSelection

IlvSelection makeSelection(IlvActivityGraphic ag)

This method is called by an activity graphic to create and return a selection object for itself.

Note, that the selection object must be compatible with all activity renderer implementations in use, not just the specific renderer implementation this method is being invoked on. This is because the renderer assigned to an activity graphic may change while the activity graphic remains selected. The default IlvActivityGraphicSelection class is generic and is compatible with all renderer implementations.

Parameters:

ag - The activity graphic.

Returns:

The selection object.

Since:

JViews 3.5

getToolTipText

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

This method is called by an activity graphic to return tooltip text for itself. This method can return null to turn off the tooltip for the activity graphic.

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

getPopupMenu

JPopupMenu getPopupMenu(IlvActivityGraphic ag,
                        IlvPoint p,
                        IlvTransformer t,
                        IlvManagerView view,
                        IlvPopupMenuManager popupManager)

This method is called by an activity graphic to return the Swing pop-up menu to display when the pop-up is triggered while the mouse pointer is at a specified location inside the activity graphic object. You can override this method to display different pop-up menus over different parts of your graphic object.

This method can return null to turn off the pop-up menu for this activity graphic object.

Note that you must enable the pop-up menu mechanism for the manager view by calling the method IlvGanttSheet.setPopupMenusEnabled(boolean).

Parameters:

ag - The activity graphic.

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

t - The transformer that converts the coordinate system of this object (the manager coordinates) into the coordinate system of the manager view in which the tooltip is about to be displayed (the view coordinates).

view - The manager view that triggered the pop-up menu.

popupManager - The pop-up menu manager.

Returns:

The Swing pop-up menu, which can be null.

Since:

JViews 7.5

See Also:

IlvActivityGraphic.getPopupMenu(IlvPoint,IlvTransformer,IlvManagerView,IlvPopupMenuManager)

getPopupMenuName

String getPopupMenuName()

This method is called by an activity graphic to return the name of the Swing pop-up menu. This method can return null.

Returns:

The name of the Swing pop-up menu, which can be null.

Since:

JViews 7.5

See Also:

IlvActivityGraphic.getPopupMenu(IlvPoint,IlvTransformer,IlvManagerView,IlvPopupMenuManager)