com.infragistics.faces.chart.component
Class Legend

java.lang.Object
  com.infragistics.faces.shared.component.ModelComponent
      com.infragistics.faces.chart.component.Legend

All Implemented Interfaces:

java.io.Serializable

public class Legend

extends ModelComponent

A legend displays tabular information related to the data presented in the chart component.

The legend table may contain as many columns as required by the user. Columns are added by defining column headers in the Legend itself, or by defining column entries in the individual LegendItems.

For the most part, the legend is populated automatically with little or no user intervention.

See Also:

Serialized Form

Constructor Summary

Legend()

Method Summary

java.lang.String	getHeaders() Returns the collection of column header strings.
java.lang.String	getHeaderStyleClass() Returns the CSS style class applied to this legend's column headers.
java.util.List	getItems() Returns the collection of nested legend items.
java.lang.String	getItemStyleClass() Returns the default style class for nested legend items.
java.lang.String	getPosition() Returns the automatic layout positioning flag.
java.lang.String	getStyle() Returns the CSS style applied when this legend is rendered.
java.lang.String	getStyleClass() Returns the CSS style applied when this legend is rendered.
boolean	isAutoItems() Returns the flag to indicate that this legend should be automatically populated from chart series/datapoints.
void	setAutoItems(boolean autoItems) Sets the flag to indicate that this legend should be automatically populated from chart series/datapoints.
void	setHeaders(java.lang.String headers) Sets the collection of column header strings.
void	setHeaderStyleClass(java.lang.String headerStyleClass) Sets the CSS style class applied to this legend's column headers.
void	setItems(java.util.List items) Sets the collection of nested legend items.
void	setItemStyleClass(java.lang.String itemStyleClass) Sets the default style class for nested legend items.
void	setPosition(java.lang.String position) Sets the automatic layout positioning flag.
void	setStyle(java.lang.String style) Sets the CSS style applied when this legend is rendered.
void	setStyleClass(java.lang.String styleClass) Sets the CSS style applied when this legend is rendered.

Methods inherited from class com.infragistics.faces.shared.component.ModelComponent

getParent, getValueBinding, setParent, setValueBinding

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Legend

public Legend()

Method Detail

isAutoItems

public boolean isAutoItems()

Returns the flag to indicate that this legend should be automatically populated from chart series/datapoints.

Returns:

boolean

setAutoItems

public void setAutoItems(boolean autoItems)

Sets the flag to indicate that this legend should be automatically populated from chart series/datapoints.

Parameters:

autoItems - boolean

getHeaders

public java.lang.String getHeaders()

Returns the collection of column header strings.

Returns:

java.lang.String

setHeaders

public void setHeaders(java.lang.String headers)

Sets the collection of column header strings.

Parameters:

headers - String

getHeaderStyleClass

public java.lang.String getHeaderStyleClass()

Returns the CSS style class applied to this legend's column headers.

Returns:

java.lang.String

setHeaderStyleClass

public void setHeaderStyleClass(java.lang.String headerStyleClass)

Sets the CSS style class applied to this legend's column headers.

Parameters:

headerStyleClass - String

getItems

public java.util.List getItems()

Returns the collection of nested legend items.

Returns:

com.infragistics.faces.chart.component.LegendItem

setItems

public void setItems(java.util.List items)

Sets the collection of nested legend items.

Parameters:

items - java.util.List

getItemStyleClass

public java.lang.String getItemStyleClass()

Returns the default style class for nested legend items.

Returns:

java.lang.String

setItemStyleClass

public void setItemStyleClass(java.lang.String itemStyleClass)

Sets the default style class for nested legend items.

Parameters:

itemStyleClass - String

getPosition

public java.lang.String getPosition()

Returns the automatic layout positioning flag.

Returns:

com.infragistics.faces.shared.enumeration.Position (bottom, left, right, top)

setPosition

public void setPosition(java.lang.String position)

Sets the automatic layout positioning flag.

Parameters:

position - String (bottom, left, right, top)

getStyle

public java.lang.String getStyle()

Returns the CSS style applied when this legend is rendered.

Returns:

java.lang.String

setStyle

public void setStyle(java.lang.String style)

Sets the CSS style applied when this legend is rendered.

Parameters:

style - String

getStyleClass

public java.lang.String getStyleClass()

Returns the CSS style applied when this legend is rendered.

Returns:

java.lang.String

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Sets the CSS style applied when this legend is rendered.

Parameters:

styleClass - String