Class RibbonButton
- 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,HasMenuIconClickHandlers
- Direct Known Subclasses:
IconButton,RibbonMenuButton
icon, title and optional menuIcon and is capable of horizontal and vertical orientation.-
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 TypeMethodDescriptionAdd a menuIconClick handler.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.click()Notification method fired when a user clicks anywhere on this button.protected JavaScriptObjectcreate()getAlign()Horizontal alignment of this button's content.Default stateful CSS class for this button.Default class used to construct theEditProxyfor this component when the component isfirst placed into edit mode.getIcon()Icon to show to the left of or above the title, according to the button'sorientation.This attribute is not supported in this subclass.This attribute is not supported in this subclass.Default CSS class for this button'sicon.Icon to show above the title whenOrientationis "vertical".intThe size of the large icon for this button.Getter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.getMenu()The menu to show when themenu-iconis clicked.The horizontal alignment of this button's menu, in relation to the button.Allows you to specify an animation effect to apply to the menu when it is being shown.intThe height of the icon for this button.Base URL for an Image that shows amenuwhen clicked.Default CSS class to apply to the element showing this button'smenu-icon.intThe width of the icon for this button.static RibbonButtongetOrCreateRef(JavaScriptObject jsObj) Deprecated.intWhether to show the title-text for this RibbonButton.Whether to show an Icon in this RibbonButton.The menu drops down below the menu button.Whether to show themenu-iconwhich fires theRibbonButton.menuIconClick()notification method when clicked.Whether to show a Disabled version of themenuIcon.Whether to show a Down version of themenuIcon.Whether to show an Over version of themenuIcon.showTitle is not applicable to this class - useshowButtonTitleinstead.Vertical alignment of this button's content.booleanWhether this button renders vertically.Notification method fired when a user clicks on theiconin this RibbonButton.Horizontal alignment of this button's content.setBaseStyle(String baseStyle) Default stateful CSS class for this button.static voidsetDefaultProperties(RibbonButton ribbonButtonProperties) Class level method to set the default properties of this class.setEditProxyConstructor(String editProxyConstructor) Default class used to construct theEditProxyfor this component when the component isfirst placed into edit mode.Icon to show to the left of or above the title, according to the button'sorientation.setIconAlign(String iconAlign) This attribute is not supported in this subclass.setIconOrientation(String iconOrientation) This attribute is not supported in this subclass.setIconStyle(String iconStyle) Default CSS class for this button'sicon.setLargeIcon(String largeIcon) Icon to show above the title whenOrientationis "vertical".setLargeIconSize(int largeIconSize) The size of the large icon for this button.Setter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.The menu to show when themenu-iconis clicked.setMenuAlign(Alignment menuAlign) The horizontal alignment of this button's menu, in relation to the button.setMenuAnimationEffect(String menuAnimationEffect) Allows you to specify an animation effect to apply to the menu when it is being shown.setMenuIconHeight(int menuIconHeight) The height of the icon for this button.setMenuIconSrc(String menuIconSrc) Base URL for an Image that shows amenuwhen clicked.setMenuIconStyle(String menuIconStyle) Default CSS class to apply to the element showing this button'smenu-icon.setMenuIconWidth(int menuIconWidth) The width of the icon for this button.setOrientation(String orientation) Deprecated.in favor ofverticalwhich, if set, takes precendence over this settingsetRowSpan(int rowSpan) setShowButtonTitle(Boolean showButtonTitle) Whether to show the title-text for this RibbonButton.setShowIcon(Boolean showIcon) Whether to show an Icon in this RibbonButton.setShowMenuBelow(Boolean showMenuBelow) The menu drops down below the menu button.setShowMenuIcon(Boolean showMenuIcon) Whether to show themenu-iconwhich fires theRibbonButton.menuIconClick()notification method when clicked.setShowMenuIconDisabled(Boolean showMenuIconDisabled) Whether to show a Disabled version of themenuIcon.setShowMenuIconDown(Boolean showMenuIconDown) Whether to show a Down version of themenuIcon.setShowMenuIconOver(Boolean showMenuIconOver) Whether to show an Over version of themenuIcon.setShowMenuOnClick(Boolean showMenuOnClick) setShowTitle(Boolean showTitle) showTitle is not applicable to this class - useshowButtonTitleinstead.setValign(VerticalAlignment valign) Vertical alignment of this button's content.setVertical(boolean vertical) Whether this button renders vertically.showMenu()Shows this button'smenu.Methods inherited from class com.smartgwt.client.widgets.Button
action, addIconClickHandler, addTitleHoverHandler, addToRadioGroup, assertIsButton, deselect, getActionType, getAdaptWidthShowIconOnly, getAutoFit, getCanAdaptWidth, getDefiningProperty, getDisabledIconCursor, getHeight, getHeightAsString, getHiliteAccessKey, getIconCursor, getIconHeight, getIconOnlyBaseStyle, getIconSize, getIconSpacing, getIconWidth, getOverflow, getRadioGroup, getShowClippedTitleOnHover, getShowDisabled, getShowDisabledIcon, getShowDown, getShowDownIcon, getShowFocused, getShowFocusedIcon, getShowRollOver, getShowRollOverIcon, getShowSelectedIcon, getState, getStyleName, getTitle, getWidth, getWidthAsString, getWrap, removeFromRadioGroup, removeFromRadioGroup, select, setActionType, setAdaptWidthShowIconOnly, setAutoFit, setCanAdaptWidth, setDefaultProperties, setDefiningProperty, setDisabledIconCursor, setHeight, setHeight, setHiliteAccessKey, setIconCursor, setIconHeight, setIconOnlyBaseStyle, setIconSize, setIconSpacing, setIconWidth, setLogicalStructure, setOverflow, setRadioGroup, setShowClippedTitleOnHover, setShowDisabled, setShowDisabledIcon, setShowDown, setShowDownIcon, setShowFocused, setShowFocusedIcon, setShowRollOver, setShowRollOverIcon, setShowSelectedIcon, setState, setStyleName, setTitle, setTitleHoverFormatter, setWidth, setWidth, setWrap, titleClipped, titleHoverHTMLMethods inherited from class com.smartgwt.client.widgets.StatefulCanvas
getAriaLabel, getAriaStateDefaults, getIgnoreRTL, getLabelHPad, getLabelVPad, getOverCanvas, getOverCanvasConstructor, getRedrawOnStateChange, getSelected, getShowFocusedAsOver, getShowOverCanvas, getShowRTLIcon, getStateSuffix, getVIconStyle, isSelected, setAriaLabel, setDefaultProperties, setIgnoreRTL, setLabelHPad, setLabelVPad, setLogicalStructure, setOverCanvasConstructor, setRedrawOnStateChange, setSelected, setShowFocusedAsOver, 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
-
RibbonButton
public RibbonButton() -
RibbonButton
-
RibbonButton
-
-
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
-
setAlign
Horizontal alignment of this button's content. If unset,vertical buttonsare center-aligned and horizontal buttons left-aligned by default.- Overrides:
setAlignin classButton- Parameters:
align- New align value. Default value is null- Returns:
RibbonButtoninstance, for chaining setter calls- See Also:
-
getAlign
Horizontal alignment of this button's content. If unset,vertical buttonsare center-aligned and horizontal buttons left-aligned by default. -
setBaseStyle
Default stateful CSS class for this button. WheniconStyleormenuIconStyleare unset, they will default to the value of this attribute, suffixed withH/VIconorH/VMenuIconrespectively, depending on the value ofvertical.- Overrides:
setBaseStylein classButton- Parameters:
baseStyle- New baseStyle value. Default value is "ribbonButton"- Returns:
RibbonButtoninstance, for chaining setter calls- See Also:
-
getBaseStyle
Default stateful CSS class for this button. WheniconStyleormenuIconStyleare unset, they will default to the value of this attribute, suffixed withH/VIconorH/VMenuIconrespectively, depending on the value ofvertical.- Overrides:
getBaseStylein classButton- Returns:
- Current baseStyle value. Default value is "ribbonButton"
- See Also:
-
setEditProxyConstructor
public RibbonButton setEditProxyConstructor(String editProxyConstructor) throws IllegalStateException Default class used to construct theEditProxyfor this component when the component isfirst placed into edit mode.- Overrides:
setEditProxyConstructorin classStatefulCanvas- Parameters:
editProxyConstructor- New editProxyConstructor value. Default value is "RibbonButtonEditProxy"- Returns:
RibbonButtoninstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getEditProxyConstructor
Default class used to construct theEditProxyfor this component when the component isfirst placed into edit mode.- Overrides:
getEditProxyConstructorin classStatefulCanvas- Returns:
- Current editProxyConstructor value. Default value is "RibbonButtonEditProxy"
- See Also:
-
setIcon
Icon to show to the left of or above the title, according to the button'sorientation.When specifying
vertical = true, this icon will be stretched to thelargeIconSizeunless alargeIconis specified.
If this method is called after the component has been drawn/initialized: Sets a new Icon for this button after initialization.- Overrides:
setIconin classButton- Parameters:
icon- URL of new icon. Default value is null- Returns:
RibbonButtoninstance, for chaining setter calls- See Also:
-
getIcon
Icon to show to the left of or above the title, according to the button'sorientation.When specifying
vertical = true, this icon will be stretched to thelargeIconSizeunless alargeIconis specified. -
setIconAlign
This attribute is not supported in this subclass. However, RTL mode is still supported.- Overrides:
setIconAlignin classButton- Parameters:
iconAlign- New iconAlign value. Default value is null- Returns:
RibbonButtoninstance, for chaining setter calls- See Also:
-
getIconAlign
This attribute is not supported in this subclass. However, RTL mode is still supported.- Overrides:
getIconAlignin classButton- Returns:
- Current iconAlign value. Default value is null
- See Also:
-
setIconOrientation
This attribute is not supported in this subclass. However, RTL mode is still supported.- Overrides:
setIconOrientationin classButton- Parameters:
iconOrientation- New iconOrientation value. Default value is null- Returns:
RibbonButtoninstance, for chaining setter calls- See Also:
-
getIconOrientation
This attribute is not supported in this subclass. However, RTL mode is still supported.- Overrides:
getIconOrientationin classButton- Returns:
- Current iconOrientation value. Default value is null
- See Also:
-
setIconStyle
Default CSS class for this button'sicon. If unset, defaults tobaseStylesuffixed withVIconorHIcondepending on the value ofvertical.- Overrides:
setIconStylein classButton- Parameters:
iconStyle- New iconStyle value. Default value is null- Returns:
RibbonButtoninstance, for chaining setter calls- See Also:
-
getIconStyle
Default CSS class for this button'sicon. If unset, defaults tobaseStylesuffixed withVIconorHIcondepending on the value ofvertical.- Overrides:
getIconStylein classButton- Returns:
- Current iconStyle value. Default value is null
- See Also:
-
setLargeIcon
Icon to show above the title whenOrientationis "vertical".If a largeIcon is not specified, the
normal iconwill be stretched to thelargeIconSize.
If this method is called after the component has been drawn/initialized: Sets a new Large-Icon for vertical buttons after initialization - synonymous withsetIconfor normal horizontal buttons.- Parameters:
largeIcon- New largeIcon value. Default value is null- Returns:
RibbonButtoninstance, for chaining setter calls- See Also:
-
getLargeIcon
Icon to show above the title whenOrientationis "vertical".If a largeIcon is not specified, the
normal iconwill be stretched to thelargeIconSize.- Returns:
- Current largeIcon value. Default value is null
- See Also:
-
setLargeIconSize
The size of the large icon for this button. IflargeIconis not specified, thenormal iconwill be stretched to this size.- Parameters:
largeIconSize- New largeIconSize value. Default value is 32- Returns:
RibbonButtoninstance, for chaining setter calls
-
getLargeIconSize
public int getLargeIconSize()The size of the large icon for this button. IflargeIconis not specified, thenormal iconwill be stretched to this size.- Returns:
- Current largeIconSize value. Default value is 32
-
getMenu
The menu to show when themenu-iconis clicked.For a menu button with no menu (menu: null) the up/down arrow image can be suppressed by setting
showMenuIcon:false.- Returns:
- Current menu value. Default value is null
-
setMenuAlign
The horizontal alignment of this button's menu, in relation to the button. When unset, default behavior is to align the right edges of button and menu if the page is in RTL mode, and the left edges otherwise.- Parameters:
menuAlign- New menuAlign value. Default value is null- Returns:
RibbonButtoninstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getMenuAlign
The horizontal alignment of this button's menu, in relation to the button. When unset, default behavior is to align the right edges of button and menu if the page is in RTL mode, and the left edges otherwise.- Returns:
- Current menuAlign value. Default value is null
-
setMenuAnimationEffect
Allows you to specify an animation effect to apply to the menu when it is being shown. Valid options are "none" (no animation), "fade", "slide" and "wipe". If unspecified falls through tomenu.showAnimationEffectNote : This is an advanced setting
- Parameters:
menuAnimationEffect- New menuAnimationEffect value. Default value is null- Returns:
RibbonButtoninstance, for chaining setter calls
-
getMenuAnimationEffect
Allows you to specify an animation effect to apply to the menu when it is being shown. Valid options are "none" (no animation), "fade", "slide" and "wipe". If unspecified falls through tomenu.showAnimationEffect- Returns:
- Current menuAnimationEffect value. Default value is null
-
setMenuIconHeight
The height of the icon for this button.- Parameters:
menuIconHeight- New menuIconHeight value. Default value is 13- Returns:
RibbonButtoninstance, for chaining setter calls
-
getMenuIconHeight
public int getMenuIconHeight()The height of the icon for this button.- Returns:
- Current menuIconHeight value. Default value is 13
-
setMenuIconSrc
Base URL for an Image that shows amenuwhen clicked. See alsoshowMenuIconDisabledandshowMenuIconOver.- Parameters:
menuIconSrc- New menuIconSrc value. Default value is "[SKINIMG]/Menu/submenu_down.png"- Returns:
RibbonButtoninstance, for chaining setter calls- See Also:
-
getMenuIconSrc
Base URL for an Image that shows amenuwhen clicked. See alsoshowMenuIconDisabledandshowMenuIconOver.- Returns:
- Current menuIconSrc value. Default value is "[SKINIMG]/Menu/submenu_down.png"
- See Also:
-
setMenuIconStyle
Default CSS class to apply to the element showing this button'smenu-icon. If unset, defaults tobaseStylesuffixed withVMenuIconorHMenuIcondepending on the value ofvertical.- Parameters:
menuIconStyle- New menuIconStyle value. Default value is null- Returns:
RibbonButtoninstance, for chaining setter calls- See Also:
-
getMenuIconStyle
Default CSS class to apply to the element showing this button'smenu-icon. If unset, defaults tobaseStylesuffixed withVMenuIconorHMenuIcondepending on the value ofvertical.- Returns:
- Current menuIconStyle value. Default value is null
- See Also:
-
setMenuIconWidth
The width of the icon for this button.- Parameters:
menuIconWidth- New menuIconWidth value. Default value is 14- Returns:
RibbonButtoninstance, for chaining setter calls
-
getMenuIconWidth
public int getMenuIconWidth()The width of the icon for this button.- Returns:
- Current menuIconWidth value. Default value is 14
-
setOrientation
Deprecated.in favor ofverticalwhich, if set, takes precendence over this settingThe orientation of this RibbonButton. The default value, "vertical", rendersicon,titleand potentiallymenuIcon, from top to bottom: "horizontal" does the same from top to bottom.- Parameters:
orientation- New orientation value. Default value is "vertical"- Returns:
RibbonButtoninstance, for chaining setter calls
-
getOrientation
Deprecated.in favor ofverticalwhich, if set, takes precendence over this settingThe orientation of this RibbonButton. The default value, "vertical", rendersicon,titleand potentiallymenuIcon, from top to bottom: "horizontal" does the same from top to bottom.- Returns:
- Current orientation value. Default value is "vertical"
-
setRowSpan
- Parameters:
rowSpan- New rowSpan value. Default value is 1- Returns:
RibbonButtoninstance, for chaining setter calls
-
getRowSpan
public int getRowSpan()- Returns:
- Current rowSpan value. Default value is 1
-
setShowButtonTitle
Whether to show the title-text for this RibbonButton. If set to false, title-text is omitted altogether and just the icon is displayed.- Parameters:
showButtonTitle- New showButtonTitle value. Default value is true- Returns:
RibbonButtoninstance, for chaining setter calls
-
getShowButtonTitle
Whether to show the title-text for this RibbonButton. If set to false, title-text is omitted altogether and just the icon is displayed.- Returns:
- Current showButtonTitle value. Default value is true
-
setShowIcon
Whether to show an Icon in this RibbonButton. Set to false to render a text-only button.- Parameters:
showIcon- New showIcon value. Default value is null- Returns:
RibbonButtoninstance, for chaining setter calls
-
getShowIcon
Whether to show an Icon in this RibbonButton. Set to false to render a text-only button.- Returns:
- Current showIcon value. Default value is null
-
setShowMenuBelow
The menu drops down below the menu button. Set to false if the menu should appear above the menu button.- Parameters:
showMenuBelow- New showMenuBelow value. Default value is true- Returns:
RibbonButtoninstance, for chaining setter calls
-
getShowMenuBelow
The menu drops down below the menu button. Set to false if the menu should appear above the menu button.- Returns:
- Current showMenuBelow value. Default value is true
-
setShowMenuIcon
Whether to show themenu-iconwhich fires theRibbonButton.menuIconClick()notification method when clicked.- Parameters:
showMenuIcon- New showMenuIcon value. Default value is null- Returns:
RibbonButtoninstance, for chaining setter calls
-
getShowMenuIcon
Whether to show themenu-iconwhich fires theRibbonButton.menuIconClick()notification method when clicked.- Returns:
- Current showMenuIcon value. Default value is null
-
setShowMenuIconDisabled
Whether to show a Disabled version of themenuIcon.- Parameters:
showMenuIconDisabled- New showMenuIconDisabled value. Default value is true- Returns:
RibbonButtoninstance, for chaining setter calls
-
getShowMenuIconDisabled
Whether to show a Disabled version of themenuIcon.- Returns:
- Current showMenuIconDisabled value. Default value is true
-
setShowMenuIconDown
Whether to show a Down version of themenuIcon.- Parameters:
showMenuIconDown- New showMenuIconDown value. Default value is false- Returns:
RibbonButtoninstance, for chaining setter calls
-
getShowMenuIconDown
Whether to show a Down version of themenuIcon.- Returns:
- Current showMenuIconDown value. Default value is false
-
setShowMenuIconOver
Whether to show an Over version of themenuIcon.- Parameters:
showMenuIconOver- New showMenuIconOver value. Default value is true- Returns:
RibbonButtoninstance, for chaining setter calls
-
getShowMenuIconOver
Whether to show an Over version of themenuIcon.- Returns:
- Current showMenuIconOver value. Default value is true
-
setShowMenuOnClick
If set to true, shows this button'smenuwhen a user clicks anywhere in the button, rather than specifically on themenuIcon.Note that this property has a different meaning than
showMenuOnClickin the ancestor classStatefulCanvas.- Overrides:
setShowMenuOnClickin classStatefulCanvas- Parameters:
showMenuOnClick- New showMenuOnClick value. Default value is false- Returns:
RibbonButtoninstance, for chaining setter calls
-
getShowMenuOnClick
If set to true, shows this button'smenuwhen a user clicks anywhere in the button, rather than specifically on themenuIcon.Note that this property has a different meaning than
showMenuOnClickin the ancestor classStatefulCanvas.- Overrides:
getShowMenuOnClickin classStatefulCanvas- Returns:
- Current showMenuOnClick value. Default value is false
-
setShowTitle
showTitle is not applicable to this class - useshowButtonTitleinstead.- Parameters:
showTitle- New showTitle value. Default value is null- Returns:
RibbonButtoninstance, for chaining setter calls
-
getShowTitle
showTitle is not applicable to this class - useshowButtonTitleinstead.- Returns:
- Current showTitle value. Default value is null
-
setValign
Vertical alignment of this button's content. If unset,vertical buttonsare top-aligned and horizontal buttons center-aligned by default.- Overrides:
setValignin classButton- Parameters:
valign- New valign value. Default value is null- Returns:
RibbonButtoninstance, for chaining setter calls- See Also:
-
getValign
Vertical alignment of this button's content. If unset,vertical buttonsare top-aligned and horizontal buttons center-aligned by default. -
setVertical
Whether this button renders vertically. Renders theicon,titleand potentiallymenuIconfrom top to bottom, when true, and from left to right when false.- Parameters:
vertical- New vertical value. Default value is false- Returns:
RibbonButtoninstance, for chaining setter calls
-
getVertical
public boolean getVertical()Whether this button renders vertically. Renders theicon,titleand potentiallymenuIconfrom top to bottom, when true, and from left to right when false.- Returns:
- Current vertical value. Default value is false
-
click
Notification method fired when a user clicks anywhere on this button. If the click occurred directly on theiconor themenuIcon, the related notificationsiconClickandmenuIconClickare fired first and must return false to prevent this notification from firing.If a
menuis installed then, by default, it is only displayed when a user clicks on themenuIcon. This can be altered viashowMenuOnClick.- Returns:
- return false to cancel event-bubbling
-
iconClick
Notification method fired when a user clicks on theiconin this RibbonButton. callevent.cancel()to suppress the standard click handling code.- Returns:
- return false to cancel event-bubbling
-
showMenu
- Returns:
- true if a menu was shown
-
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:
ribbonButtonProperties- properties that should be used as new defaults when instances of this class are created- See Also:
-
setLogicalStructure
Setter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility. -
getLogicalStructure
Getter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.- Specified by:
getLogicalStructurein interfaceLogicalStructure- Overrides:
getLogicalStructurein classButton
-
verticalwhich, if set, takes precendence over this setting