net.sf.basedb.clients.web.extensions.toolbar
Interface ButtonAction

All Superinterfaces:

Action

All Known Implementing Classes:

Button, ButtonBean, FixedButtonFactory

public interface ButtonAction
extends Action

Actions represented as buttons in a toolbar.

Version:

2.7

Author:

nicklas

Last modified

$Date:2008-03-20 12:15:25 +0100 (Thu, 20 Mar 2008) $

Method Summary

String	getClazz() Class attribute of the main button tag.
String	getIcon() Get a reference to an image that will be displayed in the menu.
String	getId() ID attribute of the main button tag.
String	getOnClick() A javascript action that is executed when the user clicks on the button.
String	getStyle() Extra CSS style attributes that will be added to the style attribute of the main button tag.
String	getTitle() Get the title of the button.
String	getTooltip() A tooltip that is shown as a yellow popup when the user points the mouse at the button.
boolean	isEnabled() If the button should be enabled or disabled.
boolean	isVisible() If the button should be visible or not.

Method Detail

getId

String getId()

ID attribute of the main button tag. You need to set this value to reference the button in a javascript.

Returns:

The ID, or null

getClazz

String getClazz()

Class attribute of the main button tag. The default value is "button".

Returns:

Class attribute, or null to use the default "button"

getStyle

String getStyle()

Extra CSS style attributes that will be added to the style attribute of the main button tag.

Returns:

Style attributes, or null

getTitle

String getTitle()

Get the title of the button.

getTooltip

String getTooltip()

A tooltip that is shown as a yellow popup when the user points the mouse at the button.

Returns:

The tooltip or null to not display any tooltip

getIcon

String getIcon()

Get a reference to an image that will be displayed in the menu. It is recommended that the image is 16x16 pixels to line up with the other icons used by the BASE.

Returns:

A reference to an image, or null if no image should be used

isEnabled

boolean isEnabled()

If the button should be enabled or disabled.

isVisible

boolean isVisible()

If the button should be visible or not.

getOnClick

String getOnClick()

A javascript action that is executed when the user clicks on the button.

Returns:

The javascript action