Class Button
- 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,HasIconClickHandlers,HasKeyDownHandlers,HasKeyPressHandlers,HasMouseDownHandlers,HasMouseMoveHandlers,HasMouseOutHandlers,HasMouseOverHandlers,HasMouseStillDownHandlers,HasMouseUpHandlers,HasMouseWheelHandlers,HasMovedHandlers,HasParentMovedHandlers,HasResizedHandlers,HasRightMouseDownHandlers,HasRuleContextChangedHandlers,HasScrolledHandlers,HasShowContextMenuHandlers,HasTitleHoverHandlers,HasVisibilityChangedHandlers
- Direct Known Subclasses:
Label,MenuButton,NavigationButton,RibbonButton,ToolStripButton
-
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 TypeMethodDescriptionvoidaction()This property contains the default 'action' for the Button to fire when activated.addIconClickHandler(IconClickHandler handler) Add a iconClick handler.addTitleHoverHandler(TitleHoverHandler handler) Add a titleHover handler.voidaddToRadioGroup(String groupID) Add this widget to the specified mutually exclusive selection group with the ID passed in.static voidassertIsButton(Canvas targetCanvas, String message) Internal method to verify class of targetCanvas.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()Select this object.Behavior on state changes -- BUTTON, RADIO or CHECKBOXbooleanIfcanAdaptWidthis true, and this button has a specifiedicon, should the title be hidden, allowing the button to shrink down to just show the icon when there isn't enough horizontal space in a layout to show the default sized button?getAlign()Horizontal alignment of this component's title.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.This flag enablesadaptive widthfor the button.This attribute denotes the name of a property to use as agetDefiningPropertyName()for this property when generating and resolvingAutoTest locators with search segments.Specifies the cursor to display when the mouse pointer is over the icon image and thisStatefulCanvasisdisabled.Size for this component's vertical dimension.Size for this component's vertical dimension.If set to true, if thetitleof this button contains the specifiedaccessKey, when the title is displayed to the user it will be modified to include HTML to underline the accessKey.
Note that this property may cause titles that include HTML (rather than simple strings) to be inappropriately modified, so should be disabled if your title string includes HTML characters.getIcon()Optional icon to be shown with the button title text.If this button is showing an icon should it be right or left aligned?Specifies the cursor to display when the mouse pointer is over the icon image.Height in pixels of the icon image.if defined,iconOnlyBaseStyleis used as the base CSS style className, instead ofbaseStyle, ifcanAdaptWidthis set and thetitle is not being shown.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.intPixels between icon and title text.Base CSS style applied to the icon image.Width in pixels of the icon image.Getter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.static ButtongetOrCreateRef(JavaScriptObject jsObj) Clip the contents of the button if necessary.String identifier for this canvas's mutually exclusive selection group.If true and the title is clipped, then a hover containing the full title of this button is enabled.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? IfStatefulCanvas.showFocusedAsOveristrue, then"over"will be used to indicate focus.If using an icon for this button, whether to switch the icon image when the button receives focus.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.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.getWidth()Size for this component's horizontal dimension.Size for this component's horizontal dimension.getWrap()A boolean indicating whether the button's title should word-wrap, if necessary.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.setAdaptWidthShowIconOnly(boolean adaptWidthShowIconOnly) IfcanAdaptWidthis true, and this button has a specifiedicon, should the title be hidden, allowing the button to shrink down to just show the icon when there isn't enough horizontal space in a layout to show the default sized button?Horizontal alignment of this component's title.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.setCanAdaptWidth(Boolean canAdaptWidth) This flag enablesadaptive widthfor the button.static voidsetDefaultProperties(Button buttonProperties) Class level method to set the default properties of this class.setDefiningProperty(String definingProperty) This attribute denotes the name of a property to use as agetDefiningPropertyName()for this property when generating and resolvingAutoTest locators with search segments.setDisabledIconCursor(Cursor disabledIconCursor) Specifies the cursor to display when the mouse pointer is over the icon image and thisStatefulCanvasisdisabled.Size for this component's vertical dimension.voidSize for this component's vertical dimension.setHiliteAccessKey(Boolean hiliteAccessKey) If set to true, if thetitleof this button contains the specifiedaccessKey, when the title is displayed to the user it will be modified to include HTML to underline the accessKey.
Note that this property may cause titles that include HTML (rather than simple strings) to be inappropriately modified, so should be disabled if your title string includes HTML characters.Optional icon to be shown with the button title text.setIconAlign(String iconAlign) If this button is showing an icon should it be right or left aligned?setIconCursor(Cursor iconCursor) Specifies the cursor to display when the mouse pointer is over the icon image.setIconHeight(Integer iconHeight) Height in pixels of the icon image.setIconOnlyBaseStyle(String iconOnlyBaseStyle) if defined,iconOnlyBaseStyleis used as the base CSS style className, instead ofbaseStyle, ifcanAdaptWidthis set and thetitle is not being shown.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.setIconSpacing(int iconSpacing) Pixels between icon and title text.setIconStyle(String iconStyle) Base CSS style applied to the icon image.setIconWidth(Integer iconWidth) Width in pixels of the icon image.Setter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.setOverflow(Overflow overflow) Clip the contents of the button if necessary.setRadioGroup(String radioGroup) String identifier for this canvas's mutually exclusive selection group.setShowClippedTitleOnHover(Boolean showClippedTitleOnHover) If true and the title is clipped, then a hover containing the full title of this button is enabled.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? IfStatefulCanvas.showFocusedAsOveristrue, then"over"will be used to indicate focus.setShowFocusedIcon(Boolean showFocusedIcon) If using an icon for this button, whether to switch the icon image when the button receives focus.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.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.voidsetTitleHoverFormatter(TitleHoverFormatter formatter) Provide a custom implementation oftitleHoverHTML(java.lang.String).setValign(VerticalAlignment valign) Vertical alignment of this component's title.Size for this component's horizontal dimension.voidSize for this component's horizontal dimension.A boolean indicating whether the button's title should word-wrap, if necessary.booleanIs the title of this button clipped?titleHoverHTML(String defaultHTML) Returns the HTML that is displayed by the defaulttitleHoverhandler.Methods inherited from class com.smartgwt.client.widgets.StatefulCanvas
getAriaLabel, getAriaStateDefaults, getEditProxyConstructor, getIgnoreRTL, getLabelHPad, getLabelVPad, getOverCanvas, getOverCanvasConstructor, getRedrawOnStateChange, getSelected, getShowFocusedAsOver, getShowMenuOnClick, getShowOverCanvas, getShowRTLIcon, getStateSuffix, getVIconStyle, isSelected, setAriaLabel, setDefaultProperties, setEditProxyConstructor, setIgnoreRTL, setLabelHPad, setLabelVPad, setLogicalStructure, setOverCanvasConstructor, setRedrawOnStateChange, setSelected, setShowFocusedAsOver, setShowMenuOnClick, setShowOverCanvas, setShowRTLIcon, setTitleFormatter, setTitleStyle, setVIconStyleMethods 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, 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, 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, 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, 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, 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, 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, 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, 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
-
Button
public Button() -
Button
-
Button
-
-
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
- Overrides:
createin classStatefulCanvas
-
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.- Overrides:
setActionTypein classStatefulCanvas- Parameters:
actionType- new action type. Default value is "button"- Returns:
Buttoninstance, for chaining setter calls- See Also:
-
getActionType
Behavior on state changes -- BUTTON, RADIO or CHECKBOX- Overrides:
getActionTypein classStatefulCanvas- Returns:
- Return the 'actionType' for this canvas (radio / checkbox / button). Default value is "button"
- See Also:
-
setAdaptWidthShowIconOnly
IfcanAdaptWidthis true, and this button has a specifiedicon, should the title be hidden, allowing the button to shrink down to just show the icon when there isn't enough horizontal space in a layout to show the default sized button?- Parameters:
adaptWidthShowIconOnly- New adaptWidthShowIconOnly value. Default value is true- Returns:
Buttoninstance, for chaining setter calls- See Also:
-
getAdaptWidthShowIconOnly
public boolean getAdaptWidthShowIconOnly()IfcanAdaptWidthis true, and this button has a specifiedicon, should the title be hidden, allowing the button to shrink down to just show the icon when there isn't enough horizontal space in a layout to show the default sized button?- Returns:
- Current adaptWidthShowIconOnly value. Default value is true
- See Also:
-
setAlign
Horizontal alignment of this component's title.
If this method is called after the component has been drawn/initialized: Sets the (horizontal) alignment of this buttons content.- Overrides:
setAlignin classStatefulCanvas- Parameters:
align- New align value. Default value is Canvas.CENTER- Returns:
Buttoninstance, for chaining setter calls- See Also:
-
getAlign
Horizontal alignment of this component's title.- Overrides:
getAlignin classStatefulCanvas- Returns:
- Current align value. Default value is Canvas.CENTER
- See Also:
-
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 theStatefulCanvas.autoFitproperty. 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.- Overrides:
setAutoFitin classStatefulCanvas- Parameters:
autoFit- New autoFit setting. Default value is null- Returns:
Buttoninstance, 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"
- Overrides:
getAutoFitin classStatefulCanvas- 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
StatefulCanvas.styleName. If unset, thestyleNamewill be used as a defaultbaseStylevalue.As the component changes
StatefulCanvas.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
StatefulCanvas.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 withwrap. 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.- Overrides:
setBaseStylein classStatefulCanvas- Parameters:
baseStyle- new base style. Default value is "button"- Returns:
Buttoninstance, 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
StatefulCanvas.styleName. If unset, thestyleNamewill be used as a defaultbaseStylevalue.As the component changes
StatefulCanvas.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
StatefulCanvas.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 withwrap. 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- Overrides:
getBaseStylein classStatefulCanvas- Returns:
- Current baseStyle value. Default value is "button"
- See Also:
-
setCanAdaptWidth
This flag enablesadaptive widthfor the button.If enabled the button will support rendering in a 'collapsed' view if there isn't enough space in a layout to render it at normal size. There are a couple of ways this can be achieved.
- If
adaptWidthShowIconOnlyis true and this button shows an icon, the title will be hidden if there isn't enough space to render it, allowing it to shrink to either the rendered icon width, or any specifiedminWidth, whichever is larger. - Otherwise, if the button has a specified
minWidth, andautoFitis true, autoFit will be temporarily disabled, if there isn't enough room, allowing the title to be clipped
titleHoverHTML().- Overrides:
setCanAdaptWidthin classCanvas- Parameters:
canAdaptWidth- New canAdaptWidth value. Default value is false- Returns:
Buttoninstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
- If
-
getCanAdaptWidth
This flag enablesadaptive widthfor the button.If enabled the button will support rendering in a 'collapsed' view if there isn't enough space in a layout to render it at normal size. There are a couple of ways this can be achieved.
- If
adaptWidthShowIconOnlyis true and this button shows an icon, the title will be hidden if there isn't enough space to render it, allowing it to shrink to either the rendered icon width, or any specifiedminWidth, whichever is larger. - Otherwise, if the button has a specified
minWidth, andautoFitis true, autoFit will be temporarily disabled, if there isn't enough room, allowing the title to be clipped
titleHoverHTML().- Overrides:
getCanAdaptWidthin classCanvas- Returns:
- Current canAdaptWidth value. Default value is false
- See Also:
- If
-
setDefiningProperty
This attribute denotes the name of a property to use as agetDefiningPropertyName()for this property when generating and resolvingAutoTest locators with search segments.Note : This is an advanced setting
- Overrides:
setDefiningPropertyin classCanvas- Parameters:
definingProperty- New definingProperty value. Default value is "title"- Returns:
Buttoninstance, for chaining setter calls
-
getDefiningProperty
This attribute denotes the name of a property to use as agetDefiningPropertyName()for this property when generating and resolvingAutoTest locators with search segments.- Overrides:
getDefiningPropertyin classCanvas- Returns:
- Current definingProperty value. Default value is "title"
-
setDisabledIconCursor
Specifies the cursor to display when the mouse pointer is over the icon image and thisStatefulCanvasisdisabled.If not set and the mouse pointer is over the icon image,
iconCursorwill be used.- Parameters:
disabledIconCursor- New disabledIconCursor value. Default value is null- Returns:
Buttoninstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getDisabledIconCursor
Specifies the cursor to display when the mouse pointer is over the icon image and thisStatefulCanvasisdisabled.If not set and the mouse pointer is over the icon image,
iconCursorwill be used.- Returns:
- Current disabledIconCursor value. Default value is null
- See Also:
-
setHeight
Size for this component's vertical dimension. SeeCanvas.heightfor more details.Note that if
StatefulCanvas.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 classStatefulCanvas- Parameters:
height- New height value. Default value is null- Returns:
Buttoninstance, for chaining setter calls- See Also:
-
getHeight
Size for this component's vertical dimension. SeeCanvas.heightfor more details.Note that if
StatefulCanvas.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:
getHeightin classStatefulCanvas- Returns:
- Current height value. Default value is null
- See Also:
-
setHeight
Size for this component's vertical dimension. SeeCanvas.heightfor more details.Note that if
StatefulCanvas.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 classStatefulCanvas- Parameters:
height- New height value. Default value is null- See Also:
-
getHeightAsString
Size for this component's vertical dimension. SeeCanvas.heightfor more details.Note that if
StatefulCanvas.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 classStatefulCanvas- Returns:
- Current height value. Default value is null
- See Also:
-
setHiliteAccessKey
If set to true, if thetitleof this button contains the specifiedaccessKey, when the title is displayed to the user it will be modified to include HTML to underline the accessKey.
Note that this property may cause titles that include HTML (rather than simple strings) to be inappropriately modified, so should be disabled if your title string includes HTML characters.- Parameters:
hiliteAccessKey- New hiliteAccessKey value. Default value is null- Returns:
Buttoninstance, for chaining setter calls
-
getHiliteAccessKey
If set to true, if thetitleof this button contains the specifiedaccessKey, when the title is displayed to the user it will be modified to include HTML to underline the accessKey.
Note that this property may cause titles that include HTML (rather than simple strings) to be inappropriately modified, so should be disabled if your title string includes HTML characters.- Returns:
- Current hiliteAccessKey value. Default value is null
-
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.- Overrides:
setIconin classStatefulCanvas- Parameters:
icon- URL of new icon. Default value is null- Returns:
Buttoninstance, 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.
- Overrides:
getIconin classStatefulCanvas- Returns:
- Current icon value. Default value is null
- See Also:
-
setIconAlign
If this button is showing an icon should it be right or left aligned?- Parameters:
iconAlign- New iconAlign value. Default value is null- Returns:
Buttoninstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getIconAlign
If this button is showing an icon should it be right or left aligned?- Returns:
- Current iconAlign value. Default value is null
- See Also:
-
setIconCursor
Specifies the cursor to display when the mouse pointer is over the icon image.- Parameters:
iconCursor- New iconCursor value. Default value is null- Returns:
Buttoninstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getIconCursor
Specifies the cursor to display when the mouse pointer is over the icon image.- Returns:
- Current iconCursor value. Default value is null
- See Also:
-
setIconHeight
Height in pixels of the icon image.If unset, defaults to
iconSize.- Overrides:
setIconHeightin classStatefulCanvas- Parameters:
iconHeight- New iconHeight value. Default value is null- Returns:
Buttoninstance, 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.- Overrides:
getIconHeightin classStatefulCanvas- Returns:
- Current iconHeight value. Default value is null
- See Also:
-
setIconOnlyBaseStyle
if defined,iconOnlyBaseStyleis used as the base CSS style className, instead ofbaseStyle, ifcanAdaptWidthis set and thetitle is not being shown.- Parameters:
iconOnlyBaseStyle- New iconOnlyBaseStyle value. Default value is null- Returns:
Buttoninstance, for chaining setter calls- See Also:
-
getIconOnlyBaseStyle
if defined,iconOnlyBaseStyleis used as the base CSS style className, instead ofbaseStyle, ifcanAdaptWidthis set and thetitle is not being shown.- Returns:
- Current iconOnlyBaseStyle 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.- Overrides:
setIconOrientationin classStatefulCanvas- Parameters:
iconOrientation- The new orientation of the icon relative to the text of the button. Default value is "left"- Returns:
Buttoninstance, 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".- Overrides:
getIconOrientationin classStatefulCanvas- 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.- Overrides:
setIconSizein classStatefulCanvas- Parameters:
iconSize- New iconSize value. Default value is 16- Returns:
Buttoninstance, 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.- Overrides:
getIconSizein classStatefulCanvas- Returns:
- Current iconSize value. Default value is 16
- See Also:
-
setIconSpacing
Pixels between icon and title text.- Parameters:
iconSpacing- New iconSpacing value. Default value is 6- Returns:
Buttoninstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getIconSpacing
public int getIconSpacing()Pixels between icon and title text.- Returns:
- Current iconSpacing value. Default value is 6
- 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 StatefulCanvas.selectedandStatefulCanvas.showSelectedIconare true.iconStyle+FocusedApplied when the component has keyboard focus, if StatefulCanvas.showFocusedIconis true, andStatefulCanvas.showFocusedAsOveris not true.iconStyle+OverApplied when StatefulCanvas.showRollOverIconis set to true and either the user rolls over the component orStatefulCanvas.showFocusedAsOveris true and the component has keyboard focus.iconStyle+DownApplied when the user presses the mouse button on the component if StatefulCanvas.showDownIconis set to trueiconStyle+DisabledApplied when the component is disabledifStatefulCanvas.showDisabledIconis 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
StatefulCanvas.showRTLIconis true, then in RTL mode, a final "RTL" suffix will be appended.- Overrides:
setIconStylein classStatefulCanvas- Parameters:
iconStyle- New iconStyle value. Default value is null- Returns:
Buttoninstance, 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 StatefulCanvas.selectedandStatefulCanvas.showSelectedIconare true.iconStyle+FocusedApplied when the component has keyboard focus, if StatefulCanvas.showFocusedIconis true, andStatefulCanvas.showFocusedAsOveris not true.iconStyle+OverApplied when StatefulCanvas.showRollOverIconis set to true and either the user rolls over the component orStatefulCanvas.showFocusedAsOveris true and the component has keyboard focus.iconStyle+DownApplied when the user presses the mouse button on the component if StatefulCanvas.showDownIconis set to trueiconStyle+DisabledApplied when the component is disabledifStatefulCanvas.showDisabledIconis 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
StatefulCanvas.showRTLIconis true, then in RTL mode, a final "RTL" suffix will be appended.- Overrides:
getIconStylein classStatefulCanvas- Returns:
- Current iconStyle value. Default value is null
- See Also:
-
setIconWidth
Width in pixels of the icon image.If unset, defaults to
iconSize.- Overrides:
setIconWidthin classStatefulCanvas- Parameters:
iconWidth- New iconWidth value. Default value is null- Returns:
Buttoninstance, 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.- Overrides:
getIconWidthin classStatefulCanvas- Returns:
- Current iconWidth value. Default value is null
- See Also:
-
setOverflow
Clip the contents of the button if necessary.Note : This is an advanced setting
- Overrides:
setOverflowin classCanvas- Parameters:
overflow- New overflow value. Default value is Canvas.HIDDEN- Returns:
Buttoninstance, for chaining setter calls- See Also:
-
getOverflow
Clip the contents of the button if necessary.- Overrides:
getOverflowin classCanvas- Returns:
- Current overflow value. Default value is Canvas.HIDDEN
- See Also:
-
setRadioGroup
String identifier for this canvas's mutually exclusive selection group.Note : This is an advanced setting
- Overrides:
setRadioGroupin classStatefulCanvas- Parameters:
radioGroup- New radioGroup value. Default value is null- Returns:
Buttoninstance, for chaining setter calls- See Also:
-
getRadioGroup
String identifier for this canvas's mutually exclusive selection group.- Overrides:
getRadioGroupin classStatefulCanvas- Returns:
- Current radioGroup value. Default value is null
- See Also:
-
setShowClippedTitleOnHover
If true and the title is clipped, then a hover containing the full title of this button is enabled.- Parameters:
showClippedTitleOnHover- New showClippedTitleOnHover value. Default value is false- Returns:
Buttoninstance, for chaining setter calls
-
getShowClippedTitleOnHover
If true and the title is clipped, then a hover containing the full title of this button is enabled.- Returns:
- Current showClippedTitleOnHover value. Default value is false
-
setShowDisabled
Should we visibly change state when disabled?- Overrides:
setShowDisabledin classStatefulCanvas- Parameters:
showDisabled- New showDisabled value. Default value is true- Returns:
Buttoninstance, for chaining setter calls- See Also:
-
getShowDisabled
Should we visibly change state when disabled?- Overrides:
getShowDisabledin classStatefulCanvas- 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.- Overrides:
setShowDisabledIconin classStatefulCanvas- Parameters:
showDisabledIcon- New showDisabledIcon value. Default value is true- Returns:
Buttoninstance, 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.- Overrides:
getShowDisabledIconin classStatefulCanvas- Returns:
- Current showDisabledIcon value. Default value is true
- See Also:
-
setShowDown
Should we visibly change state when the mouse goes down in this object?- Overrides:
setShowDownin classStatefulCanvas- Parameters:
showDown- New showDown value. Default value is false- Returns:
Buttoninstance, for chaining setter calls- See Also:
-
getShowDown
Should we visibly change state when the mouse goes down in this object?- Overrides:
getShowDownin classStatefulCanvas- 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.- Overrides:
setShowDownIconin classStatefulCanvas- Parameters:
showDownIcon- New showDownIcon value. Default value is false- Returns:
Buttoninstance, 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.- Overrides:
getShowDownIconin classStatefulCanvas- Returns:
- Current showDownIcon value. Default value is false
- See Also:
-
setShowFocused
Should we visibly change state when the canvas receives focus? IfStatefulCanvas.showFocusedAsOveristrue, then"over"will be used to indicate focus. Otherwise a separate"focused"state will be used.- Overrides:
setShowFocusedin classStatefulCanvas- Parameters:
showFocused- New showFocused value. Default value is false- Returns:
Buttoninstance, for chaining setter calls- See Also:
-
getShowFocused
Should we visibly change state when the canvas receives focus? IfStatefulCanvas.showFocusedAsOveristrue, then"over"will be used to indicate focus. Otherwise a separate"focused"state will be used.- Overrides:
getShowFocusedin classStatefulCanvas- Returns:
- Current showFocused value. Default value is false
- See Also:
-
setShowFocusedIcon
If using an icon for this button, whether to switch the icon image when the button receives focus.If
StatefulCanvas.showFocusedAsOveris true, the"Over"icon will be displayed when the canvas has focus, otherwise a separate"Focused"icon will be displayed- Overrides:
setShowFocusedIconin classStatefulCanvas- Parameters:
showFocusedIcon- New showFocusedIcon value. Default value is false- Returns:
Buttoninstance, 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
StatefulCanvas.showFocusedAsOveris true, the"Over"icon will be displayed when the canvas has focus, otherwise a separate"Focused"icon will be displayed- Overrides:
getShowFocusedIconin classStatefulCanvas- Returns:
- Current showFocusedIcon value. Default value is false
- See Also:
-
setShowRollOver
Should we visibly change state when the mouse goes over this object?- Overrides:
setShowRollOverin classStatefulCanvas- Parameters:
showRollOver- New showRollOver value. Default value is false- Returns:
Buttoninstance, for chaining setter calls- See Also:
-
getShowRollOver
Should we visibly change state when the mouse goes over this object?- Overrides:
getShowRollOverin classStatefulCanvas- 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.- Overrides:
setShowRollOverIconin classStatefulCanvas- Parameters:
showRollOverIcon- New showRollOverIcon value. Default value is false- Returns:
Buttoninstance, 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.- Overrides:
getShowRollOverIconin classStatefulCanvas- Returns:
- Current showRollOverIcon value. Default value is false
- See Also:
-
setShowSelectedIcon
If using an icon for this button, whether to switch the icon image when the button becomes selected.- Overrides:
setShowSelectedIconin classStatefulCanvas- Parameters:
showSelectedIcon- New showSelectedIcon value. Default value is false- Returns:
Buttoninstance, 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.- Overrides:
getShowSelectedIconin classStatefulCanvas- 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 (seeStatefulCanvas.showRollOver,StatefulCanvas.showDown,StatefulCanvas.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
StatefulCanvas.baseStyleandStatefulCanvas.getStateSuffix()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
- Overrides:
setStatein classStatefulCanvas- Parameters:
state- the new state. Default value is ""- Returns:
Buttoninstance, 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 (seeStatefulCanvas.showRollOver,StatefulCanvas.showDown,StatefulCanvas.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
StatefulCanvas.baseStyleandStatefulCanvas.getStateSuffix()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.- Overrides:
getStatein classStatefulCanvas- 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 classStatefulCanvas- 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 classStatefulCanvas- 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.- Overrides:
setTitlein classStatefulCanvas- Parameters:
title- the new title HTML. Default value is "Untitled Button"- See Also:
-
getTitle
The title HTML to display in this button.- Overrides:
getTitlein classStatefulCanvas- Returns:
- Return the title - HTML drawn inside the component.
Default is to simply return this.title. Default value is "Untitled Button"
- See Also:
-
setValign
Vertical alignment of this component's title.
If this method is called after the component has been drawn/initialized: Sets the vertical alignment of this buttons content.- Overrides:
setValignin classStatefulCanvas- Parameters:
valign- New valign value. Default value is Canvas.CENTER- Returns:
Buttoninstance, for chaining setter calls- See Also:
-
getValign
Vertical alignment of this component's title.- Overrides:
getValignin classStatefulCanvas- Returns:
- Current valign value. Default value is Canvas.CENTER
- See Also:
-
setWidth
Size for this component's horizontal dimension. SeeCanvas.widthfor more details.Note that if
StatefulCanvas.autoFitis set, this property will be ignored so that the widget is always sized just large enough to accommodate the title.- Overrides:
setWidthin classStatefulCanvas- Parameters:
width- New width value. Default value is null- Returns:
Buttoninstance, for chaining setter calls- See Also:
-
getWidth
Size for this component's horizontal dimension. SeeCanvas.widthfor more details.Note that if
StatefulCanvas.autoFitis set, this property will be ignored so that the widget is always sized just large enough to accommodate the title.- Overrides:
getWidthin classStatefulCanvas- Returns:
- Current width value. Default value is null
- See Also:
-
setWidth
Size for this component's horizontal dimension. SeeCanvas.widthfor more details.Note that if
StatefulCanvas.autoFitis set, this property will be ignored so that the widget is always sized just large enough to accommodate the title.- Overrides:
setWidthin classStatefulCanvas- Parameters:
width- New width value. Default value is null- See Also:
-
getWidthAsString
Size for this component's horizontal dimension. SeeCanvas.widthfor more details.Note that if
StatefulCanvas.autoFitis set, this property will be ignored so that the widget is always sized just large enough to accommodate the title.- Overrides:
getWidthAsStringin classStatefulCanvas- Returns:
- Current width value. Default value is null
- See Also:
-
setWrap
A boolean indicating whether the button's title should word-wrap, if necessary.
If this method is called after the component has been drawn/initialized: Set whether the title of this button should be allowed to wrap if too long for the button's specified width.- Parameters:
wrap- whether to wrap the title. Default value is false- Returns:
Buttoninstance, for chaining setter calls
-
getWrap
A boolean indicating whether the button's title should word-wrap, if necessary.- Returns:
- Current wrap value. Default value is false
-
action
public void action()This property contains the default 'action' for the Button to fire when activated. -
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.- Overrides:
addToRadioGroupin classStatefulCanvas- Parameters:
groupID- - ID of the radiogroup to which this widget should be added- See Also:
-
deselect
public void deselect()Select this object.- Overrides:
deselectin classStatefulCanvas- See Also:
-
addIconClickHandler
Add a iconClick handler.If this button is showing an
icon, a separate click handler for the icon may be defined asthis.iconClick. Returning false will suppress the standard button click handling code.- Specified by:
addIconClickHandlerin interfaceHasIconClickHandlers- Parameters:
handler- the iconClick handler- Returns:
HandlerRegistrationused to remove this handler
-
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.- Overrides:
removeFromRadioGroupin classStatefulCanvas- 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.- Overrides:
removeFromRadioGroupin classStatefulCanvas- 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.- Overrides:
selectin classStatefulCanvas- See Also:
-
titleClipped
public boolean titleClipped()Is the title of this button clipped?- Returns:
- whether the title is clipped.
-
addTitleHoverHandler
Add a titleHover handler.Optional stringMethod to fire when the user hovers over this button and the title is clipped. If
Button.showClippedTitleOnHoveris true, the default behavior is to show a hover canvas containing the HTML returned byButton.titleHoverHTML(). CallTitleHoverEvent.cancel()from withinTitleHoverHandler.onTitleHover(com.smartgwt.client.widgets.events.TitleHoverEvent)to suppress this default behavior.- Specified by:
addTitleHoverHandlerin interfaceHasTitleHoverHandlers- Parameters:
handler- the titleHover handler- Returns:
HandlerRegistrationused to remove this handler
-
titleHoverHTML
Returns the HTML that is displayed by the defaulttitleHoverhandler. Return null or an empty string to cancel the hover.Use
setTitleHoverFormatter()to provide a custom implementation.- Parameters:
defaultHTML- the HTML that would have been displayed by default. SeeHTMLString- Returns:
- HTML to be displayed in the hover. If null or an empty string, then the hover is canceled.
See
HTMLString - 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:
buttonProperties- properties that should be used as new defaults when instances of this class are created- See Also:
-
setTitleHoverFormatter
Provide a custom implementation oftitleHoverHTML(java.lang.String). -
assertIsButton
Internal method to verify class of targetCanvas. -
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 classStatefulCanvas
-