|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.Widget
com.smartgwt.client.widgets.BaseWidget
com.smartgwt.client.widgets.Canvas
com.smartgwt.client.widgets.StatefulCanvas
com.smartgwt.client.widgets.Button
public class Button
The Button widget class implements interactive, style-based button widgets.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject |
---|
UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled |
Field Summary |
---|
Fields inherited from class com.smartgwt.client.widgets.BaseWidget |
---|
config, configOnly, id, isElementSet, scClassName |
Fields inherited from class com.google.gwt.user.client.ui.UIObject |
---|
DEBUG_ID_PREFIX |
Constructor Summary | |
---|---|
Button()
|
|
Button(JavaScriptObject jsObj)
|
|
Button(String title)
|
Method Summary | |
---|---|
void |
action()
This property contains the default 'action' for the Button to fire when activated. |
HandlerRegistration |
addIconClickHandler(IconClickHandler handler)
Add a iconClick handler. |
void |
addToRadioGroup(String groupID)
Add this widget to the specified mutually exclusive selection group with the ID passed in. |
protected JavaScriptObject |
create()
|
void |
deselect()
Select this object. |
SelectionType |
getActionType()
Behavior on state changes -- BUTTON, RADIO or CHECKBOX |
Alignment |
getAlign()
Horizontal alignment of this component's title. |
Boolean |
getAutoFit()
If true, ignore the specified size of this widget and always size just large enough to accomodate the title. |
String |
getBaseStyle()
Base CSS style. |
Boolean |
getHiliteAccessKey()
If set to true, if the 'title' of this button contains the
specified 'accessKey' , when the title is displayed to the user
it will be modified to include HTML to underline the accessKey.Note that this property may cause titles that include HTML (rather than simple strings) to be inappropriately modified, so should be disabled if your title string includes HTML characters. |
String |
getIcon()
Optional icon to be shown with the button title text. |
String |
getIconAlign()
If this button is showing an icon should it be right or left aligned? |
Integer |
getIconHeight()
Height in pixels of the icon image. |
String |
getIconOrientation()
If this button is showing an icon should it appear to the left or right of the title? valid options are "left" and "right" . |
int |
getIconSize()
Size in pixels of the icon image. |
Integer |
getIconWidth()
Width in pixels of the icon image. |
static Button |
getOrCreateRef(JavaScriptObject jsObj)
|
String |
getRadioGroup()
String identifier for this canvas's mutually exclusive selection group. |
Boolean |
getSelected()
Whether this component is selected. |
Boolean |
getShowDisabled()
Should we visibly change state when disabled? |
Boolean |
getShowDisabledIcon()
If using an icon for this button, whether to switch the icon image if the button becomes disabled. |
Boolean |
getShowDown()
Should we visibly change state when the mouse goes down in this object? |
Boolean |
getShowDownIcon()
If using an icon for this button, whether to switch the icon image when the mouse goes down on the button. |
Boolean |
getShowFocused()
Should we visibly change state when the canvas recieves focus? If showFocusedAsOver is true , the
"over" will be used to indicate focus. |
Boolean |
getShowFocusedIcon()
If using an icon for this button, whether to switch the icon image when the button recieves focus. |
Boolean |
getShowRollOver()
Should we visibly change state when the mouse goes over this object? |
Boolean |
getShowRollOverIcon()
If using an icon for this button, whether to switch the icon image on mouse rollover. |
Boolean |
getShowSelectedIcon()
If using an icon for this button, whether to switch the icon image when the button becomes selected. |
State |
getState()
Current "state" of this widget. |
String |
getTitle()
The text title to display in this button. |
VerticalAlignment |
getValign()
Vertical alignment of this component's title. |
Boolean |
getWrap()
A boolean indicating whether the button's title should word-wrap, if necessary. |
Boolean |
isSelected()
Find out if this object is selected |
void |
removeFromRadioGroup()
Remove this widget from the specified mutually exclusive selection group with the ID passed in. |
void |
removeFromRadioGroup(String groupID)
Remove this widget from the specified mutually exclusive selection group with the ID passed in. |
void |
select()
Select this object. |
void |
setActionType(SelectionType actionType)
Behavior on state changes -- BUTTON, RADIO or CHECKBOX Update the 'actionType' for this canvas (radio / checkbox / button) If the canvas is currently selected, and the passed in actionType is 'button' this method will deselect the canvas. |
void |
setAlign(Alignment align)
Horizontal alignment of this component's title. |
void |
setAutoFit(Boolean autoFit)
If true, ignore the specified size of this widget and always size just large enough to accomodate the title. |
void |
setBaseStyle(String baseStyle)
Base CSS style. |
void |
setDisabled(boolean disabled)
Enable or disable this object |
void |
setHiliteAccessKey(Boolean hiliteAccessKey)
If set to true, if the 'title' of this button contains the
specified 'accessKey' , when the title is displayed to the user
it will be modified to include HTML to underline the accessKey.Note that this property may cause titles that include HTML (rather than simple strings) to be inappropriately modified, so should be disabled if your title string includes HTML characters. |
void |
setIcon(String icon)
Optional icon to be shown with the button title text. |
void |
setIconAlign(String iconAlign)
If this button is showing an icon should it be right or left aligned? |
void |
setIconHeight(Integer iconHeight)
Height in pixels of the icon image. |
void |
setIconOrientation(String iconOrientation)
If this button is showing an icon should it appear to the left or right of the title? valid options are "left" and "right" . |
void |
setIconSize(int iconSize)
Size in pixels of the icon image. |
void |
setIconWidth(Integer iconWidth)
Width in pixels of the icon image. |
void |
setRadioGroup(String radioGroup)
String identifier for this canvas's mutually exclusive selection group. |
void |
setSelected(Boolean selected)
Whether this component is selected. |
void |
setShowDisabled(Boolean showDisabled)
Should we visibly change state when disabled? |
void |
setShowDisabledIcon(Boolean showDisabledIcon)
If using an icon for this button, whether to switch the icon image if the button becomes disabled. |
void |
setShowDown(Boolean showDown)
Should we visibly change state when the mouse goes down in this object? |
void |
setShowDownIcon(Boolean showDownIcon)
If using an icon for this button, whether to switch the icon image when the mouse goes down on the button. |
void |
setShowFocused(Boolean showFocused)
Should we visibly change state when the canvas recieves focus? If showFocusedAsOver is true , the
"over" will be used to indicate focus. |
void |
setShowFocusedIcon(Boolean showFocusedIcon)
If using an icon for this button, whether to switch the icon image when the button recieves focus. |
void |
setShowRollOver(Boolean showRollOver)
Should we visibly change state when the mouse goes over this object? |
void |
setShowRollOverIcon(Boolean showRollOverIcon)
If using an icon for this button, whether to switch the icon image on mouse rollover. |
void |
setShowSelectedIcon(Boolean showSelectedIcon)
If using an icon for this button, whether to switch the icon image when the button becomes selected. |
void |
setState(State state)
Current "state" of this widget. |
void |
setTitle(String title)
The text title to display in this button. |
void |
setVAlign()
Sets the vertical alignment of this buttons content. |
void |
setValign(VerticalAlignment valign)
Vertical alignment of this component's title. |
void |
setWrap(Boolean wrap)
A boolean indicating whether the button's title should word-wrap, if necessary. |
Methods inherited from class com.smartgwt.client.widgets.StatefulCanvas |
---|
getOverCanvasConstructor, getRedrawOnStateChange, getShowFocusedAsOver, getShowOverCanvas, getStateSuffix, setOverCanvasConstructor, setRedrawOnStateChange, setShowFocusedAsOver, setShowOverCanvas, setTitleStyle |
Methods inherited from class com.google.gwt.user.client.ui.Widget |
---|
addDomHandler, addHandler, delegateEvent, doAttachChildren, doDetachChildren, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents |
Methods inherited from class com.google.gwt.user.client.ui.UIObject |
---|
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setPixelSize, setSize, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, unsinkEvents |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
---|
fireEvent |
Constructor Detail |
---|
public Button()
public Button(JavaScriptObject jsObj)
public Button(String title)
Method Detail |
---|
public static Button getOrCreateRef(JavaScriptObject jsObj)
protected JavaScriptObject create()
create
in class StatefulCanvas
public void setTitle(String title)
setTitle
in class StatefulCanvas
title
- new title. Default value is variespublic String getTitle()
getTitle
in class StatefulCanvas
Default is to simply return this.title.
public void setHiliteAccessKey(Boolean hiliteAccessKey)
'title'
of this button contains the
specified 'accessKey'
, when the title is displayed to the user
it will be modified to include HTML to underline the accessKey.
hiliteAccessKey
- hiliteAccessKey Default value is nullpublic Boolean getHiliteAccessKey()
'title'
of this button contains the
specified 'accessKey'
, when the title is displayed to the user
it will be modified to include HTML to underline the accessKey.
public void setIcon(String icon)
Specify as the partial URL to an image, relative to the imgDir of this component. Change the icon being shown next to the title text.
setIcon
in class StatefulCanvas
icon
- URL of new icon. Default value is nullpublic String getIcon()
Specify as the partial URL to an image, relative to the imgDir of this component.
getIcon
in class StatefulCanvas
public void setIconSize(int iconSize) throws IllegalStateException
The iconWidth
and iconHeight
properties can be used to
configure width and height separately.
setIconSize
in class StatefulCanvas
iconSize
- iconSize Default value is 16
IllegalStateException
- this property cannot be changed after the component has been createdpublic int getIconSize()
The iconWidth
and iconHeight
properties can be used to
configure width and height separately.
getIconSize
in class StatefulCanvas
public void setIconWidth(Integer iconWidth) throws IllegalStateException
If unset, defaults to iconSize
setIconWidth
in class StatefulCanvas
iconWidth
- iconWidth Default value is null
IllegalStateException
- this property cannot be changed after the component has been createdpublic Integer getIconWidth()
If unset, defaults to iconSize
getIconWidth
in class StatefulCanvas
public void setIconHeight(Integer iconHeight) throws IllegalStateException
If unset, defaults to iconSize
setIconHeight
in class StatefulCanvas
iconHeight
- iconHeight Default value is null
IllegalStateException
- this property cannot be changed after the component has been createdpublic Integer getIconHeight()
If unset, defaults to iconSize
getIconHeight
in class StatefulCanvas
public void setIconOrientation(String iconOrientation) throws IllegalStateException
"left"
and "right"
.
Changes the orientation of the icon relative to the text of the button.
setIconOrientation
in class StatefulCanvas
iconOrientation
- The new orientation of the icon relative to the text of the button.. Default value is "left"
IllegalStateException
- this property cannot be changed after the component has been createdpublic String getIconOrientation()
"left"
and "right"
.
getIconOrientation
in class StatefulCanvas
public void setIconAlign(String iconAlign) throws IllegalStateException
iconAlign
- iconAlign Default value is null
IllegalStateException
- this property cannot be changed after the component has been createdpublic String getIconAlign()
public void setShowDisabledIcon(Boolean showDisabledIcon) throws IllegalStateException
setShowDisabledIcon
in class StatefulCanvas
showDisabledIcon
- showDisabledIcon Default value is true
IllegalStateException
- this property cannot be changed after the component has been createdpublic Boolean getShowDisabledIcon()
getShowDisabledIcon
in class StatefulCanvas
public void setShowRollOverIcon(Boolean showRollOverIcon) throws IllegalStateException
setShowRollOverIcon
in class StatefulCanvas
showRollOverIcon
- showRollOverIcon Default value is false
IllegalStateException
- this property cannot be changed after the component has been createdpublic Boolean getShowRollOverIcon()
getShowRollOverIcon
in class StatefulCanvas
public void setShowFocusedIcon(Boolean showFocusedIcon) throws IllegalStateException
If showFocusedAsOver
is true, the "Over"
icon
will be displayed when the canvas has focus, otherwise a seperate "Focused"
icon will be displayed
setShowFocusedIcon
in class StatefulCanvas
showFocusedIcon
- showFocusedIcon Default value is false
IllegalStateException
- this property cannot be changed after the component has been createdpublic Boolean getShowFocusedIcon()
If showFocusedAsOver
is true, the "Over"
icon
will be displayed when the canvas has focus, otherwise a seperate "Focused"
icon will be displayed
getShowFocusedIcon
in class StatefulCanvas
public void setShowDownIcon(Boolean showDownIcon) throws IllegalStateException
setShowDownIcon
in class StatefulCanvas
showDownIcon
- showDownIcon Default value is false
IllegalStateException
- this property cannot be changed after the component has been createdpublic Boolean getShowDownIcon()
getShowDownIcon
in class StatefulCanvas
public void setShowSelectedIcon(Boolean showSelectedIcon) throws IllegalStateException
setShowSelectedIcon
in class StatefulCanvas
showSelectedIcon
- showSelectedIcon Default value is false
IllegalStateException
- this property cannot be changed after the component has been createdpublic Boolean getShowSelectedIcon()
getShowSelectedIcon
in class StatefulCanvas
public void setAutoFit(Boolean autoFit)
setWidth()
is explicitly called on an autoFit:true button, autoFit will be reset to false
.
Note that for StretchImgButton instances, autoFit will occur horizontally only, as unpredictable vertical sizing is
likely to distort the media. If you do want vertical auto-fit, this can be achieved by simply setting a small height,
and having overflow:"visible"
Setter method for the autoFit
property. Pass in true or false to turn autoFit on or off. When autoFit is set to false
, canvas will be resized to it's previously specified size.
setAutoFit
in class StatefulCanvas
autoFit
- New autoFit setting.. Default value is nullpublic Boolean getAutoFit()
setWidth()
is explicitly called on an autoFit:true button, autoFit will be reset to false
. Note that for StretchImgButton instances, autoFit will occur horizontally only, as unpredictable vertical sizing is likely to distort the media. If you do want vertical auto-fit, this can be achieved by simply setting a small height, and having overflow:"visible"
getAutoFit
in class StatefulCanvas
public void setBaseStyle(String baseStyle)
When the component changes state (eg becomes disabled), a suffix will be appended to this style name, reflecting the following states: "Over", "Down", or "Disabled".
If the widget is selected, the suffixes will be "Selected", "SelectedOver", etc.
If the widget has focus and showFocused
is true, and showFocusedAsOver
is
false, the suffixes will be "Focused", "FocusedOver", etc, or if the widget is both selected and focused,
"SelectedFocused", "SelectedFocusedOver", etc.
For example, if baseStyle
is set to "button", this
component is isSelected()
and the mouse cursor is over this component, the
style "buttonSelectedOver" will be used.
Sets the base CSS style. As the component changes state and/or is selected, suffixes will be added to the base style.
setBaseStyle
in class StatefulCanvas
baseStyle
- new base style. Default value is "button"public String getBaseStyle()
When the component changes state (eg becomes disabled), a suffix will be appended to this style name, reflecting the following states: "Over", "Down", or "Disabled".
If the widget is selected, the suffixes will be "Selected", "SelectedOver", etc.
If the widget has focus and showFocused
is true, and showFocusedAsOver
is
false, the suffixes will be "Focused", "FocusedOver", etc, or if the widget is both selected and focused,
"SelectedFocused", "SelectedFocusedOver", etc.
For example, if baseStyle
is set to "button", this
component is isSelected()
and the mouse cursor is over this component, the
style "buttonSelectedOver" will be used.
getBaseStyle
in class StatefulCanvas
public void setSelected(Boolean selected)
setSelected
in class StatefulCanvas
selected
- selected Default value is falsepublic Boolean getSelected()
getSelected
in class StatefulCanvas
public void setRadioGroup(String radioGroup)
Note : This is an advanced setting
setRadioGroup
in class StatefulCanvas
radioGroup
- radioGroup Default value is nullpublic String getRadioGroup()
getRadioGroup
in class StatefulCanvas
public void setActionType(SelectionType actionType)
setActionType
in class StatefulCanvas
actionType
- actionType Default value is "button"public SelectionType getActionType()
getActionType
in class StatefulCanvas
public void setState(State state)
baseStyle
for a description of how this is done. For Img
or StretchImg
based subclasses of StatefulCanvas,
the appearance may also be updated by changing the src of the rendered image. See src
and src
for a
description of how the URL is modified to reflect the state of the widget in this case.
Set the 'state' of this object, this changes it's appearance.
Note : This is an advanced setting
setState
in class StatefulCanvas
state
- new state. Default value is ""public State getState()
baseStyle
for a description of how this is done. For Img
or StretchImg
based subclasses of StatefulCanvas,
the appearance may also be updated by changing the src of the rendered image. See src
and src
for a
description of how the URL is modified to reflect the state of the widget in this case.
getState
in class StatefulCanvas
public void setShowDisabled(Boolean showDisabled)
setShowDisabled
in class StatefulCanvas
showDisabled
- showDisabled Default value is truepublic Boolean getShowDisabled()
getShowDisabled
in class StatefulCanvas
public void setShowDown(Boolean showDown)
setShowDown
in class StatefulCanvas
showDown
- showDown Default value is falsepublic Boolean getShowDown()
getShowDown
in class StatefulCanvas
public void setShowFocused(Boolean showFocused)
showFocusedAsOver
is true
, the
"over"
will be used to indicate focus. Otherwise a separate "focused"
state will
be used.
setShowFocused
in class StatefulCanvas
showFocused
- showFocused Default value is falsepublic Boolean getShowFocused()
showFocusedAsOver
is true
, the
"over"
will be used to indicate focus. Otherwise a separate "focused"
state will
be used.
getShowFocused
in class StatefulCanvas
public void setShowRollOver(Boolean showRollOver)
setShowRollOver
in class StatefulCanvas
showRollOver
- showRollOver Default value is falsepublic Boolean getShowRollOver()
getShowRollOver
in class StatefulCanvas
public void setAlign(Alignment align)
setAlign
in class StatefulCanvas
align
- align Default value is Canvas.CENTERpublic Alignment getAlign()
getAlign
in class StatefulCanvas
public void setValign(VerticalAlignment valign)
setValign
in class StatefulCanvas
valign
- valign Default value is Canvas.CENTERpublic VerticalAlignment getValign()
getValign
in class StatefulCanvas
public void setWrap(Boolean wrap)
wrap
- whether to wrap the title. Default value is falsepublic Boolean getWrap()
public void select()
select
in class StatefulCanvas
public void deselect()
deselect
in class StatefulCanvas
public Boolean isSelected()
isSelected
in class StatefulCanvas
public void addToRadioGroup(String groupID)
addToRadioGroup
in class StatefulCanvas
groupID
- - ID of the radiogroup to which this widget should be addedpublic void removeFromRadioGroup()
removeFromRadioGroup
in class StatefulCanvas
public void removeFromRadioGroup(String groupID)
removeFromRadioGroup
in class StatefulCanvas
groupID
- - optional radio group ID (to ensure the widget is removed from the appropriate
group.public void setDisabled(boolean disabled)
setDisabled
in class StatefulCanvas
disabled
- true if this widget is to be disabledpublic void action()
public void setVAlign()
public HandlerRegistration addIconClickHandler(IconClickHandler handler)
If this button is showing an 'icon'
, a separate click handler for the
icon may be defined as this.iconClick
. Returning false will suppress the standard button click handling
code.
addIconClickHandler
in interface HasIconClickHandlers
handler
- the iconClick handler
HandlerRegistration
used to remove this handler
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |