ilog.views.gantt.graphic.renderer

Class IlvActivityGraphicRenderer

java.lang.Object

ilog.views.gantt.graphic.renderer.IlvActivityGraphicRenderer

All Implemented Interfaces:

IlvActivityRenderer

Direct Known Subclasses:

IlvActivityCompositeGraphicRenderer, IlvBasicActivityBar, IlvBasicActivityLabel, IlvBasicActivitySymbol

public class IlvActivityGraphicRenderer
extends Object
implements IlvActivityRenderer

An IlvActivityGraphicRenderer is an IlvActivityRenderer implementation that renders activities, or parts of activities, by delegating to an IlvGraphic object.

An instance of this renderer can render an entire activity, or the part of an activity between the times designated by the getStartTimeProperty() and getEndTimeProperty() properties. Rendering can also be invisible, depending on the getVisibilityProperty property.

An instance of this renderer can be used for multiple activities or parts thereof. This can only happen when the rendering can be done using the same type of IlvGraphic, with only parameters changed to match the activity. See prepareGraphic(IlvActivityGraphic, IlvTransformer), and draw(Graphics, IlvActivityGraphic, IlvTransformer) for more information.

See Also:

prepareGraphic(IlvActivityGraphic, IlvTransformer), draw(Graphics, IlvActivityGraphic, IlvTransformer)

Constructor Summary

Constructors

Constructor and Description
IlvActivityGraphicRenderer(IlvGraphic graphic) Creates an IlvActivityGraphicRenderer by using a given IlvGraphic.

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.
IlvSelection	createSelection(IlvActivityGraphic g, String[] properties) Creates a new selection object for the specified activity graphic.
void	draw(Graphics dst, IlvActivityGraphic ag, IlvTransformer t) This method is called by an activity graphic to render itself.
protected void	endProcessing(IlvActivityGraphic ag) Ends the processing of an activity graphic.
int	getBaseTextDirection() Returns the base text direction for text that is drawn through this renderer.
double	getBottomMargin() Gets the bottom margin of the renderer with respect to the definition rectangle of the activity graphic.
IlvRect	getBounds(IlvActivityGraphic ag, IlvTransformer t) Returns the bounding rectangle of the drawing performed by this renderer for the given activity graphic.
IlvRect	getDefinitionRect(IlvActivityGraphic ag, IlvTransformer t) Returns the definition rectangle for the activity graphic for this renderer.
Date	getEndTime(IlvActivityGraphic ag) Returns the time point that defines the end of the rendering of this renderer for the given activity graphic.
String	getEndTimeProperty() Returns the name of the activity property which determines where the rendering drawn by this renderer ends.
IlvGraphic	getGraphic() Returns the IlvGraphic used to render activities.
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.
Date	getStartTime(IlvActivityGraphic ag) Returns the time point that defines the start of the rendering of this renderer for the given activity graphic.
String	getStartTimeProperty() Returns the name of the activity property which determines where the rendering drawn by this renderer starts.
String	getToolTipText() Returns the tooltip text for the renderer that was set by calling the setToolTipText(java.lang.String) method.
String	getToolTipText(IlvActivityGraphic ag, IlvPoint p, IlvTransformer t) This method is called by an activity graphic to return tooltip text for itself.
double	getTopMargin() Gets the top margin of the renderer with respect to the definition rectangle of the activity graphic.
String	getVisibilityProperty() Returns the name of the activity property that determines whether the rendering drawn by this renderer is present.
boolean	isPropertyEditable(String property) Specifies if a given time property of an activity of type IlvPropertyHolderActivity is editable by the user.
boolean	isRedrawNeeded(ActivityEvent evt) Deprecated. Since JViews 8.5, the method isRedrawNeeded(IlvActivityGraphic, ActivityEvent) should be implemented and used instead of this one.
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 its bounding box may have changed as a result of the specified activity event.
IlvSelection	makeSelection(IlvActivityGraphic g) called by an activity graphic to create and return a selection object for itself.
protected IlvGraphic	prepareGraphic(IlvActivityGraphic ag, IlvTransformer t) Prepares the underlying graphic for drawing by setting its visibility.
protected void	prepareGraphicVisibility(IlvActivityGraphic ag) Prepares the visibility of the underlying graphic according to the visibility property.
void	setBackground(Color bg) Sets the background color of the underlying graphic object.
void	setBaseTextDirection(int btd) Sets the base text direction for text that is drawn through this renderer.
void	setBottomMargin(double margin) Sets the bottom margin of the renderer with respect to the definition rectangle of the activity graphic.
void	setEndTimeProperty(String property) Sets the name of the activity property which determines where the rendering drawn by this renderer ends.
void	setForeground(Color fg) Sets the foreground color of the underlying graphic object.
void	setGraphic(IlvGraphic graphic) Sets the IlvGraphic used to render activities.
void	setPopupMenu(JPopupMenu popup) Sets the Swing pop-up menu of this renderer.
void	setPopupMenuName(String popupName) Sets the Swing pop-up menu of this activity graphic renderer by name.
void	setStartTimeProperty(String property) Sets the name of the activity property used to determine the start of the rendering drawn by this renderer.
void	setToolTipText(String text) Sets the tooltip text for the activity renderer.
void	setTopMargin(double margin) Sets the top margin of the renderer with respect to the definition rectangle of the activity graphic.
void	setVisibilityProperty(String property) Sets the name of the activity property that determines whether the rendering drawn by this renderer is present.
protected void	startProcessing(IlvActivityGraphic ag) Starts processing an activity graphic.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvActivityGraphicRenderer

