com.extjs.gxt.ui.client.widget.button
Class Button

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.extjs.gxt.ui.client.widget.Component
              com.extjs.gxt.ui.client.widget.BoxComponent
                  com.extjs.gxt.ui.client.widget.button.Button

All Implemented Interfaces:

Observable, IconSupport, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener

Direct Known Subclasses:

SplitButton, ToggleButton

public class Button
extends BoxComponent
implements IconSupport

A button component.

Events:

BeforeSelect : ButtonEvent(button, event)

Fires before this button is selected.

• button : this
• event : the dom event

Select : ButtonEvent(button, event)

Fires when this button is selected.

• button : this
• event : the dom event

MenuShow : ButtonEvent(button, item)

If this button has a menu, this event fires when it is shown.

• button : this
• menu : the menu

MenuHide : ButtonEvent(button, item)

If this button has a menu, this event fires when it is hidden.

• button : this
• menu : the menu

Nested Class Summary

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

Field Summary

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

DEBUG_ID_PREFIX

Constructor Summary

Button()
Creates a new button.

Button(java.lang.String text)
Creates a new button with the given text.

Button(java.lang.String text, com.google.gwt.user.client.ui.AbstractImagePrototype icon)
Creates a new button with the given text and iconStyle.

Button(java.lang.String text, com.google.gwt.user.client.ui.AbstractImagePrototype icon, SelectionListener<ButtonEvent> listener)
Creates a new button with the given text, iconStyle and specified selection listener.

Button(java.lang.String text, SelectionListener<ButtonEvent> listener)
Creates a new button with the given text and specified selection listener.

Method Summary

