Package org.opencms.gwt.client.ui

Class CmsPushButton

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.PushButton
org.opencms.gwt.client.ui.CmsPushButton
All Implemented Interfaces:
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.shared.HasHandlers, com.google.gwt.safehtml.client.HasSafeHtml, com.google.gwt.user.client.EventListener, 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.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
Direct Known Subclasses:
CmsAddOptionButton, CmsAttributeValueView.MoveHandle, CmsEditOptionButton, CmsElementOptionButton, CmsFavoritesOptionButton, CmsHoverbarCreateGalleryButton, CmsHoverbarCreateModelPageButton, CmsHoverbarMoveButton, CmsInfoOptionButton, CmsInheritedOptionButton, CmsListItem.MoveHandle, CmsMoveOptionButton, CmsPropertyDefinitionButton, CmsRemoveOptionButton, CmsScrollPanel.ResizeButton, CmsSettingsOptionButton, CmsToolbarGoBackButton, CmsToolbarGoToParentButton, CmsToolbarPublishButton
public class CmsPushButton extends com.google.gwt.user.client.ui.PushButton implements com.google.gwt.user.client.ui.HasHorizontalAlignment
Push button class.

Uses CSS classes cmsState and dependent from 'button.css', make sure it is injected.

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 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
    Constructor
    Description
    CmsPushButton()
    The constructor.
    CmsPushButton(String imageClass)
    The constructor.
    CmsPushButton(String imageClass, String downImageClass)
    The constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    clearHoverState()
    Clears the hover state of the button.
    void
    disable(String disabledReason)
    Disables the button and changes the button title attribute to the disabled reason.
    void
    enable()
    Enables the button, switching the button title attribute from the disabled reason to the original title.
    String
    getDisabledReason()
    Returns the disabled reason.
    String
    getDownImageClass()
    Returns the image class of the down face.
    protected String
    getFaceHtml(String text, String imageClass)
    Convenience method to assemble the HTML to use for a button face.
    com.google.gwt.user.client.ui.HasHorizontalAlignment.HorizontalAlignmentConstant
    getHorizontalAlignment()
    This is the alignment of the text in reference to the image, possible values are left or right.
    String
    getImageClass()
    Returns the master image class.
    I_CmsButton.Size
    getSize()
    Returns the size.
    String
    getText()
    Returns the text.
    String
    getTitle()
    Returns the title.
    boolean
    isDown()
     
    boolean
    isUseMinWidth()
    Checks if the button is constraint to a minimal width.
    protected void
    onAttach()
     
    void
    onBrowserEvent(com.google.gwt.user.client.Event event)
     
    void
    setButtonStyle(I_CmsButton.ButtonStyle style, I_CmsButton.ButtonColor color)
    Sets the button style.
    void
    setDown(boolean down)
     
    void
    setDownFace(String text, String imageClass)
    Sets the down face text and image.
    void
    setDownImageClass(String downImageClass)
    Sets the image class for the down face.
    void
    setHideFromTabNav(boolean hideFromTabNav)
    Sets the hide from tab navigation flag.
    void
    setHorizontalAlignment(com.google.gwt.user.client.ui.HasHorizontalAlignment.HorizontalAlignmentConstant align)
    This is the alignment of the text in reference to the image, possible values are left or right.
    void
    setImageClass(String imageClass)
    Sets the master image class.
    void
    setSize(I_CmsButton.Size size)
    Sets the size.
    void
    setText(String text)
    Sets the text.
    void
    setTitle(String title)
     
    void
    setUpFace(String text, String imageClass)
    Sets the up face text and image.
    void
    setUseMinWidth(boolean useMinWidth)
    Tells the button to use a minimal width.

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

    onClick, onClickCancel, onClickStart

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

    getDownDisabledFace, getDownFace, getDownHoveringFace, getHTML, getTabIndex, getUpDisabledFace, getUpFace, getUpHoveringFace, 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.shared.HasHandlers

    fireEvent

  • Constructor Details

    • CmsPushButton

      public CmsPushButton()
      The constructor.

    • CmsPushButton

      public CmsPushButton(String imageClass)
      The constructor. Setting the button icon.

      Parameters:
      imageClass - the class for the image

    • CmsPushButton

      public CmsPushButton(String imageClass, String downImageClass)
      The constructor. Setting different icons for the up and down face of the button.

      Parameters:
      imageClass - the class for the up face image
      downImageClass - the class for the down face image

  • Method Details

    • clearHoverState

      public void clearHoverState()
      Clears the hover state of the button.

      Use when opening modal popups to ensure the button is not left in hovered state.

    • disable

      public void disable(String disabledReason)
      Disables the button and changes the button title attribute to the disabled reason.

      Parameters:
      disabledReason - the disabled reason

    • enable

      public void enable()
      Enables the button, switching the button title attribute from the disabled reason to the original title.

    • getDisabledReason

      public String getDisabledReason()
      Returns the disabled reason.

      Returns:
      the disabled reason

    • getDownImageClass

      public String getDownImageClass()
      Returns the image class of the down face.

      Returns:
      the image class of the down face

    • getHorizontalAlignment

      public com.google.gwt.user.client.ui.HasHorizontalAlignment.HorizontalAlignmentConstant getHorizontalAlignment()
      This is the alignment of the text in reference to the image, possible values are left or right.

      Specified by:
      getHorizontalAlignment in interface com.google.gwt.user.client.ui.HasHorizontalAlignment
      See Also:
      • HasHorizontalAlignment.getHorizontalAlignment()

    • getImageClass

      public String getImageClass()
      Returns the master image class.

      Returns:
      the master image class

    • getSize

      public I_CmsButton.Size getSize()
      Returns the size.

      Returns:
      the size

    • getText

      public String getText()
      Returns the text.

      Specified by:
      getText in interface com.google.gwt.user.client.ui.HasText
      Overrides:
      getText in class com.google.gwt.user.client.ui.CustomButton
      Returns:
      the text

    • getTitle

      public String getTitle()
      Returns the title.

      Overrides:
      getTitle in class com.google.gwt.user.client.ui.UIObject
      Returns:
      the title

    • isDown

      public boolean isDown()
      Overrides:
      isDown in class com.google.gwt.user.client.ui.CustomButton
      See Also:
      • CustomButton.isDown()

    • isUseMinWidth

      public boolean isUseMinWidth()
      Checks if the button is constraint to a minimal width.

      Returns:
      true if the button is constraint to a minimal width

    • onBrowserEvent

      public void onBrowserEvent(com.google.gwt.user.client.Event event)
      Specified by:
      onBrowserEvent in interface com.google.gwt.user.client.EventListener
      Overrides:
      onBrowserEvent in class com.google.gwt.user.client.ui.CustomButton
      See Also:
      • CustomButton.onBrowserEvent(com.google.gwt.user.client.Event)

    • setButtonStyle

      public void setButtonStyle(I_CmsButton.ButtonStyle style, I_CmsButton.ButtonColor color)
      Sets the button style.

      Parameters:
      style - the style to set
      color - the color to set

    • setDown

      public void setDown(boolean down)
      Overrides:
      setDown in class com.google.gwt.user.client.ui.CustomButton
      See Also:
      • CustomButton.setDown(boolean)

    • setDownFace

      public void setDownFace(String text, String imageClass)
      Sets the down face text and image.

      Parameters:
      text - the down face text to set, set to null to not show any
      imageClass - the down face image class to use, set to null to not show any

    • setDownImageClass

      public void setDownImageClass(String downImageClass)
      Sets the image class for the down face.

      Parameters:
      downImageClass - the image class to set

    • setHideFromTabNav

      public void setHideFromTabNav(boolean hideFromTabNav)
      Sets the hide from tab navigation flag.

      If true the button will not be accessible by tab navigation.

      Parameters:
      hideFromTabNav - the hide from tab navigation flag

    • setHorizontalAlignment

      public void setHorizontalAlignment(com.google.gwt.user.client.ui.HasHorizontalAlignment.HorizontalAlignmentConstant align)
      This is the alignment of the text in reference to the image, possible values are left or right.

      Specified by:
      setHorizontalAlignment in interface com.google.gwt.user.client.ui.HasHorizontalAlignment
      See Also:
      • HasHorizontalAlignment.setHorizontalAlignment(com.google.gwt.user.client.ui.HasHorizontalAlignment.HorizontalAlignmentConstant)

    • setImageClass

      public void setImageClass(String imageClass)
      Sets the master image class.

      Parameters:
      imageClass - the master image class to set

    • setSize

      public void setSize(I_CmsButton.Size size)
      Sets the size.

      Parameters:
      size - the size to set

    • setText

      public void setText(String text)
      Sets the text.

      Specified by:
      setText in interface com.google.gwt.user.client.ui.HasText
      Overrides:
      setText in class com.google.gwt.user.client.ui.CustomButton
      Parameters:
      text - the text to set

    • setTitle

      public void setTitle(String title)
      Overrides:
      setTitle in class com.google.gwt.user.client.ui.UIObject
      See Also:
      • UIObject.setTitle(java.lang.String)

    • setUpFace

      public void setUpFace(String text, String imageClass)
      Sets the up face text and image.

      Parameters:
      text - the up face text to set, set to null to not show any
      imageClass - the up face image class to use, set to null to not show any

    • setUseMinWidth

      public void setUseMinWidth(boolean useMinWidth)
      Tells the button to use a minimal width.

      Parameters:
      useMinWidth - true to use a minimal width

    • getFaceHtml

      protected String getFaceHtml(String text, String imageClass)
      Convenience method to assemble the HTML to use for a button face.

      Parameters:
      text - text the up face text to set, set to null to not show any
      imageClass - the up face image class to use, set to null to not show any
      Returns:
      the HTML

    • onAttach

      protected void onAttach()
      Overrides:
      onAttach in class com.google.gwt.user.client.ui.CustomButton
      See Also:
      • CustomButton.onAttach()