public IlvActivityGraphicRenderer(IlvGraphic graphic)

Creates an IlvActivityGraphicRenderer by using a given IlvGraphic.

Parameters:

graphic - The IlvGraphic used to render activities.

Method Detail

getGraphic

public IlvGraphic getGraphic()

Returns the IlvGraphic used to render activities.

Returns:

The graphic object.

See Also:

setGraphic(ilog.views.IlvGraphic)

setGraphic

public void setGraphic(IlvGraphic graphic)

Sets the IlvGraphic used to render activities. Note that the foreground and background colors of the old graphic are not copied to the new one.

Parameters:

graphic - The new IlvGraphic.

See Also:

getGraphic()

getVisibilityProperty

public final String getVisibilityProperty()

Returns the name of the activity property that determines whether the rendering drawn by this renderer is present. This property is applied when the activity is of type IlvPropertyHolderActivity. For example, an IlvGeneralActivity or an IlvTableActivity object. The value of the property should be a Boolean. For all other activity types, this property is not applied and the rendering will always be visible.

Returns:

A property name, or null.

Since:

JViews 8.5

setVisibilityProperty

public void setVisibilityProperty(String property)

Sets the name of the activity property that determines whether the rendering drawn by this renderer is present. This property is applied when the activity is of type IlvPropertyHolderActivity. For example, an IlvGeneralActivity or an IlvTableActivity object. The value of this property should be a Boolean. For all other activity types, this property is not applied and the rendering will always be visible.

The default value of this property is null. This denotes that there is no particular constraint on visibility.

Parameters:

property - The name of the activity property.

Since:

JViews 8.5

getStartTimeProperty

public final String getStartTimeProperty()

Returns the name of the activity property which determines where the rendering drawn by this renderer starts. This property is applied when the activity is of type IlvPropertyHolderActivity. For example, an IlvGeneralActivity or an IlvTableActivity object. The value of the property should be a Date. For all other activity types, this property is not applied and rendering will start at the start of the activity. See IlvActivity.getStartTime() for more information.

Returns:

A property name, or null.

Since:

JViews 8.5

See Also:

setStartTimeProperty(String)

setStartTimeProperty

public void setStartTimeProperty(String property)

Sets the name of the activity property used to determine the start of the rendering drawn by this renderer. This property is applied when the activity is of type IlvPropertyHolderActivity. For example, an IlvGeneralActivity or an IlvTableActivity object. The value of this property should be a Date. For all other activity types, this property is not applied and the rendering will start at the start of the activity (see IlvActivity.getStartTime()).

Normally, this activity property name should be listed with the property names returned by activity.getTimeProperties(). If it is not, the rendering drawn by this renderer may lie outside the area allocated by the activity layout.

