io.keikai.ui

Class ToolbarButton

java.lang.Object

io.keikai.ui.ToolbarButton

All Implemented Interfaces:

org.zkoss.json.JSONAware

public class ToolbarButton
extends Object
implements org.zkoss.json.JSONAware

A toolbar button for Spreadsheet component (Immutable).

If the button's key is duplicated in AuxAction.getAction(), then the getTemplateURI() will be ignored and using the default template instead. Due to this limitation, you can remove the default button's key and then add a new toolbar button with an extra key which provides a different behavior implementation for it.

Since:

5.0.0

Author:

jumperchen

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ToolbarButton.Builder Toolbar button builder

Method Summary

Modifier and Type	Method and Description
String	getIconURI() Returns the icon uri, if any.
String	getKey() Returns the button key.
String	getLabel() Returns the button label.
String	getTemplateURI() Returns the template uri, if any.
String	getTooltip() Returns the tooltip text, if any.
String	toJSONString()

Methods inherited from class java.lang.Object

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

Method Detail

getKey

public String getKey()

Returns the button key.

Returns:

getLabel

public String getLabel()

Returns the button label.

Returns:

getIconURI

public String getIconURI()

Returns the icon uri, if any.

Returns:

getTooltip

public String getTooltip()

Returns the tooltip text, if any.

Returns:

getTemplateURI

public String getTemplateURI()

Returns the template uri, if any.

Returns:

toJSONString

public String toJSONString()

Specified by:

toJSONString in interface org.zkoss.json.JSONAware