LegendItem

java.lang.Object
- org.jfree.chart.LegendItem

All Implemented Interfaces:

Serializable, Cloneable
```
public class LegendItem
extends Object
implements Cloneable, Serializable
```
A temporary storage object for recording the properties of a legend item, without any consideration for layout issues.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`LegendItem(AttributedString label, String description, String toolTipText, String urlText, boolean shapeVisible, Shape shape, boolean shapeFilled, Paint fillPaint, boolean shapeOutlineVisible, Paint outlinePaint, Stroke outlineStroke, boolean lineVisible, Shape line, Stroke lineStroke, Paint linePaint)` Creates a new legend item.
`LegendItem(AttributedString label, String description, String toolTipText, String urlText, Shape shape, Paint fillPaint)` Creates a legend item with a filled shape.
`LegendItem(AttributedString label, String description, String toolTipText, String urlText, Shape shape, Paint fillPaint, Stroke outlineStroke, Paint outlinePaint)` Creates a legend item with a filled and outlined shape.
`LegendItem(AttributedString label, String description, String toolTipText, String urlText, Shape line, Stroke lineStroke, Paint linePaint)` Creates a legend item using a line.
`LegendItem(String label)` Creates a legend item with the specified label.
`LegendItem(String label, Paint paint)` Creates a legend item with the specified label and fill paint.
`LegendItem(String label, String description, String toolTipText, String urlText, boolean shapeVisible, Shape shape, boolean shapeFilled, Paint fillPaint, boolean shapeOutlineVisible, Paint outlinePaint, Stroke outlineStroke, boolean lineVisible, Shape line, Stroke lineStroke, Paint linePaint)` Creates a new legend item.
`LegendItem(String label, String description, String toolTipText, String urlText, Shape shape, Paint fillPaint)` Creates a legend item with a filled shape.
`LegendItem(String label, String description, String toolTipText, String urlText, Shape shape, Paint fillPaint, Stroke outlineStroke, Paint outlinePaint)` Creates a legend item with a filled and outlined shape.
`LegendItem(String label, String description, String toolTipText, String urlText, Shape line, Stroke lineStroke, Paint linePaint)` Creates a legend item using a line.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`clone()` Returns an independent copy of this object (except that the clone will still reference the same dataset as the original `LegendItem`).
`boolean`	`equals(Object obj)` Tests this item for equality with an arbitrary object.
`AttributedString`	`getAttributedLabel()` Returns the attributed label.
`Dataset`	`getDataset()` Returns the dataset.
`int`	`getDatasetIndex()` Returns the dataset index for this legend item.
`String`	`getDescription()` Returns the description for the legend item.
`Paint`	`getFillPaint()` Returns the fill paint.
`org.jfree.ui.GradientPaintTransformer`	`getFillPaintTransformer()` Returns the transformer used when the fill paint is an instance of `GradientPaint`.
`String`	`getLabel()` Returns the label.
`Font`	`getLabelFont()` Returns the label font.
`Paint`	`getLabelPaint()` Returns the paint used to draw the label.
`Shape`	`getLine()` Returns the line.
`Paint`	`getLinePaint()` Returns the paint used for lines.
`Stroke`	`getLineStroke()` Returns the line stroke for the series.
`Paint`	`getOutlinePaint()` Returns the outline paint.
`Stroke`	`getOutlineStroke()` Returns the outline stroke.
`int`	`getSeriesIndex()` Returns the series index for this legend item.
`Comparable`	`getSeriesKey()` Returns the series key.
`Shape`	`getShape()` Returns the shape used to label the series represented by this legend item.
`String`	`getToolTipText()` Returns the tool tip text.
`String`	`getURLText()` Returns the URL text.
`boolean`	`isLineVisible()` Returns a flag that indicates whether or not the line is visible.
`boolean`	`isShapeFilled()` Returns a flag that controls whether or not the shape is filled.
`boolean`	`isShapeOutlineVisible()` Returns the flag that controls whether or not the shape outline is visible.
`boolean`	`isShapeVisible()` Returns a flag that indicates whether or not the shape is visible.
`void`	`setDataset(Dataset dataset)` Sets the dataset.
`void`	`setDatasetIndex(int index)` Sets the dataset index for this legend item.
`void`	`setDescription(String text)` Sets the description for this legend item.
`void`	`setFillPaint(Paint paint)` Sets the fill paint.
`void`	`setFillPaintTransformer(org.jfree.ui.GradientPaintTransformer transformer)` Sets the transformer used when the fill paint is an instance of `GradientPaint`.
`void`	`setLabelFont(Font font)` Sets the label font.
`void`	`setLabelPaint(Paint paint)` Sets the paint used to draw the label.
`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 shape is visible for this legend item.
`void`	`setOutlinePaint(Paint paint)` Sets the outline paint.
`void`	`setOutlineStroke(Stroke stroke)` Sets the outline stroke.
`void`	`setSeriesIndex(int index)` Sets the series index for this legend item.
`void`	`setSeriesKey(Comparable key)` Sets the series key.
`void`	`setShape(Shape shape)` Sets the shape for the legend item.
`void`	`setShapeVisible(boolean visible)` Sets the flag that controls whether or not the shape is visible.
`void`	`setToolTipText(String text)` Sets the tool tip text for this legend item.
`void`	`setURLText(String text)` Sets the URL text.

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

- Constructor Detail
  - LegendItem
```
public LegendItem(String label)
```
    Creates a legend item with the specified label. The remaining attributes take default values.
    
    Parameters:
    
    label - the label (null not permitted).
    
    Since:
    
    1.0.10
  - LegendItem
```
public LegendItem(String label,
                  Paint paint)
