com.canto.cumulus.ui

Class ToolbarButton

java.lang.Object

com.canto.cumulus.ui.ToolbarButton

public class ToolbarButton
extends java.lang.Object

This class represents a toolbar button. Buttons can be modified, added and removed from a toolbar. An ActionHandler can be attached to a button which will be called when the button is clicked.

Since:

EJaP 6.0.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	PICTURE_MODE_DISABLED Key for the disabled button picture.
static int	PICTURE_MODE_NORMAL Key for the normal button picture.
static int	PICTURE_MODE_PRESSED Key for the pressed button picture.
static int	PICTURE_MODE_SELECTED Key for the selected button picture.

Constructor Summary

Constructors

Constructor and Description
ToolbarButton(Pixmap pixmap) Creates a new button with the associated picture.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getActionCommand() Gets the button action command.
ActionHandler	getActionHandler() Returns the current action handler.
int	getCommand() Returns the button command.
ActionHandler	getDefaultActionHandler() Return the default action handler implemented in the application itself.
java.lang.Object	getParent() Returns the parent object of this button.
Pixmap	getPixmap() Returns the button default's picture.
Pixmap	getPixmap(int mode) Returns the button picture for the specified mode.
java.lang.String	getText() Returns the text of the button, if the button is a text field button.
java.lang.String	getTooltip() Returns the tooltip string associated with this button.
boolean	isEnabled() Returns the state of this button.
boolean	isSeparator() Returns whether the button is a separator.
boolean	isText() Returns whether the button is a text field button.
void	setActionCommand(java.lang.String actionCommand) Sets the button action command.
ActionHandler	setActionHandler(ActionHandler handler) Sets the action handler for this button.
void	setEnabled(boolean bEnabled) Sets the state of this button
void	setPixmap(int mode, Pixmap pixmap) Set the button's picture for the specified mode.
void	setPixmap(Pixmap pixmap) Sets the default button's picture.
void	setTooltip(java.lang.String sTooltip) Sets the tooltip string for this button.

Methods inherited from class java.lang.Object

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

Field Detail

PICTURE_MODE_NORMAL

public static final int PICTURE_MODE_NORMAL

Key for the normal button picture.

See Also:

Constant Field Values

PICTURE_MODE_DISABLED

public static final int PICTURE_MODE_DISABLED

Key for the disabled button picture.

See Also:

Constant Field Values

PICTURE_MODE_SELECTED

public static final int PICTURE_MODE_SELECTED

Key for the selected button picture.

See Also:

Constant Field Values

PICTURE_MODE_PRESSED

public static final int PICTURE_MODE_PRESSED

Key for the pressed button picture.

See Also:

Constant Field Values

Constructor Detail

ToolbarButton

public ToolbarButton(Pixmap pixmap)

Creates a new button with the associated picture.

Parameters:

pixmap - the button default's picture.

Method Detail

getParent

public java.lang.Object getParent()

Returns the parent object of this button.

Returns:

the Toolbar to which this button belongs.

getCommand

public int getCommand()

Returns the button command.

Returns:

the button command.

isSeparator

public boolean isSeparator()

Returns whether the button is a separator.

Returns:

true if the button is a separator; false otherwise.

isText

public boolean isText()

Returns whether the button is a text field button.

Returns:

true if the button is a text field button; false otherwise.

getPixmap

public Pixmap getPixmap()

Returns the button default's picture.

Returns:

the button default's picture.

getPixmap

public Pixmap getPixmap(int mode)

Returns the button picture for the specified mode.

Parameters:

mode - the picture mode. Possible values are:

• PICTURE_MODE_NORMAL
• PICTURE_MODE_DISABLED
• PICTURE_MODE_PRESSED
• PICTURE_MODE_SELECTED

Returns:

the button picture.

setPixmap

public void setPixmap(Pixmap pixmap)

Sets the default button's picture.

Parameters:

pixmap - the picture.

setPixmap

public void setPixmap(int mode,
             Pixmap pixmap)

Set the button's picture for the specified mode.
For example:

 class MyClass
 {
     private Pixmap loadPNGPixmap (String name)
     {
         return Pixmap.createPixmapFromPNG(getClass().getResourceAsStream (name));
     }
     ...
     Pixmap normalPixmap = loadPNGPixmap("MyImage.png");
     Pixmap selectedPixmap = loadPNGPixmap("MySelectedImage.png");
     ToolbarButton myButton = new ToolbarButton(normalPixmap);
     myButton.setPixmap(ToolbarButton.PICTURE_MODE_SELECTED, selectedPixmap);
     ...
 }
 

Parameters:

mode - the picture mode. Possible values are:

• PICTURE_MODE_NORMAL
• PICTURE_MODE_DISABLED
• PICTURE_MODE_PRESSED
• PICTURE_MODE_SELECTED

pixmap - the picture.

setActionCommand

public void setActionCommand(java.lang.String actionCommand)

Sets the button action command.

Parameters:

actionCommand - a string that may specify a command associated with the item.

getActionCommand

public java.lang.String getActionCommand()

Gets the button action command.

Returns:

a string that specifies a command associated with the item.

setEnabled

public void setEnabled(boolean bEnabled)

Sets the state of this button

Parameters:

bEnabled - true if the button should be enabled; false otherwise.

isEnabled

public boolean isEnabled()

Returns the state of this button.

Returns:

true if the button is enabled; false otherwise.

getTooltip

public java.lang.String getTooltip()

Returns the tooltip string associated with this button.

Returns:

the tooltip string associated with this button.

setTooltip

public void setTooltip(java.lang.String sTooltip)

Sets the tooltip string for this button.

Parameters:

sTooltip - the tooltip string for this button.

getText

public java.lang.String getText()

Returns the text of the button, if the button is a text field button.

Returns:

the text of the button, if the button is a text field button, null otherwise.

setActionHandler

public ActionHandler setActionHandler(ActionHandler handler)

Sets the action handler for this button. This replaces the previously installed handler which is returned.
For example:

 class MyClass implements ActionHandler
 {
      ...
      ToolbarButton button = new ToolbarButton(pixmap);
      button.setActionCommand("MyCommand");
      button.setActionHandler(this);
      Application.getInstance().getToolbar().addButton(button);

      public void handleAction (ActionEvent e)
      {
          ToolbarButton button = (ToolbarButton) e.getSource();
          String cmd = button.getActionCommand();

          if (cmd.equals("MyCommand"))
          {
               JOptionPane.showMessageDialog(null, "Button " + button + " was clicked\n");
          }
      }
      ...
 }
 

Parameters:

handler - the new action handler.

Returns:

the previously installed handler.

getActionHandler

public ActionHandler getActionHandler()

Returns the current action handler.

Returns:

the current action handler.

getDefaultActionHandler

public ActionHandler getDefaultActionHandler()

Return the default action handler implemented in the application itself.

Returns:

the default (built-in) action handler.