|
|||||||||
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
public class StatefulCanvas
A component that has a set of possible states, and which presents itself differently according to which state it is in. An example is a button, which can be "up", "down", "over" or "disabled".
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 | |
---|---|
StatefulCanvas()
|
|
StatefulCanvas(JavaScriptObject jsObj)
|
Method Summary | |
---|---|
void |
addToRadioGroup(String groupID)
Add this widget to the specified mutually exclusive selection group with the ID passed in. |
protected JavaScriptObject |
create()
|
void |
deselect()
Deselect 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. |
String |
getIcon()
Optional icon to be shown with the button title text. |
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 StatefulCanvas |
getOrCreateRef(JavaScriptObject jsObj)
|
String |
getOverCanvasConstructor()
Constructor class name for this widgets 'overCanvas' |
String |
getRadioGroup()
String identifier for this canvas's mutually exclusive selection group. |
Boolean |
getRedrawOnStateChange()
Whether this widget needs to redraw to reflect state change |
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 |
getShowFocusedAsOver()
If 'showFocused' is true for this widget, should the
"over" state be used to indicate the widget as focused. |
Boolean |
getShowFocusedIcon()
If using an icon for this button, whether to switch the icon image when the button recieves focus. |
Boolean |
getShowOverCanvas()
When this property is set to true, this widget will create and show the overCanvas on user rollover. |
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. |
void |
getStateSuffix()
Returns the suffix that will be appended to the baseStyle as the component changes state and/or is selected. |
String |
getTitle()
The text title to display in this button. |
VerticalAlignment |
getValign()
Vertical alignment of this component's title. |
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 |
setIcon(String icon)
Optional icon to be shown with the button title text. |
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 |
setOverCanvasConstructor(String overCanvasConstructor)
Constructor class name for this widgets 'overCanvas' |
void |
setRadioGroup(String radioGroup)
String identifier for this canvas's mutually exclusive selection group. |
void |
setRedrawOnStateChange(Boolean redrawOnStateChange)
Whether this widget needs to redraw to reflect state change |
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 |
setShowFocusedAsOver(Boolean showFocusedAsOver)
If 'showFocused' is true for this widget, should the
"over" state be used to indicate the widget as focused. |
void |
setShowFocusedIcon(Boolean showFocusedIcon)
If using an icon for this button, whether to switch the icon image when the button recieves focus. |
void |
setShowOverCanvas(Boolean showOverCanvas)
When this property is set to true, this widget will create and show the overCanvas on user rollover. |
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 |
setTitleStyle(String titleStyle)
|
void |
setValign(VerticalAlignment valign)
Vertical alignment of this component's title. |
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 StatefulCanvas()
public StatefulCanvas(JavaScriptObject jsObj)
Method Detail |
---|
public static StatefulCanvas getOrCreateRef(JavaScriptObject jsObj)
protected JavaScriptObject create()
create
in class Canvas
public void setTitle(String title)
setTitle
in class Canvas
title
- new title. Default value is variespublic String getTitle()
getTitle
in class Canvas
Default is to simply return this.title.
public void setRedrawOnStateChange(Boolean redrawOnStateChange)
Note : This is an advanced setting
redrawOnStateChange
- redrawOnStateChange Default value is falsepublic Boolean getRedrawOnStateChange()
public void setSelected(Boolean selected)
selected
- new boolean value of whether or not the object is selected.. Default value is falsepublic Boolean getSelected()
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
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.
public void setShowRollOver(Boolean showRollOver)
showRollOver
- showRollOver Default value is falsepublic Boolean getShowRollOver()
public void setShowFocused(Boolean showFocused)
showFocusedAsOver
is true
, the
"over"
will be used to indicate focus. Otherwise a separate "focused"
state will
be used.
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.
public void setShowFocusedAsOver(Boolean showFocusedAsOver)
'showFocused'
is true for this widget, should the
"over"
state be used to indicate the widget as focused. If set to false, a separate "focused"
state will be used.
showFocusedAsOver
- showFocusedAsOver Default value is truepublic Boolean getShowFocusedAsOver()
'showFocused'
is true for this widget, should the
"over"
state be used to indicate the widget as focused. If set to false, a separate "focused"
state will be used.
public void setShowDown(Boolean showDown)
showDown
- showDown Default value is falsepublic Boolean getShowDown()
public void setShowDisabled(Boolean showDisabled)
showDisabled
- showDisabled Default value is truepublic Boolean getShowDisabled()
public void setActionType(SelectionType actionType)
actionType
- actionType Default value is "button"public SelectionType getActionType()
public void setRadioGroup(String radioGroup)
Note : This is an advanced setting
radioGroup
- radioGroup Default value is nullpublic String getRadioGroup()
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.
baseStyle
- new base style. Default value is nullpublic 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.
public void setAlign(Alignment align)
setAlign
in class Canvas
align
- align Default value is Canvas.CENTERpublic Alignment getAlign()
public void setValign(VerticalAlignment valign)
valign
- valign Default value is Canvas.CENTERpublic VerticalAlignment getValign()
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.
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"
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.
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.
public void setIconSize(int iconSize) throws IllegalStateException
The iconWidth
and iconHeight
properties can be used to
configure width and height separately.
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.
public void setIconWidth(Integer iconWidth) throws IllegalStateException
If unset, defaults to iconSize
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
public void setIconHeight(Integer iconHeight) throws IllegalStateException
If unset, defaults to iconSize
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
public void setIconOrientation(String iconOrientation) throws IllegalStateException
"left"
and "right"
.
Changes the orientation of the icon relative to the text of the button.
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"
.
public void setShowDisabledIcon(Boolean showDisabledIcon) throws IllegalStateException
showDisabledIcon
- showDisabledIcon Default value is true
IllegalStateException
- this property cannot be changed after the component has been createdpublic Boolean getShowDisabledIcon()
public void setShowRollOverIcon(Boolean showRollOverIcon) throws IllegalStateException
showRollOverIcon
- showRollOverIcon Default value is false
IllegalStateException
- this property cannot be changed after the component has been createdpublic Boolean getShowRollOverIcon()
public void setShowDownIcon(Boolean showDownIcon) throws IllegalStateException
showDownIcon
- showDownIcon Default value is false
IllegalStateException
- this property cannot be changed after the component has been createdpublic Boolean getShowDownIcon()
public void setShowSelectedIcon(Boolean showSelectedIcon) throws IllegalStateException
showSelectedIcon
- showSelectedIcon Default value is false
IllegalStateException
- this property cannot be changed after the component has been createdpublic Boolean getShowSelectedIcon()
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
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
public void setShowOverCanvas(Boolean showOverCanvas)
overCanvas
on user rollover.
Note : This is an advanced setting
showOverCanvas
- showOverCanvas Default value is falsepublic Boolean getShowOverCanvas()
overCanvas
on user rollover.
public void setOverCanvasConstructor(String overCanvasConstructor)
'overCanvas'
Note : This is an advanced setting
overCanvasConstructor
- overCanvasConstructor Default value is "Canvas"public String getOverCanvasConstructor()
'overCanvas'
public void select()
public void deselect()
public Boolean isSelected()
public void addToRadioGroup(String groupID)
groupID
- - ID of the radiogroup to which this widget should be addedpublic void removeFromRadioGroup()
public void removeFromRadioGroup(String groupID)
groupID
- - optional radio group ID (to ensure the widget is removed from the appropriate
group.public void setDisabled(boolean disabled)
setDisabled
in class Canvas
disabled
- true if this widget is to be disabledpublic void getStateSuffix()
baseStyle
as the component changes state and/or is selected. 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.
public void setTitleStyle(String titleStyle)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |