Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.jfree.chart

Class LegendItem

Implemented Interfaces:
Serializable
public class LegendItem
extends java.lang.Object
implements Serializable
A temporary storage object for recording the properties of a legend item, without any consideration for layout issues.

Constructor Summary

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

Method Summary

boolean
equals(Object obj)
Tests this item for equality with an arbitrary object.
AttributedString
getAttributedLabel()
Returns the attributed label.
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.
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.
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
setDatasetIndex(int index)
Sets the dataset index for this legend item.
void
setFillPaintTransformer(GradientPaintTransformer transformer)
Sets the transformer used when the fill paint is an instance of GradientPaint.
void
setSeriesIndex(int index)
Sets the series index for this legend item.

Constructor Details

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.
lineStroke - the stroke (null not permitted).
linePaint - the line paint (null not permitted).

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

Method Details

equals

public boolean equals(Object obj)
Tests this item for equality with an arbitrary object.
Parameters:
obj - the object (null permitted).
Returns:
A boolean.

getAttributedLabel

public AttributedString getAttributedLabel()
Returns the attributed label.
Returns:
The attributed label (possibly null).

getDatasetIndex

public int getDatasetIndex()
Returns the dataset index for this legend item.
Returns:
The dataset index.
Since:
1.0.2

getDescription

public String getDescription()
Returns the description for the legend item.
Returns:
The description.

getFillPaint

public Paint getFillPaint()
Returns the fill paint.
Returns:
The fill paint (never null).

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
See Also:
setFillPaintTransformer(GradientPaintTransformer)

getLabel

public String getLabel()
Returns the label.
Returns:
The label (never null).

getLine

public Shape getLine()
Returns the line.
Returns:
The line.

getLinePaint

public Paint getLinePaint()
Returns the paint used for lines.
Returns:
The paint.

getLineStroke

public Stroke getLineStroke()
Returns the line stroke for the series.
Returns:
The stroke (never null).

getOutlinePaint

public Paint getOutlinePaint()
Returns the outline paint.
Returns:
The outline paint (never null).

getOutlineStroke

public Stroke getOutlineStroke()
Returns the outline stroke.
Returns:
The outline stroke (never null).

getSeriesIndex

public int getSeriesIndex()
Returns the series index for this legend item.
Returns:
The series index.
Since:
1.0.2

getShape

public Shape getShape()
Returns the shape used to label the series represented by this legend item.
Returns:
The shape (never null).

getToolTipText

public String getToolTipText()
Returns the tool tip text.
Returns:
The tool tip text (possibly null).

getURLText

public String getURLText()
Returns the URL text.
Returns:
The URL text (possibly null).

isLineVisible

public boolean isLineVisible()
Returns a flag that indicates whether or not the line is visible.
Returns:
A boolean.

isShapeFilled

public boolean isShapeFilled()
Returns a flag that controls whether or not the shape is filled.
Returns:
A boolean.

isShapeOutlineVisible

public boolean isShapeOutlineVisible()
Returns the flag that controls whether or not the shape outline is visible.
Returns:
A boolean.

isShapeVisible

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

setDatasetIndex

public void setDatasetIndex(int index)
Sets the dataset index for this legend item.
Parameters:
index - the index.
Since:
1.0.2

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
See Also:
getFillPaintTransformer()

setSeriesIndex

public void setSeriesIndex(int index)
Sets the series index for this legend item.
Parameters:
index - the index.
Since:
1.0.2

Overview Package Class Use Source Tree Index Deprecated About