com.smartgwt.client.widgets
Class StatefulCanvas

java.lang.Object
  com.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

All Implemented Interfaces:

HasAttachHandlers, HasHandlers, EventListener, HasVisibility, IsWidget, LogicalStructure, HasClickHandlers, HasDoubleClickHandlers, HasDragMoveHandlers, HasDragRepositionMoveHandlers, HasDragRepositionStartHandlers, HasDragRepositionStopHandlers, HasDragResizeMoveHandlers, HasDragResizeStartHandlers, HasDragResizeStopHandlers, HasDragStartHandlers, HasDragStopHandlers, HasDropHandlers, HasDropMoveHandlers, HasDropOutHandlers, HasDropOverHandlers, HasFocusChangedHandlers, HasHoverHandlers, HasHoverHiddenHandlers, HasKeyDownHandlers, HasKeyPressHandlers, HasMouseDownHandlers, HasMouseMoveHandlers, HasMouseOutHandlers, HasMouseOverHandlers, HasMouseStillDownHandlers, HasMouseUpHandlers, HasMouseWheelHandlers, HasMovedHandlers, HasParentMovedHandlers, HasResizedHandlers, HasRightMouseDownHandlers, HasScrolledHandlers, HasShowContextMenuHandlers, HasVisibilityChangedHandlers

Direct Known Subclasses:

Button, Img, SimpleTile, StretchImg

public class StatefulCanvas
extends Canvas

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, nativeObject, 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 accommodate 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.
com.smartgwt.logicalstructure.core.LogicalStructureObject	getLogicalStructure()
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 receives 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 receives 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.
String	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 If this method is called after the component has been drawn/initialized: 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 accommodate the title.
void	setBaseStyle(String baseStyle) Base CSS style.
static void	setDefaultProperties(StatefulCanvas statefulCanvasProperties) Class level method to set the default properties of this class.
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	setJavaScriptObject(JavaScriptObject jsObj)
com.smartgwt.logicalstructure.core.LogicalStructureObject	setLogicalStructure(com.smartgwt.logicalstructure.widgets.StatefulCanvasLogicalStructure s)
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 receives 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 receives 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.smartgwt.client.widgets.Canvas

