Package com.storedobject.chart

Class Toolbox

java.lang.Object

com.storedobject.chart.AbstractPart

com.storedobject.chart.VisiblePart

com.storedobject.chart.Toolbox

All Implemented Interfaces:

Component, ComponentPart, ComponentProperty, HasPosition

public class Toolbox
extends VisiblePart
implements Component, HasPosition

Toolbox provides certain utilities (Example: "Download the chart display as an image"). Each utility is accessed via a ToolboxButton part that can be added to the Toolbox using the method addButton(ToolboxButton...). Some standard buttons are already available as static classes in this class itself.

Author:

Syam

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Toolbox.DataView
static final class	Toolbox.Download	Download tool button.
static final class	Toolbox.Restore	Restore tool button.
static final class	Toolbox.Zoom	Zoom tool button.

Constructor Summary

Constructors

Constructor	Description
Toolbox()	Constructor.
Toolbox(ToolboxButton... buttons)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addButton(ToolboxButton... buttons)	Add too buttons.
void	encodeJSON(StringBuilder sb)	Encode the JSON string with the properties of this.
final Position	getPosition(boolean create)	Get the position of this on the chart display area.
void	removeButton(ToolboxButton... buttons)	Remove tool buttons.
final void	setPosition(Position position)	Set the position of this.
void	showVertically()	Change the orientation of the toolbox display to vertical.
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

hide, show

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, getEvents

Methods inherited from interface com.storedobject.chart.ComponentPart

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

Constructor Details

Toolbox

public Toolbox()

Constructor.

Toolbox

public Toolbox(ToolboxButton... buttons)

Constructor.

Parameters:

buttons - Buttons to add.

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 VisiblePart

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

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.

showVertically

public void showVertically()

Change the orientation of the toolbox display to vertical.

addButton

public void addButton(ToolboxButton... buttons)

Add too buttons.

Parameters:

buttons - Buttons to add.

removeButton

public void removeButton(ToolboxButton... buttons)

Remove tool buttons.

Parameters:

buttons - Buttons to remove.