ToolbarButton (Keikai Spreadsheet Build 6.1.0.1 API)

java.lang.Object
- io.keikai.ui.ToolbarButton

All Implemented Interfaces:

Serializable, org.zkoss.json.JSONAware

Direct Known Subclasses:

DropdownToolbarButton
```
public class ToolbarButton
extends Object
implements org.zkoss.json.JSONAware, Serializable
```
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

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class ToolbarButton.Builder
Toolbar button builder

Constructor Summary

Constructors
Modifier Constructor Description

protected ToolbarButton(String key)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getIconClass()`	Returns the icon class, if any.
`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

- Constructor Detail
  - ToolbarButton
```
protected ToolbarButton(String key)
```
- 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:
  - getIconClass
```
public String getIconClass()
```
    Returns the icon class, if any.
    
    Returns:
    
    Since:
    
    5.2.0
  - 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