org.jplot2d.element

Interface LegendItem

All Superinterfaces:

Element

All Known Subinterfaces:

LegendItemEx, XYLegendItemEx

All Known Implementing Classes:

LegendItemImpl, XYLegendItemImpl

public interface LegendItem
extends Element

An item in legend to show a short line and a text. It will be hosted by the legend of the plot which host the Graph. If the hosting legend is disabled, it will be hosted by legend of parent plot.

Method Summary

Modifier and Type	Method and Description
Legend	getLegend() Returns the legend who show this item
Graph	getParent() Gets the parent of this component.
float	getSymbolSize() Returns the size of the symbol draw in legend.
boolean	isVisible() returns true if this item is displayed in legend; otherwise, returns false.
void	setSymbolSize(float size) Set the size of symbol draw in legend.
void	setVisible(boolean show) Sets a flag indicating whether this item should be displayed in the legend.

Methods inherited from interface org.jplot2d.element.Element

getEnvironment, getId

Method Detail

getParent

Graph getParent()

Description copied from interface: Element

Gets the parent of this component.

Specified by:

getParent in interface Element

Returns:

the parent of this component

getLegend

Legend getLegend()

Returns the legend who show this item

Returns:

the legend who show this item

isVisible

boolean isVisible()

returns true if this item is displayed in legend; otherwise, returns false.

Returns:

the flag

setVisible

void setVisible(boolean show)

Sets a flag indicating whether this item should be displayed in the legend. The default value is true, even if the Graph is invisible.

Parameters:

show - the flag

getSymbolSize

float getSymbolSize()

Returns the size of the symbol draw in legend. The default symbol size is Float.NaN, means the same size as the symbol size of XYGraph.

Returns:

the size of the symbol draw in legend

setSymbolSize

void setSymbolSize(float size)

Set the size of symbol draw in legend. Setting to Float.NaN means the same size as the symbol size of XYGraph.

Parameters:

size - the size of symbols draw in legend