Package com.storedobject.chart

Class Legend

java.lang.Object

com.storedobject.chart.AbstractPart

com.storedobject.chart.VisiblePart

com.storedobject.chart.Legend

All Implemented Interfaces:

Component, ComponentPart, ComponentProperty, HasPadding, HasPosition, VisibleProperty

public class Legend
extends VisiblePart
implements Component, HasPosition, HasPadding

Representation of legend. A legend will be automatically displayed by the SOChart. However, that can be turned off using SOChart.disableDefaultLegend() and customized legends may be added using SOChart.add(Component...).

Author:

Syam

Constructor Summary

Constructors

Constructor	Description
Legend()

Method Summary

Modifier and Type	Method	Description
void	encodeJSON(StringBuilder sb)	Encode the JSON string with the properties of this.
final Border	getBorder(boolean create)	Get the border.
Padding	getPadding(boolean create)	Get the padding of this on the chart display area.
final Position	getPosition(boolean create)	Get the position of this on the chart display area.
final TextStyle	getTextStyle(boolean create)	Get the text style.
void	hide(Chart chart)	Hide a chart.
void	setBorder(Border border)	Set the border.
void	setPadding(Padding padding)	Set the padding of this.
final void	setPosition(Position position)	Set the position of this.
void	setTextStyle(TextStyle textStyle)	Set the text style.
void	show(Chart chart)	Make a hidden chart visible again.
void	showVertically()	Display it vertically.
void	validate()	This method is invoked by SOChart to check if the component or part is valid or not.

Methods inherited from class com.storedobject.chart.VisiblePart

isVisible, setVisible

Methods inherited from class com.storedobject.chart.AbstractPart

equals, getId, getLabelTag, getName, getSerial, getZ, hashCode, hasId, setSerial, setZ

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.storedobject.chart.Component

addParts

Methods inherited from interface com.storedobject.chart.ComponentPart

className, getId, getName, getRenderingIndex, getSerial, setName, setRenderingIndex, setSerial

Methods inherited from interface com.storedobject.chart.VisibleProperty

hide, show

Constructor Details

Legend

public Legend()

Method Details

encodeJSON

public void encodeJSON(StringBuilder sb)

Description copied from interface: ComponentProperty

Encode the JSON string with the properties of this.

Specified by:

encodeJSON in interface ComponentProperty

Overrides:

encodeJSON in class AbstractPart

Parameters:

sb - Encoded JSON string to be appended to this.

validate

public void validate()

Description copied from interface: ComponentPart

This method is invoked by SOChart to check if the component or part is valid or not.

Specified by:

validate in interface ComponentPart

Overrides:

validate in class VisiblePart

showVertically

public void showVertically()

Display it vertically.

getPosition

public final Position getPosition(boolean create)

Description copied from interface: HasPosition

Get the position of this on the chart display area. (If true is passed as the parameter, a new position will be created if not already exists).

Specified by:

getPosition in interface HasPosition

Parameters:

create - Whether to create it or not.

Returns:

Position.

setPosition

public final void setPosition(Position position)

Description copied from interface: HasPosition

Set the position of this.

Specified by:

setPosition in interface HasPosition

Parameters:

position - Position to set.

getTextStyle

public final TextStyle getTextStyle(boolean create)

Get the text style.

Parameters:

create - Whether to create if not exists or not.

Returns:

Text style.

setTextStyle

public void setTextStyle(TextStyle textStyle)

Set the text style.

Parameters:

textStyle - Text style to set.

getPadding

public Padding getPadding(boolean create)

Description copied from interface: HasPadding

Get the padding of this on the chart display area. (If true is passed as the parameter, a new padding will be created if not already exists).

Specified by:

getPadding in interface HasPadding

Parameters:

create - Whether to create it or not.

Returns:

Padding.

setPadding

public void setPadding(Padding padding)

Description copied from interface: HasPadding

Set the padding of this.

Specified by:

setPadding in interface HasPadding

Parameters:

padding - Padding to set.

getBorder

public final Border getBorder(boolean create)

Get the border.

Parameters:

create - Whether to create if not exists or not.

Returns:

Border.

setBorder

public void setBorder(Border border)

Set the border.

Parameters:

border - Border.

hide

public void hide(Chart chart)

Hide a chart. The chart can be made visible by clicking on the legend later.

Parameters:

chart - Chart to hide.

show

public void show(Chart chart)

Make a hidden chart visible again.

Parameters:

chart - Chart to make visible.