ilog.views.gantt.swing.calendarview

Class IlvDefaultActivityCalendarRenderer

java.lang.Object

ilog.views.gantt.swing.calendarview.IlvDefaultActivityCalendarRenderer

All Implemented Interfaces:

IlvActivityCalendarRenderer

public class IlvDefaultActivityCalendarRenderer
extends Object
implements IlvActivityCalendarRenderer

IlvDefaultActivityCalendarRenderer renders an activity bar as a rectangle that is labeled with the activity name.

Since:

JViews 7.5

Field Summary

Fields inherited from interface ilog.views.gantt.swing.calendarview.IlvActivityCalendarRenderer

END_STYLE_CLOSED, END_STYLE_INTRA_DAY, END_STYLE_OPEN

Constructor Summary

Constructors

Constructor and Description
IlvDefaultActivityCalendarRenderer() Creates a new IlvDefaultActivityCalendarRenderer.
IlvDefaultActivityCalendarRenderer(Paint fill, Paint stroke) Creates a new IlvDefaultActivityCalendarRenderer.

Method Summary

Modifier and Type	Method and Description
void	draw(Graphics g, IlvActivity activity, boolean isSelected, Rectangle rect, ComponentOrientation orientation, int startStyle, int endStyle) This method is called by an IlvMonthPanel to render an activity bar on a single row within the month grid.
Image	getClockImage() Returns the image used to indicate that the start or end of an activity terminates within the bounds of a day.
Paint	getFillPaint() Returns the paint object used to fill the rectangular bar.
Font	getLabelFont() Returns the font used to label the rectangular bar.
int	getLabelMargin() Returns the label margin.
Paint	getLabelPaint() Returns the paint object used to label the rectangular bar.
Paint	getSelectionFillPaint() Returns the paint object used to fill the rectangular bar when the activity is selected.
Paint	getSelectionStrokePaint() Returns the paint object used to stroke the rectangular bar when the activity is selected.
Stroke	getStroke() Returns the style used to stroke the rectangular bar.
Paint	getStrokePaint() Returns the paint object used to stroke the rectangular bar.
String	getToolTipText(IlvActivity activity, IlvGanttModel model, Calendar calendar, MouseEvent event) This method is called by an IlvMonthPanel to return tooltip text for a displayed activity.
void	setClockImage(Image clock) Sets the image that will be used to indicate that the start or end of an activity terminates within the bounds of a day.
void	setFillPaint(Paint paint) Sets the paint object used to fill the rectangular bar.
void	setLabelFont(Font font) Sets the font used to label the rectangular bar.
void	setLabelMargin(int margin) Sets the label margin.
void	setLabelPaint(Paint paint) Sets the paint object used to label the rectangular bar.
void	setSelectionFillPaint(Paint paint) Sets the paint object used to fill the rectangular bar when the activity is selected.
void	setSelectionStrokePaint(Paint paint) Sets the paint object used to stroke the rectangular bar when the activity is selected.
void	setStroke(Stroke stroke) Sets the style used to stroke the rectangular bar.
void	setStrokePaint(Paint paint) Sets the paint object used to stroke the rectangular bar.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvDefaultActivityCalendarRenderer

public IlvDefaultActivityCalendarRenderer(Paint fill,
                                          Paint stroke)

Creates a new IlvDefaultActivityCalendarRenderer.

Parameters:

fill - The fill paint, or null to indicate that the bar will not be filled.

stroke - The stroke paint, or null to indicate that the bar will not be stroked.

IlvDefaultActivityCalendarRenderer

public IlvDefaultActivityCalendarRenderer()

Creates a new IlvDefaultActivityCalendarRenderer.

Method Detail

getFillPaint

public Paint getFillPaint()

Returns the paint object used to fill the rectangular bar. The default value is an IlvLinearGradientPaint.

Returns:

The fill paint, or null if the bar will not be filled.

See Also:

setFillPaint(java.awt.Paint)

setFillPaint

public void setFillPaint(Paint paint)

Sets the paint object used to fill the rectangular bar. During filling of the bar, the top-left corner of the bar will be translated to be the 0,0 origin of the graphics context. You can therefore use this as a reference point for specifying a GradientPaint. An alternative is to use an IlvLinearGradientPaint and specify that it should adapt to its display area.

Parameters:

paint - The fill paint, or null to indicate that the bar will not be filled.

See Also:

getFillPaint()

getSelectionFillPaint

public Paint getSelectionFillPaint()

Returns the paint object used to fill the rectangular bar when the activity is selected. The default value is a light yellow color.

Returns:

The fill paint, or null if the bar will not be filled when the activity is selected.

See Also:

setSelectionFillPaint(java.awt.Paint)

setSelectionFillPaint

public void setSelectionFillPaint(Paint paint)

Sets the paint object used to fill the rectangular bar when the activity is selected. During filling of the bar, the top-left corner of the bar will be translated to be the 0,0 origin of the graphics context. You can therefore use this as a reference point for specifying a GradientPaint. An alternative is to use an IlvLinearGradientPaint and specify that it should adapt to its display area.

Parameters:

paint - The fill paint, or null to indicate that the bar will not be filled when the activity is selected.

See Also:

getSelectionFillPaint()

getStrokePaint

public Paint getStrokePaint()

Returns the paint object used to stroke the rectangular bar. The default value is the color black.

Returns:

The stroke paint, or null if the bar will not be stroked.

See Also:

setStrokePaint(java.awt.Paint)

setStrokePaint

public void setStrokePaint(Paint paint)

