ilog.views.gantt.swing.calendarview

Class IlvDefaultMilestoneCalendarRenderer

java.lang.Object

ilog.views.gantt.swing.calendarview.IlvDefaultMilestoneCalendarRenderer

All Implemented Interfaces:

IlvMilestoneCalendarRenderer

public class IlvDefaultMilestoneCalendarRenderer
extends Object
implements IlvMilestoneCalendarRenderer

IlvDefaultMilestoneCalendarRenderer renders a milestone as a symbol that is labeled with the activity name.

Since:

JViews 7.5

Field Summary

Fields

Modifier and Type	Field and Description
static int	MILESTONE_CIRCLE Renders the milestone symbol as a circle.
static int	MILESTONE_DIAMOND Renders the milestone symbol as a diamond.
static int	MILESTONE_SQUARE Renders the milestone symbol as a square.
static int	MILESTONE_TRIANGLE Renders the milestone symbol as a triangle.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected Shape	createSymbolShape(Rectangle2D rect) Creates the symbol shape within the specified bounding box.
void	draw(Graphics g, IlvActivity milestone, boolean isSelected, Rectangle rect, Color background, ComponentOrientation orientation) This method is called by an IlvMonthPanel to render a milestone within the month grid.
Paint	getFillPaint() Returns the paint object used to fill the symbol.
Font	getLabelFont() Returns the font used to label the symbol.
int	getLabelMargin() Returns the label margin.
Paint	getLabelPaint() Returns the paint object used to label the symbol.
Paint	getSelectionFillPaint() Returns the paint object used to fill the symbol when the milestone is selected.
Paint	getSelectionStrokePaint() Returns the paint object used to stroke the symbol when the milestone is selected.
Stroke	getStroke() Returns the style used to stroke the symbol.
Paint	getStrokePaint() Returns the paint object used to stroke the symbol.
int	getSymbol() Returns the symbol type.
String	getToolTipText(IlvActivity milestone, IlvGanttModel model, Calendar calendar, MouseEvent event) This method is called by an IlvMonthPanel to return tooltip text for a displayed milestone.
void	setFillPaint(Paint paint) Sets the paint object used to fill the symbol.
void	setLabelFont(Font font) Sets the font used to label the symbol.
void	setLabelMargin(int margin) Sets the label margin.
void	setLabelPaint(Paint paint) Sets the paint object used to label the symbol.
void	setSelectionFillPaint(Paint paint) Sets the paint object used to fill the symbol when the milestone is selected.
void	setSelectionStrokePaint(Paint paint) Sets the paint object used to stroke the symbol when the milestone is selected.
void	setStroke(Stroke stroke) Sets the style used to stroke the symbol.
void	setStrokePaint(Paint paint) Sets the paint object used to stroke the symbol.
void	setSymbol(int symbol) Sets the symbol type.

Methods inherited from class java.lang.Object

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

Field Detail

MILESTONE_CIRCLE

public static final int MILESTONE_CIRCLE

Renders the milestone symbol as a circle.

See Also:

setSymbol(int), Constant Field Values

MILESTONE_SQUARE

public static final int MILESTONE_SQUARE

Renders the milestone symbol as a square.

See Also:

setSymbol(int), Constant Field Values

MILESTONE_TRIANGLE

public static final int MILESTONE_TRIANGLE

Renders the milestone symbol as a triangle.

See Also:

setSymbol(int), Constant Field Values

MILESTONE_DIAMOND

public static final int MILESTONE_DIAMOND

Renders the milestone symbol as a diamond. This is the default shape.

See Also:

setSymbol(int), Constant Field Values

Constructor Detail

IlvDefaultMilestoneCalendarRenderer

public IlvDefaultMilestoneCalendarRenderer(Paint fill,
                                           Paint stroke)

Creates a new IlvDefaultMilestoneCalendarRenderer.

Parameters:

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

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

IlvDefaultMilestoneCalendarRenderer

public IlvDefaultMilestoneCalendarRenderer()

Creates a new IlvDefaultMilestoneRendererCalendar.

Method Detail

getSymbol

public int getSymbol()

Returns the symbol type. The value will be one of the constants: MILESTONE_CIRCLE, MILESTONE_DIAMOND, MILESTONE_SQUARE, or MILESTONE_TRIANGLE. The default value is MILESTONE_DIAMOND.

