Package org.opencms.ade.containerpage.client.ui

Class A_CmsToolbarOptionButton

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.google.gwt.user.client.ui.FocusWidget

com.google.gwt.user.client.ui.ButtonBase

com.google.gwt.user.client.ui.CustomButton

com.google.gwt.user.client.ui.ToggleButton

org.opencms.gwt.client.ui.CmsToggleButton

org.opencms.gwt.client.ui.A_CmsToolbarButton<CmsContainerpageHandler>

org.opencms.ade.containerpage.client.ui.A_CmsToolbarOptionButton

All Implemented Interfaces:

com.google.gwt.editor.client.IsEditor<com.google.gwt.editor.client.LeafValueEditor<java.lang.Boolean>>, com.google.gwt.event.dom.client.HasAllDragAndDropHandlers, com.google.gwt.event.dom.client.HasAllFocusHandlers, com.google.gwt.event.dom.client.HasAllGestureHandlers, com.google.gwt.event.dom.client.HasAllKeyHandlers, com.google.gwt.event.dom.client.HasAllMouseHandlers, com.google.gwt.event.dom.client.HasAllTouchHandlers, com.google.gwt.event.dom.client.HasBlurHandlers, com.google.gwt.event.dom.client.HasClickHandlers, com.google.gwt.event.dom.client.HasDoubleClickHandlers, com.google.gwt.event.dom.client.HasDragEndHandlers, com.google.gwt.event.dom.client.HasDragEnterHandlers, com.google.gwt.event.dom.client.HasDragHandlers, com.google.gwt.event.dom.client.HasDragLeaveHandlers, com.google.gwt.event.dom.client.HasDragOverHandlers, com.google.gwt.event.dom.client.HasDragStartHandlers, com.google.gwt.event.dom.client.HasDropHandlers, com.google.gwt.event.dom.client.HasFocusHandlers, com.google.gwt.event.dom.client.HasGestureChangeHandlers, com.google.gwt.event.dom.client.HasGestureEndHandlers, com.google.gwt.event.dom.client.HasGestureStartHandlers, com.google.gwt.event.dom.client.HasKeyDownHandlers, com.google.gwt.event.dom.client.HasKeyPressHandlers, com.google.gwt.event.dom.client.HasKeyUpHandlers, com.google.gwt.event.dom.client.HasMouseDownHandlers, com.google.gwt.event.dom.client.HasMouseMoveHandlers, com.google.gwt.event.dom.client.HasMouseOutHandlers, com.google.gwt.event.dom.client.HasMouseOverHandlers, com.google.gwt.event.dom.client.HasMouseUpHandlers, com.google.gwt.event.dom.client.HasMouseWheelHandlers, com.google.gwt.event.dom.client.HasTouchCancelHandlers, com.google.gwt.event.dom.client.HasTouchEndHandlers, com.google.gwt.event.dom.client.HasTouchMoveHandlers, com.google.gwt.event.dom.client.HasTouchStartHandlers, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.logical.shared.HasValueChangeHandlers<java.lang.Boolean>, com.google.gwt.event.shared.HasHandlers, com.google.gwt.safehtml.client.HasSafeHtml, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.TakesValue<java.lang.Boolean>, com.google.gwt.user.client.ui.Focusable, com.google.gwt.user.client.ui.HasEnabled, com.google.gwt.user.client.ui.HasFocus, com.google.gwt.user.client.ui.HasHorizontalAlignment, com.google.gwt.user.client.ui.HasHTML, com.google.gwt.user.client.ui.HasText, com.google.gwt.user.client.ui.HasValue<java.lang.Boolean>, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsWidget, com.google.gwt.user.client.ui.SourcesClickEvents, com.google.gwt.user.client.ui.SourcesFocusEvents, com.google.gwt.user.client.ui.SourcesKeyboardEvents, com.google.gwt.user.client.ui.SourcesMouseEvents, I_CmsToolbarButton

Direct Known Subclasses:

CmsAddToFavoritesButton, CmsToolbarEditButton, CmsToolbarInfoButton, CmsToolbarListAddButton, CmsToolbarListManagerButton, CmsToolbarMoveButton, CmsToolbarRemoveButton, CmsToolbarSelectionButton, CmsToolbarSettingsButton

public abstract class A_CmsToolbarOptionButton
extends A_CmsToolbarButton<CmsContainerpageHandler>

Abstract button class implementing common methods of I_CmsToolbarButton for container-page tool-bar buttons with element functions.

Since:

8.0.0

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.CustomButton

com.google.gwt.user.client.ui.CustomButton.Face

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasHorizontalAlignment

com.google.gwt.user.client.ui.HasHorizontalAlignment.AutoHorizontalAlignmentConstant, com.google.gwt.user.client.ui.HasHorizontalAlignment.HorizontalAlignmentConstant

Field Summary

