Package org.opencms.gwt.client.ui

Class CmsToggleButton

  • 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
    Direct Known Subclasses:
    A_CmsToolbarButton
    public class CmsToggleButton
extends com.google.gwt.user.client.ui.ToggleButton
implements com.google.gwt.user.client.ui.HasHorizontalAlignment
    Tool-bar button class.

    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
      CmsToggleButton()
      Constructor.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void disable​(java.lang.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.
      java.lang.String getDownImageClass()
      Returns the image class of the down face.
      protected java.lang.String getFaceHtml​(java.lang.String text, java.lang.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.
      java.lang.String getImageClass()
      Returns the imageClass.
      I_CmsButton.Size getSize()
      Returns the size.
      java.lang.String getText()
      Returns the text.
      java.lang.String getTitle()
      Returns the title.
      boolean isUseMinWidth()
      Returns the useMinWidth.
      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​(java.lang.String text, java.lang.String imageClass)
      Sets the down face text and image.
      void setDownImageClass​(java.lang.String imageClass)
      Sets the imageClassDown.
      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​(java.lang.String imageClass)
      Sets the imageClass.
      void setSize​(I_CmsButton.Size size)
      Sets the size.
      void setText​(java.lang.String text)
      Sets the text.
      void setTitle​(java.lang.String title)  
      void setUpFace​(java.lang.String text, java.lang.String imageClass)
      Sets the up face text and image.
      void setUseMinWidth​(boolean useMinWidth)
      Sets the useMinWidth.

      • 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.shared.HasHandlers

        fireEvent

    • Method Detail

      • disable

        public void disable​(java.lang.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.

      • getDownImageClass

        public java.lang.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 java.lang.String getImageClass()
        Returns the imageClass.

        Returns:
        the imageClass

      • getText

        public java.lang.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 java.lang.String getTitle()
        Returns the title.

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

      • isUseMinWidth

        public boolean isUseMinWidth()
        Returns the useMinWidth.

        Returns:
        the useMinWidth

      • 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)

      • setDown

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

      • setDownFace

        public void setDownFace​(java.lang.String text,
                        java.lang.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​(java.lang.String imageClass)
        Sets the imageClassDown.

        Parameters:
        imageClass - the imageClass to set

      • 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​(java.lang.String imageClass)
        Sets the imageClass.

        Parameters:
        imageClass - the imageClass to set

      • setText

        public void setText​(java.lang.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​(java.lang.String title)
        Overrides:
        setTitle in class com.google.gwt.user.client.ui.UIObject
        See Also:
        UIObject.setTitle(java.lang.String)

      • setUpFace

        public void setUpFace​(java.lang.String text,
                      java.lang.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)
        Sets the useMinWidth.

        Parameters:
        useMinWidth - the useMinWidth to set

      • getFaceHtml

        protected java.lang.String getFaceHtml​(java.lang.String text,
                                       java.lang.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