org.jfree.chart.title

Class LegendGraphic

public class LegendGraphic extends AbstractBlock implements Block, PublicCloneable

The graphical item within a legend item.
Constructor Summary
LegendGraphic(Shape shape, Paint fillPaint)
Creates a new legend graphic.
Method Summary
Size2Darrange(Graphics2D g2, RectangleConstraint constraint)
Arranges the contents of the block, within the given constraints, and returns the block size.
protected Size2DarrangeNN(Graphics2D g2)
Performs the layout with no constraint, so the content size is determined by the bounds of the shape and/or line drawn to represent the series.
Objectclone()
Returns a clone of this LegendGraphic instance.
voiddraw(Graphics2D g2, Rectangle2D area)
Draws the graphic item within the specified area.
Objectdraw(Graphics2D g2, Rectangle2D area, Object params)
Draws the block within the specified area.
booleanequals(Object obj)
Tests this LegendGraphic instance for equality with an arbitrary object.
PaintgetFillPaint()
Returns the paint used to fill the shape.
GradientPaintTransformergetFillPaintTransformer()
Returns the transformer used when the fill paint is an instance of GradientPaint.
ShapegetLine()
Returns the line centered about (0, 0).
PaintgetLinePaint()
Returns the line paint.
StrokegetLineStroke()
Returns the line stroke.
PaintgetOutlinePaint()
Returns the outline paint.
StrokegetOutlineStroke()
Returns the outline stroke.
ShapegetShape()
Returns the shape.
RectangleAnchorgetShapeAnchor()
Returns the shape anchor.
RectangleAnchorgetShapeLocation()
Returns the shape location.
inthashCode()
Returns a hash code for this instance.
booleanisLineVisible()
Returns the flag that controls whether or not the line is visible.
booleanisShapeFilled()
Returns a flag that controls whether or not the shapes are filled.
booleanisShapeOutlineVisible()
Returns a flag that controls whether the shape outline is visible.
booleanisShapeVisible()
Returns a flag that controls whether or not the shape is visible.
voidsetFillPaint(Paint paint)
Sets the paint used to fill the shape.
voidsetFillPaintTransformer(GradientPaintTransformer transformer)
Sets the transformer used when the fill paint is an instance of GradientPaint.
voidsetLine(Shape line)
Sets the line.
voidsetLinePaint(Paint paint)
Sets the line paint.
voidsetLineStroke(Stroke stroke)
Sets the line stroke.
voidsetLineVisible(boolean visible)
Sets the flag that controls whether or not the line is visible.
voidsetOutlinePaint(Paint paint)
Sets the outline paint.
voidsetOutlineStroke(Stroke stroke)
Sets the outline stroke.
voidsetShape(Shape shape)
Sets the shape.
voidsetShapeAnchor(RectangleAnchor anchor)
Sets the shape anchor.
voidsetShapeFilled(boolean filled)
Sets a flag that controls whether or not the shape is filled.
voidsetShapeLocation(RectangleAnchor location)
Sets the shape location.
voidsetShapeOutlineVisible(boolean visible)
Sets a flag that controls whether or not the shape outline is visible.
voidsetShapeVisible(boolean visible)
Sets a flag that controls whether or not the shape is visible.

Constructor Detail

LegendGraphic

public LegendGraphic(Shape shape, Paint fillPaint)
Creates a new legend graphic.

Parameters: shape the shape (null not permitted). fillPaint the fill paint (null not permitted).

Method Detail

arrange

public Size2D arrange(Graphics2D g2, RectangleConstraint constraint)
Arranges the contents of the block, within the given constraints, and returns the block size.

Parameters: g2 the graphics device. constraint the constraint (null not permitted).

Returns: The block size (in Java2D units, never null).

arrangeNN

protected Size2D arrangeNN(Graphics2D g2)
Performs the layout with no constraint, so the content size is determined by the bounds of the shape and/or line drawn to represent the series.

Parameters: g2 the graphics device.

Returns: The content size.

clone

public Object clone()
Returns a clone of this LegendGraphic instance.

Returns: A clone of this LegendGraphic instance.

Throws: CloneNotSupportedException if there is a problem cloning.

draw

public void draw(Graphics2D g2, Rectangle2D area)
Draws the graphic item within the specified area.

Parameters: g2 the graphics device. area the area.