Fields inherited from class org.opencms.gwt.client.ui.A_CmsToolbarButton

m_handler

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Fields inherited from interface com.google.gwt.user.client.ui.HasHorizontalAlignment

ALIGN_CENTER, ALIGN_DEFAULT, ALIGN_JUSTIFY, ALIGN_LEFT, ALIGN_LOCALE_END, ALIGN_LOCALE_START, ALIGN_RIGHT

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	A_CmsToolbarOptionButton(I_CmsButton.ButtonData buttonData, CmsContainerpageHandler handler)	Constructor.

Method Summary

Modifier and Type	Method	Description
CmsElementOptionButton	createOptionForElement(CmsContainerPageElementPanel element)	Creates an element options button associated with this button and assigns the click-handler.
boolean	isOptionAvailable(CmsContainerPageElementPanel element)	Checks whether an option button should be shown for a container page element.
abstract void	onElementClick(com.google.gwt.event.dom.client.ClickEvent event, CmsContainerPageElementPanel element)	Method is executed when the element option button is clicked.
void	onToolbarActivate()	Method executed when the button is activated.
void	onToolbarDeactivate()	Method executed when the button is deactivated.

Methods inherited from class org.opencms.gwt.client.ui.A_CmsToolbarButton

getButtonData, getHandler, isActive, onToolbarClick, setActive

Methods inherited from class org.opencms.gwt.client.ui.CmsToggleButton

disable, enable, getDownImageClass, getFaceHtml, getHorizontalAlignment, getImageClass, getSize, getText, getTitle, isUseMinWidth, onBrowserEvent, setButtonStyle, setDown, setDownFace, setDownImageClass, setHorizontalAlignment, setImageClass, setSize, setText, setTitle, setUpFace, setUseMinWidth

Methods inherited from class com.google.gwt.user.client.ui.ToggleButton

addValueChangeHandler, asEditor, getValue, isDown, onClick, setValue, setValue

Methods inherited from class com.google.gwt.user.client.ui.CustomButton

getDownDisabledFace, getDownFace, getDownHoveringFace, getHTML, getTabIndex, getUpDisabledFace, getUpFace, getUpHoveringFace, onAttach, onClickCancel, onClickStart, onDetach, setAccessKey, setEnabled, setFocus, setHTML, setHTML, setTabIndex

Methods inherited from class com.google.gwt.user.client.ui.FocusWidget

addBlurHandler, addClickHandler, addClickListener, addDoubleClickHandler, addDragEndHandler, addDragEnterHandler, addDragHandler, addDragLeaveHandler, addDragOverHandler, addDragStartHandler, addDropHandler, addFocusHandler, addFocusListener, addGestureChangeHandler, addGestureEndHandler, addGestureStartHandler, addKeyboardListener, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addMouseDownHandler, addMouseListener, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseUpHandler, addMouseWheelHandler, addMouseWheelListener, addTouchCancelHandler, addTouchEndHandler, addTouchMoveHandler, addTouchStartHandler, getFocusImpl, isEnabled, removeClickListener, removeFocusListener, removeKeyboardListener, removeMouseListener, removeMouseWheelListener

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, setVisible, setWidth, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.gwt.event.dom.client.HasClickHandlers

addClickHandler

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Methods inherited from interface org.opencms.gwt.client.ui.I_CmsToolbarButton

getTitle, setEnabled

Constructor Detail

A_CmsToolbarOptionButton

protected A_CmsToolbarOptionButton(I_CmsButton.ButtonData buttonData,
                                   CmsContainerpageHandler handler)

Constructor.

Parameters:

buttonData - the button data

handler - the container-page handler

Method Detail

createOptionForElement

public CmsElementOptionButton createOptionForElement(CmsContainerPageElementPanel element)

Creates an element options button associated with this button and assigns the click-handler.

If this method returns null, no option button should be shown.

Parameters:

element - the element to create the button for

Returns:

the created button

isOptionAvailable

public boolean isOptionAvailable(CmsContainerPageElementPanel element)

Checks whether an option button should be shown for a container page element.

Parameters:

element - a container page element

Returns:

true if the option should be shown for the given element

onElementClick

public abstract void onElementClick(com.google.gwt.event.dom.client.ClickEvent event,
                                    CmsContainerPageElementPanel element)

Method is executed when the element option button is clicked.

Parameters:

event - the mouse event (stop propagation if appropriate)

element - the element the option button is associated to

onToolbarActivate

public void onToolbarActivate()

Description copied from interface: I_CmsToolbarButton

Method executed when the button is activated.

See Also:

I_CmsToolbarButton.onToolbarActivate()

onToolbarDeactivate

public void onToolbarDeactivate()

Description copied from interface: I_CmsToolbarButton

Method executed when the button is deactivated.

See Also:

I_CmsToolbarButton.onToolbarDeactivate()