public class

LegendGraphic

extends AbstractBlock
implements Block
java.lang.Object
   ↳ org.jfree.chart.block.AbstractBlock
     ↳ org.jfree.chart.title.LegendGraphic

Class Overview

The graphical item within a legend item.

Summary

Public Constructors
LegendGraphic(Shape shape, Paint fillPaint)
Creates a new legend graphic.
Public Methods
Size2D arrange(Graphics2D g2, RectangleConstraint constraint)
Arranges the contents of the block, within the given constraints, and returns the block size.
Object clone()
Returns a clone of this LegendGraphic instance.
void draw(Graphics2D g2, Rectangle2D area)
Draws the graphic item within the specified area.
Object draw(Graphics2D g2, Rectangle2D area, Object params)
Draws the block within the specified area.
boolean equals(Object obj)
Tests this LegendGraphic instance for equality with an arbitrary object.
Paint getFillPaint()
Returns the paint used to fill the shape.
GradientPaintTransformer getFillPaintTransformer()
Returns the transformer used when the fill paint is an instance of GradientPaint.
Shape getLine()
Returns the line centered about (0, 0).
Paint getLinePaint()
Returns the line paint.
Stroke getLineStroke()
Returns the line stroke.
Paint getOutlinePaint()
Returns the outline paint.
Stroke getOutlineStroke()
Returns the outline stroke.
Shape getShape()
Returns the shape.
RectangleAnchor getShapeAnchor()
Returns the shape anchor.
RectangleAnchor getShapeLocation()
Returns the shape location.
int hashCode()
Returns a hash code for this instance.
boolean isLineVisible()
Returns the flag that controls whether or not the line is visible.
boolean isShapeFilled()
Returns a flag that controls whether or not the shapes are filled.
boolean isShapeOutlineVisible()
Returns a flag that controls whether the shape outline is visible.
boolean isShapeVisible()
Returns a flag that controls whether or not the shape is visible.
void setFillPaint(Paint paint)
Sets the paint used to fill the shape.
void setFillPaintTransformer(GradientPaintTransformer transformer)
Sets the transformer used when the fill paint is an instance of GradientPaint.
void setLine(Shape line)
Sets the line.
void setLinePaint(Paint paint)
Sets the line paint.
void setLineStroke(Stroke stroke)
Sets the line stroke.
void setLineVisible(boolean visible)
Sets the flag that controls whether or not the line is visible.
void setOutlinePaint(Paint paint)
Sets the outline paint.
void setOutlineStroke(Stroke stroke)
Sets the outline stroke.
void setShape(Shape shape)
Sets the shape.
void setShapeAnchor(RectangleAnchor anchor)
Sets the shape anchor.
void setShapeFilled(boolean filled)
Sets a flag that controls whether or not the shape is filled.
void setShapeLocation(RectangleAnchor location)
Sets the shape location.
void setShapeOutlineVisible(boolean visible)
Sets a flag that controls whether or not the shape outline is visible.
void setShapeVisible(boolean visible)
Sets a flag that controls whether or not the shape is visible.
Protected Methods
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.
[Expand]
Inherited Methods
From class org.jfree.chart.block.AbstractBlock
From class java.lang.Object
From interface org.jfree.chart.block.Block

Public Constructors

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

Public Methods

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

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.

public void draw (Graphics2D g2, Rectangle2D area)

Draws the graphic item within the specified area.

Parameters
g2 the graphics device.
area the area.

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.

public boolean equals (Object obj)

Tests this LegendGraphic instance for equality with an arbitrary object.

Parameters
obj the object (null permitted).
Returns
  • A boolean.

public Paint getFillPaint ()

Returns the paint used to fill the shape.

Returns
  • The fill paint.
See Also

public GradientPaintTransformer getFillPaintTransformer ()

Returns the transformer used when the fill paint is an instance of GradientPaint.

Returns
  • The transformer (never null).
See Also

public Shape getLine ()

Returns the line centered about (0, 0).

Returns
  • The line.
See Also

public Paint getLinePaint ()

Returns the line paint.

Returns
  • The paint.
See Also

public Stroke getLineStroke ()

Returns the line stroke.

Returns
  • The stroke.
See Also

public Paint getOutlinePaint ()

Returns the outline paint.

Returns
  • The paint.
See Also

public Stroke getOutlineStroke ()

Returns the outline stroke.

Returns
  • The stroke.
See Also

public Shape getShape ()

Returns the shape.

Returns
  • The shape.
See Also

public RectangleAnchor getShapeAnchor ()

Returns the shape anchor.

Returns
  • The shape anchor.
See Also

public RectangleAnchor getShapeLocation ()

Returns the shape location.

Returns
  • The shape location.
See Also

public int hashCode ()

Returns a hash code for this instance.

Returns
  • A hash code.

public boolean isLineVisible ()

Returns the flag that controls whether or not the line is visible.

Returns
  • A boolean.
See Also

public boolean isShapeFilled ()

Returns a flag that controls whether or not the shapes are filled.

Returns
  • A boolean.
See Also

public boolean isShapeOutlineVisible ()

Returns a flag that controls whether the shape outline is visible.

Returns
  • A boolean.
See Also

public boolean isShapeVisible ()

Returns a flag that controls whether or not the shape is visible.

Returns
  • A boolean.
See Also

public void setFillPaint (Paint paint)

Sets the paint used to fill the shape.

Parameters
paint the paint.
See Also

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).
See Also

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.
See Also

public void setLinePaint (Paint paint)

Sets the line paint.

Parameters
paint the paint.
See Also

public void setLineStroke (Stroke stroke)

Sets the line stroke.

Parameters
stroke the stroke.
See Also

public void setLineVisible (boolean visible)

Sets the flag that controls whether or not the line is visible.

Parameters
visible the flag.
See Also

public void setOutlinePaint (Paint paint)

Sets the outline paint.

Parameters
paint the paint.
See Also

public void setOutlineStroke (Stroke stroke)

Sets the outline stroke.

Parameters
stroke the stroke.
See Also

public void setShape (Shape shape)

Sets the shape.

Parameters
shape the shape.
See Also

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).
See Also

public void setShapeFilled (boolean filled)

Sets a flag that controls whether or not the shape is filled.

Parameters
filled the flag.
See Also

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).
See Also

public void setShapeOutlineVisible (boolean visible)

Sets a flag that controls whether or not the shape outline is visible.

Parameters
visible the flag.
See Also

public void setShapeVisible (boolean visible)

Sets a flag that controls whether or not the shape is visible.

Parameters
visible the flag.
See Also

Protected Methods

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.