public class StatefulCanvas extends Canvas
config, configOnly, id, isElementSet, nativeObject, scClassName| Constructor and Description |
|---|
StatefulCanvas() |
StatefulCanvas(com.google.gwt.core.client.JavaScriptObject jsObj) |
| 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.
|
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.Integer |
getIconWidth()
Width in pixels of the icon image.
|
com.smartgwt.logicalstructure.core.LogicalStructureObject |
getLogicalStructure() |
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, the
"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.
|
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. |
java.lang.String |
getTitle()
The text title 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.
|
static void |
setDefaultProperties(StatefulCanvas statefulCanvasProperties)
Class level method to set the default properties of this class.
|
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 |
setIconWidth(java.lang.Integer iconWidth)
Width in pixels of the icon image.
|
void |
setJavaScriptObject(com.google.gwt.core.client.JavaScriptObject jsObj) |
com.smartgwt.logicalstructure.core.LogicalStructureObject |
setLogicalStructure(com.smartgwt.logicalstructure.widgets.StatefulCanvasLogicalStructure s) |
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, the
"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 |
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 text title to display in this button.
|
void |
setTitleStyle(java.lang.String titleStyle) |
void |
setValign(VerticalAlignment valign)
Vertical alignment of this component's title.
|
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, addStyleName, addVisibilityChangedHandler, adjustForContent, 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, asSGWTComponent, blur, bringToFront, clear, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsFocus, containsPoint, containsPoint, deparent, depeer, disable, enable, focus, focusInNextTabElement, focusInPreviousTabElement, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaRole, getAutoDraw, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBottom, getById, getByJSObject, getByLocalId, getCanAcceptDrop, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanHover, getCanSelectText, getCanvasAutoChild, getCanvasItem, getChildren, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getClassName, getContentElement, 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, 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, getHtmlPosition, getImage, 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, getOuterElement, getOverflow, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getParentElement, 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, getTestInstance, 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, linkHTML, linkHTML, 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, 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, setAriaState, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, 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, setGroupBorderCSS, setGroupLabelBackgroundColor, setGroupLabelStyleName, setGroupTitle, setHeight, setHeight, setHeight100, setHideUsingDisplayNone, 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, setScrollbarConstructor, 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, showNextTo, showNextTo, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, updateHover, updateHover, updateShadow, visibleAtPoint, willAcceptDropaddDrawHandler, 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, getElement, getElement, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hashCode, initNativeObject, internalSetID, internalSetID, isConfigOnly, isCreated, onBind, onDestroy, onDraw, setAttribute, 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, toStringaddAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEventsaddStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent, unsinkEventspublic StatefulCanvas()
public StatefulCanvas(com.google.gwt.core.client.JavaScriptObject jsObj)
public static StatefulCanvas getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public void setJavaScriptObject(com.google.gwt.core.client.JavaScriptObject jsObj)
setJavaScriptObject in class Canvaspublic static void changeAutoChildDefaults(java.lang.String autoChildName,
Canvas defaults)
autoChildName.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.AutoChildUsagepublic static void changeAutoChildDefaults(java.lang.String autoChildName,
FormItem defaults)
autoChildName.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.AutoChildUsageprotected com.google.gwt.core.client.JavaScriptObject create()
public void setActionType(SelectionType actionType)
actionType - actionType Default value is "button"State overview and related methodspublic SelectionType getActionType()
State overview and related methodspublic void setAlign(Alignment align)
setAlign in class Canvasalign - align Default value is Canvas.CENTERAppearance overview and related methodspublic Alignment getAlign()
Appearance overview and related methodspublic void setAutoFit(java.lang.Boolean autoFit)
setWidth() is explicitly called on an autoFit:true button, autoFit will be reset to false.
Note that for StretchImgButton instances, autoFit will occur horizontally only, as unpredictable vertical sizing is
likely to distort the media. If you do want vertical auto-fit, this can be achieved by simply setting a small height,
and having overflow:"visible"
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.
autoFit - New autoFit setting.. Default value is nullSizing overview and related methodspublic java.lang.Boolean getAutoFit()
setWidth() is explicitly called on an autoFit:true button, autoFit will be reset to false. Note that for StretchImgButton instances, autoFit will occur horizontally only, as unpredictable vertical sizing is likely to distort the media. If you do want vertical auto-fit, this can be achieved by simply setting a small height, and having overflow:"visible"
Sizing overview and related methodspublic void setBaseStyle(java.lang.String baseStyle)
When the component changes state (eg becomes disabled), a suffix will be appended to this style name, reflecting the following states: "Over", "Down", or "Disabled".
If the widget is selected, the suffixes will be "Selected", "SelectedOver", etc.
If the widget has focus and showFocused is true, and showFocusedAsOver is
false, the suffixes will be "Focused", "FocusedOver", etc, or if the widget is both selected and focused,
"SelectedFocused", "SelectedFocusedOver", etc.
For example, if baseStyle is set to "button", this
component is 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.
baseStyle - new base style. See CSSStyleName. Default value is nullpublic java.lang.String getBaseStyle()
When the component changes state (eg becomes disabled), a suffix will be appended to this style name, reflecting the following states: "Over", "Down", or "Disabled".
If the widget is selected, the suffixes will be "Selected", "SelectedOver", etc.
If the widget has focus and showFocused is true, and showFocusedAsOver is
false, the suffixes will be "Focused", "FocusedOver", etc, or if the widget is both selected and focused,
"SelectedFocused", "SelectedFocusedOver", etc.
For example, if baseStyle is set to "button", this
component is selected and the mouse cursor is over this
component, the style "buttonSelectedOver" will be used.
CSSStyleNamepublic void setIcon(java.lang.String icon)
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.
icon - URL of new icon. See SCImgURL. Default value is nullButtonIcon overview and related methodspublic java.lang.String getIcon()
Specify as the partial URL to an image, relative to the imgDir of this component.
SCImgURLButtonIcon overview and related methodspublic void setIconHeight(java.lang.Integer iconHeight)
throws java.lang.IllegalStateException
If unset, defaults to iconSize
iconHeight - iconHeight Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdButtonIcon overview and related methodspublic java.lang.Integer getIconHeight()
If unset, defaults to iconSize
ButtonIcon overview and related methodspublic void setIconOrientation(java.lang.String iconOrientation)
throws java.lang.IllegalStateException
"left" and "right".
iconOrientation - The new orientation of the icon relative to the text of the button.. See String. Default value is "left"java.lang.IllegalStateException - this property cannot be changed after the component has been createdButtonIcon overview and related methodspublic java.lang.String getIconOrientation()
"left" and "right".StringButtonIcon overview and related methodspublic void setIconSize(int iconSize)
throws java.lang.IllegalStateException
The iconWidth and iconHeight properties can be used to
configure width and height separately.
iconSize - iconSize Default value is 16java.lang.IllegalStateException - this property cannot be changed after the component has been createdButtonIcon overview and related methodspublic int getIconSize()
The iconWidth and iconHeight properties can be used to
configure width and height separately.
ButtonIcon overview and related methodspublic void setIconWidth(java.lang.Integer iconWidth)
throws java.lang.IllegalStateException
If unset, defaults to iconSize
iconWidth - iconWidth Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdButtonIcon overview and related methodspublic java.lang.Integer getIconWidth()
If unset, defaults to iconSize
ButtonIcon overview and related methodspublic Canvas getOverCanvas() throws java.lang.IllegalStateException
showOverCanvas is true. See documentation for AutoChild
for information on how to customize this canvas.
For an overview of how to use and configure AutoChildren, see Using AutoChildren.
java.lang.IllegalStateException - if this widget has not yet been rendered.public void setOverCanvasConstructor(java.lang.String overCanvasConstructor)
overCanvas
Note : This is an advanced setting
overCanvasConstructor - . See String. Default value is "Canvas"public java.lang.String getOverCanvasConstructor()
overCanvasStringpublic void setRadioGroup(java.lang.String radioGroup)
Note : This is an advanced setting
radioGroup - . See String. Default value is nullState overview and related methodspublic java.lang.String getRadioGroup()
StringState overview and related methodspublic void setRedrawOnStateChange(java.lang.Boolean redrawOnStateChange)
Note : This is an advanced setting
redrawOnStateChange - redrawOnStateChange Default value is falseState overview and related methodspublic java.lang.Boolean getRedrawOnStateChange()
State overview and related methodspublic void setSelected(java.lang.Boolean selected)
selected - new boolean value of whether or not the object is selected.. Default value is falseState overview and related methodspublic java.lang.Boolean getSelected()
State overview and related methodspublic void setShowDisabled(java.lang.Boolean showDisabled)
showDisabled - showDisabled Default value is trueState overview and related methodspublic java.lang.Boolean getShowDisabled()
State overview and related methodspublic void setShowDisabledIcon(java.lang.Boolean showDisabledIcon)
throws java.lang.IllegalStateException
showDisabledIcon - showDisabledIcon Default value is truejava.lang.IllegalStateException - this property cannot be changed after the component has been createdButtonIcon overview and related methodspublic java.lang.Boolean getShowDisabledIcon()
ButtonIcon overview and related methodspublic void setShowDown(java.lang.Boolean showDown)
showDown - showDown Default value is falseState overview and related methodspublic java.lang.Boolean getShowDown()
State overview and related methodspublic void setShowDownIcon(java.lang.Boolean showDownIcon)
throws java.lang.IllegalStateException
showDownIcon - showDownIcon Default value is falsejava.lang.IllegalStateException - this property cannot be changed after the component has been createdButtonIcon overview and related methodspublic java.lang.Boolean getShowDownIcon()
ButtonIcon overview and related methodspublic void setShowFocused(java.lang.Boolean showFocused)
showFocusedAsOver is true, the
"over" will be used to indicate focus. Otherwise a separate "focused" state will
be used.showFocused - showFocused Default value is falseState overview and related methodspublic java.lang.Boolean getShowFocused()
showFocusedAsOver is true, the
"over" will be used to indicate focus. Otherwise a separate "focused" state will
be used.State overview and related methodspublic void setShowFocusedAsOver(java.lang.Boolean showFocusedAsOver)
showFocused is true for this widget, should the
"over" state be used to indicate the widget as focused. If set to false, a separate "focused"
state will be used.showFocusedAsOver - showFocusedAsOver Default value is trueState overview and related methodspublic java.lang.Boolean getShowFocusedAsOver()
showFocused is true for this widget, should the
"over" state be used to indicate the widget as focused. If set to false, a separate "focused"
state will be used.State overview and related methodspublic void setShowFocusedIcon(java.lang.Boolean showFocusedIcon)
throws java.lang.IllegalStateException
If showFocusedAsOver is true, the "Over" icon
will be displayed when the canvas has focus, otherwise a separate "Focused" icon will be displayed
showFocusedIcon - showFocusedIcon Default value is falsejava.lang.IllegalStateException - this property cannot be changed after the component has been createdButtonIcon overview and related methodspublic java.lang.Boolean getShowFocusedIcon()
If showFocusedAsOver is true, the "Over" icon
will be displayed when the canvas has focus, otherwise a separate "Focused" icon will be displayed
ButtonIcon overview and related methodspublic void setShowOverCanvas(java.lang.Boolean showOverCanvas)
overCanvas on user rollover.
Note : This is an advanced setting
showOverCanvas - showOverCanvas Default value is falsepublic java.lang.Boolean getShowOverCanvas()
overCanvas on user rollover.public void setShowRollOver(java.lang.Boolean showRollOver)
showRollOver - showRollOver Default value is falseState overview and related methodspublic java.lang.Boolean getShowRollOver()
State overview and related methodspublic void setShowRollOverIcon(java.lang.Boolean showRollOverIcon)
throws java.lang.IllegalStateException
showRollOverIcon - showRollOverIcon Default value is falsejava.lang.IllegalStateException - this property cannot be changed after the component has been createdButtonIcon overview and related methodspublic java.lang.Boolean getShowRollOverIcon()
ButtonIcon overview and related methodspublic void setShowSelectedIcon(java.lang.Boolean showSelectedIcon)
throws java.lang.IllegalStateException
showSelectedIcon - showSelectedIcon Default value is falsejava.lang.IllegalStateException - this property cannot be changed after the component has been createdButtonIcon overview and related methodspublic java.lang.Boolean getShowSelectedIcon()
ButtonIcon overview and related methodspublic void setState(State state)
baseStyle for a description of how this is done. For Img or StretchImg based subclasses of StatefulCanvas,
the appearance may also be updated by changing the src of the rendered image. See src and src for a
description of how the URL is modified to reflect the state of the widget in this case.
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
state - the new state.. Default value is ""State,
State overview and related methodspublic State getState()
baseStyle for a description of how this is done. For Img or StretchImg based subclasses of StatefulCanvas,
the appearance may also be updated by changing the src of the rendered image. See src and src for a
description of how the URL is modified to reflect the state of the widget in this case.
State,
State overview and related methodspublic void setTitle(java.lang.String title)
setTitle in class Canvastitle - new title. See HTMLString. Default value is variesBasics overview and related methodspublic java.lang.String getTitle()
getTitle in class Canvas Default is to simply return this.title.. See HTMLString
Basics overview and related methodspublic void setValign(VerticalAlignment valign)
valign - valign Default value is Canvas.CENTERAppearance overview and related methodspublic VerticalAlignment getValign()
Appearance overview and related methodspublic void addToRadioGroup(java.lang.String groupID)
groupID - - ID of the radiogroup to which this widget should be addedState overview and related methodspublic void deselect()
State overview and related methodspublic java.lang.String getStateSuffix()
baseStyle as the component changes state and/or is selected. When the component changes state (eg becomes disabled), a suffix will be appended to this style name, reflecting the following states: "Over", "Down", or "Disabled".
If the widget is selected, the suffixes will be "Selected", "SelectedOver", etc.
If the widget has focus and
showFocused is true, and showFocusedAsOver is false, the suffixes will be
"Focused", "FocusedOver", etc, or if the widget is both selected and focused, "SelectedFocused", "SelectedFocusedOver",
etc.
For example, if baseStyle is set to "button", this component is selected and the mouse cursor is over this component, the style
"buttonSelectedOver" will be used.
public java.lang.Boolean isSelected()
State overview and related methodspublic void removeFromRadioGroup()
State overview and related methodspublic void removeFromRadioGroup(java.lang.String groupID)
groupID - - optional radio group ID (to ensure the widget is removed from the appropriate
group.State overview and related methodspublic void select()
State overview and related methodspublic static void setDefaultProperties(StatefulCanvas statefulCanvasProperties)
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.
statefulCanvasProperties - properties that should be used as new defaults when instances of this class are createdpublic void setTitleStyle(java.lang.String titleStyle)
public com.smartgwt.logicalstructure.core.LogicalStructureObject setLogicalStructure(com.smartgwt.logicalstructure.widgets.StatefulCanvasLogicalStructure s)
public com.smartgwt.logicalstructure.core.LogicalStructureObject getLogicalStructure()
getLogicalStructure in interface LogicalStructuregetLogicalStructure in class Canvas