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:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.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

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field Summary

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

config, configOnly, factoryCreated, factoryProperties, id, nativeObject, scClassName

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
StatefulCanvas()
StatefulCanvas(com.google.gwt.core.client.JavaScriptObject jsObj)

Method Summary

Modifier and Type	Method and Description
void	addToRadioGroup(java.lang.String groupID) Add this widget to the specified mutually exclusive selection group with the ID passed in.
static void	changeAutoChildDefaults(java.lang.String autoChildName, Canvas defaults) Changes the defaults for Canvas AutoChildren named autoChildName.
static void	changeAutoChildDefaults(java.lang.String autoChildName, FormItem defaults) Changes the defaults for FormItem AutoChildren named autoChildName.
protected com.google.gwt.core.client.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.
java.lang.Boolean	getAutoFit() If true, ignore the specified size of this widget and always size just large enough to accommodate the title.
java.lang.String	getBaseStyle() Base CSS style className applied to the component.
java.lang.String	getEditProxyConstructor() Default class used to construct the EditProxy for this component when the component is first placed into edit mode.
java.lang.String	getIcon() Optional icon to be shown with the button title text.
java.lang.Integer	getIconHeight() Height in pixels of the icon image.
java.lang.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.
java.lang.String	getIconStyle() Base CSS style applied to the icon image.
java.lang.Integer	getIconWidth() Width in pixels of the icon image.
boolean	getIgnoreRTL() Should horizontal alignment-related attributes align and iconOrientation be mirrored in RTL mode? This is the default behavior unless ignoreRTL is set to true.
com.smartgwt.logicalstructure.core.LogicalStructureObject	getLogicalStructure() Getter implementing the LogicalStructure interface, which supports Eclipse's logical structure debugging facility.
static StatefulCanvas	getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
Canvas	getOverCanvas() Auto generated child widget to be shown when the user rolls over this canvas if showOverCanvas is true.
java.lang.String	getOverCanvasConstructor() Constructor class name for this widget's overCanvas
java.lang.String	getRadioGroup() String identifier for this canvas's mutually exclusive selection group.
java.lang.Boolean	getRedrawOnStateChange() Whether this widget needs to redraw to reflect state change
java.lang.Boolean	getSelected() Whether this component is selected.
java.lang.Boolean	getShowDisabled() Should we visibly change state when disabled?
java.lang.Boolean	getShowDisabledIcon() If using an icon for this button, whether to switch the icon image if the button becomes disabled.
java.lang.Boolean	getShowDown() Should we visibly change state when the mouse goes down in this object?
java.lang.Boolean	getShowDownIcon() If using an icon for this button, whether to switch the icon image when the mouse goes down on the button.
java.lang.Boolean	getShowFocused() Should we visibly change state when the canvas receives focus? If showFocusedAsOver is true, then "over" will be used to indicate focus.
java.lang.Boolean	getShowFocusedAsOver() If showFocused is true for this widget, should the "over" state be used to indicate the widget as focused.
java.lang.Boolean	getShowFocusedIcon() If using an icon for this button, whether to switch the icon image when the button receives focus.
java.lang.Boolean	getShowOverCanvas() When this property is set to true, this widget will create and show the overCanvas on user rollover.
java.lang.Boolean	getShowRollOver() Should we visibly change state when the mouse goes over this object?
java.lang.Boolean	getShowRollOverIcon() If using an icon for this button, whether to switch the icon image on mouse rollover.
boolean	getShowRTLIcon() Is RTL media available for the icon? If true, then in RTL mode, the image's src will have "_rtl" inserted immediately before the file extension.
java.lang.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.
java.lang.String	getStateSuffix() Returns the suffix that will be appended to the baseStyle as the component changes state and/or is selected / focused.
java.lang.String	getTitle() The title HTML to display in this button.
VerticalAlignment	getValign() Vertical alignment of this component's title.
java.lang.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(java.lang.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(java.lang.Boolean autoFit) If true, ignore the specified size of this widget and always size just large enough to accommodate the title.
void	setBaseStyle(java.lang.String baseStyle) Base CSS style className applied to the component.
static void	setDefaultProperties(StatefulCanvas statefulCanvasProperties) Class level method to set the default properties of this class.
void	setEditProxyConstructor(java.lang.String editProxyConstructor) Default class used to construct the EditProxy for this component when the component is first placed into edit mode.
void	setIcon(java.lang.String icon) Optional icon to be shown with the button title text.
void	setIconHeight(java.lang.Integer iconHeight) Height in pixels of the icon image.
void	setIconOrientation(java.lang.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	setIconStyle(java.lang.String iconStyle) Base CSS style applied to the icon image.
void	setIconWidth(java.lang.Integer iconWidth) Width in pixels of the icon image.
void	setIgnoreRTL(boolean ignoreRTL) Should horizontal alignment-related attributes align and iconOrientation be mirrored in RTL mode? This is the default behavior unless ignoreRTL is set to true.
com.smartgwt.logicalstructure.core.LogicalStructureObject	setLogicalStructure(com.smartgwt.logicalstructure.widgets.StatefulCanvasLogicalStructure s) Setter implementing the LogicalStructure interface, which supports Eclipse's logical structure debugging facility.
void	setOverCanvasConstructor(java.lang.String overCanvasConstructor) Constructor class name for this widget's overCanvas
void	setRadioGroup(java.lang.String radioGroup) String identifier for this canvas's mutually exclusive selection group.
void	setRedrawOnStateChange(java.lang.Boolean redrawOnStateChange) Whether this widget needs to redraw to reflect state change
void	setSelected(java.lang.Boolean selected) Whether this component is selected.
void	setShowDisabled(java.lang.Boolean showDisabled) Should we visibly change state when disabled?
void	setShowDisabledIcon(java.lang.Boolean showDisabledIcon) If using an icon for this button, whether to switch the icon image if the button becomes disabled.
void	setShowDown(java.lang.Boolean showDown) Should we visibly change state when the mouse goes down in this object?
void	setShowDownIcon(java.lang.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(java.lang.Boolean showFocused) Should we visibly change state when the canvas receives focus? If showFocusedAsOver is true, then "over" will be used to indicate focus.
void	setShowFocusedAsOver(java.lang.Boolean showFocusedAsOver) If showFocused is true for this widget, should the "over" state be used to indicate the widget as focused.
void	setShowFocusedIcon(java.lang.Boolean showFocusedIcon) If using an icon for this button, whether to switch the icon image when the button receives focus.
void	setShowOverCanvas(java.lang.Boolean showOverCanvas) When this property is set to true, this widget will create and show the overCanvas on user rollover.
void	setShowRollOver(java.lang.Boolean showRollOver) Should we visibly change state when the mouse goes over this object?
void	setShowRollOverIcon(java.lang.Boolean showRollOverIcon) If using an icon for this button, whether to switch the icon image on mouse rollover.
void	setShowRTLIcon(boolean showRTLIcon) Is RTL media available for the icon? If true, then in RTL mode, the image's src will have "_rtl" inserted immediately before the file extension.
void	setShowSelectedIcon(java.lang.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(java.lang.String title) The title HTML to display in this button.
void	setTitleStyle(java.lang.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, 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, addPeer, addPeer, addResizedHandler, addRightMouseDownHandler, addScrolledHandler, addShowContextMenuHandler, addSnapAlignCandidate, addStyleName, addVisibilityChangedHandler, adjustForContent, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateMove, animateMove, animateMove, animateMove, animateRect, animateRect, animateRect, animateRect, animateResize, animateResize, animateResize, animateResize, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateShow, animateShow, animateShow, animateShow, animateShow, animateShow, asSGWTComponent, blur, bringToFront, clear, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsFocus, containsPoint, containsPoint, deparent, depeer, disable, enable, encloses, focus, focusInNextTabElement, focusInPreviousTabElement, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAlwaysShowScrollbars, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaRole, getAutoDraw, getAutoMaskComponents, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBottom, getById, getByJSObject, getByLocalId, getCanAcceptDrop, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanHover, getCanSelectText, getCanvasAutoChild, getCanvasItem, getChildren, getChildrenResizeSnapAlign, getChildrenSnapAlign, getChildrenSnapCenterAlign, getChildrenSnapEdgeAlign, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getClassName, getComponentMask, getComponentMaskDefaults, getContentElement, getContents, getContextMenu, getCursor, getDataPath, getDefaultHeight, getDefaultWidth, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDisableTouchScrollingForDrag, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragMaskType, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragType, getDropTypes, getDropTypesAsString, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getEditNode, getEditProxy, getElement, getElement, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFormItemAutoChild, getFullDataPath, getGroupBorderCSS, getGroupLabelBackgroundColor, getGroupLabelStyleName, getGroupTitle, getHeight, getHeightAsString, getHideUsingDisplayNone, getHoverAlign, getHoverAutoDestroy, getHoverComponent, getHoverDelay, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapOrigin, getHSnapOrigin, getHSnapPosition, getHSnapPosition, getHtmlElement, getHtmlPosition, getImage, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getIsPrinting, getIsSnapAlignCandidate, getKeepInParentRect, getLayoutAlign, getLeavePageSpace, getLeft, getLeftAsString, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getMargin, getMasterCanvas, getMasterElement, getMatchElement, getMaxHeight, getMaxWidth, getMenuConstructor, getMinHeight, getMinNonEdgeSize, getMinWidth, getMomentumScrollMinSpeed, getMouseStillDownDelay, getMouseStillDownInitialDelay, getNextZIndex, getNoDoubleClicks, getNoDropCursor, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOuterElement, getOverflow, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getPanelContainer, getParentCanvas, getParentElement, getPeers, getPercentBox, getPercentSource, getPosition, getPrefix, getPrintChildrenAbsolutelyPositioned, getPrintHTML, getPrintHTML, getPrompt, getProportionalResizeModifiers, getProportionalResizing, getRect, getRedrawOnResize, getResizeBarTarget, getResizeFrom, getRight, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowDepth, getShadowImage, getShadowOffset, getShadowSoftness, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowHover, getShowHoverComponents, getShowResizeBar, getShowShadow, getShowSnapGrid, getShrinkElementOnHide, getSkinImgDir, getSnapAlignCandidates, getSnapAlignCenterLineStyle, getSnapAlignEdgeLineStyle, getSnapAxis, getSnapEdge, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapPosition, getSnapPosition, getSnapResizeToAlign, getSnapResizeToGrid, getSnapTo, getSnapToAlign, getSnapToCenterAlign, getSnapToEdgeAlign, getSnapToGrid, getSnapVDirection, getSnapVGap, getStyleName, getTabIndex, getTestInstance, getTooltip, getTop, getTopAsString, getTopElement, getUseBackMask, getUseDragMask, getUseNativeDrag, getUseOpacityFilter, getUseTouchScrolling, getValuesManager, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWidth, getVSnapOrigin, getVSnapOrigin, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getZIndex, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideComponentMask, hideComponentMask, hideContextMenu, imgHTML, imgHTML, imgHTML, intersects, isDirty, isDisabled, isDrawn, isFocused, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, markForDestroy, markForRedraw, markForRedraw, moveAbove, moveBelow, moveBy, moveTo, onAttach, onDetach, onInit, pageScrollDown, pageScrollUp, parentResized, placeNear, placeNear, placeNear, printComponents, provideRuleContext, redraw, redraw, removeChild, removeChild, removePeer, removePeer, removeSnapAlignCandidate, resizeBy, resizeTo, resizeTo, revealChild, revealChild, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAllowExternalFilters, setAlwaysShowScrollbars, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaRole, setAriaState, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setAutoDraw, setAutoHeight, setAutoMaskComponents, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBottom, setCanAcceptDrop, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setChildren, setChildrenResizeSnapAlign, setChildrenSnapAlign, setChildrenSnapCenterAlign, setChildrenSnapEdgeAlign, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setComponentMaskDefaults, setContents, setContextMenu, setCursor, setDataPath, setDefaultHeight, setDefaultPageSpace, setDefaultProperties, setDefaultWidth, setDisabled, setDisabledCursor, setDisableTouchScrollingForDrag, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragMaskType, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragType, setDropTypes, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setEditMode, setEditMode, setEditMode, setElement, setExtraSpace, setFacetId, setGroupBorderCSS, setGroupLabelBackgroundColor, setGroupLabelStyleName, setGroupTitle, setHeight, setHeight, setHeight, setHeight100, setHideUsingDisplayNone, setHoverAlign, setHoverAutoDestroy, setHoverDelay, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlElement, setHtmlPosition, setImage, setImage, setInitHandler, setIsGroup, setIsSnapAlignCandidate, setKeepInParentRect, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeavePageSpace, setLeft, setLeft, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLogicalStructure, setMargin, setMatchElement, setMaxHeight, setMaxWidth, setMenuConstructor, setMinHeight, setMinNonEdgeSize, setMinWidth, setMomentumScrollMinSpeed, setMouseStillDownDelay, setMouseStillDownInitialDelay, setNeverUseFilters, setNoDoubleClicks, setNoDropCursor, setOpacity, setOverflow, setPadding, setPageLeft, setPageTop, setParentCanvas, setParentElement, setPeers, setPercentBox, setPercentSource, setPosition, setPrefix, setPrintChildrenAbsolutelyPositioned, setPrompt, setProportionalResizeModifiers, setProportionalResizing, setRect, setRect, setRedrawOnResize, setResizeBarTarget, setResizeFrom, setResizeFrom, setRight, setScrollbarConstructor, setScrollbarSize, setShadowDepth, setShadowImage, setShadowOffset, setShadowSoftness, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowHover, setShowHoverComponents, setShowResizeBar, setShowShadow, setShowSnapGrid, setShrinkElementOnHide, setSkinImgDir, setSmoothFade, setSnapAlignCandidates, setSnapAlignCenterLineStyle, setSnapAlignEdgeLineStyle, setSnapAxis, setSnapEdge, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToAlign, setSnapResizeToGrid, setSnapTo, setSnapToAlign, setSnapToCenterAlign, setSnapToEdgeAlign, setSnapToGrid, setSnapVDirection, setSnapVGap, setStyleName, setTabIndex, setTooltip, setTop, setTop, setUseBackMask, setUseDragMask, setUseNativeDrag, setUseOpacityFilter, setUseTouchScrolling, setValuesManager, setVisibility, setVisible, setWidth, setWidth, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showClickMask, showComponentMask, showComponentMask, showNextTo, showNextTo, showNextTo, showNextTo, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, updateEditNode, updateHover, updateHover, updateShadow, visibleAtPoint, willAcceptDrop

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

addDrawHandler, applyFactoryProperties, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hasAutoAssignedID, hashCode, initNativeObject, internalSetID, internalSetID, isConfigOnly, isCreated, isFactoryCreated, onBind, onDestroy, onDraw, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setDragTracker, setFactoryCreated, setID, setJavaScriptObject, 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, fireEvent, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

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

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(com.google.gwt.core.client.JavaScriptObject jsObj)

Method Detail

getOrCreateRef

public static StatefulCanvas getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)

changeAutoChildDefaults

public static void changeAutoChildDefaults(java.lang.String autoChildName,
                                           Canvas defaults)

Changes the defaults for Canvas AutoChildren named autoChildName.

Parameters:

autoChildName - name of an AutoChild to customize the defaults for.

defaults - Canvas defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties. For usage tips on this param, see SGWTProperties.

See Also:

AutoChildUsage

changeAutoChildDefaults

public static void changeAutoChildDefaults(java.lang.String autoChildName,
                                           FormItem defaults)

Changes the defaults for FormItem AutoChildren named autoChildName.

Parameters:

autoChildName - name of an AutoChild to customize the defaults for.

defaults - FormItem defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties. For usage tips on this param, see SGWTProperties.

See Also:

AutoChildUsage

create

protected com.google.gwt.core.client.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 - 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 - 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(java.lang.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 java.lang.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(java.lang.String baseStyle)

Base CSS style className applied to the component.

As the component changes state and/or is selected, suffixes will be added to the base style. In some cases more than one suffix will be appended to reflect a combined state ("Selected" + "Disabled", for example).

See getStateSuffix() for a description of the default set of suffixes which may be applied to the baseStyle

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 java.lang.String getBaseStyle()

Base CSS style className applied to the component.

As the component changes state and/or is selected, suffixes will be added to the base style. In some cases more than one suffix will be appended to reflect a combined state ("Selected" + "Disabled", for example).

See getStateSuffix() for a description of the default set of suffixes which may be applied to the baseStyle

Returns:

See CSSStyleName

setEditProxyConstructor

public void setEditProxyConstructor(java.lang.String editProxyConstructor)
                             throws java.lang.IllegalStateException

Default class used to construct the EditProxy for this component when the component is first placed into edit mode.

Overrides:

setEditProxyConstructor in class Canvas

Parameters:

editProxyConstructor - See SCClassName . Default value is "StatefulCanvasEditProxy"

Throws:

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

getEditProxyConstructor

public java.lang.String getEditProxyConstructor()

Default class used to construct the EditProxy for this component when the component is first placed into edit mode.

Overrides:

getEditProxyConstructor in class Canvas

Returns:

See SCClassName

setIcon

public void setIcon(java.lang.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 java.lang.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(java.lang.Integer iconHeight)
                   throws java.lang.IllegalStateException

Height in pixels of the icon image.

If unset, defaults to iconSize.

Parameters:

iconHeight - Default value is null

Throws:

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

See Also:

ButtonIcon overview and related methods

getIconHeight

public java.lang.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(java.lang.String iconOrientation)
                        throws java.lang.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.. Default value is "left"

Throws:

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

See Also:

ButtonIcon overview and related methods

getIconOrientation

public java.lang.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:

String

See Also:

ButtonIcon overview and related methods

setIconSize

public void setIconSize(int iconSize)
                 throws java.lang.IllegalStateException

Size in pixels of the icon image.

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

Note: When configuring the properties of a StatefulCanvas (or derivative) AutoChild, it is best to set the iconWidth and iconHeight to the same value rather than setting an iconSize. This is because certain skins or customizations thereto might set the iconWidth and iconHeight, making the customization of the AutoChild's iconSize ineffective.

Parameters:

iconSize - Default value is 16

Throws:

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

Note: When configuring the properties of a StatefulCanvas (or derivative) AutoChild, it is best to set the iconWidth and iconHeight to the same value rather than setting an iconSize. This is because certain skins or customizations thereto might set the iconWidth and iconHeight, making the customization of the AutoChild's iconSize ineffective.

Returns:

int

See Also:

ButtonIcon overview and related methods

setIconStyle

public void setIconStyle(java.lang.String iconStyle)

Base CSS style applied to the icon image. If set, as the StatefulCanvas changes state and/or is selected, suffixes will be appended to iconStyle to form the className set on the image element.

The following table lists out the standard set of suffixes which may be appended:

CSS Class Applied	Description
iconStyle	Default CSS style
iconStyle+Selected	Applied when selected and showSelectedIcon are true.
iconStyle+Focused	Applied when the component has keyboard focus, if showFocusedIcon is true, and showFocusedAsOver is not true.
iconStyle+Over	Applied when showRollOverIcon is set to true and either the user rolls over the component or showFocusedAsOver is true and the component has keyboard focus.
iconStyle+Down	Applied when the user presses the mouse button on the component if showDownIcon is set to true
iconStyle+Disabled	Applied when the component is disabled if showDisabledIcon is true.
Combined styles
iconStyle+SelectedFocused	Combined Selected and focused styling
iconStyle+SelectedOver	Combined Selected and rollOver styling
iconStyle+FocusedOver	Combined Focused and rollOver styling
iconStyle+SelectedFocusedOver	Combined Selected, Focused and rollOver styling
iconStyle+SelectedDown	Combined Selected and mouse-down styling
iconStyle+FocusedDown	Combined Focused and mouse-down styling
iconStyle+SelectedFocusedDown	Combined Selected, Focused and mouse-down styling
iconStyle+SelectedDisabled	Combined Selected and Disabled styling

In addition, if showRTLIcon is true, then in RTL mode, a final "RTL" suffix will be appended.

If this method is called after the component has been drawn/initialized: Setter for iconStyle.

Parameters:

iconStyle - the new iconStyle (may be null to remove the className on the image). See CSSStyleName . Default value is null

See Also:

ButtonIcon overview and related methods

getIconStyle

public java.lang.String getIconStyle()

Base CSS style applied to the icon image. If set, as the StatefulCanvas changes state and/or is selected, suffixes will be appended to iconStyle to form the className set on the image element.

The following table lists out the standard set of suffixes which may be appended:

CSS Class Applied	Description
iconStyle	Default CSS style
iconStyle+Selected	Applied when selected and showSelectedIcon are true.
iconStyle+Focused	Applied when the component has keyboard focus, if showFocusedIcon is true, and showFocusedAsOver is not true.
iconStyle+Over	Applied when showRollOverIcon is set to true and either the user rolls over the component or showFocusedAsOver is true and the component has keyboard focus.
iconStyle+Down	Applied when the user presses the mouse button on the component if showDownIcon is set to true
iconStyle+Disabled	Applied when the component is disabled if showDisabledIcon is true.
Combined styles
iconStyle+SelectedFocused	Combined Selected and focused styling
iconStyle+SelectedOver	Combined Selected and rollOver styling
iconStyle+FocusedOver	Combined Focused and rollOver styling
iconStyle+SelectedFocusedOver	Combined Selected, Focused and rollOver styling
iconStyle+SelectedDown	Combined Selected and mouse-down styling
iconStyle+FocusedDown	Combined Focused and mouse-down styling
iconStyle+SelectedFocusedDown	Combined Selected, Focused and mouse-down styling
iconStyle+SelectedDisabled	Combined Selected and Disabled styling

In addition, if showRTLIcon is true, then in RTL mode, a final "RTL" suffix will be appended.

Returns:

See CSSStyleName

See Also:

ButtonIcon overview and related methods

setIconWidth

public void setIconWidth(java.lang.Integer iconWidth)
                  throws java.lang.IllegalStateException

Width in pixels of the icon image.

If unset, defaults to iconSize.

Parameters:

iconWidth - Default value is null

Throws:

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

See Also:

ButtonIcon overview and related methods

getIconWidth

public java.lang.Integer getIconWidth()

Width in pixels of the icon image.

If unset, defaults to iconSize.

Returns:

Integer

See Also:

ButtonIcon overview and related methods

setIgnoreRTL

public void setIgnoreRTL(boolean ignoreRTL)

Should horizontal alignment-related attributes align and iconOrientation be mirrored in RTL mode? This is the default behavior unless ignoreRTL is set to true.

If this method is called after the component has been drawn/initialized: Setter for ignoreRTL.

Note : This is an advanced setting

Parameters:

ignoreRTL - new value for ignoreRTL.. Default value is false

getIgnoreRTL

public boolean getIgnoreRTL()

Should horizontal alignment-related attributes align and iconOrientation be mirrored in RTL mode? This is the default behavior unless ignoreRTL is set to true.

Returns:

boolean

getOverCanvas

public Canvas getOverCanvas()
                     throws java.lang.IllegalStateException

Auto generated child widget to be shown when the user rolls over this canvas if showOverCanvas is true. See documentation for com.smartgwt.client.types.AutoChild for information on how to customize this canvas.

For an overview of how to use and configure AutoChildren, see Using AutoChildren.

Returns:

Canvas

Throws:

java.lang.IllegalStateException - if this widget has not yet been rendered.

setOverCanvasConstructor

public void setOverCanvasConstructor(java.lang.String overCanvasConstructor)

Constructor class name for this widget's overCanvas

Note : This is an advanced setting

Parameters:

overCanvasConstructor - Default value is "Canvas"

getOverCanvasConstructor

public java.lang.String getOverCanvasConstructor()

Constructor class name for this widget's overCanvas

Returns:

String

setRadioGroup

public void setRadioGroup(java.lang.String radioGroup)

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

Note : This is an advanced setting

Parameters:

radioGroup - Default value is null

See Also:

State overview and related methods

getRadioGroup

public java.lang.String getRadioGroup()

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

Returns:

String

See Also:

State overview and related methods

setRedrawOnStateChange

public void setRedrawOnStateChange(java.lang.Boolean redrawOnStateChange)

Whether this widget needs to redraw to reflect state change

Note : This is an advanced setting

Parameters:

redrawOnStateChange - Default value is false

See Also:

State overview and related methods

getRedrawOnStateChange

public java.lang.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(java.lang.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 java.lang.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(java.lang.Boolean showDisabled)

Should we visibly change state when disabled?

Parameters:

showDisabled - Default value is true

See Also:

State overview and related methods

getShowDisabled

public java.lang.Boolean getShowDisabled()

Should we visibly change state when disabled?

Returns:

Boolean

See Also:

State overview and related methods

setShowDisabledIcon

public void setShowDisabledIcon(java.lang.Boolean showDisabledIcon)
                         throws java.lang.IllegalStateException

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

Parameters:

showDisabledIcon - Default value is true

Throws:

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

See Also:

ButtonIcon overview and related methods

getShowDisabledIcon

public java.lang.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(java.lang.Boolean showDown)

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

Parameters:

showDown - Default value is false

See Also:

State overview and related methods

getShowDown

public java.lang.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(java.lang.Boolean showDownIcon)
                     throws java.lang.IllegalStateException

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

Parameters:

showDownIcon - Default value is false

Throws:

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

See Also:

ButtonIcon overview and related methods

getShowDownIcon

public java.lang.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(java.lang.Boolean showFocused)

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

Parameters:

showFocused - Default value is false

See Also:

State overview and related methods

getShowFocused

public java.lang.Boolean getShowFocused()

Should we visibly change state when the canvas receives focus? If showFocusedAsOver is true, then "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(java.lang.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 - Default value is true

See Also:

State overview and related methods

getShowFocusedAsOver

public java.lang.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(java.lang.Boolean showFocusedIcon)
                        throws java.lang.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 - Default value is false

Throws:

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

See Also:

ButtonIcon overview and related methods

getShowFocusedIcon

public java.lang.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(java.lang.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 - Default value is false

getShowOverCanvas

public java.lang.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(java.lang.Boolean showRollOver)

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

Parameters:

showRollOver - Default value is false

See Also:

State overview and related methods

getShowRollOver

public java.lang.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(java.lang.Boolean showRollOverIcon)
                         throws java.lang.IllegalStateException

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

Parameters:

showRollOverIcon - Default value is false

Throws:

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

See Also:

ButtonIcon overview and related methods

getShowRollOverIcon

public java.lang.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

setShowRTLIcon

public void setShowRTLIcon(boolean showRTLIcon)
                    throws java.lang.IllegalStateException

Is RTL media available for the icon? If true, then in RTL mode, the image's src will have "_rtl" inserted immediately before the file extension. For example, if icon is "myIcon.png" and showRTLIcon is true, then in RTL mode, the image's src will be set to "myIcon_rtl.png".

Parameters:

showRTLIcon - Default value is false

Throws:

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

getShowRTLIcon

public boolean getShowRTLIcon()

Is RTL media available for the icon? If true, then in RTL mode, the image's src will have "_rtl" inserted immediately before the file extension. For example, if icon is "myIcon.png" and showRTLIcon is true, then in RTL mode, the image's src will be set to "myIcon_rtl.png".

Returns:

boolean

setShowSelectedIcon

public void setShowSelectedIcon(java.lang.Boolean showSelectedIcon)
                         throws java.lang.IllegalStateException

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

Parameters:

showSelectedIcon - Default value is false

Throws:

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

See Also:

ButtonIcon overview and related methods

getShowSelectedIcon

public java.lang.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. The state setting is automatically updated as the user interacts with the component (see showRollOver, showDown, showDisabled).

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 and getStateSuffix() 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 Img.src and StretchImgButton.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: Sets the state of this object, changing its appearance. Note: newState cannot be State.STATE_DISABLED if this.showDisabled is false.

Note : This is an advanced setting

Parameters:

state - the new state.. Default value is ""

See Also:

State, State overview and related methods

getState

public State getState()

Current "state" of this widget. The state setting is automatically updated as the user interacts with the component (see showRollOver, showDown, showDisabled).

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 and getStateSuffix() 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 Img.src and StretchImgButton.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(java.lang.String title)

The title HTML to display in this button.

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

Overrides:

setTitle in class Canvas

Parameters:

title - the new title HTML. See HTMLString . Default value is null

See Also:

Basics overview and related methods

getTitle

public java.lang.String getTitle()

The title HTML to display in this button.

Overrides:

getTitle in class Canvas

Returns:

Return the title - 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 - 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(java.lang.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

See Also:

State overview and related methods

deselect

public void deselect()

Deselect this object.

See Also:

State overview and related methods

getStateSuffix

public java.lang.String getStateSuffix()

Returns the suffix that will be appended to the baseStyle as the component changes state and/or is selected / focused.

The following table lists out the standard set of suffixes which may be applied to the base style:

CSS Class Applied	Description
baseStyle	Default css style
baseStyle+Selected	Applied when selected is set to true
baseStyle+Focused	Applied when the component has keyboard focus, if showFocused is true, and showFocusedAsOver is not true.
baseStyle+Over	Applied when showRollOver is set to true and either the user rolls over the component or showFocusedAsOver is true and the component has keyboard focus.
baseStyle+Down	Applied when the user presses the mouse button on the component if showDown is set to true
baseStyle+Disabled	Applied when the component is disabled if showDisabled is true.
Combined styles
baseStyle+SelectedFocused	Combined Selected and focused styling
baseStyle+SelectedOver	Combined Selected and rollOver styling
baseStyle+FocusedOver	Combined Focused and rollOver styling
baseStyle+SelectedFocusedOver	Combined Selected, Focused and rollOver styling
baseStyle+SelectedDown	Combined Selected and mouse-down styling
baseStyle+FocusedDown	Combined Focused and mouse-down styling
baseStyle+SelectedFocusedDown	Combined Selected, Focused and mouse-down styling
baseStyle+SelectedDisabled	Combined Selected and Disabled styling

Returns:

suffix to be appended to the baseStyle

isSelected

public java.lang.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.

See Also:

State overview and related methods

removeFromRadioGroup

public void removeFromRadioGroup(java.lang.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.

See Also:

State overview and related methods

setDefaultProperties

public static void setDefaultProperties(StatefulCanvas statefulCanvasProperties)

Class level method to set the default properties of this class. If set, then all existing and subsequently created instances of this class will automatically have default properties corresponding to the properties set on the SmartGWT class instance passed to this function before its underlying SmartClient JS object was created. 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 affect 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. Calling this method after instances have been created can result in undefined behavior, since it bypasses any setters and a class instance may have already examined a particular property and not be expecting any changes through this route.

Parameters:

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

See Also:

SGWTProperties

setTitleStyle

public void setTitleStyle(java.lang.String titleStyle)

setLogicalStructure

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

Setter implementing the LogicalStructure interface, which supports Eclipse's logical structure debugging facility.

getLogicalStructure

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

Getter implementing the LogicalStructure interface, which supports Eclipse's logical structure debugging facility.

Specified by:

getLogicalStructure in interface LogicalStructure

Overrides:

getLogicalStructure in class Canvas