com.canto.cumulus.ui

Class Toolbar

java.lang.Object

com.canto.cumulus.ui.Toolbar

public class Toolbar
extends java.lang.Object

The Toolbar class allows you to access and modify the application's toolbar. The application has one unique instance of toolbar. A toolbar consists of ToolbarButton.

Since:

EJaP 6.0.0

Method Summary

Methods

Modifier and Type	Method and Description
void	addButton(int index, ToolbarButton button) Add a button at a specified index.
void	addButton(ToolbarButton button) Add a button at the end of the toolbar.
void	addSeparator() Adds a separator at the end of the toolbar.
void	addSeparator(int index) Adds a separator at the specified index.
int	countButtons() Returns the number of buttons in this toolbar.
ToolbarButton	getButton(int index) Returns a button by index.
ToolbarButton	getButtonByID(int id) Returns a button by ID.
java.lang.Object	getParent() Returns the parent object for this object.
void	removeButtonAt(int index) Removes a button at the specified index.

Methods inherited from class java.lang.Object

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

Method Detail

getParent

public java.lang.Object getParent()

Returns the parent object for this object.

Returns:

the Application to which this object belongs.

countButtons

public int countButtons()

Returns the number of buttons in this toolbar.

Returns:

the number of buttons in this toolbar.

getButton

public ToolbarButton getButton(int index)

Returns a button by index.

Parameters:

index - the index of the button in the toolbar.

Returns:

a button by index.

getButtonByID

public ToolbarButton getButtonByID(int id)
                            throws CumulusException

Returns a button by ID.

Parameters:

id - the button ID.

Returns:

a button by ID.

Throws:

CumulusException - if the specified button is not in the toolbar.

addButton

public void addButton(int index,
             ToolbarButton button)

Add a button at a specified index.

Parameters:

index - the index where to add the button.

button - the button to add.

addButton

public void addButton(ToolbarButton button)

Add a button at the end of the toolbar.

Parameters:

button - the button to add.

removeButtonAt

public void removeButtonAt(int index)

Removes a button at the specified index.

Parameters:

index - the index of the button to remove.

addSeparator

public void addSeparator(int index)

Adds a separator at the specified index.

Parameters:

index - the index where to add the separator.

addSeparator

public void addSeparator()

Adds a separator at the end of the toolbar.