addChild, addChild, addChild, addChild, addClickHandler, addDoubleClickHandler, addDragMoveHandler, addDragRepositionMoveHandler, addDragRepositionStartHandler, addDragRepositionStopHandler, addDragResizeMoveHandler, addDragResizeStartHandler, addDragResizeStopHandler, addDragStartHandler, addDragStopHandler, addDropHandler, addDropMoveHandler, addDropOutHandler, addDropOverHandler, addFocusChangedHandler, addHoverHandler, addHoverHiddenHandler, addKeyDownHandler, addKeyPressHandler, addMouseDownHandler, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseStillDownHandler, addMouseUpHandler, addMouseWheelHandler, addMovedHandler, addParentMovedHandler, addPeer, addPeer, addResizedHandler, addRightMouseDownHandler, addScrolledHandler, addShowContextMenuHandler, addStyleName, addVisibilityChangedHandler, adjustForContent, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateMove, animateMove, animateMove, animateMove, animateRect, animateRect, animateRect, animateResize, animateResize, animateResize, animateScroll, animateScroll, animateScroll, animateShow, animateShow, animateShow, blur, bringToFront, clear, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsFocus, containsPoint, containsPoint, convertToCanvasArray, deparent, depeer, disable, enable, focus, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaRole, getAttribute, getAutoDraw, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBottom, getById, getCanAcceptDrop, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanHover, getCanSelectText, getCanvasItem, getChildren, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getClassName, getContents, getContextMenu, getCursor, getDataPath, getDefaultHeight, getDefaultWidth, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragType, getDropTypes, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFullDataPath, getGroupTitle, getHeight, getHeightAsString, getHoverAlign, getHoverAutoDestroy, getHoverComponent, getHoverDelay, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapOrigin, getHSnapOrigin, getHSnapPosition, getHSnapPosition, getHtmlPosition, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getKeepInParentRect, getLayoutAlign, getLeft, getLeftAsString, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getMargin, getMasterElement, getMatchElement, getMaxHeight, getMaxWidth, getMenuConstructor, getMinHeight, getMinWidth, getMouseStillDownDelay, getMouseStillDownInitialDelay, getNextZIndex, getNoDoubleClicks, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOverflow, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getParentElement, getParentElements, getPeers, getPercentBox, getPercentSource, getPosition, getPrefix, getPrintChildrenAbsolutelyPositioned, getPrintHTML, getPrintHTML, getPrompt, getRect, getRedrawOnResize, getResizeBarTarget, getResizeFrom, getRight, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowDepth, getShadowImage, getShadowOffset, getShadowSoftness, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowHover, getShowHoverComponents, getShowResizeBar, getShowShadow, getSkinImgDir, getSnapAxis, getSnapEdge, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapResizeToGrid, getSnapTo, getSnapToGrid, getSnapVDirection, getSnapVGap, getStyleName, getTabIndex, getTooltip, getTop, getTopAsString, getTopElement, getUseBackMask, getUseOpacityFilter, getValuesManager, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWidth, getVSnapOrigin, getVSnapOrigin, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideContextMenu, imgHTML, imgHTML, imgHTML, intersects, isDirty, isDisabled, isDrawn, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, markForDestroy, markForRedraw, markForRedraw, moveAbove, moveBelow, moveBy, moveTo, onAttach, onDetach, onInit, parentResized, printComponents, redraw, redraw, removeChild, removeChild, removePeer, removePeer, resizeBy, resizeTo, resizeTo, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAllowExternalFilters, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaRole, setAutoDraw, setAutoHeight, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBottom, setCanAcceptDrop, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setCanvasItem, setChildren, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setContents, setContextMenu, setCursor, setDataPath, setDefaultHeight, setDefaultProperties, setDefaultWidth, setDisabled, setDisabledCursor, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragType, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setExtraSpace, setFacetId, setGroupTitle, setHeight, setHeight, setHeight100, setHoverAlign, setHoverAutoDestroy, setHoverDelay, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlPosition, setImage, setImage, setIsGroup, setKeepInParentRect, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeft, setLeft, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLogicalStructure, setMargin, setMatchElement, setMaxHeight, setMaxWidth, setMenuConstructor, setMinHeight, setMinWidth, setMouseStillDownDelay, setMouseStillDownInitialDelay, setNeverUseFilters, setNoDoubleClicks, setOpacity, setOverflow, setPadding, setPageLeft, setPageTop, setParentElement, setPeers, setPercentBox, setPercentSource, setPosition, setPrefix, setPrintChildrenAbsolutelyPositioned, setPrompt, setRect, setRect, setRedrawOnResize, setResizeBarTarget, setResizeFrom, setResizeFrom, setRight, setScrollbarSize, setShadowDepth, setShadowImage, setShadowOffset, setShadowSoftness, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowHover, setShowHoverComponents, setShowResizeBar, setShowShadow, setSkinImgDir, setSmoothFade, setSnapAxis, setSnapEdge, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToGrid, setSnapTo, setSnapToGrid, setSnapVDirection, setSnapVGap, setStyleName, setTabIndex, setTooltip, setTop, setTop, setUseBackMask, setUseOpacityFilter, setValuesManager, setVisibility, setVisible, setWidth, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showClickMask, showNextTo, showNextTo, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, updateHover, updateHover, updateShadow, visibleAtPoint, willAcceptDrop

Methods inherited from class com.smartgwt.client.widgets.BaseWidget

addDrawHandler, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, fireEvent, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getElement, getElement, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hashCode, initNativeObject, isConfigOnly, isCreated, onDestroy, onDraw, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setDragTracker, setElement, setHtmlElement, setID, setLogicalStructure, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setScClassName, toString

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

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, 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, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent, 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

StatefulCanvas

public StatefulCanvas()

StatefulCanvas

public StatefulCanvas(JavaScriptObject jsObj)

