| java.lang.Object org.jfree.chart.LegendItem
LegendItem | public class LegendItem implements Serializable(Code) | | A temporary storage object for recording the properties of a legend item,
without any consideration for layout issues.
|
Constructor Summary | |
public | LegendItem(String label, String description, String toolTipText, String urlText, Shape shape, Paint fillPaint) Creates a legend item with a filled shape. | 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. | public | LegendItem(String label, String description, String toolTipText, String urlText, Shape line, Stroke lineStroke, Paint linePaint) Creates a legend item using a line. | 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. | public | LegendItem(AttributedString label, String description, String toolTipText, String urlText, Shape shape, Paint fillPaint) Creates a legend item with a filled shape. | 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. | public | LegendItem(AttributedString label, String description, String toolTipText, String urlText, Shape line, Stroke lineStroke, Paint linePaint) Creates a legend item using a line. | 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. |
LegendItem | public LegendItem(String label, String description, String toolTipText, String urlText, Shape shape, Paint fillPaint)(Code) | | 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). Parameters: description - the description (null permitted). Parameters: toolTipText - the tool tip text (null permitted). Parameters: urlText - the URL text (null permitted). Parameters: shape - the shape (null not permitted). Parameters: 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)(Code) | | Creates a legend item with a filled and outlined shape.
Parameters: label - the label (null not permitted). Parameters: description - the description (null permitted). Parameters: toolTipText - the tool tip text (null permitted). Parameters: urlText - the URL text (null permitted). Parameters: shape - the shape (null not permitted). Parameters: fillPaint - the paint used to fill the shape (null not permitted). Parameters: outlineStroke - the outline stroke (null not permitted). Parameters: outlinePaint - the outline paint (null not permitted). |
LegendItem | public LegendItem(String label, String description, String toolTipText, String urlText, Shape line, Stroke lineStroke, Paint linePaint)(Code) | | Creates a legend item using a line.
Parameters: label - the label (null not permitted). Parameters: description - the description (null permitted). Parameters: toolTipText - the tool tip text (null permitted). Parameters: urlText - the URL text (null permitted). Parameters: line - the line (null not permitted). Parameters: lineStroke - the line stroke (null not permitted). Parameters: 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)(Code) | | Creates a new legend item.
Parameters: label - the label (null not permitted). Parameters: description - the description (not currently used, null permitted). Parameters: toolTipText - the tool tip text (null permitted). Parameters: urlText - the URL text (null permitted). Parameters: shapeVisible - a flag that controls whether or not the shape is displayed. Parameters: shape - the shape (null permitted). Parameters: shapeFilled - a flag that controls whether or not the shape is filled. Parameters: fillPaint - the fill paint (null not permitted). Parameters: shapeOutlineVisible - a flag that controls whether or not the shape is outlined. Parameters: outlinePaint - the outline paint (null not permitted). Parameters: outlineStroke - the outline stroke (null not permitted). Parameters: lineVisible - a flag that controls whether or not the line is visible. Parameters: line - the line. Parameters: lineStroke - the stroke (null not permitted). Parameters: linePaint - the line paint (null not permitted). |
LegendItem | public LegendItem(AttributedString label, String description, String toolTipText, String urlText, Shape shape, Paint fillPaint)(Code) | | 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). Parameters: description - the description (null permitted). Parameters: toolTipText - the tool tip text (null permitted). Parameters: urlText - the URL text (null permitted). Parameters: shape - the shape (null not permitted). Parameters: 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)(Code) | | Creates a legend item with a filled and outlined shape.
Parameters: label - the label (null not permitted). Parameters: description - the description (null permitted). Parameters: toolTipText - the tool tip text (null permitted). Parameters: urlText - the URL text (null permitted). Parameters: shape - the shape (null not permitted). Parameters: fillPaint - the paint used to fill the shape (null not permitted). Parameters: outlineStroke - the outline stroke (null not permitted). Parameters: outlinePaint - the outline paint (null not permitted). |
LegendItem | public LegendItem(AttributedString label, String description, String toolTipText, String urlText, Shape line, Stroke lineStroke, Paint linePaint)(Code) | | Creates a legend item using a line.
Parameters: label - the label (null not permitted). Parameters: description - the description (null permitted). Parameters: toolTipText - the tool tip text (null permitted). Parameters: urlText - the URL text (null permitted). Parameters: line - the line (null not permitted). Parameters: lineStroke - the line stroke (null not permitted). Parameters: 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)(Code) | | Creates a new legend item.
Parameters: label - the label (null not permitted). Parameters: description - the description (not currently used, null permitted). Parameters: toolTipText - the tool tip text (null permitted). Parameters: urlText - the URL text (null permitted). Parameters: shapeVisible - a flag that controls whether or not the shape is displayed. Parameters: shape - the shape (null permitted). Parameters: shapeFilled - a flag that controls whether or not the shape is filled. Parameters: fillPaint - the fill paint (null not permitted). Parameters: shapeOutlineVisible - a flag that controls whether or not the shape is outlined. Parameters: outlinePaint - the outline paint (null not permitted). Parameters: outlineStroke - the outline stroke (null not permitted). Parameters: lineVisible - a flag that controls whether or not the line is visible. Parameters: line - the line. Parameters: lineStroke - the stroke (null not permitted). Parameters: linePaint - the line paint (null not permitted). |
equals | public boolean equals(Object obj)(Code) | | Tests this item for equality with an arbitrary object.
Parameters: obj - the object (null permitted). A boolean. |
getAttributedLabel | public AttributedString getAttributedLabel()(Code) | | Returns the attributed label.
The attributed label (possibly null ). |
getDescription | public String getDescription()(Code) | | Returns the description for the legend item.
The description. |
getFillPaint | public Paint getFillPaint()(Code) | | Returns the fill paint.
The fill paint (never null ). |
getLabel | public String getLabel()(Code) | | Returns the label.
The label (never null ). |
getLine | public Shape getLine()(Code) | | Returns the line.
The line. |
getLinePaint | public Paint getLinePaint()(Code) | | Returns the paint used for lines.
The paint. |
getLineStroke | public Stroke getLineStroke()(Code) | | Returns the line stroke for the series.
The stroke (never null ). |
getOutlinePaint | public Paint getOutlinePaint()(Code) | | Returns the outline paint.
The outline paint (never null ). |
getOutlineStroke | public Stroke getOutlineStroke()(Code) | | Returns the outline stroke.
The outline stroke (never null ). |
getSeriesIndex | public int getSeriesIndex()(Code) | | Returns the series index for this legend item.
The series index. since: 1.0.2 |
getShape | public Shape getShape()(Code) | | Returns the shape used to label the series represented by this legend
item.
The shape (never null ). |
getToolTipText | public String getToolTipText()(Code) | | Returns the tool tip text.
The tool tip text (possibly null ). |
getURLText | public String getURLText()(Code) | | Returns the URL text.
The URL text (possibly null ). |
isLineVisible | public boolean isLineVisible()(Code) | | Returns a flag that indicates whether or not the line is visible.
A boolean. |
isShapeFilled | public boolean isShapeFilled()(Code) | | Returns a flag that controls whether or not the shape is filled.
A boolean. |
isShapeOutlineVisible | public boolean isShapeOutlineVisible()(Code) | | Returns the flag that controls whether or not the shape outline
is visible.
A boolean. |
isShapeVisible | public boolean isShapeVisible()(Code) | | Returns a flag that indicates whether or not the shape is visible.
A boolean. |
setDataset | public void setDataset(Dataset dataset)(Code) | | Sets the dataset.
Parameters: dataset - the dataset. since: 1.0.6 |
setDatasetIndex | public void setDatasetIndex(int index)(Code) | | Sets the dataset index for this legend item.
Parameters: index - the index. since: 1.0.2 See Also: LegendItem.getDatasetIndex() |
setFillPaintTransformer | public void setFillPaintTransformer(GradientPaintTransformer transformer)(Code) | | 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: LegendItem.getFillPaintTransformer() |
setSeriesIndex | public void setSeriesIndex(int index)(Code) | | Sets the series index for this legend item.
Parameters: index - the index. since: 1.0.2 |
setSeriesKey | public void setSeriesKey(Comparable key)(Code) | | Sets the series key.
Parameters: key - the series key. since: 1.0.6 |
|
|