CustomButton (GWT Javadoc)

Overview

Package

Class

Use

Deprecated

Help

GWT 2.7.0

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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

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

All Implemented Interfaces:: HasAllDragAndDropHandlers, HasAllFocusHandlers, HasAllGestureHandlers, HasAllKeyHandlers, HasAllMouseHandlers, HasAllTouchHandlers, HasBlurHandlers, HasClickHandlers, HasDoubleClickHandlers, HasDragEndHandlers, HasDragEnterHandlers, HasDragHandlers, HasDragLeaveHandlers, HasDragOverHandlers, HasDragStartHandlers, HasDropHandlers, HasFocusHandlers, HasGestureChangeHandlers, HasGestureEndHandlers, HasGestureStartHandlers, HasKeyDownHandlers, HasKeyPressHandlers, HasKeyUpHandlers, HasMouseDownHandlers, HasMouseMoveHandlers, HasMouseOutHandlers, HasMouseOverHandlers, HasMouseUpHandlers, HasMouseWheelHandlers, HasTouchCancelHandlers, HasTouchEndHandlers, HasTouchMoveHandlers, HasTouchStartHandlers, HasAttachHandlers, HasHandlers, HasSafeHtml, EventListener, Focusable, HasEnabled, HasFocus, HasHTML, HasText, HasVisibility, IsWidget, SourcesClickEvents, SourcesFocusEvents, SourcesKeyboardEvents, SourcesMouseEvents

Direct Known Subclasses:: PushButton, ToggleButton

public abstract class CustomButton
extends ButtonBase
extends ButtonBase

CustomButton is a base button class with built in support for a set number of button faces. Each face has its own style modifier. For example, the state for down and hovering is assigned the CSS modifier down-hovering. So, if the button's overall style name is gwt-PushButton then when showing the down-hovering face, the button's style is gwt-PushButton-down-hovering. The overall style name can be used to change the style of the button irrespective of the current face.

Each button face can be assigned is own image, text, or html contents. If no content is defined for a face, then the face will use the contents of another face. For example, if down-hovering does not have defined contents, it will use the contents defined by the down face.

The supported faces are defined below:

CSS style name	Getter method	description of face	defaults to contents of face
up	`getUpFace()`	face shown when button is up	none
down	`getDownFace()`	face shown when button is down	up
up-hovering	`getUpHoveringFace()`	face shown when button is up and hovering	up
up-disabled	`getUpDisabledFace()`	face shown when button is up and disabled	up
down-hovering	`getDownHoveringFace()`	face shown when button is down and hovering	down
down-disabled	`getDownDisabledFace()`	face shown when button is down and disabled	down

Use in UiBinder Templates

When working with CustomButton subclasses in UiBinder templates, you can set text and assign ImageResources for their various faces via child elements:

<g:upFace>
<g:downFace>
<g:upHoveringFace>
<g:downHoveringFace>
<g:upDisabledFace>
<g:downDisabledFace>

Each face element can take an optional image attribute and an html body. For example:

 <ui:image field='downButton'/> <!-- define an ImageResource -->

 <g:PushButton ui:field='pushButton' enabled='true'>
   <g:upFace>
     <b>click me</b>
   </gwt:upFace>
   <g:upHoveringFace>
     <b>Click ME!</b>
   </gwt:upHoveringFace>

   <g:downFace image='{downButton}'/>
   <g:downHoveringFace image='{downButton}'/>
 </g:PushButton>

Nested Class Summary
`class`	`CustomButton.Face` Represents a button's face.

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
`UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled`

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.Widget
`eventsToSink`

Fields inherited from class com.google.gwt.user.client.ui.UIObject
`DEBUG_ID_PREFIX, MISSING_ELEMENT_ERROR, SETELEMENT_TWICE_ERROR`