Returns:

The symbol type.

See Also:

setSymbol(int)

setSymbol

public void setSymbol(int symbol)

Sets the symbol type.

Parameters:

symbol - The symbol type, which must be one of the constants: MILESTONE_CIRCLE, MILESTONE_DIAMOND, MILESTONE_SQUARE, or MILESTONE_TRIANGLE.

See Also:

getSymbol()

getFillPaint

public Paint getFillPaint()

Returns the paint object used to fill the symbol. The default value is the color orange.

Returns:

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

See Also:

setFillPaint(java.awt.Paint)

setFillPaint

public void setFillPaint(Paint paint)

Sets the paint object used to fill the symbol. During filling of the symbol, the top-left corner of the symbol 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 symbol will not be filled.

See Also:

getFillPaint()

getSelectionFillPaint

public Paint getSelectionFillPaint()

Returns the paint object used to fill the symbol when the milestone is selected. The default value is a light yellow color.

Returns:

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

See Also:

setSelectionFillPaint(java.awt.Paint)

setSelectionFillPaint

public void setSelectionFillPaint(Paint paint)

Sets the paint object used to fill the symbol when the milestone is selected. During filling of the symbol, the top-left corner of the symbol 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 symbol will not be filled when the milestone is selected.

See Also:

getSelectionFillPaint()

getStrokePaint

public Paint getStrokePaint()

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

Returns:

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

See Also:

setStrokePaint(java.awt.Paint)

setStrokePaint

public void setStrokePaint(Paint paint)

Sets the paint object used to stroke the symbol. During stroking of the symbol, the top-left corner of the symbol 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 symbol will not be stroked.

See Also:

getStrokePaint()

getSelectionStrokePaint

public Paint getSelectionStrokePaint()

Returns the paint object used to stroke the symbol when the milestone is selected. The default value is the color red.

Returns:

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

See Also:

setSelectionStrokePaint(java.awt.Paint)

setSelectionStrokePaint

public void setSelectionStrokePaint(Paint paint)

Sets the paint object used to stroke the symbol when the milestone is selected. During filling of the symbol, the top-left corner of the symbol 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 symbol will not be stroked when the milestone is selected.

See Also:

getSelectionStrokePaint()

getStroke

public Stroke getStroke()

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

Returns:

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

See Also:

setStroke(java.awt.Stroke)

setStroke

public void setStroke(Stroke stroke)

Sets the style used to stroke the symbol.

Parameters:

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

See Also:

getStroke()

getLabelFont

public Font getLabelFont()

Returns the font used to label the symbol.

Returns:

The font.

See Also:

setLabelFont(java.awt.Font)

setLabelFont

public void setLabelFont(Font font)

Sets the font used to label the symbol.

Parameters:

font - The font.

See Also:

getLabelFont()

getLabelPaint

public Paint getLabelPaint()

Returns the paint object used to label the symbol. 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 symbol. During labeling of the symbol, the top-left corner of the symbol 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()

createSymbolShape

protected Shape createSymbolShape(Rectangle2D rect)

Creates the symbol shape within the specified bounding box. This method checks the current symbol type and creates the corresponding shape.

Parameters:

rect - The bounding box of the symbol.

Returns:

The symbol shape.

draw

public void draw(Graphics g,
                 IlvActivity milestone,
                 boolean isSelected,
                 Rectangle rect,
                 Color background,
                 ComponentOrientation orientation)

This method is called by an IlvMonthPanel to render a milestone within the month grid.

Specified by:

draw in interface IlvMilestoneCalendarRenderer

Parameters:

g - The graphics context in which to paint.

milestone - The milestone to be rendered.

isSelected - Indicates whether the milestone is selected.

rect - The bounding box of the milestone.

background - The background color of the milestone. If null, the milestone should render itself non-opaquely.

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

getToolTipText

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

This method is called by an IlvMonthPanel to return tooltip text for a displayed milestone. This method can return null to disable the tooltip for the milestone.

Specified by:

getToolTipText in interface IlvMilestoneCalendarRenderer

Parameters:

milestone - The milestone.

model - The data model that contains the milestone.

calendar - The date that corresponds to the mouse position.

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

Returns:

The tooltip text.