```
    Creates a legend item with the specified label and fill paint. The remaining attributes take default values.
    
    Parameters:
    
    label - the label (null not permitted).
    
    paint - the paint (null not permitted).
    
    Since:
    
    1.0.12
  - LegendItem
```
public LegendItem(String label,
                  String description,
                  String toolTipText,
                  String urlText,
                  Shape shape,
                  Paint fillPaint)
```
    Creates a legend item with a filled shape. The shape is not outlined, and no line is visible.
    
    Parameters:
    
    label - the label (null not permitted).
    
    description - the description (null permitted).
    
    toolTipText - the tool tip text (null permitted).
    
    urlText - the URL text (null permitted).
    
    shape - the shape (null not permitted).
    
    fillPaint - the paint used to fill the shape (null not permitted).
  - LegendItem
```
public LegendItem(String label,
                  String description,
                  String toolTipText,
                  String urlText,
                  Shape shape,
                  Paint fillPaint,
                  Stroke outlineStroke,
                  Paint outlinePaint)
```
    Creates a legend item with a filled and outlined shape.
    
    Parameters:
    
    label - the label (null not permitted).
    
    description - the description (null permitted).
    
    toolTipText - the tool tip text (null permitted).
    
    urlText - the URL text (null permitted).
    
    shape - the shape (null not permitted).
    
    fillPaint - the paint used to fill the shape (null not permitted).
    
    outlineStroke - the outline stroke (null not permitted).
    
    outlinePaint - the outline paint (null not permitted).
  - LegendItem
```
public LegendItem(String label,
                  String description,
                  String toolTipText,
                  String urlText,
                  Shape line,
                  Stroke lineStroke,
                  Paint linePaint)
```
    Creates a legend item using a line.
    
    Parameters:
    
    label - the label (null not permitted).
    
    description - the description (null permitted).
    
    toolTipText - the tool tip text (null permitted).
    
    urlText - the URL text (null permitted).
    
    line - the line (null not permitted).
    
    lineStroke - the line stroke (null not permitted).
    
    linePaint - the line paint (null not permitted).
  - LegendItem
```
public LegendItem(String label,
                  String description,
                  String toolTipText,
                  String urlText,
                  boolean shapeVisible,
                  Shape shape,
                  boolean shapeFilled,
                  Paint fillPaint,
                  boolean shapeOutlineVisible,
                  Paint outlinePaint,
                  Stroke outlineStroke,
                  boolean lineVisible,
                  Shape line,
                  Stroke lineStroke,
                  Paint linePaint)
```
    Creates a new legend item.
    
    Parameters:
    
    label - the label (null not permitted).
    
    description - the description (not currently used, null permitted).
    
    toolTipText - the tool tip text (null permitted).
    
    urlText - the URL text (null permitted).
    
    shapeVisible - a flag that controls whether or not the shape is displayed.
    
    shape - the shape (null permitted).
    
    shapeFilled - a flag that controls whether or not the shape is filled.
    
    fillPaint - the fill paint (null not permitted).
    
    shapeOutlineVisible - a flag that controls whether or not the shape is outlined.
    
    outlinePaint - the outline paint (null not permitted).
    
    outlineStroke - the outline stroke (null not permitted).
    
    lineVisible - a flag that controls whether or not the line is visible.
    
    line - the line.
    
    lineStroke - the stroke (null not permitted).
    
    linePaint - the line paint (null not permitted).
  - LegendItem
```
public LegendItem(AttributedString label,
                  String description,
                  String toolTipText,
                  String urlText,
                  Shape shape,
                  Paint fillPaint)
