Modifier and Type	Class and Description
public static class	Legend.LegendItem A item to be displayed on a Legend

Field Summary

Modifier and Type	Field and Description
private static final int	GAP
private ObjectProperty<ObservableList<Legend.LegendItem>>	items The legend items to display in this legend
private ListChangeListener<Legend.LegendItem>	itemsListener
private BooleanProperty	vertical The legend items should be laid out vertically in columns rather than horizontally in rows

Constructor Summary

Access	Constructor and Description
public	Legend()

Method Summary

Modifier and Type	Method and Description
protected double	computePrefHeight(double the width that should be used if preferred height depends on it forWidth) Overrides javafx.scene.layout.TilePane.computePrefHeight. Computes the preferred height of this region for the given width; Region subclasses should override this method to return an appropriate value based on their content and layout strategy.
protected double	computePrefWidth(double the height that should be used if preferred width depends on it forHeight) Overrides javafx.scene.layout.TilePane.computePrefWidth. Computes the preferred width of this region for the given height.
public final ObservableList<Legend.LegendItem>	getItems()
public final boolean	isVertical()
public final ObjectProperty<ObservableList<Legend.LegendItem>>	itemsProperty()
public final void	setItems(ObservableList<Legend.LegendItem> value)
public final void	setVertical(boolean value)
public final BooleanProperty	verticalProperty()

Field Detail

GAP	back to summary
private static final int GAP

items	back to summary
private ObjectProperty<ObservableList<Legend.LegendItem>> items The legend items to display in this legend

itemsListener	back to summary
private ListChangeListener<Legend.LegendItem> itemsListener

vertical	back to summary
private BooleanProperty vertical The legend items should be laid out vertically in columns rather than horizontally in rows

Constructor Detail

Legend	back to summary
public Legend()

Method Detail

computePrefHeight	back to summary
protected double computePrefHeight(double forWidth) Overrides javafx.scene.layout.TilePane.computePrefHeight. Doc from javafx.scene.layout.Region.computePrefHeight. Computes the preferred height of this region for the given width; Region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a HORIZONTAL content bias, then the width parameter can be ignored. Parameters forWidth:double Doc from javafx.scene.Parent.computePrefHeight. the width that should be used if preferred height depends on it Returns:double the computed preferred height for this region Annotations @Override

computePrefHeight

back to summary

protected double computePrefHeight(double forWidth)

Overrides javafx.scene.layout.TilePane.computePrefHeight.

Doc from javafx.scene.layout.Region.computePrefHeight.

Computes the preferred height of this region for the given width; Region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a HORIZONTAL content bias, then the width parameter can be ignored.

Parameters

forWidth:double

Doc from javafx.scene.Parent.computePrefHeight.

the width that should be used if preferred height depends on it

Returns:double

the computed preferred height for this region

Annotations

@Override

computePrefWidth	back to summary
protected double computePrefWidth(double forHeight) Overrides javafx.scene.layout.TilePane.computePrefWidth. Doc from javafx.scene.layout.Region.computePrefWidth. Computes the preferred width of this region for the given height. Region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a VERTICAL content bias, then the height parameter can be ignored. Parameters forHeight:double Doc from javafx.scene.Parent.computePrefWidth. the height that should be used if preferred width depends on it Returns:double the computed preferred width for this region Annotations @Override

computePrefWidth

back to summary

protected double computePrefWidth(double forHeight)

Overrides javafx.scene.layout.TilePane.computePrefWidth.

Doc from javafx.scene.layout.Region.computePrefWidth.

Computes the preferred width of this region for the given height. Region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a VERTICAL content bias, then the height parameter can be ignored.

Parameters

forHeight:double

Doc from javafx.scene.Parent.computePrefWidth.

the height that should be used if preferred width depends on it

Returns:double

the computed preferred width for this region

Annotations

@Override

getItems	back to summary
public final ObservableList<Legend.LegendItem> getItems()

isVertical	back to summary
public final boolean isVertical()

itemsProperty	back to summary
public final ObjectProperty<ObservableList<Legend.LegendItem>> itemsProperty()

setItems	back to summary
public final void setItems(ObservableList<Legend.LegendItem> value)

setVertical	back to summary
public final void setVertical(boolean value)

verticalProperty	back to summary
public final BooleanProperty verticalProperty()

com.sun.javafx.charts back to summary

public Class Legend.LegendItem

Class Inheritance

extends Object

java.lang.Object
com.sun.javafx.charts.Legend.LegendItem

A item to be displayed on a Legend

Field Summary

Modifier and Type	Field and Description
private Label	label Label used to represent the legend item
private ObjectProperty<Node>	symbol The symbol to use next to the item text, set to null for no symbol.
private StringProperty	text The item text

Constructor Summary

Access	Constructor and Description
public	LegendItem(String text)
public	LegendItem(String text, Node symbol)

Method Summary

Modifier and Type	Method and Description
public final Node	getSymbol()
public final String	getText()
public final void	setSymbol(Node value)
public final void	setText(String value)
public final ObjectProperty<Node>	symbolProperty()
public final StringProperty	textProperty()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

label	back to summary
private Label label Label used to represent the legend item

symbol	back to summary
private ObjectProperty<Node> symbol The symbol to use next to the item text, set to null for no symbol. The default is a simple square of symbolFill

text	back to summary
private StringProperty text The item text

Constructor Detail

LegendItem	back to summary
public LegendItem(String text)

LegendItem	back to summary
public LegendItem(String text, Node symbol)

Method Detail

getSymbol	back to summary
public final Node getSymbol()

getText	back to summary
public final String getText()

setSymbol	back to summary
public final void setSymbol(Node value)

setText	back to summary
public final void setText(String value)

symbolProperty	back to summary
public final ObjectProperty<Node> symbolProperty()

textProperty	back to summary
public final StringProperty textProperty()

public Class Legend

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class Legend.LegendItem

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail