LegendGraphic

java.lang.Object
- org.jfree.chart.block.AbstractBlock
- - org.jfree.chart.title.LegendGraphic

All Implemented Interfaces:

Serializable, Cloneable, Block, org.jfree.ui.Drawable, org.jfree.util.PublicCloneable
```
public class LegendGraphic
extends AbstractBlock
implements Block, org.jfree.util.PublicCloneable
```
The graphical item within a legend item.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

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

Constructors
Constructor and Description
`LegendGraphic(Shape shape, Paint fillPaint)` Creates a new legend graphic.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`org.jfree.ui.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.
`org.jfree.ui.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.
`org.jfree.ui.RectangleAnchor`	`getShapeAnchor()` Returns the shape anchor.
`org.jfree.ui.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(org.jfree.ui.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(org.jfree.ui.RectangleAnchor anchor)` Sets the shape anchor.
`void`	`setShapeFilled(boolean filled)` Sets a flag that controls whether or not the shape is filled.
`void`	`setShapeLocation(org.jfree.ui.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.

Methods inherited from class org.jfree.chart.block.AbstractBlock
arrange, getBorder, getBounds, getContentXOffset, getContentYOffset, getFrame, getHeight, getID, getMargin, getPadding, getWidth, setBorder, setBorder, setBounds, setFrame, setHeight, setID, setMargin, setMargin, setPadding, setPadding, setWidth

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jfree.chart.block.Block
arrange, getBounds, getID, setBounds, setID

- 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
  - isShapeVisible
```
public boolean isShapeVisible()
```
    Returns a flag that controls whether or not the shape is visible.
    
    Returns:
    
    A boolean.
    
    See Also:
    
    setShapeVisible(boolean)
  - setShapeVisible
```
public void setShapeVisible(boolean visible)
```
    Sets a flag that controls whether or not the shape is visible.
    
    Parameters:
    
    visible - the flag.
    
    See Also:
    
    isShapeVisible()
  - getShape
```
public Shape getShape()
```
    Returns the shape.
    
    Returns:
    
    The shape.
    
    See Also:
    
    setShape(Shape)
  - setShape
```
public void setShape(Shape shape)
```
    Sets the shape.
    
    Parameters:
    
    shape - the shape.
    
    See Also:
    
    getShape()
  - isShapeFilled
```
public boolean isShapeFilled()
```
    Returns a flag that controls whether or not the shapes are filled.
    
    Returns:
    
    A boolean.
    
    See Also:
    
    setShapeFilled(boolean)
  - setShapeFilled
```
public void setShapeFilled(boolean filled)
```
    Sets a flag that controls whether or not the shape is filled.
    
    Parameters:
    
    filled - the flag.
    
    See Also:
    
    isShapeFilled()
  - getFillPaint
```
public Paint getFillPaint()
```
    Returns the paint used to fill the shape.
    
    Returns:
    
    The fill paint.
    
    See Also:
    
    setFillPaint(Paint)
  - setFillPaint
```
public void setFillPaint(Paint paint)
```
    Sets the paint used to fill the shape.
    
    Parameters:
    
    paint - the paint.
    
    See Also:
    
    getFillPaint()
  - getFillPaintTransformer
```
public org.jfree.ui.GradientPaintTransformer getFillPaintTransformer()
```
    Returns the transformer used when the fill paint is an instance of GradientPaint.
    
    Returns:
    
    The transformer (never null).
    
    Since:
    
    1.0.4.
    
    See Also:
    
    setFillPaintTransformer(GradientPaintTransformer)
  - setFillPaintTransformer
```
public void setFillPaintTransformer(org.jfree.ui.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
    
    See Also:
    
    getFillPaintTransformer()
  - isShapeOutlineVisible
```
public boolean isShapeOutlineVisible()
```
    Returns a flag that controls whether the shape outline is visible.
    
    Returns:
    
    A boolean.
    
    See Also:
    
    setShapeOutlineVisible(boolean)
  - setShapeOutlineVisible
```
public void setShapeOutlineVisible(boolean visible)
```
    Sets a flag that controls whether or not the shape outline is visible.
    
    Parameters:
    
    visible - the flag.
    
    See Also:
    
    isShapeOutlineVisible()
  - getOutlinePaint
```
public Paint getOutlinePaint()
```
    Returns the outline paint.
    
    Returns:
    
    The paint.
    
    See Also:
    
    setOutlinePaint(Paint)
  - setOutlinePaint
```
public void setOutlinePaint(Paint paint)
```
    Sets the outline paint.
    
    Parameters:
    
    paint - the paint.
    
    See Also:
    
    getOutlinePaint()
  - getOutlineStroke
```
public Stroke getOutlineStroke()
```
    Returns the outline stroke.
    
    Returns:
    
    The stroke.
    
    See Also:
    
    setOutlineStroke(Stroke)
  - setOutlineStroke
```
public void setOutlineStroke(Stroke stroke)
```
    Sets the outline stroke.
    
    Parameters:
    
    stroke - the stroke.
    
    See Also:
    
    getOutlineStroke()
  - getShapeAnchor
```
public org.jfree.ui.RectangleAnchor getShapeAnchor()
```
    Returns the shape anchor.
    
    Returns:
    
    The shape anchor.
    
    See Also:
    
    getShapeAnchor()
  - setShapeAnchor
```
public void setShapeAnchor(org.jfree.ui.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:
    
    setShapeAnchor(RectangleAnchor)
  - getShapeLocation
```
public org.jfree.ui.RectangleAnchor getShapeLocation()
```
    Returns the shape location.
    
    Returns:
    
    The shape location.
    
    See Also:
    
    setShapeLocation(RectangleAnchor)
  - setShapeLocation
```
public void setShapeLocation(org.jfree.ui.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:
    
    getShapeLocation()
  - isLineVisible
```
public boolean isLineVisible()
```
    Returns the flag that controls whether or not the line is visible.
    
    Returns:
    
    A boolean.
    
    See Also:
    
    setLineVisible(boolean)
  - setLineVisible
```
public void setLineVisible(boolean visible)
```
    Sets the flag that controls whether or not the line is visible.
    
    Parameters:
    
    visible - the flag.
    
    See Also:
    
    isLineVisible()
  - getLine
```
public Shape getLine()
```
    Returns the line centered about (0, 0).
    
    Returns:
    
    The line.
    
    See Also:
    
    setLine(Shape)
  - 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.
    
    See Also:
    
    getLine()
  - getLinePaint
```
public Paint getLinePaint()
```
    Returns the line paint.
    
    Returns:
    
    The paint.
    
    See Also:
    
    setLinePaint(Paint)
  - setLinePaint
```
public void setLinePaint(Paint paint)
```
    Sets the line paint.
    
    Parameters:
    
    paint - the paint.
    
    See Also:
    
    getLinePaint()
  - getLineStroke
```
public Stroke getLineStroke()
```
    Returns the line stroke.
    
    Returns:
    
    The stroke.
    
    See Also:
    
    setLineStroke(Stroke)
  - setLineStroke
```
public void setLineStroke(Stroke stroke)
```
    Sets the line stroke.
    
    Parameters:
    
    stroke - the stroke.
    
    See Also:
    
    getLineStroke()
  - arrange
```
public org.jfree.ui.Size2D arrange(Graphics2D g2,
                                   RectangleConstraint constraint)
```
    Arranges the contents of the block, within the given constraints, and returns the block size.
    
    Specified by:
    
    arrange in interface Block
    
    Overrides:
    
    arrange in class AbstractBlock
    
    Parameters:
    
    g2 - the graphics device.
    
    constraint - the constraint (null not permitted).
    
    Returns:
    
    The block size (in Java2D units, never null).
  - draw
```
public void draw(Graphics2D g2,
                 Rectangle2D area)
```
    Draws the graphic item within the specified area.
    
    Specified by:
    
    draw in interface org.jfree.ui.Drawable
    
    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.
    
    Specified by:
    
    draw in interface Block
    
    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.
    
    Overrides:
    
    equals in class AbstractBlock
    
    Parameters:
    
    obj - the object (null permitted).
    
    Returns:
    
    A boolean.
  - hashCode
```
public int hashCode()
```
    Returns a hash code for this instance.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    A hash code.
  - clone
```
public Object clone()
             throws CloneNotSupportedException
```
    Returns a clone of this LegendGraphic instance.
    
    Specified by:
    
    clone in interface org.jfree.util.PublicCloneable
    
    Overrides:
    
    clone in class AbstractBlock
    
    Returns:
    
    A clone of this LegendGraphic instance.
    
    Throws:
    
    CloneNotSupportedException - if there is a problem cloning.

Class LegendGraphic

Constructor Summary

Method Summary

Methods inherited from class org.jfree.chart.block.AbstractBlock

Methods inherited from class java.lang.Object

Methods inherited from interface org.jfree.chart.block.Block

Constructor Detail

LegendGraphic

Method Detail

isShapeVisible

setShapeVisible

getShape

setShape

isShapeFilled

setShapeFilled

getFillPaint

setFillPaint

getFillPaintTransformer

setFillPaintTransformer

isShapeOutlineVisible

setShapeOutlineVisible

getOutlinePaint

setOutlinePaint

getOutlineStroke

setOutlineStroke

getShapeAnchor

setShapeAnchor

getShapeLocation

setShapeLocation

isLineVisible

setLineVisible

getLine

setLine

getLinePaint

setLinePaint

getLineStroke

setLineStroke

arrange

draw

draw

equals

hashCode

clone