```
    Creates a legend item with a filled shape. The shape is not outlined, and no line is visible.
    
    Parameters:
    
    label - the label (null not permitted).
    
    description - the description (null permitted).
    
    toolTipText - the tool tip text (null permitted).
    
    urlText - the URL text (null permitted).
    
    shape - the shape (null not permitted).
    
    fillPaint - the paint used to fill the shape (null not permitted).
  - LegendItem
```
public LegendItem(AttributedString label,
                  String description,
                  String toolTipText,
                  String urlText,
                  Shape shape,
                  Paint fillPaint,
                  Stroke outlineStroke,
                  Paint outlinePaint)
```
    Creates a legend item with a filled and outlined shape.
    
    Parameters:
    
    label - the label (null not permitted).
    
    description - the description (null permitted).
    
    toolTipText - the tool tip text (null permitted).
    
    urlText - the URL text (null permitted).
    
    shape - the shape (null not permitted).
    
    fillPaint - the paint used to fill the shape (null not permitted).
    
    outlineStroke - the outline stroke (null not permitted).
    
    outlinePaint - the outline paint (null not permitted).
  - LegendItem
```
public LegendItem(AttributedString label,
                  String description,
                  String toolTipText,
                  String urlText,
                  Shape line,
                  Stroke lineStroke,
                  Paint linePaint)
```
    Creates a legend item using a line.
    
    Parameters:
    
    label - the label (null not permitted).
    
    description - the description (null permitted).
    
    toolTipText - the tool tip text (null permitted).
    
    urlText - the URL text (null permitted).
    
    line - the line (null not permitted).
    
    lineStroke - the line stroke (null not permitted).
    
    linePaint - the line paint (null not permitted).
  - LegendItem
```
public LegendItem(AttributedString label,
                  String description,
                  String toolTipText,
                  String urlText,
                  boolean shapeVisible,
                  Shape shape,
                  boolean shapeFilled,
                  Paint fillPaint,
                  boolean shapeOutlineVisible,
                  Paint outlinePaint,
                  Stroke outlineStroke,
                  boolean lineVisible,
                  Shape line,
                  Stroke lineStroke,
                  Paint linePaint)