Method Detail

getOrCreateRef

public static StatefulCanvas getOrCreateRef(JavaScriptObject jsObj)

setJavaScriptObject

public void setJavaScriptObject(JavaScriptObject jsObj)

Overrides:

setJavaScriptObject in class Canvas

create

protected JavaScriptObject create()

Overrides:

create in class Canvas

setActionType

public void setActionType(SelectionType actionType)

Behavior on state changes -- BUTTON, RADIO or CHECKBOX

If this method is called after the component has been drawn/initialized: 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.

Parameters:

actionType - actionType Default value is "button"

See Also:

State overview and related methods

getActionType

public SelectionType getActionType()

Behavior on state changes -- BUTTON, RADIO or CHECKBOX

Returns:

Return the 'actionType' for this canvas (radio / checkbox / button)

See Also:

State overview and related methods

setAlign

public void setAlign(Alignment align)

Horizontal alignment of this component's title.

Overrides:

setAlign in class Canvas

Parameters:

align - align Default value is Canvas.CENTER

See Also:

Appearance overview and related methods

getAlign

public Alignment getAlign()

Horizontal alignment of this component's title.

Returns:

Alignment

See Also:

Appearance overview and related methods

setAutoFit

public void setAutoFit(Boolean autoFit)

If true, ignore the specified size of this widget and always size just large enough to accommodate the title. If 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"

If this method is called after the component has been drawn/initialized: 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.

Parameters:

autoFit - New autoFit setting.. Default value is null

See Also:

Sizing overview and related methods

getAutoFit

public Boolean getAutoFit()

If true, ignore the specified size of this widget and always size just large enough to accommodate the title. If 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"

Returns:

Boolean

See Also:

Sizing overview and related methods

setBaseStyle

public void setBaseStyle(String baseStyle)

Base CSS style. As the component changes state and/or is selected, suffixes will be added to the base style.

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 selected and the mouse cursor is over this component, the style "buttonSelectedOver" will be used.

If this method is called after the component has been drawn/initialized: Sets the base CSS style. As the component changes state and/or is selected, suffixes will be added to the base style.

Parameters:

baseStyle - new base style. See CSSStyleName. Default value is null

getBaseStyle

public String getBaseStyle()

Base CSS style. As the component changes state and/or is selected, suffixes will be added to the base style.

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 selected and the mouse cursor is over this component, the style "buttonSelectedOver" will be used.

Returns:

. See CSSStyleName

setIcon

public void setIcon(String icon)

Optional icon to be shown with the button title text.

Specify as the partial URL to an image, relative to the imgDir of this component.

If this method is called after the component has been drawn/initialized: Change the icon being shown next to the title text.

Parameters:

icon - URL of new icon. See SCImgURL. Default value is null

See Also:

ButtonIcon overview and related methods

getIcon

public String getIcon()

Optional icon to be shown with the button title text.

Specify as the partial URL to an image, relative to the imgDir of this component.

Returns:

. See SCImgURL

See Also:

ButtonIcon overview and related methods

setIconHeight

public void setIconHeight(Integer iconHeight)
                   throws IllegalStateException

Height in pixels of the icon image.

If unset, defaults to iconSize

Parameters:

iconHeight - iconHeight Default value is null

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

ButtonIcon overview and related methods

getIconHeight

public Integer getIconHeight()

Height in pixels of the icon image.

If unset, defaults to iconSize

Returns:

Integer

See Also:

ButtonIcon overview and related methods

setIconOrientation

public void setIconOrientation(String iconOrientation)
                        throws IllegalStateException

If this button is showing an icon should it appear to the left or right of the title? valid options are "left" and "right".

If this method is called after the component has been drawn/initialized: Changes the orientation of the icon relative to the text of the button.

Parameters:

iconOrientation - The new orientation of the icon relative to the text of the button.. See String. Default value is "left"

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

ButtonIcon overview and related methods

getIconOrientation

public 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".

Returns:

. See String

See Also:

ButtonIcon overview and related methods

setIconSize

