Package com.storedobject.chart

Class ToolboxButton

java.lang.Object

com.storedobject.chart.AbstractPart

com.storedobject.chart.VisiblePart

com.storedobject.chart.ToolboxButton

All Implemented Interfaces:

ComponentPart, ComponentProperty, VisibleProperty

Direct Known Subclasses:

Toolbox.DataView, Toolbox.Download, Toolbox.Restore, Toolbox.Zoom

public abstract class ToolboxButton
extends VisiblePart

This is the base class for creating "toolbox buttons" that can be added to Toolbox. A standard set of "toolbox buttons" are available as static classes within Toolbox. However, support for "custom toolbox buttons" is not yet implemented.

Author:

Syam

Constructor Summary

Constructors

Constructor	Description
ToolboxButton()

Method Summary

Modifier and Type	Method	Description
protected void	encodeCaptionJSON(StringBuilder sb)	Encode caption part here.
void	encodeJSON(StringBuilder sb)	Encode the JSON string with the properties of this.
String	getCaption()	Get the caption for this (will be shown as a tooltip).
void	setCaption(String caption)	Set the caption for this (will be shown as a tooltip).

Methods inherited from class com.storedobject.chart.VisiblePart

isVisible, setVisible, validate

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.ComponentPart

className, getRenderingIndex, setName, setRenderingIndex

Methods inherited from interface com.storedobject.chart.VisibleProperty

hide, show

Constructor Details

ToolboxButton

public ToolboxButton()

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.

encodeCaptionJSON

protected void encodeCaptionJSON(StringBuilder sb)

Encode caption part here. The default implementation does what is necessary to handle the return value of getCaption().

Parameters:

sb - Append the encoded stuff to this.

getCaption

public String getCaption()

Get the caption for this (will be shown as a tooltip).

Returns:

Caption.

setCaption

public void setCaption(String caption)

Set the caption for this (will be shown as a tooltip).

Parameters:

caption - Caption.