```
    Creates a new legend item.
    
    Parameters:
    
    label - the label (null not permitted).
    
    description - the description (not currently used, null permitted).
    
    toolTipText - the tool tip text (null permitted).
    
    urlText - the URL text (null permitted).
    
    shapeVisible - a flag that controls whether or not the shape is displayed.
    
    shape - the shape (null permitted).
    
    shapeFilled - a flag that controls whether or not the shape is filled.
    
    fillPaint - the fill paint (null not permitted).
    
    shapeOutlineVisible - a flag that controls whether or not the shape is outlined.
    
    outlinePaint - the outline paint (null not permitted).
    
    outlineStroke - the outline stroke (null not permitted).
    
    lineVisible - a flag that controls whether or not the line is visible.
    
    line - the line (null not permitted).
    
    lineStroke - the stroke (null not permitted).
    
    linePaint - the line paint (null not permitted).
- Method Detail
  - getDataset
```
public Dataset getDataset()
```
    Returns the dataset.
    
    Returns:
    
    The dataset.
    
    Since:
    
    1.0.6
    
    See Also:
    
    setDatasetIndex(int)
  - setDataset
```
public void setDataset(Dataset dataset)
```
    Sets the dataset.
    
    Parameters:
    
    dataset - the dataset.
    
    Since:
    
    1.0.6
  - getDatasetIndex
```
public int getDatasetIndex()
```
    Returns the dataset index for this legend item.
    
    Returns:
    
    The dataset index.
    
    Since:
    
    1.0.2
    
    See Also:
    
    setDatasetIndex(int), getDataset()
  - setDatasetIndex
```
public void setDatasetIndex(int index)
```
    Sets the dataset index for this legend item.
    
    Parameters:
    
    index - the index.
    
    Since:
    
    1.0.2
    
    See Also:
    
    getDatasetIndex()
  - getSeriesKey
```
public Comparable getSeriesKey()
```
    Returns the series key.
    
    Returns:
    
    The series key.
    
    Since:
    
    1.0.6
    
    See Also:
    
    setSeriesKey(Comparable)
  - setSeriesKey
```
public void setSeriesKey(Comparable key)
```
    Sets the series key.
    
    Parameters:
    
    key - the series key.
    
    Since:
    
    1.0.6
  - getSeriesIndex
```
public int getSeriesIndex()
```
    Returns the series index for this legend item.
    
    Returns:
    
    The series index.
    
    Since:
    
    1.0.2
  - setSeriesIndex
```
public void setSeriesIndex(int index)
```
    Sets the series index for this legend item.
    
    Parameters:
    
    index - the index.
    
    Since:
    
    1.0.2
  - getLabel
```
public String getLabel()
```
    Returns the label.
    
    Returns:
    
    The label (never null).
  - getLabelFont
```
public Font getLabelFont()
```
    Returns the label font.
    
    Returns:
    
    The label font (possibly null).
    
    Since:
    
    1.0.11
  - setLabelFont
```
public void setLabelFont(Font font)
```
    Sets the label font.
    
    Parameters:
    
    font - the font (null permitted).
    
    Since:
    
    1.0.11
  - getLabelPaint
```
public Paint getLabelPaint()
```
    Returns the paint used to draw the label.
    
    Returns:
    
    The paint (possibly null).
    
    Since:
    
    1.0.11
  - setLabelPaint
```
public void setLabelPaint(Paint paint)
```
    Sets the paint used to draw the label.
    
    Parameters:
    
    paint - the paint (null permitted).
    
    Since:
    
    1.0.11
  - getAttributedLabel
```
public AttributedString getAttributedLabel()
```
    Returns the attributed label.
    
    Returns:
    
    The attributed label (possibly null).
  - getDescription
```
public String getDescription()
```
    Returns the description for the legend item.
    
    Returns:
    
    The description (possibly null).
    
    See Also:
    
    setDescription(java.lang.String)
  - setDescription
```
public void setDescription(String text)
```
    Sets the description for this legend item.
    
    Parameters:
    
    text - the description (null permitted).
    
    Since:
    
    1.0.14
    
    See Also:
    
    getDescription()
  - getToolTipText
```
public String getToolTipText()
```
    Returns the tool tip text.
    
    Returns:
    
    The tool tip text (possibly null).
    
    See Also:
    
    setToolTipText(java.lang.String)
  - setToolTipText
```
public void setToolTipText(String text)
```
    Sets the tool tip text for this legend item.
    
    Parameters:
    
    text - the text (null permitted).
    
    Since:
    
    1.0.14
    
    See Also:
    
    getToolTipText()
  - getURLText
```
public String getURLText()
```
    Returns the URL text.
    
    Returns:
    
    The URL text (possibly null).
    
    See Also:
    
    setURLText(java.lang.String)
  - setURLText
```
public void setURLText(String text)
```
    Sets the URL text.
    
    Parameters:
    
    text - the text (null permitted).
    
    Since:
    
    1.0.14
    
    See Also:
    
    getURLText()
  - isShapeVisible
```
public boolean isShapeVisible()
```
    Returns a flag that indicates whether or not the shape is visible.
    
    Returns:
    
    A boolean.
    
    See Also:
    
    setShapeVisible(boolean)
  - setShapeVisible
```
public void setShapeVisible(boolean visible)
```
    Sets the flag that controls whether or not the shape is visible.
    
    Parameters:
    
    visible - the new flag value.
    
    Since:
    
    1.0.14
    
    See Also:
    
    isShapeVisible(), isLineVisible()
  - getShape
```
public Shape getShape()
```
    Returns the shape used to label the series represented by this legend item.
    
    Returns:
    
    The shape (never null).
    
    See Also:
    
    setShape(java.awt.Shape)
  - setShape
```
public void setShape(Shape shape)
```
    Sets the shape for the legend item.
    
    Parameters:
    
    shape - the shape (null not permitted).
    
    Since:
    
    1.0.14
    
    See Also:
    
    getShape()
  - isShapeFilled
```
public boolean isShapeFilled()
```
    Returns a flag that controls whether or not the shape is filled.
    
    Returns:
    
    A boolean.
  - getFillPaint
```
public Paint getFillPaint()
```
    Returns the fill paint.
    
    Returns:
    
    The fill paint (never null).
  - setFillPaint
```
public void setFillPaint(Paint paint)
```
    Sets the fill paint.
    
    Parameters:
    
    paint - the paint (null not permitted).
    
    Since:
    
    1.0.11
  - isShapeOutlineVisible
```
public boolean isShapeOutlineVisible()
```
    Returns the flag that controls whether or not the shape outline is visible.
    
    Returns:
    
    A boolean.
  - getLineStroke
```
public Stroke getLineStroke()
```
    Returns the line stroke for the series.
    
    Returns:
    
    The stroke (never null).
  - setLineStroke
```
public void setLineStroke(Stroke stroke)
```
    Sets the line stroke.
    
    Parameters:
    
    stroke - the stroke (null not permitted).
    
    Since:
    
    1.0.18
  - getLinePaint
```
public Paint getLinePaint()
```
    Returns the paint used for lines.
    
    Returns:
    
    The paint (never null).
  - setLinePaint
```
public void setLinePaint(Paint paint)
```
    Sets the line paint.
    
    Parameters:
    
    paint - the paint (null not permitted).
    
    Since:
    
    1.0.11
  - getOutlinePaint
```
public Paint getOutlinePaint()
```
    Returns the outline paint.
    
    Returns:
    
    The outline paint (never null).
  - setOutlinePaint
```
public void setOutlinePaint(Paint paint)
```
    Sets the outline paint.
    
    Parameters:
    
    paint - the paint (null not permitted).
    
    Since:
    
    1.0.11
  - getOutlineStroke
```
public Stroke getOutlineStroke()
```
    Returns the outline stroke.
    
    Returns:
    
    The outline stroke (never null).
    
    See Also:
    
    setOutlineStroke(java.awt.Stroke)
  - setOutlineStroke
```
public void setOutlineStroke(Stroke stroke)
```
    Sets the outline stroke.
    
    Parameters:
    
    stroke - the stroke (null not permitted).
    
    Since:
    
    1.0.14
    
    See Also:
    
    getOutlineStroke()
  - isLineVisible
```
public boolean isLineVisible()
```
    Returns a flag that indicates 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 shape is visible for this legend item.
    
    Parameters:
    
    visible - the new flag value.
    
    Since:
    
    1.0.14
    
    See Also:
    
    isLineVisible()
  - getLine
```
public Shape getLine()
```
    Returns the line.
    
    Returns:
    
    The line (never null).
    
    See Also:
    
    setLine(java.awt.Shape), isLineVisible()
  - setLine
```
public void setLine(Shape line)
```
    Sets the line.
    
    Parameters:
    
    line - the line (null not permitted).
    
    Since:
    
    1.0.14
    
    See Also:
    
    getLine()
  - 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()
  - equals
```
public boolean equals(Object obj)
```
    Tests this item for equality with an arbitrary object.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj - the object (null permitted).
    
    Returns:
    
    A boolean.
  - clone
```
public Object clone()
             throws CloneNotSupportedException
```
    Returns an independent copy of this object (except that the clone will still reference the same dataset as the original LegendItem).
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    A clone.
    
    Throws:
    
    CloneNotSupportedException - if the legend item cannot be cloned.
    
    Since:
    
    1.0.10

Class LegendItem

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LegendItem

LegendItem

LegendItem

LegendItem

LegendItem

LegendItem

LegendItem

LegendItem

LegendItem

LegendItem

Method Detail

getDataset

setDataset

getDatasetIndex

setDatasetIndex

getSeriesKey

setSeriesKey

getSeriesIndex

setSeriesIndex

getLabel

getLabelFont

setLabelFont

getLabelPaint

setLabelPaint

getAttributedLabel

getDescription

setDescription

getToolTipText

setToolTipText

getURLText

setURLText

isShapeVisible

setShapeVisible

getShape

setShape

isShapeFilled

getFillPaint

setFillPaint

isShapeOutlineVisible

getLineStroke

setLineStroke

getLinePaint

setLinePaint

getOutlinePaint

setOutlinePaint

getOutlineStroke

setOutlineStroke

isLineVisible

setLineVisible

getLine

setLine

getFillPaintTransformer

setFillPaintTransformer

equals

clone