Class StatefulCanvas
- All Implemented Interfaces:
HasAttachHandlers,HasHandlers,EventListener,HasVisibility,IsWidget,LogicalStructure,HasClearHandlers,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,HasRuleContextChangedHandlers,HasScrolledHandlers,HasShowContextMenuHandlers,HasVisibilityChangedHandlers
- Direct Known Subclasses:
Button,Img,SimpleTile,StretchImg,ToggleSwitch
-
Nested Class Summary
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled -
Field Summary
Fields inherited from class com.smartgwt.client.widgets.BaseWidget
config, configOnly, factoryCreated, factoryProperties, id, nativeObject, scClassNameFields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddToRadioGroup(String groupID) Add this widget to the specified mutually exclusive selection group with the ID passed in.static voidchangeAutoChildDefaults(String autoChildName, Canvas defaults) Changes the defaults for Canvas AutoChildren namedautoChildName.static voidchangeAutoChildDefaults(String autoChildName, FormItem defaults) Changes the defaults for FormItem AutoChildren namedautoChildName.protected JavaScriptObjectcreate()voiddeselect()Deselect this object.Behavior on state changes -- BUTTON, RADIO or CHECKBOXgetAlign()Horizontal alignment of this component's title.If specified this property returns thearia-labelattribute to write out inscreenReaderMode.Retrieves dynamically calculated defaultARIA state mappingproperties for this canvas.If true, ignore the specified size of this widget and always size just large enough to accommodate the title.Base CSS style className applied to the component.Default class used to construct theEditProxyfor this component when the component isfirst placed into edit mode.Size for this component's vertical dimension.Size for this component's vertical dimension.getIcon()Optional icon to be shown with the button title text.Height in pixels of the icon image.If this button is showing an icon should it appear to the left or right of the title? valid options are"left"and"right".intSize in pixels of the icon image.Base CSS style applied to the icon image.Width in pixels of the icon image.booleanShould horizontal alignment-related attributesalignandiconOrientationbe mirrored in RTL mode? This is the default behavior unless ignoreRTL is set to true.If non-null, specifies the horizontal padding applied to the label, if any.If non-null, specifies the vertical padding applied to the label, if any.Getter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.static StatefulCanvasgetOrCreateRef(JavaScriptObject jsObj) Auto generated child widget to be shown when the user rolls over this canvas ifshowOverCanvasis true.Constructor class name for this widget'soverCanvasString identifier for this canvas's mutually exclusive selection group.Whether this widget needs to redraw to reflect state changeWhether this component is selected.Should we visibly change state when disabled?If using an icon for this button, whether to switch the icon image if the button becomes disabled.Should we visibly change state when the mouse goes down in this object?If using an icon for this button, whether to switch the icon image when the mouse goes down on the button.Should we visibly change state when the canvas receives focus? IfshowFocusedAsOveristrue, then"over"will be used to indicate focus.IfshowFocusedis true for this widget, should the"over"state be used to indicate the widget as focused.If using an icon for this button, whether to switch the icon image when the button receives focus.If true, this widget will fireshowContextMenu()to show thecontext menuif one is defined, rather thanclick(), when the left mouse is clicked.When this property is set to true, this widget will create and show theoverCanvason user rollover.Should we visibly change state when the mouse goes over this object?If using an icon for this button, whether to switch the icon image on mouse rollover.booleanIsRTLmedia available for the icon? If true, then in RTL mode, the image's src will have "_rtl" inserted immediately before the file extension.If using an icon for this button, whether to switch the icon image when the button becomes selected.getState()Current "state" of this widget.getTitle()The title HTML to display in this button.Vertical alignment of this component's title.Base CSS style applied to the icon image whenverticalis set to true.getWidth()Size for this component's horizontal dimension.Size for this component's horizontal dimension.Find out if this object is selected.voidRemove this widget from the specified mutually exclusive selection group with the ID passed in.voidremoveFromRadioGroup(String groupID) Remove this widget from the specified mutually exclusive selection group with the ID passed in.voidselect()Select this object.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.Horizontal alignment of this component's title.setAriaLabel(String ariaLabel) If specified this property returns thearia-labelattribute to write out inscreenReaderMode.setAutoFit(Boolean autoFit) If true, ignore the specified size of this widget and always size just large enough to accommodate the title.setBaseStyle(String baseStyle) Base CSS style className applied to the component.static voidsetDefaultProperties(StatefulCanvas statefulCanvasProperties) Class level method to set the default properties of this class.setEditProxyConstructor(String editProxyConstructor) Default class used to construct theEditProxyfor this component when the component isfirst placed into edit mode.Size for this component's vertical dimension.voidSize for this component's vertical dimension.Optional icon to be shown with the button title text.setIconHeight(Integer iconHeight) Height in pixels of the icon image.setIconOrientation(String iconOrientation) If this button is showing an icon should it appear to the left or right of the title? valid options are"left"and"right".setIconSize(int iconSize) Size in pixels of the icon image.setIconStyle(String iconStyle) Base CSS style applied to the icon image.setIconWidth(Integer iconWidth) Width in pixels of the icon image.setIgnoreRTL(boolean ignoreRTL) Should horizontal alignment-related attributesalignandiconOrientationbe mirrored in RTL mode? This is the default behavior unless ignoreRTL is set to true.setLabelHPad(Integer labelHPad) If non-null, specifies the horizontal padding applied to the label, if any.setLabelVPad(Integer labelVPad) If non-null, specifies the vertical padding applied to the label, if any.Setter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.setOverCanvasConstructor(String overCanvasConstructor) Constructor class name for this widget'soverCanvassetRadioGroup(String radioGroup) String identifier for this canvas's mutually exclusive selection group.setRedrawOnStateChange(Boolean redrawOnStateChange) Whether this widget needs to redraw to reflect state changesetSelected(Boolean selected) Whether this component is selected.setShowDisabled(Boolean showDisabled) Should we visibly change state when disabled?setShowDisabledIcon(Boolean showDisabledIcon) If using an icon for this button, whether to switch the icon image if the button becomes disabled.setShowDown(Boolean showDown) Should we visibly change state when the mouse goes down in this object?setShowDownIcon(Boolean showDownIcon) If using an icon for this button, whether to switch the icon image when the mouse goes down on the button.setShowFocused(Boolean showFocused) Should we visibly change state when the canvas receives focus? IfshowFocusedAsOveristrue, then"over"will be used to indicate focus.setShowFocusedAsOver(Boolean showFocusedAsOver) IfshowFocusedis true for this widget, should the"over"state be used to indicate the widget as focused.setShowFocusedIcon(Boolean showFocusedIcon) If using an icon for this button, whether to switch the icon image when the button receives focus.setShowMenuOnClick(Boolean showMenuOnClick) If true, this widget will fireshowContextMenu()to show thecontext menuif one is defined, rather thanclick(), when the left mouse is clicked.setShowOverCanvas(Boolean showOverCanvas) When this property is set to true, this widget will create and show theoverCanvason user rollover.setShowRollOver(Boolean showRollOver) Should we visibly change state when the mouse goes over this object?setShowRollOverIcon(Boolean showRollOverIcon) If using an icon for this button, whether to switch the icon image on mouse rollover.setShowRTLIcon(boolean showRTLIcon) IsRTLmedia available for the icon? If true, then in RTL mode, the image's src will have "_rtl" inserted immediately before the file extension.setShowSelectedIcon(Boolean showSelectedIcon) If using an icon for this button, whether to switch the icon image when the button becomes selected.Current "state" of this widget.voidsetStyleName(String styleName) voidThe title HTML to display in this button.voidsetTitleFormatter(TitleFormatter customizer) setTitleStyle(String titleStyle) setValign(VerticalAlignment valign) Vertical alignment of this component's title.setVIconStyle(String vIconStyle) Base CSS style applied to the icon image whenverticalis set to true.Size for this component's horizontal dimension.voidSize for this component's horizontal dimension.Methods inherited from class com.smartgwt.client.widgets.Canvas
addChild, addChild, addChild, addChild, addChild, addClearHandler, 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, addRuleContextChangedHandler, addScrolledHandler, addShowContextMenuHandler, addSnapAlignCandidate, addStyleName, addVisibilityChangedHandler, adjustForContent, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateHide, 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, animateShow, asSGWTComponent, blur, bringToFront, clear, clearExplicitTabIndex, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsEventTarget, containsFocus, containsPoint, containsPoint, dataContextChanged, deparent, depeer, disable, doValueDictation, doVoiceCommand, enable, encloses, focus, focusAfterGroup, focusAtEnd, focusInNextTabElement, focusInPreviousTabElement, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAdaptiveHeightPriority, getAdaptiveWidthPriority, getAlwaysManageFocusNavigation, getAlwaysShowScrollbars, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideEffect, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeLayoutMode, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaHandleID, getAriaRole, getAutoMaskComponents, getAutoParent, getAutoPopulateData, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBorderRadius, getBottom, getById, getByJSObject, getByLocalId, getCanAcceptDrop, getCanAdaptHeight, getCanAdaptWidth, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanHover, getCanSelectText, getCanvasAutoChild, getCanvasItem, getChildren, getChildrenResizeSnapAlign, getChildrenSnapAlign, getChildrenSnapCenterAlign, getChildrenSnapEdgeAlign, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getChildTabPosition, getClassName, getComponentMask, getComponentMaskDefaults, getContentElement, getContents, getContextMenu, getCorrectZoomOverflow, getCursor, getDataContext, getDataPath, getDefaultHeight, getDefaultWidth, getDefiningProperty, getDefiningPropertyName, getDefiningPropertyNameOptions, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDisableTouchScrollingForDrag, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragMaskType, getDragMaxHeight, getDragMaxWidth, getDragMinHeight, getDragMinWidth, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragTargetAsString, getDragType, getDropTarget, getDropTargetAsString, getDropTypes, getDropTypesAsString, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getEditNode, getEditProxy, getElement, getElement, getEnableWhen, getEndLine, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFloatingScrollbars, getFormItemAutoChild, getForwardSVGeventsToObject, getFullDataPath, getGroupBorderCSS, getGroupLabelBackgroundColor, getGroupLabelStyleName, getGroupPadding, getGroupTitle, getHideUsingDisplayNone, getHoverAlign, getHoverAutoDestroy, getHoverAutoFitMaxWidth, getHoverAutoFitMaxWidthAsString, getHoverAutoFitWidth, getHoverComponent, getHoverDelay, getHoverFocusKey, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverPersist, getHoverScreen, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapPosition, getHSnapPosition, getHtmlElement, getHtmlElementAsString, getHtmlPosition, getImage, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getIsPrinting, getIsRuleScope, getIsSnapAlignCandidate, getKeepInParentRect, getLayoutAlign, getLeaveGroupLabelSpace, getLeavePageSpace, getLeft, getLeftAsString, getLocalId, getLocateByIDOnly, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getLocatorName, getMargin, getMasterCanvas, getMasterElement, getMatchElement, getMatchElementHeight, getMatchElementWidth, getMaxHeight, getMaxWidth, getMaxZoomOverflowError, getMenuConstructor, getMinHeight, getMinNonEdgeSize, getMinWidth, getMomentumScrollMinSpeed, getMouseStillDownDelay, getMouseStillDownInitialDelay, getName, getNativeAutoHideScrollbars, getNextZIndex, getNoDoubleClicks, getNoDropCursor, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOuterElement, getOverflow, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getPaletteDefaults, getPanelContainer, getParentCanvas, getParentElement, getPeers, getPendingMarkerStyle, getPendingMarkerVisible, getPercentBox, getPercentSource, getPersistentMatchElement, getPointerSettings, getPointerTarget, getPointerTargetAsString, getPosition, getPrefix, getPrintChildrenAbsolutelyPositioned, getPrintHTML, getPrintHTML, getPrintStyleName, getPrompt, getProportionalResizeModifiers, getProportionalResizing, getReceiveScrollbarEvents, getRect, getRedrawOnResize, getResizeBarTarget, getResizeFrom, getRight, getRuleContext, getRuleContext, getRuleScope, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowColor, getShadowDepth, getShadowHOffset, getShadowImage, getShadowOffset, getShadowSoftness, getShadowSpread, getShadowVOffset, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowHover, getShowHoverComponents, getShowPointer, getShowResizeBar, getShowShadow, getShowSnapGrid, getShrinkElementOnHide, getSizeMayChangeOnRedraw, getSkinImgDir, getSnapAlignCandidates, getSnapAlignCenterLineStyle, getSnapAlignEdgeLineStyle, getSnapAxis, getSnapEdge, getSnapGridLineProperties, getSnapGridStyle, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapPosition, getSnapPosition, getSnapResizeToAlign, getSnapResizeToGrid, getSnapTo, getSnapToAlign, getSnapToCenterAlign, getSnapToEdgeAlign, getSnapToGrid, getSnapVDirection, getSnapVGap, getStartLine, getTabIndex, getTestDataContext, getTestInstance, getTooltip, getTop, getTopAsString, getTopElement, getUISummary, getUpdateTabPositionOnDraw, getUpdateTabPositionOnReparent, getUseBackMask, getUseCSSShadow, getUseDragMask, getUseImageForSVG, getUseNativeDrag, getUseOpacityFilter, getUseTouchScrolling, getValuesManager, getValuesManagerAsString, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWhen, getVisibleWidth, getVSnapPosition, getVSnapPosition, getWorkflows, getZIndex, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideComponentMask, hideComponentMask, hideContextMenu, imgHTML, imgHTML, imgHTML, initComplete, intersects, isDirty, isDisabled, 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, print, print, print, print, printComponents, provideRuleContext, provideRuleContext, redraw, redraw, registerFontScaledPaddingStyles, removeChild, removeChild, removePeer, removePeer, removeRuleContext, removeSnapAlignCandidate, resizeAutoChildAttributes, resizeBy, resizeControls, resizeControlsTo, resizeFonts, resizeFonts, resizeFonts, resizeFontsTo, resizeIcons, resizePadding, resizePadding, resizeTo, resizeTo, revealChild, revealChild, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollTo, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAdaptHeightByCustomizer, setAdaptiveHeightPriority, setAdaptiveWidthPriority, setAdaptWidthByCustomizer, setAllowExternalFilters, setAlwaysManageFocusNavigation, setAlwaysShowScrollbars, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideEffect, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeLayoutMode, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaRole, setAriaState, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setAutoHeight, setAutoMaskComponents, setAutoParent, setAutoPopulateData, setAutoResizeAutoChildAttributes, setAutoResizeIcons, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBorderRadius, setBottom, setCanAcceptDrop, setCanAdaptHeight, setCanAdaptWidth, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setChildren, setChildrenResizeSnapAlign, setChildrenSnapAlign, setChildrenSnapCenterAlign, setChildrenSnapEdgeAlign, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setComponentMaskDefaults, setContents, setContextMenu, setCorrectZoomOverflow, setCursor, setDataContext, setDataPath, setDefaultHeight, setDefaultPageSpace, setDefaultProperties, setDefaultShowCustomScrollbars, setDefaultWidth, setDefiningProperty, setDefiningPropertyNameOptions, setDisabled, setDisabledCursor, setDisableTouchScrollingForDrag, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragMaskType, setDragMaxHeight, setDragMaxWidth, setDragMinHeight, setDragMinWidth, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragTarget, setDragType, setDropTarget, setDropTarget, setDropTypes, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setEditMode, setEditMode, setEditMode, setElement, setEnableWhen, setEndLine, setExtraSpace, setFacetId, setFloatingScrollbars, setForwardSVGeventsToObject, setGroupBorderCSS, setGroupLabelBackgroundColor, setGroupLabelStyleName, setGroupPadding, setGroupTitle, setHeight, setHeight100, setHideUsingDisplayNone, setHoverAlign, setHoverAutoDestroy, setHoverAutoFitMaxWidth, setHoverAutoFitMaxWidth, setHoverAutoFitWidth, setHoverDelay, setHoverFocusKey, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverPersist, setHoverScreen, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlElement, setHtmlElement, setHtmlPosition, setImage, setImage, setInitHandler, setIsGroup, setIsRuleScope, setIsSnapAlignCandidate, setKeepInParentRect, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeaveGroupLabelSpace, setLeavePageSpace, setLeft, setLeft, setLocateByIDOnly, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLocatorName, setLocatorParent, setLocatorParent, setLogicalStructure, setMargin, setMatchElement, setMatchElementHeight, setMatchElementWidth, setMaxHeight, setMaxWidth, setMaxZoomOverflowError, setMenuConstructor, setMinHeight, setMinNonEdgeSize, setMinWidth, setMomentumScrollMinSpeed, setMouseStillDownDelay, setMouseStillDownInitialDelay, setName, setNativeAutoHideScrollbars, setNeverUseFilters, setNoDoubleClicks, setNoDropCursor, setOpacity, setOverflow, setPadding, setPageLeft, setPageTop, setPanelContainer, setParentCanvas, setParentElement, setPeers, setPendingMarkerStyle, setPendingMarkerVisible, setPercentBox, setPercentSource, setPersistentMatchElement, setPointerSettings, setPointerTarget, setPosition, setPrefix, setPrintChildrenAbsolutelyPositioned, setPrintStyleName, setPrompt, setProportionalResizeModifiers, setProportionalResizing, setReceiveScrollbarEvents, setRect, setRect, setRedrawOnResize, setRelativeTabPosition, setResizeBarTarget, setResizeFrom, setResizeFrom, setRight, setRuleScope, setScrollbarConstructor, setScrollbarSize, setShadowColor, setShadowDepth, setShadowHOffset, setShadowImage, setShadowOffset, setShadowSoftness, setShadowSpread, setShadowVOffset, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowHover, setShowHoverComponents, setShowPointer, setShowResizeBar, setShowShadow, setShowSnapGrid, setShrinkElementOnHide, setSizeMayChangeOnRedraw, setSkinImgDir, setSmoothFade, setSnapAlignCandidates, setSnapAlignCenterLineStyle, setSnapAlignEdgeLineStyle, setSnapAxis, setSnapEdge, setSnapGridLineProperties, setSnapGridStyle, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToAlign, setSnapResizeToGrid, setSnapTo, setSnapToAlign, setSnapToCenterAlign, setSnapToEdgeAlign, setSnapToGrid, setSnapVDirection, setSnapVGap, setStartLine, setTabIndex, setTestDataContext, setTooltip, setTop, setTop, setUpdateTabPositionOnDraw, setUpdateTabPositionOnReparent, setUseBackMask, setUseCSSShadow, setUseDragMask, setUseImageForSVG, setUseNativeDrag, setUseOpacityFilter, setUseTouchScrolling, setValuesManager, setValuesManager, setVisibility, setVisible, setVisibleWhen, setWidth, setWidth100, setWorkflows, setZIndex, shouldDragScroll, show, showClickMask, showComponentMask, showComponentMask, showNextTo, showNextTo, showNextTo, showNextTo, showPendingMarker, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, startDebuggingOverflow, stopDebuggingOverflow, supportsValueDictation, supportsVoiceCommands, updateChildTabPosition, updateChildTabPositions, updateEditNode, updateHover, updateHover, updateShadow, updateTabPositionForDraw, visibleAtPoint, willAcceptDropMethods inherited from class com.smartgwt.client.widgets.BaseWidget
addDrawHandler, addDynamicProperty, addDynamicProperty, addDynamicProperty, addDynamicProperty, applyFactoryProperties, clearDynamicProperty, completeCreation, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hasAutoAssignedID, hasDynamicProperty, hashCode, initNativeObject, internalSetID, internalSetID, isConfigOnly, isCreated, isDrawn, 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, setDefaultProperties, setDragTracker, setFactoryCreated, setID, setJavaScriptObject, setLogicalStructure, setLogicalStructure, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setScClassName, toStringMethods 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, unsinkEventsMethods 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, sinkBitlessEventMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
-
Constructor Details
-
StatefulCanvas
public StatefulCanvas() -
StatefulCanvas
-
-
Method Details
-
getOrCreateRef
-
changeAutoChildDefaults
Changes the defaults for Canvas AutoChildren namedautoChildName.- 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, seeSGWTProperties.- See Also:
-
changeAutoChildDefaults
Changes the defaults for FormItem AutoChildren namedautoChildName.- 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, seeSGWTProperties.- See Also:
-
create
-
setActionType
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- new action type. Default value is "button"- Returns:
StatefulCanvasinstance, for chaining setter calls- See Also:
-
getActionType
Behavior on state changes -- BUTTON, RADIO or CHECKBOX- Returns:
- Return the 'actionType' for this canvas (radio / checkbox / button). Default value is "button"
- See Also:
-
setAlign
Horizontal alignment of this component's title.- Overrides:
setAlignin classCanvas- Parameters:
align- New align value. Default value is Canvas.CENTER- Returns:
StatefulCanvasinstance, for chaining setter calls- See Also:
-
getAlign
Horizontal alignment of this component's title.- Returns:
- Current align value. Default value is Canvas.CENTER
- See Also:
-
setAriaLabel
If specified this property returns thearia-labelattribute to write out inscreenReaderMode.If unset, aria-label will default to
this.promptif specified, otherwisethis.title.Note : This is an advanced setting
- Parameters:
ariaLabel- New ariaLabel value. Default value is null- Returns:
StatefulCanvasinstance, for chaining setter calls
-
getAriaLabel
If specified this property returns thearia-labelattribute to write out inscreenReaderMode.If unset, aria-label will default to
this.promptif specified, otherwisethis.title.- Returns:
- Method to return the
aria-labelfor this component (seegetAriaStateDefaults()).Returns
ariaLabelif specified, otherwiseprompt, otherwisetitle. Default value is null
-
setAutoFit
If true, ignore the specified size of this widget and always size just large enough to accommodate the title. IfsetWidth()is explicitly called on an autoFit:true button, autoFit will be reset tofalse.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 theautoFitproperty. Pass in true or false to turn autoFit on or off. When autoFit is set tofalse, canvas will be resized to it's previously specified size.- Parameters:
autoFit- New autoFit setting. Default value is null- Returns:
StatefulCanvasinstance, for chaining setter calls- See Also:
-
getAutoFit
If true, ignore the specified size of this widget and always size just large enough to accommodate the title. IfsetWidth()is explicitly called on an autoFit:true button, autoFit will be reset tofalse.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:
- Current autoFit value. Default value is null
- See Also:
-
setBaseStyle
Base CSS style className applied to the component.Note that if specified, this property takes precedence over any specified
styleName. If unset, thestyleNamewill be used as a defaultbaseStylevalue.As the component changes
stateand/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 baseStyleRotated Titles
The Framework doesn't have built-in support for rotating button titles in a fashion similar to
FacetChart.rotateLabels. However, you can manually configure a button to render with a rotated title by applying custom CSS via this property.For example, given a button with a height of 120 and a width of 48, if you copied the existing buttonXXX style declarations from skin_styles.css as new, rotatedTitleButtonXXX declarations, and then added the lines:
-ms-transform: translate(-38px,0px) rotate(270deg); -webkit-transform: translate(-38px,0px) rotate(270deg); transform: translate(-38px,0px) rotate(270deg); overflow: hidden; text-overflow: ellipsis; width:116px;in the declaration section beginning:.rotatedTitleButton, .rotatedTitleButtonSelected, .rotatedTitleButtonSelectedOver, .rotatedTitleButtonSelectedDown, .rotatedTitleButtonSelectedDisabled, .rotatedTitleButtonOver, .rotatedTitleButtonDown, .rotatedTitleButtonDisabled {then applying that style to the button withoverflow: "clip_h" would yield a vertically-rendered title with overflow via ellipsis as expected, and also wrap withButton.wrap. Note that:- The explicit width applied via CSS is needed because rotated elements don't inherit dimensions in their new orientation from the DOM - the transform/rotation occurs independently of layout.
- The translation transform required along the x-axis is roughly (width - height) / 2, but may need slight offsetting for optimal centering.
- We've explicitly avoided describing an approach based on CSS "writing-mode", since support is incomplete and bugs are present in popular browsers such as Firefox and Safari that would prevent it from being used without Framework assistance.
Note on css-margins: Developers should be aware that the css "margin" property is unreliable for certain subclasses of StatefulCanvas, including
buttons. Developers may use the explicitCanvas.marginproperty to specify button margins, or for a button within a layout, consider the layout propertiesLayout.layoutMargin,Layout.membersMargin
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. Default value is null- Returns:
StatefulCanvasinstance, for chaining setter calls- See Also:
-
getBaseStyle
Base CSS style className applied to the component.Note that if specified, this property takes precedence over any specified
styleName. If unset, thestyleNamewill be used as a defaultbaseStylevalue.As the component changes
stateand/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 baseStyleRotated Titles
The Framework doesn't have built-in support for rotating button titles in a fashion similar to
FacetChart.rotateLabels. However, you can manually configure a button to render with a rotated title by applying custom CSS via this property.For example, given a button with a height of 120 and a width of 48, if you copied the existing buttonXXX style declarations from skin_styles.css as new, rotatedTitleButtonXXX declarations, and then added the lines:
-ms-transform: translate(-38px,0px) rotate(270deg); -webkit-transform: translate(-38px,0px) rotate(270deg); transform: translate(-38px,0px) rotate(270deg); overflow: hidden; text-overflow: ellipsis; width:116px;in the declaration section beginning:.rotatedTitleButton, .rotatedTitleButtonSelected, .rotatedTitleButtonSelectedOver, .rotatedTitleButtonSelectedDown, .rotatedTitleButtonSelectedDisabled, .rotatedTitleButtonOver, .rotatedTitleButtonDown, .rotatedTitleButtonDisabled {then applying that style to the button withoverflow: "clip_h" would yield a vertically-rendered title with overflow via ellipsis as expected, and also wrap withButton.wrap. Note that:- The explicit width applied via CSS is needed because rotated elements don't inherit dimensions in their new orientation from the DOM - the transform/rotation occurs independently of layout.
- The translation transform required along the x-axis is roughly (width - height) / 2, but may need slight offsetting for optimal centering.
- We've explicitly avoided describing an approach based on CSS "writing-mode", since support is incomplete and bugs are present in popular browsers such as Firefox and Safari that would prevent it from being used without Framework assistance.
Note on css-margins: Developers should be aware that the css "margin" property is unreliable for certain subclasses of StatefulCanvas, including
buttons. Developers may use the explicitCanvas.marginproperty to specify button margins, or for a button within a layout, consider the layout propertiesLayout.layoutMargin,Layout.membersMargin- Returns:
- Current baseStyle value. Default value is null
- See Also:
-
setEditProxyConstructor
public StatefulCanvas setEditProxyConstructor(String editProxyConstructor) throws IllegalStateException Default class used to construct theEditProxyfor this component when the component isfirst placed into edit mode.- Overrides:
setEditProxyConstructorin classCanvas- Parameters:
editProxyConstructor- New editProxyConstructor value. Default value is "StatefulCanvasEditProxy"- Returns:
StatefulCanvasinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getEditProxyConstructor
Default class used to construct theEditProxyfor this component when the component isfirst placed into edit mode.- Overrides:
getEditProxyConstructorin classCanvas- Returns:
- Current editProxyConstructor value. Default value is "StatefulCanvasEditProxy"
- See Also:
-
setHeight
Size for this component's vertical dimension. SeeCanvas.heightfor more details.Note that if
autoFitis set on non-StretchImgButtoninstances, this property will be ignored so that the widget is always sized just large enough to accommodate the title.- Overrides:
setHeightin classCanvas- Parameters:
height- New height value. Default value is null- Returns:
StatefulCanvasinstance, for chaining setter calls- See Also:
-
getHeight
Size for this component's vertical dimension. SeeCanvas.heightfor more details.Note that if
autoFitis set on non-StretchImgButtoninstances, this property will be ignored so that the widget is always sized just large enough to accommodate the title. -
setHeight
Size for this component's vertical dimension. SeeCanvas.heightfor more details.Note that if
autoFitis set on non-StretchImgButtoninstances, this property will be ignored so that the widget is always sized just large enough to accommodate the title. -
getHeightAsString
Size for this component's vertical dimension. SeeCanvas.heightfor more details.Note that if
autoFitis set on non-StretchImgButtoninstances, this property will be ignored so that the widget is always sized just large enough to accommodate the title.- Overrides:
getHeightAsStringin classCanvas- Returns:
- Current height value. Default value is null
- See Also:
-
setIcon
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. A sprited image can be specified using the
SCSpriteConfigformat.Note that the string "blank" is a valid setting for this attribute and will always result in the system blank image, with no state suffixes applied. Typically, this might be used when an iconStyle is also specified and the iconStyle renders the icon via a stateful background-image or other CSS approach.
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. Default value is null- Returns:
StatefulCanvasinstance, for chaining setter calls- See Also:
-
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. A sprited image can be specified using the
SCSpriteConfigformat.Note that the string "blank" is a valid setting for this attribute and will always result in the system blank image, with no state suffixes applied. Typically, this might be used when an iconStyle is also specified and the iconStyle renders the icon via a stateful background-image or other CSS approach.
- Returns:
- Current icon value. Default value is null
- See Also:
-
setIconHeight
Height in pixels of the icon image.If unset, defaults to
iconSize.- Parameters:
iconHeight- New iconHeight value. Default value is null- Returns:
StatefulCanvasinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getIconHeight
Height in pixels of the icon image.If unset, defaults to
iconSize.- Returns:
- Current iconHeight value. Default value is null
- See Also:
-
setIconOrientation
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"- Returns:
StatefulCanvasinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
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:
- Current iconOrientation value. Default value is "left"
- See Also:
-
setIconSize
Size in pixels of the icon image.The
iconWidthandiconHeightproperties 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 theiconWidthandiconHeightto the same value rather than setting aniconSize. This is because certain skins or customizations thereto might set theiconWidthandiconHeight, making the customization of the AutoChild'siconSizeineffective.- Parameters:
iconSize- New iconSize value. Default value is 16- Returns:
StatefulCanvasinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getIconSize
public int getIconSize()Size in pixels of the icon image.The
iconWidthandiconHeightproperties 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 theiconWidthandiconHeightto the same value rather than setting aniconSize. This is because certain skins or customizations thereto might set theiconWidthandiconHeight, making the customization of the AutoChild'siconSizeineffective.- Returns:
- Current iconSize value. Default value is 16
- See Also:
-
setIconStyle
Base CSS style applied to the icon image. If set, as theStatefulCanvaschangesstateand/or isselected, suffixes will be appended toiconStyleto 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 iconStyleDefault CSS style iconStyle+SelectedApplied when selectedandshowSelectedIconare true.iconStyle+FocusedApplied when the component has keyboard focus, if showFocusedIconis true, andshowFocusedAsOveris not true.iconStyle+OverApplied when showRollOverIconis set to true and either the user rolls over the component orshowFocusedAsOveris true and the component has keyboard focus.iconStyle+DownApplied when the user presses the mouse button on the component if showDownIconis set to trueiconStyle+DisabledApplied when the component is disabledifshowDisabledIconis true.Combined styles iconStyle+SelectedFocusedCombined Selected and focused styling iconStyle+SelectedOverCombined Selected and rollOver styling iconStyle+FocusedOverCombined Focused and rollOver styling iconStyle+SelectedFocusedOverCombined Selected, Focused and rollOver styling iconStyle+SelectedDownCombined Selected and mouse-down styling iconStyle+FocusedDownCombined Focused and mouse-down styling iconStyle+SelectedFocusedDownCombined Selected, Focused and mouse-down styling iconStyle+SelectedDisabledCombined Selected and Disabled styling In addition, if
showRTLIconis 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 foriconStyle.- Parameters:
iconStyle- the newiconStyle(may benullto remove the className on the image). Default value is null- Returns:
StatefulCanvasinstance, for chaining setter calls- See Also:
-
getIconStyle
Base CSS style applied to the icon image. If set, as theStatefulCanvaschangesstateand/or isselected, suffixes will be appended toiconStyleto 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 iconStyleDefault CSS style iconStyle+SelectedApplied when selectedandshowSelectedIconare true.iconStyle+FocusedApplied when the component has keyboard focus, if showFocusedIconis true, andshowFocusedAsOveris not true.iconStyle+OverApplied when showRollOverIconis set to true and either the user rolls over the component orshowFocusedAsOveris true and the component has keyboard focus.iconStyle+DownApplied when the user presses the mouse button on the component if showDownIconis set to trueiconStyle+DisabledApplied when the component is disabledifshowDisabledIconis true.Combined styles iconStyle+SelectedFocusedCombined Selected and focused styling iconStyle+SelectedOverCombined Selected and rollOver styling iconStyle+FocusedOverCombined Focused and rollOver styling iconStyle+SelectedFocusedOverCombined Selected, Focused and rollOver styling iconStyle+SelectedDownCombined Selected and mouse-down styling iconStyle+FocusedDownCombined Focused and mouse-down styling iconStyle+SelectedFocusedDownCombined Selected, Focused and mouse-down styling iconStyle+SelectedDisabledCombined Selected and Disabled styling In addition, if
showRTLIconis true, then in RTL mode, a final "RTL" suffix will be appended.- Returns:
- Current iconStyle value. Default value is null
- See Also:
-
setIconWidth
Width in pixels of the icon image.If unset, defaults to
iconSize.- Parameters:
iconWidth- New iconWidth value. Default value is null- Returns:
StatefulCanvasinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getIconWidth
Width in pixels of the icon image.If unset, defaults to
iconSize.- Returns:
- Current iconWidth value. Default value is null
- See Also:
-
setIgnoreRTL
Should horizontal alignment-related attributesalignandiconOrientationbe 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 forignoreRTL.Note : This is an advanced setting
- Parameters:
ignoreRTL- new value for ignoreRTL. Default value is false- Returns:
StatefulCanvasinstance, for chaining setter calls
-
getIgnoreRTL
public boolean getIgnoreRTL()Should horizontal alignment-related attributesalignandiconOrientationbe mirrored in RTL mode? This is the default behavior unless ignoreRTL is set to true.- Returns:
- Current ignoreRTL value. Default value is false
-
setLabelHPad
If non-null, specifies the horizontal padding applied to the label, if any.- Parameters:
labelHPad- New labelHPad value. Default value is null- Returns:
StatefulCanvasinstance, for chaining setter calls- See Also:
-
getLabelHPad
If non-null, specifies the horizontal padding applied to the label, if any.- Returns:
- Current labelHPad value. Default value is null
- See Also:
-
setLabelVPad
If non-null, specifies the vertical padding applied to the label, if any.- Parameters:
labelVPad- New labelVPad value. Default value is null- Returns:
StatefulCanvasinstance, for chaining setter calls- See Also:
-
getLabelVPad
If non-null, specifies the vertical padding applied to the label, if any.- Returns:
- Current labelVPad value. Default value is null
- See Also:
-
getOverCanvas
Auto generated child widget to be shown when the user rolls over this canvas ifshowOverCanvasis true. See documentation forcom.smartgwt.client.types.AutoChildfor information on how to customize this canvas.This component is an AutoChild named "overCanvas". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current overCanvas value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setOverCanvasConstructor
Constructor class name for this widget'soverCanvasNote : This is an advanced setting
- Parameters:
overCanvasConstructor- New overCanvasConstructor value. Default value is "Canvas"- Returns:
StatefulCanvasinstance, for chaining setter calls
-
getOverCanvasConstructor
Constructor class name for this widget'soverCanvas- Returns:
- Current overCanvasConstructor value. Default value is "Canvas"
-
setRadioGroup
String identifier for this canvas's mutually exclusive selection group.Note : This is an advanced setting
- Parameters:
radioGroup- New radioGroup value. Default value is null- Returns:
StatefulCanvasinstance, for chaining setter calls- See Also:
-
getRadioGroup
String identifier for this canvas's mutually exclusive selection group.- Returns:
- Current radioGroup value. Default value is null
- See Also:
-
setRedrawOnStateChange
Whether this widget needs to redraw to reflect state changeNote : This is an advanced setting
- Parameters:
redrawOnStateChange- New redrawOnStateChange value. Default value is false- Returns:
StatefulCanvasinstance, for chaining setter calls- See Also:
-
getRedrawOnStateChange
Whether this widget needs to redraw to reflect state change- Returns:
- Current redrawOnStateChange value. Default value is false
- See Also:
-
setSelected
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- Returns:
StatefulCanvasinstance, for chaining setter calls- See Also:
-
getSelected
Whether this component is selected. For some components, selection affects appearance.- Returns:
- Current selected value. Default value is false
- See Also:
-
setShowDisabled
Should we visibly change state when disabled?- Parameters:
showDisabled- New showDisabled value. Default value is true- Returns:
StatefulCanvasinstance, for chaining setter calls- See Also:
-
getShowDisabled
Should we visibly change state when disabled?- Returns:
- Current showDisabled value. Default value is true
- See Also:
-
setShowDisabledIcon
If using an icon for this button, whether to switch the icon image if the button becomes disabled.- Parameters:
showDisabledIcon- New showDisabledIcon value. Default value is true- Returns:
StatefulCanvasinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getShowDisabledIcon
If using an icon for this button, whether to switch the icon image if the button becomes disabled.- Returns:
- Current showDisabledIcon value. Default value is true
- See Also:
-
setShowDown
Should we visibly change state when the mouse goes down in this object?- Parameters:
showDown- New showDown value. Default value is false- Returns:
StatefulCanvasinstance, for chaining setter calls- See Also:
-
getShowDown
Should we visibly change state when the mouse goes down in this object?- Returns:
- Current showDown value. Default value is false
- See Also:
-
setShowDownIcon
If using an icon for this button, whether to switch the icon image when the mouse goes down on the button.- Parameters:
showDownIcon- New showDownIcon value. Default value is false- Returns:
StatefulCanvasinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getShowDownIcon
If using an icon for this button, whether to switch the icon image when the mouse goes down on the button.- Returns:
- Current showDownIcon value. Default value is false
- See Also:
-
setShowFocused
Should we visibly change state when the canvas receives focus? IfshowFocusedAsOveristrue, then"over"will be used to indicate focus. Otherwise a separate"focused"state will be used.- Parameters:
showFocused- New showFocused value. Default value is false- Returns:
StatefulCanvasinstance, for chaining setter calls- See Also:
-
getShowFocused
Should we visibly change state when the canvas receives focus? IfshowFocusedAsOveristrue, then"over"will be used to indicate focus. Otherwise a separate"focused"state will be used.- Returns:
- Current showFocused value. Default value is false
- See Also:
-
setShowFocusedAsOver
IfshowFocusedis 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- New showFocusedAsOver value. Default value is true- Returns:
StatefulCanvasinstance, for chaining setter calls- See Also:
-
getShowFocusedAsOver
IfshowFocusedis 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:
- Current showFocusedAsOver value. Default value is true
- See Also:
-
setShowFocusedIcon
If using an icon for this button, whether to switch the icon image when the button receives focus.If
showFocusedAsOveris true, the"Over"icon will be displayed when the canvas has focus, otherwise a separate"Focused"icon will be displayed- Parameters:
showFocusedIcon- New showFocusedIcon value. Default value is false- Returns:
StatefulCanvasinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getShowFocusedIcon
If using an icon for this button, whether to switch the icon image when the button receives focus.If
showFocusedAsOveris true, the"Over"icon will be displayed when the canvas has focus, otherwise a separate"Focused"icon will be displayed- Returns:
- Current showFocusedIcon value. Default value is false
- See Also:
-
setShowMenuOnClick
If true, this widget will fireshowContextMenu()to show thecontext menuif one is defined, rather thanclick(), when the left mouse is clicked.Note that this property has a different interpretation in
IconButtonasIconButton.showMenuOnClick.- Parameters:
showMenuOnClick- New showMenuOnClick value. Default value is null- Returns:
StatefulCanvasinstance, for chaining setter calls
-
getShowMenuOnClick
If true, this widget will fireshowContextMenu()to show thecontext menuif one is defined, rather thanclick(), when the left mouse is clicked.Note that this property has a different interpretation in
IconButtonasIconButton.showMenuOnClick.- Returns:
- Current showMenuOnClick value. Default value is null
-
setShowOverCanvas
When this property is set to true, this widget will create and show theoverCanvason user rollover.Note : This is an advanced setting
- Parameters:
showOverCanvas- New showOverCanvas value. Default value is false- Returns:
StatefulCanvasinstance, for chaining setter calls
-
getShowOverCanvas
When this property is set to true, this widget will create and show theoverCanvason user rollover.- Returns:
- Current showOverCanvas value. Default value is false
-
setShowRollOver
Should we visibly change state when the mouse goes over this object?- Parameters:
showRollOver- New showRollOver value. Default value is false- Returns:
StatefulCanvasinstance, for chaining setter calls- See Also:
-
getShowRollOver
Should we visibly change state when the mouse goes over this object?- Returns:
- Current showRollOver value. Default value is false
- See Also:
-
setShowRollOverIcon
If using an icon for this button, whether to switch the icon image on mouse rollover.- Parameters:
showRollOverIcon- New showRollOverIcon value. Default value is false- Returns:
StatefulCanvasinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getShowRollOverIcon
If using an icon for this button, whether to switch the icon image on mouse rollover.- Returns:
- Current showRollOverIcon value. Default value is false
- See Also:
-
setShowRTLIcon
IsRTLmedia 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, ificonis "myIcon.png" and showRTLIcon is true, then in RTL mode, the image's src will be set to "myIcon_rtl.png".- Parameters:
showRTLIcon- New showRTLIcon value. Default value is false- Returns:
StatefulCanvasinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getShowRTLIcon
public boolean getShowRTLIcon()IsRTLmedia 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, ificonis "myIcon.png" and showRTLIcon is true, then in RTL mode, the image's src will be set to "myIcon_rtl.png".- Returns:
- Current showRTLIcon value. Default value is false
-
setShowSelectedIcon
If using an icon for this button, whether to switch the icon image when the button becomes selected.- Parameters:
showSelectedIcon- New showSelectedIcon value. Default value is false- Returns:
StatefulCanvasinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getShowSelectedIcon
If using an icon for this button, whether to switch the icon image when the button becomes selected.- Returns:
- Current showSelectedIcon value. Default value is false
- See Also:
-
setState
Current "state" of this widget. The state setting is automatically updated as the user interacts with the component (seeshowRollOver,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
baseStyleandgetStateSuffix()for a description of how this is done.For
ImgorStretchImgbased subclasses of StatefulCanvas, the appearance may also be updated by changing the src of the rendered image. SeeImg.srcandStretchImgButton.srcfor 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 thestateof this object, changing its appearance. Note:newStatecannot beState.STATE_DISABLEDifthis.showDisabledisfalse.Note : This is an advanced setting
- Parameters:
state- the new state. Default value is ""- Returns:
StatefulCanvasinstance, for chaining setter calls- See Also:
-
getState
Current "state" of this widget. The state setting is automatically updated as the user interacts with the component (seeshowRollOver,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
baseStyleandgetStateSuffix()for a description of how this is done.For
ImgorStretchImgbased subclasses of StatefulCanvas, the appearance may also be updated by changing the src of the rendered image. SeeImg.srcandStretchImgButton.srcfor 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. Default value is ""
- See Also:
-
setStyleName
StatefulCanvases are styled by combiningbaseStylewithStateto build a composite css style name. In most cases,statefulCanvas.styleNamewill have no effect on statefulCanvas styling and should not be used.If the
baseStyleis not explicitly specified for a class, thestyleNamewill be used as a default baseStyle. Other than that, this attribute will be ignored.- Overrides:
setStyleNamein classCanvas- Parameters:
styleName- New styleName value. Default value is "normal"- See Also:
-
getStyleName
StatefulCanvases are styled by combiningbaseStylewithStateto build a composite css style name. In most cases,statefulCanvas.styleNamewill have no effect on statefulCanvas styling and should not be used.If the
baseStyleis not explicitly specified for a class, thestyleNamewill be used as a default baseStyle. Other than that, this attribute will be ignored.- Overrides:
getStyleNamein classCanvas- Returns:
- Current styleName value. Default value is "normal"
- See Also:
-
setTitle
The title HTML to display in this button.
If this method is called after the component has been drawn/initialized: Setter for thetitle. -
getTitle
The title HTML to display in this button. -
setValign
Vertical alignment of this component's title.- Parameters:
valign- New valign value. Default value is Canvas.CENTER- Returns:
StatefulCanvasinstance, for chaining setter calls- See Also:
-
getValign
Vertical alignment of this component's title.- Returns:
- Current valign value. Default value is Canvas.CENTER
- See Also:
-
setVIconStyle
Base CSS style applied to the icon image whenverticalis set to true. If set, as theStatefulCanvaschangesstateand/or isselected, suffixes will be appended tovIconStyleto form the className set on the image element.The
iconStylefor details about stateful suffixes.- Parameters:
vIconStyle- New vIconStyle value. Default value is null- Returns:
StatefulCanvasinstance, for chaining setter calls- See Also:
-
getVIconStyle
Base CSS style applied to the icon image whenverticalis set to true. If set, as theStatefulCanvaschangesstateand/or isselected, suffixes will be appended tovIconStyleto form the className set on the image element.The
iconStylefor details about stateful suffixes.- Returns:
- Current vIconStyle value. Default value is null
- See Also:
-
setWidth
Size for this component's horizontal dimension. SeeCanvas.widthfor more details.Note that if
autoFitis set, this property will be ignored so that the widget is always sized just large enough to accommodate the title.- Overrides:
setWidthin classCanvas- Parameters:
width- New width value. Default value is null- Returns:
StatefulCanvasinstance, for chaining setter calls- See Also:
-
getWidth
Size for this component's horizontal dimension. SeeCanvas.widthfor more details.Note that if
autoFitis set, this property will be ignored so that the widget is always sized just large enough to accommodate the title. -
setWidth
Size for this component's horizontal dimension. SeeCanvas.widthfor more details.Note that if
autoFitis set, this property will be ignored so that the widget is always sized just large enough to accommodate the title. -
getWidthAsString
Size for this component's horizontal dimension. SeeCanvas.widthfor more details.Note that if
autoFitis set, this property will be ignored so that the widget is always sized just large enough to accommodate the title.- Overrides:
getWidthAsStringin classCanvas- Returns:
- Current width value. Default value is null
- See Also:
-
addToRadioGroup
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:
-
deselect
public void deselect()Deselect this object.- See Also:
-
getAriaStateDefaults
Retrieves dynamically calculated defaultARIA state mappingproperties for this canvas. These will be combined with explicitly specified aria state as described inCanvas.getAriaState().Overridden by StatefulCanvas to pick up
aria-label.- Overrides:
getAriaStateDefaultsin classCanvas- Returns:
- dynamically calculated default aria state properties
-
getStateSuffix
Returns the suffix that will be appended to thebaseStyleas the component changesstateand/or is selected / focused.Note that suffixes will only be included if the relevant
show[StateName]attributes (EGshowRollOver,showFocused, etc) are set to true.The following table lists out the standard set of suffixes which may be applied to the base style:
CSS Class Applied Description baseStyleDefault css style baseStyle+SelectedApplied when selectedis set to true.baseStyle+FocusedApplied when the component has keyboard focus, if showFocusedis true, andshowFocusedAsOveris not true.baseStyle+OverApplied when showRollOveris set to true and either the user rolls over the component orshowFocusedAsOveris true and the component has keyboard focus.baseStyle+DownApplied when the user presses the mouse button on the component if showDownis set to truebaseStyle+DisabledApplied when the component is disabledifshowDisabledis true.Combined styles baseStyle+SelectedFocusedCombined Selected and focused styling baseStyle+SelectedOverCombined Selected and rollOver styling baseStyle+FocusedOverCombined Focused and rollOver styling baseStyle+SelectedFocusedOverCombined Selected, Focused and rollOver styling baseStyle+SelectedDownCombined Selected and mouse-down styling baseStyle+FocusedDownCombined Focused and mouse-down styling baseStyle+SelectedFocusedDownCombined Selected, Focused and mouse-down styling baseStyle+SelectedDisabledCombined Selected and Disabled styling - Returns:
- suffix to be appended to the baseStyle
-
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:
-
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.- Parameters:
groupID- - optional radio group ID (to ensure the widget is removed from the appropriate group.- See Also:
-
select
public void select()Select this object.- See Also:
-
setDefaultProperties
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:
-
setTitleStyle
-
setTitleFormatter
-
isSelected
Find out if this object is selected.- Returns:
- Boolean
- See Also:
-
setLogicalStructure
Setter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility. -
getLogicalStructure
Getter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.- Specified by:
getLogicalStructurein interfaceLogicalStructure- Overrides:
getLogicalStructurein classCanvas
-