public class Button extends StatefulCanvas implements HasIconClickHandlers, HasTitleHoverHandlers
config, configOnly, factoryCreated, factoryProperties, id, nativeObject, scClassName| Constructor and Description |
|---|
Button() |
Button(com.google.gwt.core.client.JavaScriptObject jsObj) |
Button(java.lang.String title) |
| Modifier and Type | Method and Description |
|---|---|
void |
action()
This property contains the default 'action' for the Button to fire when activated.
|
com.google.gwt.event.shared.HandlerRegistration |
addIconClickHandler(IconClickHandler handler)
Add a iconClick handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addTitleHoverHandler(TitleHoverHandler handler)
Add a titleHover handler.
|
void |
addToRadioGroup(java.lang.String groupID)
Add this widget to the specified mutually exclusive selection group with the ID passed in.
|
static void |
assertIsButton(Canvas targetCanvas,
java.lang.String message)
Internal method to verify class of targetCanvas.
|
static void |
changeAutoChildDefaults(java.lang.String autoChildName,
Canvas defaults)
Changes the defaults for Canvas AutoChildren named
autoChildName. |
static void |
changeAutoChildDefaults(java.lang.String autoChildName,
FormItem defaults)
Changes the defaults for FormItem AutoChildren named
autoChildName. |
protected com.google.gwt.core.client.JavaScriptObject |
create() |
void |
deselect()
Select this object.
|
SelectionType |
getActionType()
Behavior on state changes -- BUTTON, RADIO or CHECKBOX
|
boolean |
getAdaptWidthShowIconOnly()
If
canAdaptWidth is true, and this button has a specified
icon, 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? |
Alignment |
getAlign()
Horizontal alignment of this component's title.
|
java.lang.Boolean |
getAutoFit()
If true, ignore the specified size of this widget and always size just large enough to accommodate the title.
|
java.lang.String |
getBaseStyle()
Base CSS style className applied to the component.
|
java.lang.Boolean |
getCanAdaptWidth()
This flag enables
adaptive width for the button. |
Cursor |
getDisabledIconCursor()
Specifies the cursor to display when the mouse pointer is over the icon image and this
StatefulCanvas is
disabled. |
java.lang.Integer |
getHeight()
Size for this component's vertical dimension.
|
java.lang.String |
getHeightAsString()
Size for this component's vertical dimension.
|
java.lang.Boolean |
getHiliteAccessKey()
If set to true, if the
title of this button contains the
specified accessKey, 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. |
java.lang.String |
getIcon()
Optional icon to be shown with the button title text.
|
java.lang.String |
getIconAlign()
If this button is showing an icon should it be right or left aligned?
|
Cursor |
getIconCursor()
Specifies the cursor to display when the mouse pointer is over the icon image.
|
java.lang.Integer |
getIconHeight()
Height in pixels of the icon image.
|
java.lang.String |
getIconOnlyBaseStyle()
if defined,
iconOnlyBaseStyle is used as the base CSS style className, instead of baseStyle, if canAdaptWidth is set and the title is not being shown. |
java.lang.String |
getIconOrientation()
If this button is showing an icon should it appear to the left or right of the title? valid options are
"left" and "right". |
int |
getIconSize()
Size in pixels of the icon image.
|
int |
getIconSpacing()
Pixels between icon and title text.
|
java.lang.String |
getIconStyle()
Base CSS style applied to the icon image.
|
java.lang.Integer |
getIconWidth()
Width in pixels of the icon image.
|
com.smartgwt.logicalstructure.core.LogicalStructureObject |
getLogicalStructure()
Getter implementing the
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility. |
static Button |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
Overflow |
getOverflow()
Clip the contents of the button if necessary.
|
java.lang.String |
getRadioGroup()
String identifier for this canvas's mutually exclusive selection group.
|
java.lang.Boolean |
getShowClippedTitleOnHover()
If true and the title is clipped, then a hover containing the full title of this button is enabled.
|
java.lang.Boolean |
getShowDisabled()
Should we visibly change state when disabled?
|
java.lang.Boolean |
getShowDisabledIcon()
If using an icon for this button, whether to switch the icon image if the button becomes disabled.
|
java.lang.Boolean |
getShowDown()
Should we visibly change state when the mouse goes down in this object?
|
java.lang.Boolean |
getShowDownIcon()
If using an icon for this button, whether to switch the icon image when the mouse goes down on the button.
|
java.lang.Boolean |
getShowFocused()
Should we visibly change state when the canvas receives focus? If
StatefulCanvas.showFocusedAsOver is true,
then "over" will be used to indicate focus. |
java.lang.Boolean |
getShowFocusedIcon()
If using an icon for this button, whether to switch the icon image when the button receives focus.
|
java.lang.Boolean |
getShowRollOver()
Should we visibly change state when the mouse goes over this object?
|
java.lang.Boolean |
getShowRollOverIcon()
If using an icon for this button, whether to switch the icon image on mouse rollover.
|
java.lang.Boolean |
getShowSelectedIcon()
If using an icon for this button, whether to switch the icon image when the button becomes selected.
|
State |
getState()
Current "state" of this widget.
|
java.lang.String |
getTitle()
The title HTML to display in this button.
|
VerticalAlignment |
getValign()
Vertical alignment of this component's title.
|
java.lang.Integer |
getWidth()
Size for this component's horizontal dimension.
|
java.lang.String |
getWidthAsString()
Size for this component's horizontal dimension.
|
java.lang.Boolean |
getWrap()
A boolean indicating whether the button's title should word-wrap, if necessary.
|
void |
removeFromRadioGroup()
Remove this widget from the specified mutually exclusive selection group with the ID passed in.
|
void |
removeFromRadioGroup(java.lang.String groupID)
Remove this widget from the specified mutually exclusive selection group with the ID passed in.
|
void |
select()
Select this object.
|
Button |
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. |
Button |
setAdaptWidthShowIconOnly(boolean adaptWidthShowIconOnly)
If
canAdaptWidth is true, and this button has a specified
icon, 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? |
Button |
setAlign(Alignment align)
Horizontal alignment of this component's title.
|
Button |
setAutoFit(java.lang.Boolean autoFit)
If true, ignore the specified size of this widget and always size just large enough to accommodate the title.
|
Button |
setBaseStyle(java.lang.String baseStyle)
Base CSS style className applied to the component.
|
Button |
setCanAdaptWidth(java.lang.Boolean canAdaptWidth)
This flag enables
adaptive width for the button. |
static void |
setDefaultProperties(Button buttonProperties)
Class level method to set the default properties of this class.
|
Button |
setDisabledIconCursor(Cursor disabledIconCursor)
Specifies the cursor to display when the mouse pointer is over the icon image and this
StatefulCanvas is
disabled. |
Button |
setHeight(java.lang.Integer height)
Size for this component's vertical dimension.
|
void |
setHeight(java.lang.String height)
Size for this component's vertical dimension.
|
Button |
setHiliteAccessKey(java.lang.Boolean hiliteAccessKey)
If set to true, if the
title of this button contains the
specified accessKey, 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. |
Button |
setIcon(java.lang.String icon)
Optional icon to be shown with the button title text.
|
Button |
setIconAlign(java.lang.String iconAlign)
If this button is showing an icon should it be right or left aligned?
|
Button |
setIconCursor(Cursor iconCursor)
Specifies the cursor to display when the mouse pointer is over the icon image.
|
Button |
setIconHeight(java.lang.Integer iconHeight)
Height in pixels of the icon image.
|
Button |
setIconOnlyBaseStyle(java.lang.String iconOnlyBaseStyle)
if defined,
iconOnlyBaseStyle is used as the base CSS style className, instead of baseStyle, if canAdaptWidth is set and the title is not being shown. |
Button |
setIconOrientation(java.lang.String iconOrientation)
If this button is showing an icon should it appear to the left or right of the title? valid options are
"left" and "right". |
Button |
setIconSize(int iconSize)
Size in pixels of the icon image.
|
Button |
setIconSpacing(int iconSpacing)
Pixels between icon and title text.
|
Button |
setIconStyle(java.lang.String iconStyle)
Base CSS style applied to the icon image.
|
Button |
setIconWidth(java.lang.Integer iconWidth)
Width in pixels of the icon image.
|
com.smartgwt.logicalstructure.core.LogicalStructureObject |
setLogicalStructure(com.smartgwt.logicalstructure.widgets.ButtonLogicalStructure s)
Setter implementing the
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility. |
Button |
setOverflow(Overflow overflow)
Clip the contents of the button if necessary.
|
Button |
setRadioGroup(java.lang.String radioGroup)
String identifier for this canvas's mutually exclusive selection group.
|
Button |
setShowClippedTitleOnHover(java.lang.Boolean showClippedTitleOnHover)
If true and the title is clipped, then a hover containing the full title of this button is enabled.
|
Button |
setShowDisabled(java.lang.Boolean showDisabled)
Should we visibly change state when disabled?
|
Button |
setShowDisabledIcon(java.lang.Boolean showDisabledIcon)
If using an icon for this button, whether to switch the icon image if the button becomes disabled.
|
Button |
setShowDown(java.lang.Boolean showDown)
Should we visibly change state when the mouse goes down in this object?
|
Button |
setShowDownIcon(java.lang.Boolean showDownIcon)
If using an icon for this button, whether to switch the icon image when the mouse goes down on the button.
|
Button |
setShowFocused(java.lang.Boolean showFocused)
Should we visibly change state when the canvas receives focus? If
StatefulCanvas.showFocusedAsOver is true,
then "over" will be used to indicate focus. |
Button |
setShowFocusedIcon(java.lang.Boolean showFocusedIcon)
If using an icon for this button, whether to switch the icon image when the button receives focus.
|
Button |
setShowRollOver(java.lang.Boolean showRollOver)
Should we visibly change state when the mouse goes over this object?
|
Button |
setShowRollOverIcon(java.lang.Boolean showRollOverIcon)
If using an icon for this button, whether to switch the icon image on mouse rollover.
|
Button |
setShowSelectedIcon(java.lang.Boolean showSelectedIcon)
If using an icon for this button, whether to switch the icon image when the button becomes selected.
|
Button |
setState(State state)
Current "state" of this widget.
|
void |
setTitle(java.lang.String title)
The title HTML to display in this button.
|
void |
setTitleHoverFormatter(TitleHoverFormatter formatter)
Provide a custom implementation of
titleHoverHTML(java.lang.String). |
Button |
setValign(VerticalAlignment valign)
Vertical alignment of this component's title.
|
Button |
setWidth(java.lang.Integer width)
Size for this component's horizontal dimension.
|
void |
setWidth(java.lang.String width)
Size for this component's horizontal dimension.
|
Button |
setWrap(java.lang.Boolean wrap)
A boolean indicating whether the button's title should word-wrap, if necessary.
|
boolean |
titleClipped()
Is the title of this button clipped?
|
java.lang.String |
titleHoverHTML(java.lang.String defaultHTML)
Returns the HTML that is displayed by the default
titleHover handler. |
getAriaLabel, getEditProxyConstructor, getIgnoreRTL, getLabelHPad, getLabelVPad, getOverCanvas, getOverCanvasConstructor, getRedrawOnStateChange, getSelected, getShowFocusedAsOver, getShowMenuOnClick, getShowOverCanvas, getShowRTLIcon, getStateSuffix, isSelected, setAriaLabel, setDefaultProperties, setEditProxyConstructor, setIgnoreRTL, setLabelHPad, setLabelVPad, setLogicalStructure, setOverCanvasConstructor, setRedrawOnStateChange, setSelected, setShowFocusedAsOver, setShowMenuOnClick, setShowOverCanvas, setShowRTLIcon, setTitleFormatter, setTitleStyleaddChild, 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, 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, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, 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, getDataPath, getDefaultHeight, getDefaultWidth, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDisableTouchScrollingForDrag, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragMaskType, getDragMaxHeight, getDragMaxWidth, getDragMinHeight, getDragMinWidth, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragType, getDropTypes, getDropTypesAsString, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getEditNode, getEditProxy, getElement, getElement, getEnableWhen, getEndLine, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFormItemAutoChild, getForwardSVGeventsToObject, getFullDataPath, getGroupBorderCSS, getGroupLabelBackgroundColor, getGroupLabelStyleName, getGroupTitle, getHideUsingDisplayNone, getHoverAlign, getHoverAutoDestroy, getHoverAutoFitMaxWidth, getHoverAutoFitMaxWidthAsString, getHoverAutoFitWidth, getHoverComponent, getHoverDelay, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapOrigin, getHSnapOrigin, getHSnapPosition, getHSnapPosition, getHtmlElement, getHtmlPosition, getImage, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getIsPrinting, getIsRuleScope, getIsSnapAlignCandidate, getKeepInParentRect, getLayoutAlign, getLeavePageSpace, getLeft, getLeftAsString, getLocalId, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getLocatorName, getMargin, getMasterCanvas, getMasterElement, getMatchElement, getMaxHeight, getMaxWidth, getMaxZoomOverflowError, getMenuConstructor, getMinHeight, getMinNonEdgeSize, getMinWidth, getMomentumScrollMinSpeed, getMouseStillDownDelay, getMouseStillDownInitialDelay, getName, getNextZIndex, getNoDoubleClicks, getNoDropCursor, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOuterElement, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getPaletteDefaults, getPanelContainer, getParentCanvas, getParentElement, getPeers, getPercentBox, getPercentSource, 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, 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, getStyleName, getTabIndex, getTestInstance, getTooltip, getTop, getTopAsString, getTopElement, getUpdateTabPositionOnDraw, getUpdateTabPositionOnReparent, getUseBackMask, getUseCSSShadow, getUseDragMask, getUseImageForSVG, getUseNativeDrag, getUseOpacityFilter, getUseTouchScrolling, getValuesManager, getValuesManagerAsString, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWhen, getVisibleWidth, getVSnapOrigin, getVSnapOrigin, getVSnapPosition, getVSnapPosition, getZIndex, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideComponentMask, hideComponentMask, hideContextMenu, imgHTML, imgHTML, imgHTML, 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, resizeFonts, resizeFonts, resizeFonts, resizeIcons, resizePadding, resizePadding, resizeTo, resizeTo, revealChild, revealChild, scrollBy, scrollByPercent, 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, setAutoResizeAutoChildAttributes, setAutoResizeIcons, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBottom, setCanAcceptDrop, setCanAdaptHeight, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setChildren, setChildrenResizeSnapAlign, setChildrenSnapAlign, setChildrenSnapCenterAlign, setChildrenSnapEdgeAlign, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setComponentMaskDefaults, setContents, setContextMenu, setCorrectZoomOverflow, setCursor, setDataPath, setDefaultHeight, setDefaultPageSpace, setDefaultProperties, setDefaultShowCustomScrollbars, setDefaultWidth, setDisabled, setDisabledCursor, setDisableTouchScrollingForDrag, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragMaskType, setDragMaxHeight, setDragMaxWidth, setDragMinHeight, setDragMinWidth, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragType, setDropTypes, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setEditMode, setEditMode, setEditMode, setElement, setEnableWhen, setEndLine, setExtraSpace, setFacetId, setForwardSVGeventsToObject, setGroupBorderCSS, setGroupLabelBackgroundColor, setGroupLabelStyleName, setGroupTitle, setHeight, setHeight100, setHideUsingDisplayNone, setHoverAlign, setHoverAutoDestroy, setHoverAutoFitMaxWidth, setHoverAutoFitMaxWidth, setHoverAutoFitWidth, setHoverDelay, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlElement, setHtmlPosition, setImage, setImage, setInitHandler, setIsGroup, setIsRuleScope, setIsSnapAlignCandidate, setKeepInParentRect, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeavePageSpace, setLeft, setLeft, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLocatorName, setLogicalStructure, setMargin, setMatchElement, setMaxHeight, setMaxWidth, setMaxZoomOverflowError, setMenuConstructor, setMinHeight, setMinNonEdgeSize, setMinWidth, setMomentumScrollMinSpeed, setMouseStillDownDelay, setMouseStillDownInitialDelay, setName, setNeverUseFilters, setNoDoubleClicks, setNoDropCursor, setOpacity, setPadding, setPageLeft, setPageTop, setPanelContainer, setParentCanvas, setParentElement, setPeers, setPercentBox, setPercentSource, 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, 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, setStyleName, setTabIndex, setTooltip, setTop, setTop, setUpdateTabPositionOnDraw, setUpdateTabPositionOnReparent, setUseBackMask, setUseCSSShadow, setUseDragMask, setUseImageForSVG, setUseNativeDrag, setUseOpacityFilter, setUseTouchScrolling, setValuesManager, setValuesManager, setVisibility, setVisible, setVisibleWhen, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showClickMask, showComponentMask, showComponentMask, showNextTo, showNextTo, showNextTo, showNextTo, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, updateChildTabPosition, updateChildTabPositions, updateEditNode, updateHover, updateHover, updateShadow, updateTabPositionForDraw, visibleAtPoint, willAcceptDropaddDrawHandler, 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, toStringaddAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEventsaddStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEventpublic Button()
public Button(com.google.gwt.core.client.JavaScriptObject jsObj)
public Button(java.lang.String title)
public static Button getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public static void changeAutoChildDefaults(java.lang.String autoChildName,
Canvas defaults)
autoChildName.autoChildName - name of an AutoChild to customize the defaults for.defaults - Canvas defaults to apply. These defaults override any existing properties
without destroying or wiping out non-overridden properties. For usage tips on this
param, see SGWTProperties.AutoChildUsagepublic static void changeAutoChildDefaults(java.lang.String autoChildName,
FormItem defaults)
autoChildName.autoChildName - name of an AutoChild to customize the defaults for.defaults - FormItem defaults to apply. These defaults override any existing properties
without destroying or wiping out non-overridden properties. For usage tips on this
param, see SGWTProperties.AutoChildUsageprotected com.google.gwt.core.client.JavaScriptObject create()
create in class StatefulCanvaspublic Button setActionType(SelectionType actionType)
setActionType in class StatefulCanvasactionType - New actionType value. Default value is "button"Button instance, for chaining setter callsState overview and related methods,
Radio / Toggle Behavior Examplepublic SelectionType getActionType()
getActionType in class StatefulCanvasState overview and related methods,
Radio / Toggle Behavior Examplepublic Button setAdaptWidthShowIconOnly(boolean adaptWidthShowIconOnly)
canAdaptWidth is true, and this button has a specified
icon, 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?adaptWidthShowIconOnly - New adaptWidthShowIconOnly value. Default value is trueButton instance, for chaining setter callssetCanAdaptWidth(java.lang.Boolean),
setIconOnlyBaseStyle(java.lang.String)public boolean getAdaptWidthShowIconOnly()
canAdaptWidth is true, and this button has a specified
icon, 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?getCanAdaptWidth(),
getIconOnlyBaseStyle()public Button setAlign(Alignment align)
setAlign in class StatefulCanvasalign - New align value. Default value is Canvas.CENTERButton instance, for chaining setter callsAppearance overview and related methodspublic Alignment getAlign()
getAlign in class StatefulCanvasAppearance overview and related methodspublic Button setAutoFit(java.lang.Boolean autoFit)
setWidth() is explicitly called on an autoFit:true button, autoFit will be reset to false.
Note that for StretchImgButton instances, autoFit will occur horizontally only, as unpredictable vertical sizing is
likely to distort the media. If you do want vertical auto-fit, this can be achieved by simply setting a small height,
and having overflow:"visible"
If this method is called after the component has been drawn/initialized:
Setter method for the StatefulCanvas.autoFit property. Pass in true or false to turn autoFit on or off. When autoFit is set to false, canvas will be resized to it's previously specified size.
setAutoFit in class StatefulCanvasautoFit - New autoFit setting. Default value is nullButton instance, for chaining setter callsSizing overview and related methods,
Auto Fit Examplepublic java.lang.Boolean getAutoFit()
setWidth() is explicitly called on an autoFit:true button, autoFit will be reset to false. Note that for StretchImgButton instances, autoFit will occur horizontally only, as unpredictable vertical sizing is likely to distort the media. If you do want vertical auto-fit, this can be achieved by simply setting a small height, and having overflow:"visible"
getAutoFit in class StatefulCanvasSizing overview and related methods,
Auto Fit Examplepublic Button setBaseStyle(java.lang.String baseStyle)
As the component changes StatefulCanvas.state and/or is
selected,
suffixes will be added to the base style. In some cases more than one suffix will
be appended to reflect a combined state ("Selected" + "Disabled", for example).
See StatefulCanvas.getStateSuffix() for a description
of the default set
of suffixes which may be applied to the baseStyle
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 with overflow: "clip_h"
would yield a vertically-rendered title with overflow via ellipsis as expected, and also
wrap with wrap.
Note that:setBaseStyle in class StatefulCanvasbaseStyle - new base style. Default value is "button"Button instance, for chaining setter callssetIconOnlyBaseStyle(java.lang.String),
CSSStyleNamepublic java.lang.String getBaseStyle()
As the component changes StatefulCanvas.state and/or is
selected,
suffixes will be added to the base style. In some cases more than one suffix will
be appended to reflect a combined state ("Selected" + "Disabled", for example).
See StatefulCanvas.getStateSuffix() for a description
of the default set
of suffixes which may be applied to the baseStyle
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 with overflow: "clip_h"
would yield a vertically-rendered title with overflow via ellipsis as expected, and also
wrap with wrap.
Note that:getBaseStyle in class StatefulCanvasgetIconOnlyBaseStyle(),
CSSStyleNamepublic Button setCanAdaptWidth(java.lang.Boolean canAdaptWidth) throws java.lang.IllegalStateException
adaptive width for 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.
adaptWidthShowIconOnly is 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 specified minWidth, whichever is
larger.minWidth, and autoFit is true, autoFit will be temporarily
disabled, if there isn't enough room, allowing the title to be clippedtitleHoverHTML().setCanAdaptWidth in class CanvascanAdaptWidth - New canAdaptWidth value. Default value is falseButton instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdCanvas.setCanAdaptWidth(java.lang.Boolean),
Button Adaptive Width Examplepublic java.lang.Boolean getCanAdaptWidth()
adaptive width for 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.
adaptWidthShowIconOnly is 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 specified minWidth, whichever is
larger.minWidth, and autoFit is true, autoFit will be temporarily
disabled, if there isn't enough room, allowing the title to be clippedtitleHoverHTML().getCanAdaptWidth in class CanvasCanvas.getCanAdaptWidth(),
Button Adaptive Width Examplepublic Button setDisabledIconCursor(Cursor disabledIconCursor) throws java.lang.IllegalStateException
StatefulCanvas is
disabled. If not set and the mouse pointer is over the icon
image, iconCursor will be used.
disabledIconCursor - New disabledIconCursor value. Default value is nullButton instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdCues overview and related methodspublic Cursor getDisabledIconCursor()
StatefulCanvas is
disabled. If not set and the mouse pointer is over the icon
image, iconCursor will be used.
Cues overview and related methodspublic Button setHeight(java.lang.Integer height)
Canvas.height
for more details. Note that if StatefulCanvas.autoFit
is set on non-StretchImgButton instances, this property will be ignored so that the
widget is always sized just large enough to accommodate the title.
setHeight in class StatefulCanvasheight - New height value. Default value is nullButton instance, for chaining setter callsStatefulCanvas.setAutoFit(java.lang.Boolean),
Sizing overview and related methodspublic java.lang.Integer getHeight()
Canvas.height
for more details. Note that if StatefulCanvas.autoFit
is set on non-StretchImgButton instances, this property will be ignored so that the
widget is always sized just large enough to accommodate the title.
getHeight in class StatefulCanvasStatefulCanvas.getAutoFit(),
Sizing overview and related methodspublic void setHeight(java.lang.String height)
Canvas.height
for more details. Note that if StatefulCanvas.autoFit
is set on non-StretchImgButton instances, this property will be ignored so that the
widget is always sized just large enough to accommodate the title.
setHeight in class StatefulCanvasheight - New height value. Default value is nullStatefulCanvas.setAutoFit(java.lang.Boolean),
Sizing overview and related methodspublic java.lang.String getHeightAsString()
Canvas.height
for more details. Note that if StatefulCanvas.autoFit
is set on non-StretchImgButton instances, this property will be ignored so that the
widget is always sized just large enough to accommodate the title.
getHeightAsString in class StatefulCanvasStatefulCanvas.getAutoFit(),
Sizing overview and related methodspublic Button setHiliteAccessKey(java.lang.Boolean hiliteAccessKey)
title of this button contains the
specified accessKey, when the title is displayed to the user it
will be modified to include HTML to underline the accessKey.hiliteAccessKey - New hiliteAccessKey value. Default value is nullButton instance, for chaining setter callspublic java.lang.Boolean getHiliteAccessKey()
title of this button contains the
specified accessKey, when the title is displayed to the user it
will be modified to include HTML to underline the accessKey.public Button setIcon(java.lang.String icon)
Specify as the partial URL to an image, relative to the
imgDir of this component. A sprited image can be specified using the SCSpriteConfig
format.
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.
setIcon in class StatefulCanvasicon - URL of new icon. Default value is nullButton instance, for chaining setter callsSCImgURL,
ButtonIcon overview and related methods,
Icons Examplepublic java.lang.String getIcon()
Specify as the partial URL to an image, relative to the
imgDir of this component. A sprited image can be specified using the SCSpriteConfig
format.
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.
getIcon in class StatefulCanvasSCImgURL,
ButtonIcon overview and related methods,
Icons Examplepublic Button setIconAlign(java.lang.String iconAlign) throws java.lang.IllegalStateException
iconAlign - New iconAlign value. Default value is nullButton instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdButtonIcon overview and related methodspublic java.lang.String getIconAlign()
ButtonIcon overview and related methodspublic Button setIconCursor(Cursor iconCursor) throws java.lang.IllegalStateException
iconCursor - New iconCursor value. Default value is nullButton instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdsetDisabledIconCursor(com.smartgwt.client.types.Cursor),
Cues overview and related methodspublic Cursor getIconCursor()
getDisabledIconCursor(),
Cues overview and related methodspublic Button setIconHeight(java.lang.Integer iconHeight) throws java.lang.IllegalStateException
If unset, defaults to iconSize.
setIconHeight in class StatefulCanvasiconHeight - New iconHeight value. Default value is nullButton instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdButtonIcon overview and related methodspublic java.lang.Integer getIconHeight()
If unset, defaults to iconSize.
getIconHeight in class StatefulCanvasButtonIcon overview and related methodspublic Button setIconOnlyBaseStyle(java.lang.String iconOnlyBaseStyle)
iconOnlyBaseStyle is used as the base CSS style className, instead of baseStyle, if canAdaptWidth is set and the title is not being shown.iconOnlyBaseStyle - New iconOnlyBaseStyle value. Default value is nullButton instance, for chaining setter callsCanvas.setCanAdaptWidth(java.lang.Boolean),
TabSet.setSimpleTabIconOnlyBaseStyle(java.lang.String),
CSSStyleNamepublic java.lang.String getIconOnlyBaseStyle()
iconOnlyBaseStyle is used as the base CSS style className, instead of baseStyle, if canAdaptWidth is set and the title is not being shown.Canvas.getCanAdaptWidth(),
TabSet.getSimpleTabIconOnlyBaseStyle(),
CSSStyleNamepublic Button setIconOrientation(java.lang.String iconOrientation) throws java.lang.IllegalStateException
"left" and "right".
setIconOrientation in class StatefulCanvasiconOrientation - The new orientation of the icon relative to the text of the button. Default value is "left"Button instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdButtonIcon overview and related methods,
Icons Examplepublic java.lang.String getIconOrientation()
"left" and "right".getIconOrientation in class StatefulCanvasButtonIcon overview and related methods,
Icons Examplepublic Button setIconSize(int iconSize) throws java.lang.IllegalStateException
The iconWidth and
iconHeight properties can be used to configure width
and height separately.
Note: When configuring the properties of a StatefulCanvas (or derivative) AutoChild, it is best to set the iconWidth and iconHeight
to the same value rather than setting an iconSize. This is because certain skins or customizations thereto
might set the iconWidth and iconHeight, making the customization of the AutoChild's
iconSize ineffective.
setIconSize in class StatefulCanvasiconSize - New iconSize value. Default value is 16Button instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdButtonIcon overview and related methodspublic int getIconSize()
The iconWidth and
iconHeight properties can be used to configure width
and height separately.
Note: When configuring the properties of a StatefulCanvas (or derivative) AutoChild, it is best to set the iconWidth and iconHeight
to the same value rather than setting an iconSize. This is because certain skins or customizations thereto
might set the iconWidth and iconHeight, making the customization of the AutoChild's
iconSize ineffective.
getIconSize in class StatefulCanvasButtonIcon overview and related methodspublic Button setIconSpacing(int iconSpacing) throws java.lang.IllegalStateException
iconSpacing - New iconSpacing value. Default value is 6Button instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdButtonIcon overview and related methodspublic int getIconSpacing()
ButtonIcon overview and related methodspublic Button setIconStyle(java.lang.String iconStyle)
StatefulCanvas changes state and/or is selected, suffixes will be appended to iconStyle to
form the className set on the image element. The following table lists out the standard set of suffixes which may be appended:
| CSS Class Applied | Description |
|---|---|
iconStyle | Default CSS style |
iconStyle+Selected | Applied when StatefulCanvas.selected and StatefulCanvas.showSelectedIcon are true. |
iconStyle+Focused | Applied when the component has keyboard focus, if
StatefulCanvas.showFocusedIcon is true, and
StatefulCanvas.showFocusedAsOver is not
true. |
iconStyle+Over | Applied when StatefulCanvas.showRollOverIcon is set to true and
either the user rolls over the component or StatefulCanvas.showFocusedAsOver is true and the component has keyboard focus. |
iconStyle+Down | Applied when the user presses the mouse button on the component
if StatefulCanvas.showDownIcon is set to
true |
iconStyle+Disabled | Applied when the component is disabled if StatefulCanvas.showDisabledIcon is true. |
| Combined styles | |
iconStyle+SelectedFocused |
Combined Selected and focused styling |
iconStyle+SelectedOver |
Combined Selected and rollOver styling |
iconStyle+FocusedOver |
Combined Focused and rollOver styling |
iconStyle+SelectedFocusedOver |
Combined Selected, Focused and rollOver styling |
iconStyle+SelectedDown |
Combined Selected and mouse-down styling |
iconStyle+FocusedDown |
Combined Focused and mouse-down styling |
iconStyle+SelectedFocusedDown |
Combined Selected, Focused and mouse-down styling |
iconStyle+SelectedDisabled | Combined Selected and Disabled styling |
In addition, if StatefulCanvas.showRTLIcon is true, then in RTL mode, a final "RTL" suffix will be appended.
setIconStyle in class StatefulCanvasiconStyle - New iconStyle value. Default value is nullButton instance, for chaining setter callsCSSStyleName,
ButtonIcon overview and related methodspublic java.lang.String getIconStyle()
StatefulCanvas changes state and/or is selected, suffixes will be appended to iconStyle to
form the className set on the image element. The following table lists out the standard set of suffixes which may be appended:
| CSS Class Applied | Description |
|---|---|
iconStyle | Default CSS style |
iconStyle+Selected | Applied when StatefulCanvas.selected and StatefulCanvas.showSelectedIcon are true. |
iconStyle+Focused | Applied when the component has keyboard focus, if
StatefulCanvas.showFocusedIcon is true, and
StatefulCanvas.showFocusedAsOver is not
true. |
iconStyle+Over | Applied when StatefulCanvas.showRollOverIcon is set to true and
either the user rolls over the component or StatefulCanvas.showFocusedAsOver is true and the component has keyboard focus. |
iconStyle+Down | Applied when the user presses the mouse button on the component
if StatefulCanvas.showDownIcon is set to
true |
iconStyle+Disabled | Applied when the component is disabled if StatefulCanvas.showDisabledIcon is true. |
| Combined styles | |
iconStyle+SelectedFocused |
Combined Selected and focused styling |
iconStyle+SelectedOver |
Combined Selected and rollOver styling |
iconStyle+FocusedOver |
Combined Focused and rollOver styling |
iconStyle+SelectedFocusedOver |
Combined Selected, Focused and rollOver styling |
iconStyle+SelectedDown |
Combined Selected and mouse-down styling |
iconStyle+FocusedDown |
Combined Focused and mouse-down styling |
iconStyle+SelectedFocusedDown |
Combined Selected, Focused and mouse-down styling |
iconStyle+SelectedDisabled | Combined Selected and Disabled styling |
In addition, if StatefulCanvas.showRTLIcon is true, then in RTL mode, a final "RTL" suffix will be appended.
getIconStyle in class StatefulCanvasCSSStyleName,
ButtonIcon overview and related methodspublic Button setIconWidth(java.lang.Integer iconWidth) throws java.lang.IllegalStateException
If unset, defaults to iconSize.
setIconWidth in class StatefulCanvasiconWidth - New iconWidth value. Default value is nullButton instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdButtonIcon overview and related methodspublic java.lang.Integer getIconWidth()
If unset, defaults to iconSize.
getIconWidth in class StatefulCanvasButtonIcon overview and related methodspublic Button setOverflow(Overflow overflow)
Note : This is an advanced setting
setOverflow in class Canvasoverflow - New overflow value. Default value is Canvas.HIDDENButton instance, for chaining setter callsCanvas.setOverflow(com.smartgwt.client.types.Overflow)public Overflow getOverflow()
getOverflow in class CanvasCanvas.getOverflow()public Button setRadioGroup(java.lang.String radioGroup)
Note : This is an advanced setting
setRadioGroup in class StatefulCanvasradioGroup - New radioGroup value. Default value is nullButton instance, for chaining setter callsState overview and related methods,
Radio / Toggle Behavior Examplepublic java.lang.String getRadioGroup()
getRadioGroup in class StatefulCanvasState overview and related methods,
Radio / Toggle Behavior Examplepublic Button setShowClippedTitleOnHover(java.lang.Boolean showClippedTitleOnHover)
showClippedTitleOnHover - New showClippedTitleOnHover value. Default value is falseButton instance, for chaining setter callspublic java.lang.Boolean getShowClippedTitleOnHover()
public Button setShowDisabled(java.lang.Boolean showDisabled)
setShowDisabled in class StatefulCanvasshowDisabled - New showDisabled value. Default value is trueButton instance, for chaining setter callsState overview and related methods,
States Examplepublic java.lang.Boolean getShowDisabled()
getShowDisabled in class StatefulCanvasState overview and related methods,
States Examplepublic Button setShowDisabledIcon(java.lang.Boolean showDisabledIcon) throws java.lang.IllegalStateException
setShowDisabledIcon in class StatefulCanvasshowDisabledIcon - New showDisabledIcon value. Default value is trueButton instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdButtonIcon overview and related methodspublic java.lang.Boolean getShowDisabledIcon()
getShowDisabledIcon in class StatefulCanvasButtonIcon overview and related methodspublic Button setShowDown(java.lang.Boolean showDown)
setShowDown in class StatefulCanvasshowDown - New showDown value. Default value is falseButton instance, for chaining setter callsState overview and related methods,
States Examplepublic java.lang.Boolean getShowDown()
getShowDown in class StatefulCanvasState overview and related methods,
States Examplepublic Button setShowDownIcon(java.lang.Boolean showDownIcon) throws java.lang.IllegalStateException
setShowDownIcon in class StatefulCanvasshowDownIcon - New showDownIcon value. Default value is falseButton instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdButtonIcon overview and related methods,
Icons Examplepublic java.lang.Boolean getShowDownIcon()
getShowDownIcon in class StatefulCanvasButtonIcon overview and related methods,
Icons Examplepublic Button setShowFocused(java.lang.Boolean showFocused)
StatefulCanvas.showFocusedAsOver is true,
then "over" will be used to indicate focus. Otherwise a separate "focused" state
will be used.setShowFocused in class StatefulCanvasshowFocused - New showFocused value. Default value is falseButton instance, for chaining setter callsState overview and related methodspublic java.lang.Boolean getShowFocused()
StatefulCanvas.showFocusedAsOver is true,
then "over" will be used to indicate focus. Otherwise a separate "focused" state
will be used.getShowFocused in class StatefulCanvasState overview and related methodspublic Button setShowFocusedIcon(java.lang.Boolean showFocusedIcon) throws java.lang.IllegalStateException
If StatefulCanvas.showFocusedAsOver is true, the
"Over" icon will be displayed when the canvas has focus, otherwise a separate "Focused" icon
will be displayed
setShowFocusedIcon in class StatefulCanvasshowFocusedIcon - New showFocusedIcon value. Default value is falseButton instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdButtonIcon overview and related methodspublic java.lang.Boolean getShowFocusedIcon()
If StatefulCanvas.showFocusedAsOver is true, the
"Over" icon will be displayed when the canvas has focus, otherwise a separate "Focused" icon
will be displayed
getShowFocusedIcon in class StatefulCanvasButtonIcon overview and related methodspublic Button setShowRollOver(java.lang.Boolean showRollOver)
setShowRollOver in class StatefulCanvasshowRollOver - New showRollOver value. Default value is falseButton instance, for chaining setter callsState overview and related methods,
States Examplepublic java.lang.Boolean getShowRollOver()
getShowRollOver in class StatefulCanvasState overview and related methods,
States Examplepublic Button setShowRollOverIcon(java.lang.Boolean showRollOverIcon) throws java.lang.IllegalStateException
setShowRollOverIcon in class StatefulCanvasshowRollOverIcon - New showRollOverIcon value. Default value is falseButton instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdButtonIcon overview and related methodspublic java.lang.Boolean getShowRollOverIcon()
getShowRollOverIcon in class StatefulCanvasButtonIcon overview and related methodspublic Button setShowSelectedIcon(java.lang.Boolean showSelectedIcon) throws java.lang.IllegalStateException
setShowSelectedIcon in class StatefulCanvasshowSelectedIcon - New showSelectedIcon value. Default value is falseButton instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdButtonIcon overview and related methodspublic java.lang.Boolean getShowSelectedIcon()
getShowSelectedIcon in class StatefulCanvasButtonIcon overview and related methodspublic Button setState(State state)
StatefulCanvas.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.baseStyle and
StatefulCanvas.getStateSuffix() for a description of
how this is done.
For Img or StretchImg
based subclasses of StatefulCanvas, the appearance may also be updated by changing the src of the rendered image. See
Img.src and StretchImgButton.src for a description of how the URL is modified to reflect the state of the widget in this case.
If this method is called after the component has been drawn/initialized:
Sets the state of this object, changing its appearance. Note: newState cannot be State.STATE_DISABLED if this.showDisabled is false.
Note : This is an advanced setting
setState in class StatefulCanvasstate - the new state. Default value is ""Button instance, for chaining setter callsState,
State overview and related methodspublic State getState()
StatefulCanvas.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.baseStyle and
StatefulCanvas.getStateSuffix() for a description of
how this is done.
For Img or StretchImg
based subclasses of StatefulCanvas, the appearance may also be updated by changing the src of the rendered image. See
Img.src and StretchImgButton.src for a description of how the URL is modified to reflect the state of the widget in this case.
getState in class StatefulCanvasState,
State overview and related methodspublic void setTitle(java.lang.String title)
title.setTitle in class StatefulCanvastitle - the new title HTML. Default value is "Untitled Button"HTMLString,
Basics overview and related methods,
States Examplepublic java.lang.String getTitle()
getTitle in class StatefulCanvasDefault is to simply return this.title. Default value is "Untitled Button"
HTMLString,
Basics overview and related methods,
States Examplepublic Button setValign(VerticalAlignment valign)
setValign in class StatefulCanvasvalign - New valign value. Default value is Canvas.CENTERButton instance, for chaining setter callsAppearance overview and related methodspublic VerticalAlignment getValign()
getValign in class StatefulCanvasAppearance overview and related methodspublic Button setWidth(java.lang.Integer width)
Canvas.width
for more details. Note that if StatefulCanvas.autoFit
is set, this property will be ignored so that the widget is always sized just large enough to accommodate the title.
setWidth in class StatefulCanvaswidth - New width value. Default value is nullButton instance, for chaining setter callsStatefulCanvas.setAutoFit(java.lang.Boolean),
Sizing overview and related methodspublic java.lang.Integer getWidth()
Canvas.width
for more details. Note that if StatefulCanvas.autoFit
is set, this property will be ignored so that the widget is always sized just large enough to accommodate the title.
getWidth in class StatefulCanvasStatefulCanvas.getAutoFit(),
Sizing overview and related methodspublic void setWidth(java.lang.String width)
Canvas.width
for more details. Note that if StatefulCanvas.autoFit
is set, this property will be ignored so that the widget is always sized just large enough to accommodate the title.
setWidth in class StatefulCanvaswidth - New width value. Default value is nullStatefulCanvas.setAutoFit(java.lang.Boolean),
Sizing overview and related methodspublic java.lang.String getWidthAsString()
Canvas.width
for more details. Note that if StatefulCanvas.autoFit
is set, this property will be ignored so that the widget is always sized just large enough to accommodate the title.
getWidthAsString in class StatefulCanvasStatefulCanvas.getAutoFit(),
Sizing overview and related methodspublic Button setWrap(java.lang.Boolean wrap)
wrap - whether to wrap the title. Default value is falseButton instance, for chaining setter callsBasics overview and related methodspublic java.lang.Boolean getWrap()
Basics overview and related methodspublic void action()
public void addToRadioGroup(java.lang.String groupID)
addToRadioGroup in class StatefulCanvasgroupID - - ID of the radiogroup to which this widget should be addedState overview and related methodspublic void deselect()
deselect in class StatefulCanvasState overview and related methodspublic com.google.gwt.event.shared.HandlerRegistration addIconClickHandler(IconClickHandler handler)
If this button is showing an icon, a separate click handler for the
icon may be defined as this.iconClick. Returning false will suppress the standard button click handling
code.
addIconClickHandler in interface HasIconClickHandlershandler - the iconClick handlerHandlerRegistration used to remove this handlerpublic void removeFromRadioGroup()
removeFromRadioGroup in class StatefulCanvasState overview and related methodspublic void removeFromRadioGroup(java.lang.String groupID)
removeFromRadioGroup in class StatefulCanvasgroupID - - optional radio group ID (to ensure the widget is removed from the appropriate
group.State overview and related methodspublic void select()
select in class StatefulCanvasState overview and related methodspublic boolean titleClipped()
public com.google.gwt.event.shared.HandlerRegistration addTitleHoverHandler(TitleHoverHandler handler)
Optional stringMethod to fire when the user hovers over this button and the title is clipped. If Button.showClippedTitleOnHover is true, the default
behavior is to show a hover canvas containing the HTML returned by Button.titleHoverHTML(). Call TitleHoverEvent.cancel() from within TitleHoverHandler.onTitleHover(com.smartgwt.client.widgets.events.TitleHoverEvent) to suppress this default behavior.
addTitleHoverHandler in interface HasTitleHoverHandlershandler - the titleHover handlerHandlerRegistration used to remove this handlerpublic java.lang.String titleHoverHTML(java.lang.String defaultHTML)
titleHover handler. Return null or an empty string to cancel the hover. Use setTitleHoverFormatter() to
provide a custom implementation.
defaultHTML - the HTML that would have been displayed by default.
See HTMLStringHTMLStringHTMLStringpublic static void setDefaultProperties(Button buttonProperties)
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.
buttonProperties - properties that should be used as new defaults when instances of this class are createdSGWTPropertiespublic void setTitleHoverFormatter(TitleHoverFormatter formatter)
titleHoverHTML(java.lang.String).public static void assertIsButton(Canvas targetCanvas, java.lang.String message)
public com.smartgwt.logicalstructure.core.LogicalStructureObject setLogicalStructure(com.smartgwt.logicalstructure.widgets.ButtonLogicalStructure s)
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility.public com.smartgwt.logicalstructure.core.LogicalStructureObject getLogicalStructure()
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility.getLogicalStructure in interface LogicalStructuregetLogicalStructure in class StatefulCanvas