draw

public Object draw(Graphics2D g2, Rectangle2D area, Object params)
Draws the block within the specified area.

Parameters: g2 the graphics device. area the area. params ignored (null permitted).

Returns: Always null.

equals

public boolean equals(Object obj)
Tests this LegendGraphic instance for equality with an arbitrary object.

Parameters: obj the object (null permitted).

Returns: A boolean.

getFillPaint

public Paint getFillPaint()
Returns the paint used to fill the shape.

Returns: The fill paint.

getFillPaintTransformer

public GradientPaintTransformer getFillPaintTransformer()
Returns the transformer used when the fill paint is an instance of GradientPaint.

Returns: The transformer (never null).

Since: 1.0.4.

getLine

public Shape getLine()
Returns the line centered about (0, 0).

Returns: The line.

getLinePaint

public Paint getLinePaint()
Returns the line paint.

Returns: The paint.

getLineStroke

public Stroke getLineStroke()
Returns the line stroke.

Returns: The stroke.

getOutlinePaint

public Paint getOutlinePaint()
Returns the outline paint.

Returns: The paint.

getOutlineStroke

public Stroke getOutlineStroke()
Returns the outline stroke.

Returns: The stroke.

getShape

public Shape getShape()
Returns the shape.

Returns: The shape.

getShapeAnchor

public RectangleAnchor getShapeAnchor()
Returns the shape anchor.

Returns: The shape anchor.

getShapeLocation

public RectangleAnchor getShapeLocation()
Returns the shape location.

Returns: The shape location.

hashCode

public int hashCode()
Returns a hash code for this instance.

Returns: A hash code.

isLineVisible

public boolean isLineVisible()
Returns the flag that controls whether or not the line is visible.

Returns: A boolean.

isShapeFilled

public boolean isShapeFilled()
Returns a flag that controls whether or not the shapes are filled.

Returns: A boolean.

isShapeOutlineVisible

public boolean isShapeOutlineVisible()
Returns a flag that controls whether the shape outline is visible.

Returns: A boolean.

isShapeVisible

public boolean isShapeVisible()
Returns a flag that controls whether or not the shape is visible.

Returns: A boolean.

setFillPaint

public void setFillPaint(Paint paint)
Sets the paint used to fill the shape.

Parameters: paint the paint.

setFillPaintTransformer

public void setFillPaintTransformer(GradientPaintTransformer transformer)
Sets the transformer used when the fill paint is an instance of GradientPaint.

Parameters: transformer the transformer (null not permitted).

Since: 1.0.4

setLine

public void setLine(Shape line)
Sets the line. A Shape is used here, because then you can use Line2D, GeneralPath or any other Shape to represent the line.

Parameters: line the line.

setLinePaint

public void setLinePaint(Paint paint)
Sets the line paint.

Parameters: paint the paint.

setLineStroke

public void setLineStroke(Stroke stroke)
Sets the line stroke.

Parameters: stroke the stroke.

setLineVisible

public void setLineVisible(boolean visible)
Sets the flag that controls whether or not the line is visible.

Parameters: visible the flag.

setOutlinePaint

public void setOutlinePaint(Paint paint)
Sets the outline paint.

Parameters: paint the paint.

setOutlineStroke

public void setOutlineStroke(Stroke stroke)
Sets the outline stroke.

Parameters: stroke the stroke.

setShape

public void setShape(Shape shape)
Sets the shape.

Parameters: shape the shape.

setShapeAnchor

public void setShapeAnchor(RectangleAnchor anchor)
Sets the shape anchor. This defines a point on the shapes bounding rectangle that will be used to align the shape to a location.

Parameters: anchor the anchor (null not permitted).

setShapeFilled

public void setShapeFilled(boolean filled)
Sets a flag that controls whether or not the shape is filled.

Parameters: filled the flag.

setShapeLocation

public void setShapeLocation(RectangleAnchor location)
Sets the shape location. This defines a point within the drawing area that will be used to align the shape to.

Parameters: location the location (null not permitted).

setShapeOutlineVisible

public void setShapeOutlineVisible(boolean visible)
Sets a flag that controls whether or not the shape outline is visible.

Parameters: visible the flag.

setShapeVisible

public void setShapeVisible(boolean visible)
Sets a flag that controls whether or not the shape is visible.

Parameters: visible the flag.