public void setIconSize(int iconSize)
                 throws IllegalStateException

Size in pixels of the icon image.

The iconWidth and iconHeight properties can be used to configure width and height separately.

Parameters:

iconSize - iconSize Default value is 16

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

ButtonIcon overview and related methods

getIconSize

public int getIconSize()

Size in pixels of the icon image.

The iconWidth and iconHeight properties can be used to configure width and height separately.

Returns:

int

See Also:

ButtonIcon overview and related methods

setIconWidth

public void setIconWidth(Integer iconWidth)
                  throws IllegalStateException

Width in pixels of the icon image.

If unset, defaults to iconSize

Parameters:

iconWidth - iconWidth Default value is null

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

ButtonIcon overview and related methods

getIconWidth

public Integer getIconWidth()

Width in pixels of the icon image.

If unset, defaults to iconSize

Returns:

Integer

See Also:

ButtonIcon overview and related methods

setOverCanvasConstructor

public void setOverCanvasConstructor(String overCanvasConstructor)

Constructor class name for this widgets overCanvas

Note : This is an advanced setting

Parameters:

overCanvasConstructor - . See String. Default value is "Canvas"

getOverCanvasConstructor

public String getOverCanvasConstructor()

Constructor class name for this widgets overCanvas

Returns:

. See String

setRadioGroup

public void setRadioGroup(String radioGroup)

String identifier for this canvas's mutually exclusive selection group.

Note : This is an advanced setting

Parameters:

radioGroup - . See String. Default value is null

See Also:

State overview and related methods

getRadioGroup

public String getRadioGroup()

String identifier for this canvas's mutually exclusive selection group.

Returns:

. See String

See Also:

State overview and related methods

setRedrawOnStateChange

public void setRedrawOnStateChange(Boolean redrawOnStateChange)

Whether this widget needs to redraw to reflect state change

Note : This is an advanced setting

Parameters:

redrawOnStateChange - redrawOnStateChange Default value is false

See Also:

State overview and related methods

getRedrawOnStateChange

public Boolean getRedrawOnStateChange()

Whether this widget needs to redraw to reflect state change

Returns:

Boolean

See Also:

State overview and related methods

setSelected

public void setSelected(Boolean selected)

Whether this component is selected. For some components, selection affects appearance.

If this method is called after the component has been drawn/initialized: Set this object to be selected or deselected.

Parameters:

selected - new boolean value of whether or not the object is selected.. Default value is false

See Also:

State overview and related methods

getSelected

public Boolean getSelected()

Whether this component is selected. For some components, selection affects appearance.

Returns:

Boolean

See Also:

State overview and related methods

setShowDisabled

public void setShowDisabled(Boolean showDisabled)

Should we visibly change state when disabled?

Parameters:

showDisabled - showDisabled Default value is true

See Also:

State overview and related methods

getShowDisabled

public Boolean getShowDisabled()

Should we visibly change state when disabled?

Returns:

Boolean

See Also:

State overview and related methods

setShowDisabledIcon

public void setShowDisabledIcon(Boolean showDisabledIcon)
                         throws IllegalStateException

If using an icon for this button, whether to switch the icon image if the button becomes disabled.

Parameters:

showDisabledIcon - showDisabledIcon Default value is true

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

ButtonIcon overview and related methods

getShowDisabledIcon

public Boolean getShowDisabledIcon()

If using an icon for this button, whether to switch the icon image if the button becomes disabled.

Returns:

Boolean

See Also:

ButtonIcon overview and related methods

setShowDown

public void setShowDown(Boolean showDown)

Should we visibly change state when the mouse goes down in this object?

Parameters:

showDown - showDown Default value is false

See Also:

State overview and related methods

getShowDown

public Boolean getShowDown()

Should we visibly change state when the mouse goes down in this object?

Returns:

Boolean

See Also:

State overview and related methods

setShowDownIcon

public void setShowDownIcon(Boolean showDownIcon)
                     throws IllegalStateException

If using an icon for this button, whether to switch the icon image when the mouse goes down on the button.

Parameters:

