com.smartgwt.mobile.client.widgets

Class BaseButton

java.lang.Object

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

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

com.google.gwt.user.client.ui.Panel

com.google.gwt.user.client.ui.ComplexPanel

com.smartgwt.mobile.client.widgets.Canvas

com.smartgwt.mobile.client.widgets.StatefulCanvas

com.smartgwt.mobile.client.widgets.BaseButton

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.HasWidgets, com.google.gwt.user.client.ui.HasWidgets.ForIsWidget, com.google.gwt.user.client.ui.IndexedPanel, com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget, com.google.gwt.user.client.ui.IsWidget, com.smartgwt.mobile.client.internal.test.AutoTestLocatable, HasClickHandlers, HasShowContextMenuHandlers, java.lang.Iterable<com.google.gwt.user.client.ui.Widget>

Direct Known Subclasses:

Button, Segment, ToolStripButton

@SGWTInternal
public abstract class BaseButton
extends StatefulCanvas

Base abstract class for button types.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BaseButton.ButtonType

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.IndexedPanel

com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget

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

com.google.gwt.user.client.ui.HasWidgets.ForIsWidget

Field Summary

Fields

Modifier and Type	Field and Description
static ButtonsCssResource	_CSS
protected java.lang.String	tintColor Buttons support being tinted dynamically.

Fields inherited from class com.smartgwt.mobile.client.widgets.Canvas

_CONTENT_CHANGED_EVENT_TYPE, _HISTORY_ENABLED, _REQUEST_SCROLL_TO_EVENT_TYPE, id, touched

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
BaseButton() The default constructor that sets up the basic button structure.
BaseButton(BaseButton button)
BaseButton(java.lang.String title) BaseButton constructor.

Method Summary

Modifier and Type	Method and Description
float	_getContentWidth()
java.lang.Object	_getInnerAttributeFromSplitLocator(java.util.List<java.lang.String> locatorArray, com.smartgwt.mobile.client.internal.test.GetAttributeConfiguration configuration)
com.google.gwt.dom.client.SpanElement	_getLabelElement()
java.lang.String	_getStateName()
void	destroy()
com.google.gwt.resources.client.ImageResource	getIcon() Return the button icon, or null if not set.
IconAlign	getIconAlign() Return the icon alignment.
java.lang.String	getIconColor() Return the icon color.
java.lang.String	getTintColor() Return the tint color.
java.lang.String	getTitle() Return the title label.
boolean	isStretch() Should the button stretch in width?
void	setContents(java.lang.String html) Deprecated. Use setTitle(String) instead.
void	setIcon(com.google.gwt.resources.client.ImageResource icon, boolean mask) Set the button icon from an ImageResource.
void	setIcon(com.google.gwt.resources.client.ImageResource icon, boolean mask, IconAlign iconAlign) Set the button icon from an ImageResource.
void	setIconAlign(IconAlign iconAlign) Set the icon alignment.
void	setIconColor(java.lang.String iconColor) Set the icon color.
void	setStretch(boolean stretch) Should the button stretch in width?
void	setTintColor(java.lang.String tintColor) Set the button tintColor.
void	setTitle(java.lang.String title) Sets the title label of the button.
protected void	stateChanged()

Methods inherited from class com.smartgwt.mobile.client.widgets.StatefulCanvas

_getStateSuffix, _handleActivate, _setHandleDisabled, addToRadioGroup, deselect, getActionType, getBaseStyle, getRadioGroup, getShowDisabled, getShowDown, getState, getStateSuffix, isSelected, onBrowserEvent, removeFromRadioGroup, removeFromRadioGroup, select, setActionType, setBaseStyle, setRadioGroup, setSelected, setShowDisabled, setShowDown, setState

Methods inherited from class com.smartgwt.mobile.client.widgets.Canvas

_add, _booleanValue, _fireContentChangedEvent, _fireContentChangedEvent, _fireRequestScrollToEvent, _getAndroidWindowSoftInputMode, _getAttributeFromSplitLocator, _getChildFromLocatorSubstring, _getFixNavigationBarPositionDuringKeyboardFocus, _getHideTabBarDuringKeyboardFocus, _getInnerElement, _hideAddressBar, _hideAddressBarNow, _insert, _isDifferent, _isHDPIDisplay, _isIOS4OrOlder, _isIOS5, _isIOSMin6_0, _isStandaloneMode, _nativeParseFloat, _removeClassName, _setClassName, _sinkAnimationEndEvent, _sinkContentChangedEvent, _sinkFocusInEvent, _sinkFocusOutEvent, _sinkInputEvent, _sinkRequestScrollToEvent, _sinkTransitionEndEvent, _triggerDebugger, addChild, addChild, addChild, addClickHandler, addShowContextMenuHandler, disable, enable, getContextMenu, getID, getInnerHTML, getMargin, hasChild, hasChild, isAndroid, isDisabled, isEnabled, isIPad, isIPhone, isSafari, isStandAlone, isUIWebView, parseDimension, removeChild, removeChild, setContextMenu, setDisabled, setElement, setID, setMargin, setStyleName, split, useIOSNativeScrolling

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