void	addSelectionListener(SelectionListener<ButtonEvent> listener) Adds a selection listener.
Style.ButtonArrowAlign	getArrowAlign() Returns the button's arrow alignment.
com.google.gwt.user.client.ui.AbstractImagePrototype	getIcon() Returns the button's icon style.
Style.IconAlign	getIconAlign() Returns the button's icon alignment.
Menu	getMenu() Returns the button's menu (if it has one).
java.lang.String	getMenuAlign() Returns the button's menu alignment.
int	getMinWidth() Returns the button's minimum width.
boolean	getMouseEvents() Returns true if mouse over effect is disabled.
Style.ButtonScale	getScale() Returns the buttons scale.
java.lang.String	getText() Returns the button's text.
java.lang.String	getType()
void	hideMenu() Hide this button's menu (if it has one).
void	onComponentEvent(ComponentEvent ce) Any events a component receives will be forwarded to this method.
void	removeSelectionListener(SelectionListener<ButtonEvent> listener) Removes a previously added listener.
void	setArrowAlign(Style.ButtonArrowAlign arrowAlign) Sets the arrow alignment (defaults to RIGHT).
void	setIcon(com.google.gwt.user.client.ui.AbstractImagePrototype icon) Sets the button's icon style.
void	setIconAlign(Style.IconAlign iconAlign) Sets the icon alignment (defaults to LEFT).
void	setIconStyle(java.lang.String icon) Sets the icon style.
void	setMenu(Menu menu) Sets the button's menu.
void	setMenuAlign(java.lang.String menuAlign) Sets the position to align the menu to, see El.alignTo(com.google.gwt.user.client.Element, java.lang.String, int[]) for more details (defaults to 'tl-bl?'
void	setMinWidth(int minWidth) Sets he minimum width for this button (used to give a set of buttons a common width)
void	setMouseEvents(boolean handleMouseEvents) False to disable visual cues on mouseover, mouseout and mousedown (defaults to true).
void	setScale(Style.ButtonScale scale) Sets the button scale.
void	setTabIndex(int index) Sets the button's tab index.
void	setText(java.lang.String text) Sets the button's text.
void	setType(java.lang.String type) Submit, reset or button (defaults to 'button').
void	showMenu() Show this button's menu (if it has one).

Methods inherited from class com.extjs.gxt.ui.client.widget.BoxComponent

getBounds, getHeight, getHeight, getPosition, getShadow, getShadowOffset, getShadowPosition, getSize, getWidth, getWidth, isAutoHeight, isAutoWidth, isDeferHeight, isShim, setAutoHeight, setAutoWidth, setBounds, setBounds, setDeferHeight, setHeight, setHeight, setPagePosition, setPagePosition, setPixelSize, setPosition, setShadow, setShadowOffset, setShadowPosition, setShim, setSize, setSize, setWidth, setWidth, sync, syncSize

Methods inherited from class com.extjs.gxt.ui.client.widget.Component

addListener, addPlugin, addStyleName, addWidgetListener, clearState, disable, disableEvents, disableTextSelection, el, enable, enableEvents, fireEvent, fireEvent, fireEvent, fly, focus, getBaseStyle, getBorders, getContextMenu, getData, getElement, getHideMode, getId, getItemId, getListeners, getModel, getState, getStateId, getToolTip, hasListeners, hasListeners, hide, hideToolTip, isDisabledEvents, isEnabled, isRendered, isStateful, isVisible, mask, mask, mask, onBrowserEvent, recalculate, removeAllListeners, removeFromParent, removeListener, removeStyleName, removeSwallow, removeWidgetListener, render, render, repaint, saveState, setBorders, setContextMenu, setData, setElement, setEnabled, setHideMode, setId, setIntStyleAttribute, setItemId, setStateful, setStateId, setStyleAttribute, setStyleName, setTitle, setToolTip, setToolTip, setVisible, setZIndex, show, sinkEvents, swallowEvent, swallowEvent, toString, unmask

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

fireEvent, getParent, isAttached

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

addStyleDependentName, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleName, getStylePrimaryName, getTitle, isVisible, removeStyleDependentName, setStylePrimaryName, setVisible, unsinkEvents

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Button

public Button()

Creates a new button.

Button

public Button(java.lang.String text)

Creates a new button with the given text.

Parameters:

text - the button text

Button

public Button(java.lang.String text,
              SelectionListener<ButtonEvent> listener)

Creates a new button with the given text and specified selection listener.

Parameters:

text - the button's text

listener - the selection listener

Button

public Button(java.lang.String text,
              com.google.gwt.user.client.ui.AbstractImagePrototype icon)

Creates a new button with the given text and iconStyle.

Parameters:

text - the button text

icon - the icon

Button

public Button(java.lang.String text,
              com.google.gwt.user.client.ui.AbstractImagePrototype icon,
              SelectionListener<ButtonEvent> listener)

Creates a new button with the given text, iconStyle and specified selection listener.

Parameters:

text - the button text

icon - the icon

listener - the selection listener

Method Detail

addSelectionListener

public void addSelectionListener(SelectionListener<ButtonEvent> listener)

Adds a selection listener.

Parameters:

listener - the listener to add

getArrowAlign

public Style.ButtonArrowAlign getArrowAlign()

Returns the button's arrow alignment.

Returns:

the arrow alignment

getIconAlign

public Style.IconAlign getIconAlign()

Returns the button's icon alignment.

Returns:

the icon alignment

getIcon

public com.google.gwt.user.client.ui.AbstractImagePrototype getIcon()

Returns the button's icon style.

Specified by:

getIcon in interface IconSupport

Returns:

the icon style

getMenu

public Menu getMenu()

Returns the button's menu (if it has one).

Returns:

the menu

getMenuAlign

public java.lang.String getMenuAlign()

Returns the button's menu alignment.

Returns:

the menu alignment

getMinWidth

public int getMinWidth()

Returns the button's minimum width.

Returns:

the minWidth the minimum width

getMouseEvents

public boolean getMouseEvents()

Returns true if mouse over effect is disabled.

Returns:

the handleMouseEvents the handle mouse event state

getScale

public Style.ButtonScale getScale()

Returns the buttons scale.

Returns:

the scale

getText

public java.lang.String getText()

Returns the button's text.

Returns:

the button text

getType

public java.lang.String getType()

Returns:

the type

hideMenu

public void hideMenu()

Hide this button's menu (if it has one).

onComponentEvent

public void onComponentEvent(ComponentEvent ce)

Description copied from class: Component

Any events a component receives will be forwarded to this method. Subclasses should override as needed. The Component.onBrowserEvent(com.google.gwt.user.client.Event) method should not be overridden or modified.

Overrides:

onComponentEvent in class Component

Parameters:

ce - the base event

removeSelectionListener

public void removeSelectionListener(SelectionListener<ButtonEvent> listener)

Removes a previously added listener.

Parameters:

listener - the listener to be removed

setArrowAlign

public void setArrowAlign(Style.ButtonArrowAlign arrowAlign)

Sets the arrow alignment (defaults to RIGHT).

Parameters:

arrowAlign - the arrow alignment

setIconAlign

public void setIconAlign(Style.IconAlign iconAlign)

Sets the icon alignment (defaults to LEFT).

Parameters:

iconAlign - the icon alignment

setIcon

public void setIcon(com.google.gwt.user.client.ui.AbstractImagePrototype icon)

Sets the button's icon style. The style name should match a CSS style that specifies a background image using the following format:

 
 <code> .my-icon { background: url(images/icons/my-icon.png) no-repeat
 center left !important; } </code>
 
 

Specified by:

setIcon in interface IconSupport

Parameters:

icon - the icon

setIconStyle

public void setIconStyle(java.lang.String icon)

Description copied from interface: IconSupport

Sets the icon style.

Specified by:

setIconStyle in interface IconSupport

Parameters:

icon - a CSS style name

setMenu

public void setMenu(Menu menu)

Sets the button's menu.

Parameters:

menu - the menu

setMenuAlign

public void setMenuAlign(java.lang.String menuAlign)

Sets the position to align the menu to, see El.alignTo(com.google.gwt.user.client.Element, java.lang.String, int[]) for more details (defaults to 'tl-bl?', pre-render).

Parameters:

menuAlign - the menu alignment

setMinWidth

public void setMinWidth(int minWidth)

Sets he minimum width for this button (used to give a set of buttons a common width)

Parameters:

minWidth - the minimum width

setMouseEvents

public void setMouseEvents(boolean handleMouseEvents)

False to disable visual cues on mouseover, mouseout and mousedown (defaults to true).

Parameters:

handleMouseEvents - false to disable mouse over cahnges

setScale

public void setScale(Style.ButtonScale scale)

Sets the button scale.

Parameters:

scale - the scale to set

setTabIndex

public void setTabIndex(int index)

Sets the button's tab index.

Parameters:

index - the tab index

setText

public void setText(java.lang.String text)

Sets the button's text.

Parameters:

text - the new text

setType

public void setType(java.lang.String type)

Submit, reset or button (defaults to 'button').

Parameters:

type - the new type

showMenu

public void showMenu()

Show this button's menu (if it has one).