showDownIcon - showDownIcon Default value is false

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

ButtonIcon overview and related methods

getShowDownIcon

public Boolean getShowDownIcon()

If using an icon for this button, whether to switch the icon image when the mouse goes down on the button.

Returns:

Boolean

See Also:

ButtonIcon overview and related methods

setShowFocused

public void setShowFocused(Boolean showFocused)

Should we visibly change state when the canvas receives focus? If showFocusedAsOver is true, the "over" will be used to indicate focus. Otherwise a separate "focused" state will be used.

Parameters:

showFocused - showFocused Default value is false

See Also:

State overview and related methods

getShowFocused

public Boolean getShowFocused()

Should we visibly change state when the canvas receives focus? If showFocusedAsOver is true, the "over" will be used to indicate focus. Otherwise a separate "focused" state will be used.

Returns:

Boolean

See Also:

State overview and related methods

setShowFocusedAsOver

public void setShowFocusedAsOver(Boolean showFocusedAsOver)

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

Parameters:

showFocusedAsOver - showFocusedAsOver Default value is true

See Also:

State overview and related methods

getShowFocusedAsOver

public Boolean getShowFocusedAsOver()

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

Returns:

Boolean

See Also:

State overview and related methods

setShowFocusedIcon

public void setShowFocusedIcon(Boolean showFocusedIcon)
                        throws IllegalStateException

If using an icon for this button, whether to switch the icon image when the button receives focus.

If showFocusedAsOver is true, the "Over" icon will be displayed when the canvas has focus, otherwise a separate "Focused" icon will be displayed

Parameters:

showFocusedIcon - showFocusedIcon Default value is false

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

ButtonIcon overview and related methods

getShowFocusedIcon

public Boolean getShowFocusedIcon()

If using an icon for this button, whether to switch the icon image when the button receives focus.

If showFocusedAsOver is true, the "Over" icon will be displayed when the canvas has focus, otherwise a separate "Focused" icon will be displayed

Returns:

Boolean

See Also:

ButtonIcon overview and related methods

setShowOverCanvas

public void setShowOverCanvas(Boolean showOverCanvas)

When this property is set to true, this widget will create and show the overCanvas on user rollover.

Note : This is an advanced setting

Parameters:

showOverCanvas - showOverCanvas Default value is false

getShowOverCanvas

public Boolean getShowOverCanvas()

When this property is set to true, this widget will create and show the overCanvas on user rollover.

Returns:

Boolean

setShowRollOver

public void setShowRollOver(Boolean showRollOver)

Should we visibly change state when the mouse goes over this object?

Parameters:

showRollOver - showRollOver Default value is false

See Also:

State overview and related methods

getShowRollOver

public Boolean getShowRollOver()

Should we visibly change state when the mouse goes over this object?

Returns:

Boolean

See Also:

State overview and related methods

setShowRollOverIcon

public void setShowRollOverIcon(Boolean showRollOverIcon)
                         throws IllegalStateException

If using an icon for this button, whether to switch the icon image on mouse rollover.

Parameters:

showRollOverIcon - showRollOverIcon Default value is false

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

ButtonIcon overview and related methods

getShowRollOverIcon

public Boolean getShowRollOverIcon()

If using an icon for this button, whether to switch the icon image on mouse rollover.

Returns:

Boolean

See Also:

ButtonIcon overview and related methods

setShowSelectedIcon

public void setShowSelectedIcon(Boolean showSelectedIcon)
                         throws IllegalStateException

If using an icon for this button, whether to switch the icon image when the button becomes selected.

Parameters:

showSelectedIcon - showSelectedIcon Default value is false

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

ButtonIcon overview and related methods

getShowSelectedIcon

public Boolean getShowSelectedIcon()

If using an icon for this button, whether to switch the icon image when the button becomes selected.

Returns:

Boolean

See Also:

ButtonIcon overview and related methods

setState

public void setState(State state)

Current "state" of this widget. StatefulCanvases will have a different appearance based on their current state. By default this is handled by changing the css className applied to the StatefulCanvas - see 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.