Sets the paint object used to stroke the rectangular bar. During stroking of the bar, the top-left corner of the bar will be translated to be the 0,0 origin of the graphics context. You can therefore use this as a reference point for specifying a GradientPaint. An alternative is to use an IlvLinearGradientPaint and specify that it should adapt to its display area.

Parameters:

paint - The stroke paint, or null to indicate that the bar will not be stroked.

See Also:

getStrokePaint()

getSelectionStrokePaint

public Paint getSelectionStrokePaint()

Returns the paint object used to stroke the rectangular bar when the activity is selected. The default value is the color red.

Returns:

The stroke paint, or null if the bar will not be stroked when the activity is selected.

See Also:

setSelectionStrokePaint(java.awt.Paint)

setSelectionStrokePaint

public void setSelectionStrokePaint(Paint paint)

Sets the paint object used to stroke the rectangular bar when the activity is selected. During filling of the bar, the top-left corner of the bar will be translated to be the 0,0 origin of the graphics context. You can therefore use this as a reference point for specifying a GradientPaint. An alternative is to use an IlvLinearGradientPaint and specify that it should adapt to its display area.

Parameters:

paint - The stroke paint, or null to indicate that the bar will not be stroked when the activity is selected.

See Also:

getSelectionStrokePaint()

getStroke

public Stroke getStroke()

Returns the style used to stroke the rectangular bar. The default value is a BasicStroke.

Returns:

The stroke style, or null if the bar will not be stroked.

See Also:

setStroke(java.awt.Stroke)

setStroke

public void setStroke(Stroke stroke)

Sets the style used to stroke the rectangular bar.

Parameters:

stroke - The stroke style, or null to indicate that the bar will not be stroked.

See Also:

getStroke()

getLabelFont

public Font getLabelFont()

Returns the font used to label the rectangular bar.

Returns:

The font.

See Also:

setLabelFont(java.awt.Font)

setLabelFont

public void setLabelFont(Font font)

Sets the font used to label the rectangular bar.

Parameters:

font - The font.

See Also:

getLabelFont()

getLabelPaint

public Paint getLabelPaint()

Returns the paint object used to label the rectangular bar. The default value is the color black.

Returns:

The label paint.

See Also:

setLabelPaint(java.awt.Paint)

setLabelPaint

public void setLabelPaint(Paint paint)

Sets the paint object used to label the rectangular bar. During labeling of the bar, the top-left corner of the bar will be translated to be the 0,0 origin of the graphics context. You can therefore use this as a reference point for specifying a GradientPaint. An alternative is to use an IlvLinearGradientPaint and specify that it should adapt to its display area.

Parameters:

paint - The label paint.

See Also:

getLabelPaint()

getLabelMargin

public int getLabelMargin()

Returns the label margin. The default value is 5.

Returns:

The label margin.

See Also:

setLabelMargin(int)

setLabelMargin

public void setLabelMargin(int margin)

Sets the label margin.

Parameters:

margin - The margin.

See Also:

getLabelMargin()

getClockImage

public Image getClockImage()

Returns the image used to indicate that the start or end of an activity terminates within the bounds of a day.

Returns:

The clock image.

See Also:

setClockImage(java.awt.Image), draw(java.awt.Graphics, ilog.views.gantt.IlvActivity, boolean, java.awt.Rectangle, java.awt.ComponentOrientation, int, int), IlvActivityCalendarRenderer.END_STYLE_INTRA_DAY

setClockImage

public void setClockImage(Image clock)

Sets the image that will be used to indicate that the start or end of an activity terminates within the bounds of a day. This is specified by the IlvActivityCalendarRenderer.END_STYLE_INTRA_DAY rendering style.

Parameters:

clock - The clock image.

See Also:

getClockImage(), draw(java.awt.Graphics, ilog.views.gantt.IlvActivity, boolean, java.awt.Rectangle, java.awt.ComponentOrientation, int, int), IlvActivityCalendarRenderer.END_STYLE_INTRA_DAY

draw

public void draw(Graphics g,
                 IlvActivity activity,
                 boolean isSelected,
                 Rectangle rect,
                 ComponentOrientation orientation,
                 int startStyle,
                 int endStyle)

This method is called by an IlvMonthPanel to render an activity bar on a single row within the month grid.

Specified by:

draw in interface IlvActivityCalendarRenderer

Parameters:

g - The graphics context in which to paint.

activity - The activity to be rendered.

isSelected - Indicates whether the activity is selected.

rect - The bounding box of the activity bar.

orientation - The component orientation of the month panel that is asking the activity to be rendered.

startStyle - Indicates the style in which the start of the bar should be drawn. The value will be one of IlvActivityCalendarRenderer.END_STYLE_OPEN, IlvActivityCalendarRenderer.END_STYLE_CLOSED, or IlvActivityCalendarRenderer.END_STYLE_INTRA_DAY.

endStyle - Indicates the style in which the end of the bar should be drawn. The value will be one of IlvActivityCalendarRenderer.END_STYLE_OPEN, IlvActivityCalendarRenderer.END_STYLE_CLOSED, or IlvActivityCalendarRenderer.END_STYLE_INTRA_DAY.

getToolTipText

public String getToolTipText(IlvActivity activity,
                             IlvGanttModel model,
                             Calendar calendar,
                             MouseEvent event)

This method is called by an IlvMonthPanel to return tooltip text for a displayed activity. This implementation returns the name of the activity.

Specified by:

getToolTipText in interface IlvActivityCalendarRenderer

Parameters:

activity - The activity.

model - The data model that contains the activity.

calendar - The date that corresponds to the mouse position.

event - The mouse event that caused the ToolTipManager to show the tooltip.

Returns:

The activity name.