add, add, adjustIndex, checkIndexBoundsForAccess, checkIndexBoundsForInsertion, getChildren, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, insert, insert, iterator, remove, remove

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

add, add, adopt, clear, doAttachChildren, doDetachChildren, orphan, remove

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

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onDetach, 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, setHeight, setPixelSize, setSize, setStyleDependentName, 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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

_CSS

@SGWTInternal
public static final ButtonsCssResource _CSS

tintColor

protected java.lang.String tintColor

Buttons support being tinted dynamically.

Constructor Detail

BaseButton

public BaseButton()

The default constructor that sets up the basic button structure. A button should have a title and / or an icon to have a meaningful appearance.

BaseButton

public BaseButton(java.lang.String title)

BaseButton constructor.

Parameters:

title - the title label of the button

BaseButton

public BaseButton(BaseButton button)

Method Detail

_getInnerAttributeFromSplitLocator

public java.lang.Object _getInnerAttributeFromSplitLocator(java.util.List<java.lang.String> locatorArray,
                                                           com.smartgwt.mobile.client.internal.test.GetAttributeConfiguration configuration)

Specified by:

_getInnerAttributeFromSplitLocator in interface com.smartgwt.mobile.client.internal.test.AutoTestLocatable

Overrides:

_getInnerAttributeFromSplitLocator in class Canvas

destroy

public void destroy()

Overrides:

destroy in class StatefulCanvas

setContents

@Deprecated
public void setContents(java.lang.String html)

Deprecated. Use setTitle(String) instead.

Sets the title of the button.

Overrides:

setContents in class Canvas

_getContentWidth

@SGWTInternal
public final float _getContentWidth()

_getLabelElement

@SGWTInternal
public final com.google.gwt.dom.client.SpanElement _getLabelElement()

_getStateName

public java.lang.String _getStateName()

Overrides:

_getStateName in class StatefulCanvas

getTitle

public final java.lang.String getTitle()

Return the title label.

Overrides:

getTitle in class com.google.gwt.user.client.ui.UIObject

Returns:

the title label

setTitle

public void setTitle(java.lang.String title)

Sets the title label of the button.

Overrides:

setTitle in class com.google.gwt.user.client.ui.UIObject

Parameters:

title - the button title

getIcon

public final com.google.gwt.resources.client.ImageResource getIcon()

Return the button icon, or null if not set.

Returns:

the button icon

setIcon

public void setIcon(com.google.gwt.resources.client.ImageResource icon,
                    boolean mask)

Set the button icon from an ImageResource.

Note: When using masking, the ImageResource must be a separate resource at runtime. If using GWT ClientBundles, it is sufficient to set the preventInlining image option to true.

Parameters:

icon - the icon image resource.

mask - true to mask the button. Masking is typically applied to black-only icons causing its final appearance to be white

setIcon

public void setIcon(com.google.gwt.resources.client.ImageResource icon,
                    boolean mask,
                    IconAlign iconAlign)

Set the button icon from an ImageResource.

Note: When using masking, the ImageResource must be a separate resource at runtime. If using GWT ClientBundles, it is sufficient to set the preventInlining image option to true.

Parameters:

icon - the icon image resource.

mask - true to mask the button. Masking is typically applied to black-only icons causing its final appearance to be white

iconAlign - the alignment of the icon

getIconAlign

public IconAlign getIconAlign()

Return the icon alignment.

Returns:

the icon alignment. Defaults to left

setIconAlign

public void setIconAlign(IconAlign iconAlign)

Set the icon alignment. Default is left.

Parameters:

iconAlign - the icon alignment

getTintColor

public java.lang.String getTintColor()

Return the tint color. Default is null and the theme's default color is used.

Returns:

the tint color

setTintColor

public void setTintColor(java.lang.String tintColor)

Set the button tintColor. Can pass in the color name, the hex value, or the rgb / rgba value as a String.

Note: Passing a rgba string with a value for opacity allows buttons to have an opacity / translucency.

Parameters:

tintColor - the tint color

getIconColor

public final java.lang.String getIconColor()

Return the icon color.

Returns:

the icon color. Defaults to null

setIconColor

public void setIconColor(java.lang.String iconColor)

Set the icon color. This overrides the default color of the icon an applies a solid color to the icon based on the icon color provided. An example use of this is to set the icon color of a "star" icon to yellow to indicate it has been marked.

Parameters:

iconColor - the icon color. Defaults to null

isStretch

public final boolean isStretch()

Should the button stretch in width?

Returns:

true for stretch, false for auto-width based on contents

setStretch

public void setStretch(boolean stretch)

Should the button stretch in width?

Parameters:

stretch - true for stretch, false for auto-width based on contents

stateChanged

protected void stateChanged()

Overrides:

stateChanged in class StatefulCanvas