Package org.opencms.gwt.client.ui
Interface I_CmsToolbarButton
-
- All Superinterfaces:
com.google.gwt.event.dom.client.HasClickHandlers
,com.google.gwt.event.shared.HasHandlers
- All Known Implementing Classes:
A_CmsToolbarButton
,A_CmsToolbarMenu
,A_CmsToolbarOptionButton
,CmsAddToFavoritesButton
,CmsQuickLauncher
,CmsToolbarAllGalleriesMenu
,CmsToolbarClipboardMenu
,CmsToolbarContextButton
,CmsToolbarEditButton
,CmsToolbarElementInfoButton
,CmsToolbarFavLocationButton
,CmsToolbarGalleryMenu
,CmsToolbarInfoButton
,CmsToolbarListAddButton
,CmsToolbarListManagerButton
,CmsToolbarMoveButton
,CmsToolbarPublishButton
,CmsToolbarPublishButton
,CmsToolbarRemoveButton
,CmsToolbarResetButton
,CmsToolbarSaveButton
,CmsToolbarSelectionButton
,CmsToolbarSelectionButton
,CmsToolbarSettingsButton
,CmsToolbarSitemapButton
,CmsUserInfo
public interface I_CmsToolbarButton extends com.google.gwt.event.dom.client.HasClickHandlers
Interface for all tool-bar buttons.- Since:
- 8.0.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getTitle()
Returns the localized button title.boolean
isActive()
Returns whether this button is active (pushed, not disabled).void
onToolbarActivate()
Method executed when the button is activated.void
onToolbarClick()
Executed when the tool-bar button is clicked.void
onToolbarDeactivate()
Method executed when the button is deactivated.void
setActive(boolean active)
Sets the button to active (pushed, not disabled).void
setEnabled(boolean enabled)
Enables or disables the button.
-
-
-
Method Detail
-
getTitle
java.lang.String getTitle()
Returns the localized button title. Will show in tool-tip.- Returns:
- the button title
-
isActive
boolean isActive()
Returns whether this button is active (pushed, not disabled).- Returns:
true
if the button is active
-
onToolbarActivate
void onToolbarActivate()
Method executed when the button is activated.
-
onToolbarClick
void onToolbarClick()
Executed when the tool-bar button is clicked.
-
onToolbarDeactivate
void onToolbarDeactivate()
Method executed when the button is deactivated.
-
setActive
void setActive(boolean active)
Sets the button to active (pushed, not disabled).- Parameters:
active
-true
if active
-
setEnabled
void setEnabled(boolean enabled)
Enables or disables the button.- Parameters:
enabled
- if true, enable the button, else disable it
-
-