Constructor Summary
`protected`	`CustomButton()` Constructor for `CustomButton`.
	`CustomButton(Image upImage)` Constructor for `CustomButton`.
	`CustomButton(Image upImage, ClickHandler handler)` Constructor for `CustomButton`.
	`CustomButton(Image upImage, ClickListener listener)` Deprecated. Use `CustomButton(Image, ClickHandler)` instead
	`CustomButton(Image upImage, Image downImage)` Constructor for `CustomButton`.
	`CustomButton(Image upImage, Image downImage, ClickHandler handler)` Constructor for `CustomButton`.
	`CustomButton(Image upImage, Image downImage, ClickListener listener)` Deprecated. Use `CustomButton(Image, Image, ClickHandler)` instead
	`CustomButton(java.lang.String upText)` Constructor for `CustomButton`.
	`CustomButton(java.lang.String upText, ClickHandler handler)` Constructor for `CustomButton`.
	`CustomButton(java.lang.String upText, ClickListener listener)` Deprecated. Use `CustomButton(String, ClickListener)` instead
	`CustomButton(java.lang.String upText, java.lang.String downText)` Constructor for `CustomButton`.
	`CustomButton(java.lang.String upText, java.lang.String downText, ClickHandler handler)` Constructor for `CustomButton`.
	`CustomButton(java.lang.String upText, java.lang.String downText, ClickListener listener)` Deprecated. Use `CustomButton(String, String, ClickHandler)` instead

Method Summary
`(package private) void`	`finishSetup()` Common setup between constructors.
`(package private) void`	`fireClickListeners(Event nativeEvent)`
`(package private) CustomButton.Face`	`getCurrentFace()` Gets the current face of the button.
`CustomButton.Face`	`getDownDisabledFace()` Gets the downDisabled face of the button.
`CustomButton.Face`	`getDownFace()` Gets the down face of the button.
`CustomButton.Face`	`getDownHoveringFace()` Gets the downHovering face of the button.
`java.lang.String`	`getHTML()` Gets the current face's html.
`int`	`getTabIndex()` Gets the tab index.
`java.lang.String`	`getText()` Gets the current face's text.
`CustomButton.Face`	`getUpDisabledFace()` Gets the upDisabled face of the button.
`CustomButton.Face`	`getUpFace()` Gets the up face of the button.
`CustomButton.Face`	`getUpHoveringFace()` Gets the upHovering face of the button.
`protected boolean`	`isDown()` Is this button down?
`(package private) boolean`	`isHovering()` Is the mouse hovering over this button?
`protected void`	`onAttach()` Overridden on attach to ensure that a button face has been chosen before the button is displayed.
`void`	`onBrowserEvent(Event event)` Fired whenever a browser event is received.
`protected void`	`onClick()` Called when the user finishes clicking on this button.
`protected void`	`onClickCancel()` Called when the user aborts a click in progress; for example, by dragging the mouse outside of the button before releasing the mouse button.
`protected void`	`onClickStart()` Called when the user begins to click on this button.
`protected void`	`onDetach()` This method is called when a widget is detached from the browser's document.
`void`	`setAccessKey(char key)` Sets the widget's 'access key'.
`(package private) void`	`setCurrentFace(CustomButton.Face newFace)`
`protected void`	`setDown(boolean down)` Sets whether this button is down.
`void`	`setEnabled(boolean enabled)` Sets whether this button is enabled.
`void`	`setFocus(boolean focused)` Explicitly focus/unfocus this widget.
`(package private) void`	`setHovering(boolean hovering)` Sets whether this button is hovering.
`void`	`setHTML(SafeHtml html)` Sets this object's contents via known-safe HTML.
`void`	`setHTML(java.lang.String html)` Sets the current face's html.
`void`	`setTabIndex(int index)` Sets the widget's position in the tab index.
`void`	`setText(java.lang.String text)` Sets the current face's text.
`(package private) void`	`toggleDown()` Toggle the up/down attribute.

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.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, ensureHandlers, fireEvent, getHandlerCount, getHandlerManager, getLayoutData, getParent, isAttached, isOrWasAttached, onLoad, onUnload, removeFromParent, replaceElement, setLayoutData, setParent, 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, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString

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, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, 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 Detail