If this method is called after the component has been drawn/initialized: Set the 'state' of this object, this changes it's appearance.

Note : This is an advanced setting

Parameters:

state - new state. Default value is ""

See Also:

State, State overview and related methods

getState

public State getState()

Current "state" of this widget. StatefulCanvases will have a different appearance based on their current state. By default this is handled by changing the css className applied to the StatefulCanvas - see 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.

Returns:

Return the state of this StatefulCanvas

See Also:

State, State overview and related methods

setTitle

public void setTitle(String title)

The text title to display in this button.

If this method is called after the component has been drawn/initialized: Set the title.

Overrides:

setTitle in class Canvas

Parameters:

title - new title. See HTMLString. Default value is varies

See Also:

Basics overview and related methods

getTitle

public String getTitle()

The text title to display in this button.

Overrides:

getTitle in class Canvas

Returns:

Return the title - text/HTML drawn inside the component.

Default is to simply return this.title.. See HTMLString

See Also:

Basics overview and related methods

setValign

public void setValign(VerticalAlignment valign)

Vertical alignment of this component's title.

Parameters:

valign - valign Default value is Canvas.CENTER

See Also:

Appearance overview and related methods

getValign

public VerticalAlignment getValign()

Vertical alignment of this component's title.

Returns:

VerticalAlignment

See Also:

Appearance overview and related methods

addToRadioGroup

public void addToRadioGroup(String groupID)

Add this widget to the specified mutually exclusive selection group with the ID passed in. Selecting this widget will then deselect any other StatefulCanvases with the same radioGroup ID. StatefulCanvases can belong to only one radioGroup, so this method will remove from any other radiogroup of which this button is already a member.

Parameters:

groupID - - ID of the radiogroup to which this widget should be added

deselect

public void deselect()

Deselect this object.

getStateSuffix

public String getStateSuffix()

Returns the suffix that will be appended to the 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 selected and the mouse cursor is over this component, the style "buttonSelectedOver" will be used.

Returns:

suffix to be appended to the baseStyle

isSelected

public Boolean isSelected()

Find out if this object is selected

Returns:

See Also:

State overview and related methods

removeFromRadioGroup

public void removeFromRadioGroup()

Remove this widget from the specified mutually exclusive selection group with the ID passed in. No-op's if this widget is not a member of the groupID passed in. If no groupID is passed in, defaults to removing from whatever radioGroup this widget is a member of.

removeFromRadioGroup

public void removeFromRadioGroup(String groupID)

Remove this widget from the specified mutually exclusive selection group with the ID passed in. No-op's if this widget is not a member of the groupID passed in. If no groupID is passed in, defaults to removing from whatever radioGroup this widget is a member of.

Parameters:

groupID - - optional radio group ID (to ensure the widget is removed from the appropriate group.

See Also:

State overview and related methods

select

public void select()

Select this object.

setDefaultProperties

public static void setDefaultProperties(StatefulCanvas statefulCanvasProperties)

Class level method to set the default properties of this class. If set, then all subsequent instances of this class will automatically have the default properties that were set when this method was called. This is a powerful feature that eliminates the need for users to create a separate hierarchy of subclasses that only alter the default properties of this class. Can also be used for skinning / styling purposes.

Note: This method is intended for setting default attributes only and will effect all instances of the underlying class (including those automatically generated in JavaScript). This method should not be used to apply standard EventHandlers or override methods for a class - use a custom subclass instead.

Parameters:

statefulCanvasProperties - properties that should be used as new defaults when instances of this class are created

setTitleStyle

public void setTitleStyle(String titleStyle)

setLogicalStructure

public com.smartgwt.logicalstructure.core.LogicalStructureObject setLogicalStructure(com.smartgwt.logicalstructure.widgets.StatefulCanvasLogicalStructure s)

getLogicalStructure

public com.smartgwt.logicalstructure.core.LogicalStructureObject getLogicalStructure()

Specified by:

getLogicalStructure in interface LogicalStructure

Overrides:

getLogicalStructure in class Canvas