The default value is null, which denotes the start of the activity (see IlvActivity.getStartTime(). For activities of type IlvPropertyHolderActivity, this is equivalent to the property IlvPropertyHolderActivity.START_TIME_PROPERTY.

Parameters:

property - The name of the activity property.

Since:

JViews 8.5

See Also:

getStartTimeProperty(), isPropertyEditable(String)

getEndTimeProperty

public final String getEndTimeProperty()

Returns the name of the activity property which determines where the rendering drawn by this renderer ends. This property is applied when the activity is of type IlvPropertyHolderActivity. For example, an IlvGeneralActivity or an IlvTableActivity object. The value of this property should be a Date. For all other activity types, this property is not applied and the rendering will finish at the end of the activity (see IlvActivity.getEndTime()).

Returns:

A property name, or null.

Since:

JViews 8.5

See Also:

setEndTimeProperty(String)

setEndTimeProperty

public void setEndTimeProperty(String property)

Sets the name of the activity property which determines where the rendering drawn by this renderer ends. This property is applied when the activity is an IlvPropertyHolderActivity object. For example, an IlvGeneralActivity or an IlvTableActivity object. The value of the property should be a Date. For all other activity types, this property is not applied and the rendering will end when the activity finishes. See IlvActivity.getEndTime() for more information.

This activity property name should be among the property names returned by activity.getTimeProperties(). If it is not, the rendering drawn by this renderer may lie outside the area allocated by the activity layout.

The default value is null, which denotes the end of the activity (see IlvActivity.getEndTime(). For activities of type IlvPropertyHolderActivity, this is equivalent to the property IlvPropertyHolderActivity.END_TIME_PROPERTY.

Parameters:

property - The name of the activity property.

Since:

JViews 8.5

See Also:

getEndTimeProperty(), isPropertyEditable(String)

setForeground

public void setForeground(Color fg)

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

Parameters:

fg - The new color.

setBackground

public void setBackground(Color bg)

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

Parameters:

bg - The new color.

getTopMargin

public double getTopMargin()

Gets the top margin of the renderer with respect to the definition rectangle of the activity graphic.

Returns:

The proportional top margin.

See Also:

setTopMargin(double), getBottomMargin(), getBottomMargin()

setTopMargin

public void setTopMargin(double margin)

Sets the top margin of the renderer with respect to the definition rectangle of the activity graphic.

Parameters:

margin - The new proportional top margin. The value is proportional to the height of the activity graphic. Therefore, it must be enclosed in the [0.0 1.0] range.

See Also:

getTopMargin(), getBottomMargin(), setBottomMargin(double)

getBottomMargin

public double getBottomMargin()

Gets the bottom margin of the renderer with respect to the definition rectangle of the activity graphic.

Returns:

The proportional bottom margin.

See Also:

getTopMargin(), setTopMargin(double), setBottomMargin(double)

setBottomMargin

public void setBottomMargin(double margin)

Sets the bottom margin of the renderer with respect to the definition rectangle of the activity graphic.

Parameters:

margin - The new proportional bottom margin. The value is proportional to the height of the activity graphic, so the value must be enclosed in the [0.0 1.0] range.

See Also:

getBottomMargin(), getTopMargin(), setTopMargin(double)

getBaseTextDirection

public final int getBaseTextDirection()

Returns the base text direction for text that is drawn through this renderer.

The base text direction influences the display of text strings that are composed of segments that are read from left to right as well as of segments that are read from right to left. It determines the order of these segments.

Returns:

One of IlvBidiUtil.COMPONENT_DIRECTION, IlvBidiUtil.CONTEXTUAL_DIRECTION, IlvBidiUtil.LEFT_TO_RIGHT, IlvBidiUtil.RIGHT_TO_LEFT, IlvBidiUtil.INHERITED_DIRECTION.

Since:

JViews 8.8

See Also:

setBaseTextDirection(int)

setBaseTextDirection

public void setBaseTextDirection(int btd)

Sets the base text direction for text that is drawn through this renderer.

The base text direction influences the display of text strings that are composed of segments that are read from left to right as well as of segments that are read from right to left. It determines the order of these segments.

Possible values are: IlvBidiUtil.COMPONENT_DIRECTION, IlvBidiUtil.CONTEXTUAL_DIRECTION, IlvBidiUtil.LEFT_TO_RIGHT, IlvBidiUtil.RIGHT_TO_LEFT, and IlvBidiUtil.INHERITED_DIRECTION.

Parameters:

btd - The base text direction.

Since:

JViews 8.8

See Also:

getBaseTextDirection(), IlvGraphic.setBaseTextDirection(int)

getToolTipText

public String getToolTipText()

Returns the tooltip text for the renderer that was set by calling the setToolTipText(java.lang.String) method. If the text is not null, this will be the text displayed in the activity graphic's tooltip.

Returns:

The tooltip text.

Since:

JViews 5.5

See Also:

setToolTipText(java.lang.String), getToolTipText(IlvActivityGraphic,IlvPoint,IlvTransformer)

setToolTipText

public void setToolTipText(String text)

Sets the tooltip text for the activity renderer.

Parameters:

text - The tooltip text. If null, the activity graphic will display the tooltip text of the renderer's underlying graphic.

Since:

JViews 5.5

See Also:

getToolTipText(), getToolTipText(IlvActivityGraphic,IlvPoint,IlvTransformer)

getStartTime

public Date getStartTime(IlvActivityGraphic ag)

Returns the time point that defines the start of the rendering of this renderer for the given activity graphic.

If the activity is of type IlvPropertyHolderActivity, such as an IlvGeneralActivity or an IlvTableActivity, this method returns the value of the getStartTimeProperty() activity property. If not, the start time for the activity is returned.

Parameters:

ag - The activity graphic.

Returns:

The time point that defines the start of the rendering of this renderer for ag.

Since:

JViews 8.5

See Also:

getStartTimeProperty(), IlvActivity.getStartTime()

getEndTime

public Date getEndTime(IlvActivityGraphic ag)

Returns the time point that defines the end of the rendering of this renderer for the given activity graphic.

If the activity is of type IlvPropertyHolderActivity, such as an IlvGeneralActivity or an IlvTableActivity, this method returns the value of the getEndTimeProperty() activity property. If not the end time for the activity is returned.

Parameters:

ag - The activity graphic.

Returns:

The time point that defines the end of the rendering of this renderer for ag.

Since:

JViews 8.5

See Also:

getEndTimeProperty(), IlvActivity.getEndTime()

startProcessing

protected void startProcessing(IlvActivityGraphic ag)

Starts processing an activity graphic. The processing may imply drawing, getting the tooltip, or a similar operation.

Calls to startProcessing and endProcessing must occur in pairs:

 startProcessing(ag);
 try {
   ... do something ...
 } finally {
   endProcessing(ag);
 }
 

Since:

JViews 8.8

See Also:

endProcessing(IlvActivityGraphic)

endProcessing

protected void endProcessing(IlvActivityGraphic ag)

Ends the processing of an activity graphic. Calls to startProcessing and endProcessing must occur in pairs.

Since:

JViews 8.8

See Also:

startProcessing(IlvActivityGraphic)

prepareGraphicVisibility

protected void prepareGraphicVisibility(IlvActivityGraphic ag)

Prepares the visibility of the underlying graphic according to the visibility property.

Parameters:

ag - The graphic to prepare.

Since:

JViews 8.5

See Also:

getVisibilityProperty()

getDefinitionRect

public IlvRect getDefinitionRect(IlvActivityGraphic ag,
                                 IlvTransformer t)

Returns the definition rectangle for the activity graphic for this renderer. The definition rectangle has been transformed by the specified transformer.

The definition rectangle for this renderer has:

• A minimum x value that corresponds to the activity start time determined using getStartTime(IlvActivityGraphic).
• A maximum x value that corresponds to the activity end time determined using getEndTime(IlvActivityGraphic).
• A y range that is determined by the layout algorithm.

The bounding box and rendering area for the activity graphic may be smaller or larger than the definition rectangle. This adjustment can be made in the getBounds(ilog.views.gantt.graphic.IlvActivityGraphic, ilog.views.IlvTransformer) method and is usually due to margin insets, labels, or symbols that extend past the activity end times, and so on.

This method is typically used when you define a custom activity render. The getBounds method used for the renderer would look something like:

   public IlvRect getBounds(IlvActivityGraphic ag, IlvTransformer t) {
     IlvRect viewBox = getDefinitionRect(ag, t);
     ... make adjustments to box in view coordinates ...
     return viewBox;
   }
 

Parameters:

ag - The activity graphic.

t - The transformer.

Returns:

The definition rectangle transformed by the transformer.

Since:

JViews 8.5

See Also:

IlvActivityGraphic.getDefinitionRect(), getStartTime(IlvActivityGraphic), getEndTime(IlvActivityGraphic), getBounds(IlvActivityGraphic, IlvTransformer)

getBounds

public IlvRect getBounds(IlvActivityGraphic ag,
                         IlvTransformer t)

Returns the bounding rectangle of the drawing performed by this renderer for the given activity graphic.

The results of this method are used by the prepareGraphic method to position the underlying graphic prior to drawing, and to manage redraw regions. This implementation applies the transformer to the definitionRect of the activity graphic, while taking the top and bottom margins of the renderer into account. 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.

You can override this method for two purposes:

1. To customize all properties of the underlying graphic that have an influence on the bounding rectangle.
2. To modify the position and sizing of the graphic. If you do so, make sure to use the transformer argument and avoid using the transformer currently set on the Gantt sheet. This is to ensure that the sheet prints correctly when t is different than the Gantt sheet transformer used for the screen display. For example, if you want to modify the x position of the bounding box of a graphic based upon a Date value, avoid code like this:

    rect.x = ganttSheet.getPosition(aDate);
    

   Use this instead:

    IlvTimeConverter timeConverter = ag.getGanttRow().getTimeConverter();
    rect.x = IlvTimeScrollUtil.getPosition(aDate, timeConverter, t);
    

Note: the IlvActivityCompositeGraphicRenderer subclass has different methods that should be overridden if you want to modify the position and sizing of the graphic.

Specified by:

getBounds in interface IlvActivityRenderer

Parameters:

ag - The activity graphic.

t - The transformer.

Returns:

The bounding rectangle of the activity graphic.

prepareGraphic

protected IlvGraphic prepareGraphic(IlvActivityGraphic ag,
                                    IlvTransformer t)

Prepares the underlying graphic for drawing by setting its visibility. If it is visible, it is resized and positioned according to the bounds of the renderer.

Parameters:

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

t - The transformer.

Returns:

The prepared underlying graphic.

Since:

JViews 3.5

contains

public 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.

Specified by:

contains in interface IlvActivityRenderer

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:

If the point lies inside this activity graphic, true is returned.

Since:

JViews 8.1

draw

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

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

Specified by:

draw in interface IlvActivityRenderer

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

public boolean isRelayoutNeeded(IlvActivityGraphic ag,
                                ActivityEvent evt)

This method is called by an activity graphic to determine if its bounding box may have changed as a result of the specified activity event. Subclasses should override this method as needed.

Specified by:

isRelayoutNeeded in interface IlvActivityRenderer

Parameters:

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

evt - The activity event.

Returns:

This default implementation returns true if the value of getVisibilityProperty(), getStartTimeProperty(), or getEndTimeProperty() has changed.

Since:

JViews 8.5

isRedrawNeeded

public 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. Subclasses should override this method as needed.

Specified by:

isRedrawNeeded in interface IlvActivityRenderer

Parameters:

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

evt - The activity event.

Returns:

This default implementation always returns false.

Since:

JViews 8.5

isRedrawNeeded

@Deprecated
public boolean isRedrawNeeded(ActivityEvent evt)

Deprecated. Since JViews 8.5, the method isRedrawNeeded(IlvActivityGraphic, ActivityEvent) should be implemented and used instead of this one.

This method is called by an activity graphic to determine if it 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. This default implementation always returns false.

Parameters:

evt - The activity event.

isPropertyEditable

public boolean isPropertyEditable(String property)

Specifies if a given time property of an activity of type IlvPropertyHolderActivity is editable by the user.

This method can be overridden using subclasses.

Parameters:

property - Set to thevalue of getStartTimeProperty(), or getEndTimeProperty(). Do not set this parameter to null.

Returns:

If the given property can be edited by the user, true is returned. This default implementation always returns true.

Since:

JViews 8.5

makeSelection

public IlvSelection makeSelection(IlvActivityGraphic g)

called by an activity graphic to create and return a selection object for itself. This default implementation determines the list of properties to be used as handles and invokes the createSelection(IlvActivityGraphic, String[]) method.

Note: the selection object must be an instance of IlvSelection and of IlvActivitySelection.

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

Specified by:

makeSelection in interface IlvActivityRenderer

Parameters:

g - The selected activity graphic.

Returns:

The selection object.

Since:

JViews 3.5

See Also:

isPropertyEditable(String)

createSelection

public IlvSelection createSelection(IlvActivityGraphic g,
                                    String[] properties)

Creates a new selection object for the specified activity graphic. The names of Date valued properties can be supplied as positions for displaying the handles.

This method is called by makeSelection(IlvActivityGraphic).

The default implementation returns an IlvActivityGraphicSelection instance.

Note: the selection object must be an instance of IlvSelection and of IlvActivitySelection.

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

Parameters:

g - The selected activity graphic.

properties - A list of Date valued properties of the activity, or null.

Returns:

The selection object.

Since:

JViews 8.5

getToolTipText

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

This method is called by an activity graphic to return tooltip text for itself. If you have set a tooltip by calling the setToolTipText(java.lang.String) method, then that text is returned. Otherwise, this default implementation returns the tooltip text from the renderer's underlying graphic.

Specified by:

getToolTipText in interface IlvActivityRenderer

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

setPopupMenu

public void setPopupMenu(JPopupMenu popup)

Sets the Swing pop-up menu of this renderer.

Pop-up menus for Rogue Wave JViews activity graphic renderers will work only if you enable the pop-up menu mechanism for the Gantt sheet view by calling the method IlvGanttSheet.setPopupMenusEnabled(boolean).

For performance reasons, it is strongly recommended that activity graphic renderers share the same pop-up menu whenever possible.

Parameters:

popup - The Swing pop-up menu to be used for this activity graphic renderer. If popup is null, the pop-up menu is turned off for this activity graphic renderer.

Since:

JViews 7.5

See Also:

IlvPopupMenuManager, setPopupMenuName(String), getPopupMenu(IlvActivityGraphic, IlvPoint, IlvTransformer, IlvManagerView, IlvPopupMenuManager)

getPopupMenu

public 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. If you have set a pop-up menu by calling the setPopupMenu(javax.swing.JPopupMenu) method, then that pop-up menu is returned. Otherwise, this default implementation returns the pop-up menu from the underlying graphic of the renderer.

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)

Specified by:

getPopupMenu in interface IlvActivityRenderer

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:

IlvGraphic.getPopupMenu()

setPopupMenuName

public void setPopupMenuName(String popupName)

Sets the Swing pop-up menu of this activity graphic renderer by name.

This is an alternative way of setting the pop-up menu of this renderer. You need to register a Swing pop-up menu for the name through IlvPopupMenuManager.registerMenu(String, JPopupMenu) and use the name to specify the pop-up menu of this activity graphic renderer. Pop-up menus for Rogue Wave JViews activity graphic renderers will work only if your manager view is contained in a hierarchy of Swing components. In addition, you must enable the pop-up menu mechanism for the Gantt sheet view by calling the method IlvGanttSheet.setPopupMenusEnabled(boolean).

Parameters:

popupName - The name of the registered Swing pop-up menu to be used for this activity graphic renderer. If popupName is null, the pop-up menu is turned off for this activity graphic renderer.

Since:

JViews 7.5

See Also:

IlvPopupMenuManager, getPopupMenuName()

getPopupMenuName

public String getPopupMenuName()

This method is called by an activity graphic to return the name of the Swing pop-up menu. If you have set a pop-up menu name by calling the setPopupMenuName(java.lang.String) method, then that pop-up menu name is returned. Otherwise, this default implementation returns the pop-up menu name from ther underlying graphic of the renderer. This method can return null.

Specified by:

getPopupMenuName in interface IlvActivityRenderer

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), setPopupMenuName(String)