public class

LegendItem

extends Object
implements Serializable Cloneable
java.lang.Object
   ↳ org.jfree.chart.LegendItem

Class Overview

A temporary storage object for recording the properties of a legend item, without any consideration for layout issues.

Summary

Public Constructors
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, 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.
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(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(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.
Public Methods
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.
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 setFillPaint(Paint paint)
Sets the fill paint.
void setFillPaintTransformer(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 setLinePaint(Paint paint)
Sets the line paint.
void setOutlinePaint(Paint paint)
Sets the outline paint.
void setSeriesIndex(int index)
Sets the series index for this legend item.
void setSeriesKey(Comparable key)
Sets the series key.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

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

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

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

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

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

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

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

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

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

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

Public Methods

public Object clone ()

Returns an independent copy of this object (except that the clone will still reference the same dataset as the original LegendItem).

Returns
  • A clone.
Throws
CloneNotSupportedException if the legend item cannot be cloned.

public boolean equals (Object obj)

Tests this item for equality with an arbitrary object.

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

public AttributedString getAttributedLabel ()

Returns the attributed label.

Returns
  • The attributed label (possibly null).

public Dataset getDataset ()

Returns the dataset.

Returns
  • The dataset.
See Also

public int getDatasetIndex ()

Returns the dataset index for this legend item.

Returns
  • The dataset index.
See Also

public String getDescription ()

Returns the description for the legend item.

Returns
  • The description.

public Paint getFillPaint ()

Returns the fill paint.

Returns
  • The fill paint (never null).

public GradientPaintTransformer getFillPaintTransformer ()

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

Returns
  • The transformer (never null).
See Also

public String getLabel ()

Returns the label.

Returns
  • The label (never null).

public Font getLabelFont ()

Returns the label font.

Returns
  • The label font (possibly null).

public Paint getLabelPaint ()

Returns the paint used to draw the label.

Returns
  • The paint (possibly null).

public Shape getLine ()

Returns the line.

Returns
  • The line (never null).

public Paint getLinePaint ()

Returns the paint used for lines.

Returns
  • The paint (never null).

public Stroke getLineStroke ()

Returns the line stroke for the series.

Returns
  • The stroke (never null).

public Paint getOutlinePaint ()

Returns the outline paint.

Returns
  • The outline paint (never null).

public Stroke getOutlineStroke ()

Returns the outline stroke.

Returns
  • The outline stroke (never null).

public int getSeriesIndex ()

Returns the series index for this legend item.

Returns
  • The series index.

public Comparable getSeriesKey ()

Returns the series key.

Returns
  • The series key.
See Also

public Shape getShape ()

Returns the shape used to label the series represented by this legend item.

Returns
  • The shape (never null).

public String getToolTipText ()

Returns the tool tip text.

Returns
  • The tool tip text (possibly null).

public String getURLText ()

Returns the URL text.

Returns
  • The URL text (possibly null).

public boolean isLineVisible ()

Returns a flag that indicates whether or not the line is visible.

Returns
  • A boolean.

public boolean isShapeFilled ()

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

Returns
  • A boolean.

public boolean isShapeOutlineVisible ()

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

Returns
  • A boolean.

public boolean isShapeVisible ()

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

Returns
  • A boolean.

public void setDataset (Dataset dataset)

Sets the dataset.

Parameters
dataset the dataset.

public void setDatasetIndex (int index)

Sets the dataset index for this legend item.

Parameters
index the index.
See Also

public void setFillPaint (Paint paint)

Sets the fill paint.

Parameters
paint the paint (null not permitted).

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 setLabelFont (Font font)

Sets the label font.

Parameters
font the font (null permitted).

public void setLabelPaint (Paint paint)

Sets the paint used to draw the label.

Parameters
paint the paint (null permitted).

public void setLinePaint (Paint paint)

Sets the line paint.

Parameters
paint the paint (null not permitted).

public void setOutlinePaint (Paint paint)

Sets the outline paint.

Parameters
paint the paint (null not permitted).

public void setSeriesIndex (int index)

Sets the series index for this legend item.

Parameters
index the index.

public void setSeriesKey (Comparable key)

Sets the series key.

Parameters
key the series key.