public class RibbonButton extends Button implements HasMenuIconClickHandlers
icon, title and optional menuIcon and is capable of horizontal and vertical orientation.config, configOnly, factoryCreated, factoryProperties, id, nativeObject, scClassName| Constructor and Description |
|---|
RibbonButton() |
RibbonButton(com.google.gwt.core.client.JavaScriptObject jsObj) |
RibbonButton(java.lang.String title) |
| Modifier and Type | Method and Description |
|---|---|
com.google.gwt.event.shared.HandlerRegistration |
addMenuIconClickHandler(MenuIconClickHandler handler)
Add a menuIconClick handler.
|
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. |
java.lang.Boolean |
click()
Notification method fired when a user clicks anywhere on this button.
|
protected com.google.gwt.core.client.JavaScriptObject |
create() |
Alignment |
getAlign()
Horizontal alignment of this button's content.
|
java.lang.String |
getBaseStyle()
Default stateful CSS class for this button.
|
java.lang.String |
getEditProxyConstructor()
Default class used to construct the
EditProxy for this component when the component is
first placed into edit mode. |
java.lang.String |
getIcon()
Icon to show to the left of or above the title, according to the button's
orientation. |
java.lang.String |
getIconAlign()
This attribute is not supported in this subclass.
|
java.lang.String |
getIconOrientation()
This attribute is not supported in this subclass.
|
java.lang.String |
getIconStyle()
Default CSS class for this button's
icon. |
java.lang.String |
getLargeIcon()
Icon to show above the title when
Orientation is "vertical". |
int |
getLargeIconSize()
The size of the large icon for this button.
|
com.smartgwt.logicalstructure.core.LogicalStructureObject |
getLogicalStructure()
Getter implementing the
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility. |
Menu |
getMenu()
The menu to show when the
menu-icon is clicked. |
Alignment |
getMenuAlign()
The horizontal alignment of this button's menu, in relation to the button.
|
java.lang.String |
getMenuAnimationEffect()
Allows you to specify an animation effect to apply to the menu when it is being shown.
|
int |
getMenuIconHeight()
The height of the icon for this button.
|
java.lang.String |
getMenuIconSrc()
Base URL for an Image that shows a
menu when clicked. |
java.lang.String |
getMenuIconStyle()
Default CSS class to apply to the element showing this button's
menu-icon. |
int |
getMenuIconWidth()
The width of the icon for this button.
|
static RibbonButton |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
java.lang.String |
getOrientation()
Deprecated.
in favor of
vertical which, if set, takes precendence over
this setting |
int |
getRowSpan()
|
java.lang.Boolean |
getShowButtonTitle()
Whether to show the title-text for this RibbonButton.
|
java.lang.Boolean |
getShowIcon()
Whether to show an Icon in this RibbonButton.
|
java.lang.Boolean |
getShowMenuBelow()
The menu drops down below the menu button.
|
java.lang.Boolean |
getShowMenuIcon()
Whether to show the
menu-icon which fires the RibbonButton.menuIconClick() notification method when
clicked. |
java.lang.Boolean |
getShowMenuIconDisabled()
Whether to show a Disabled version of the
menuIcon. |
java.lang.Boolean |
getShowMenuIconDown()
Whether to show a Down version of the
menuIcon. |
java.lang.Boolean |
getShowMenuIconOver()
Whether to show an Over version of the
menuIcon. |
java.lang.Boolean |
getShowMenuOnClick()
|
java.lang.Boolean |
getShowTitle()
showTitle is not applicable to this class - use
showButtonTitle instead. |
VerticalAlignment |
getValign()
Vertical alignment of this button's content.
|
boolean |
getVertical()
Whether this button renders vertically.
|
java.lang.Boolean |
iconClick()
Notification method fired when a user clicks on the
icon in
this RibbonButton. |
RibbonButton |
setAlign(Alignment align)
Horizontal alignment of this button's content.
|
RibbonButton |
setBaseStyle(java.lang.String baseStyle)
Default stateful CSS class for this button.
|
static void |
setDefaultProperties(RibbonButton ribbonButtonProperties)
Class level method to set the default properties of this class.
|
RibbonButton |
setEditProxyConstructor(java.lang.String editProxyConstructor)
Default class used to construct the
EditProxy for this component when the component is
first placed into edit mode. |
RibbonButton |
setIcon(java.lang.String icon)
Icon to show to the left of or above the title, according to the button's
orientation. |
RibbonButton |
setIconAlign(java.lang.String iconAlign)
This attribute is not supported in this subclass.
|
RibbonButton |
setIconOrientation(java.lang.String iconOrientation)
This attribute is not supported in this subclass.
|
RibbonButton |
setIconStyle(java.lang.String iconStyle)
Default CSS class for this button's
icon. |
RibbonButton |
setLargeIcon(java.lang.String largeIcon)
Icon to show above the title when
Orientation is "vertical". |
RibbonButton |
setLargeIconSize(int largeIconSize)
The size of the large icon for this button.
|
com.smartgwt.logicalstructure.core.LogicalStructureObject |
setLogicalStructure(com.smartgwt.logicalstructure.widgets.RibbonButtonLogicalStructure s)
Setter implementing the
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility. |
RibbonButton |
setMenu(Menu menu)
The menu to show when the
menu-icon is clicked. |
RibbonButton |
setMenuAlign(Alignment menuAlign)
The horizontal alignment of this button's menu, in relation to the button.
|
RibbonButton |
setMenuAnimationEffect(java.lang.String menuAnimationEffect)
Allows you to specify an animation effect to apply to the menu when it is being shown.
|
RibbonButton |
setMenuIconHeight(int menuIconHeight)
The height of the icon for this button.
|
RibbonButton |
setMenuIconSrc(java.lang.String menuIconSrc)
Base URL for an Image that shows a
menu when clicked. |
RibbonButton |
setMenuIconStyle(java.lang.String menuIconStyle)
Default CSS class to apply to the element showing this button's
menu-icon. |
RibbonButton |
setMenuIconWidth(int menuIconWidth)
The width of the icon for this button.
|
RibbonButton |
setOrientation(java.lang.String orientation)
Deprecated.
in favor of
vertical which, if set, takes precendence over
this setting |
RibbonButton |
setRowSpan(int rowSpan)
|
RibbonButton |
setShowButtonTitle(java.lang.Boolean showButtonTitle)
Whether to show the title-text for this RibbonButton.
|
RibbonButton |
setShowIcon(java.lang.Boolean showIcon)
Whether to show an Icon in this RibbonButton.
|
RibbonButton |
setShowMenuBelow(java.lang.Boolean showMenuBelow)
The menu drops down below the menu button.
|
RibbonButton |
setShowMenuIcon(java.lang.Boolean showMenuIcon)
Whether to show the
menu-icon which fires the RibbonButton.menuIconClick() notification method when
clicked. |
RibbonButton |
setShowMenuIconDisabled(java.lang.Boolean showMenuIconDisabled)
Whether to show a Disabled version of the
menuIcon. |
RibbonButton |
setShowMenuIconDown(java.lang.Boolean showMenuIconDown)
Whether to show a Down version of the
menuIcon. |
RibbonButton |
setShowMenuIconOver(java.lang.Boolean showMenuIconOver)
Whether to show an Over version of the
menuIcon. |
RibbonButton |
setShowMenuOnClick(java.lang.Boolean showMenuOnClick)
|
RibbonButton |
setShowTitle(java.lang.Boolean showTitle)
showTitle is not applicable to this class - use
showButtonTitle instead. |
RibbonButton |
setValign(VerticalAlignment valign)
Vertical alignment of this button's content.
|
RibbonButton |
setVertical(boolean vertical)
Whether this button renders vertically.
|
java.lang.Boolean |
showMenu()
Shows this button's
menu. |
action, addIconClickHandler, addTitleHoverHandler, addToRadioGroup, assertIsButton, deselect, getActionType, getAdaptWidthShowIconOnly, getAutoFit, getCanAdaptWidth, 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, 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, titleHoverHTMLgetAriaLabel, getAriaStateDefaults, getIgnoreRTL, getLabelHPad, getLabelVPad, getOverCanvas, getOverCanvasConstructor, getRedrawOnStateChange, getSelected, getShowFocusedAsOver, getShowOverCanvas, getShowRTLIcon, getStateSuffix, isSelected, setAriaLabel, setDefaultProperties, setIgnoreRTL, setLabelHPad, setLabelVPad, setLogicalStructure, setOverCanvasConstructor, setRedrawOnStateChange, setSelected, setShowFocusedAsOver, 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, 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, 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, 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, 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, resizeControlsTo, resizeFonts, resizeFonts, resizeFonts, resizeFontsTo, 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, 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, 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, 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, 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, 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 RibbonButton()
public RibbonButton(com.google.gwt.core.client.JavaScriptObject jsObj)
public RibbonButton(java.lang.String title)
public static RibbonButton 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()
public RibbonButton setAlign(Alignment align)
vertical buttons are center-aligned and horizontal buttons left-aligned by default.setAlign in class Buttonalign - New align value. Default value is nullRibbonButton instance, for chaining setter callsAppearance overview and related methodspublic Alignment getAlign()
vertical buttons are center-aligned and horizontal buttons left-aligned by default.getAlign in class ButtonAppearance overview and related methodspublic RibbonButton setBaseStyle(java.lang.String baseStyle)
iconStyle or menuIconStyle are unset, they will
default to the value of this attribute, suffixed with H/VIcon or H/VMenuIcon respectively,
depending on the value of vertical.setBaseStyle in class ButtonbaseStyle - New baseStyle value. Default value is "ribbonButton"RibbonButton instance, for chaining setter callsCSSStyleName,
Appearance overview and related methodspublic java.lang.String getBaseStyle()
iconStyle or menuIconStyle are unset, they will
default to the value of this attribute, suffixed with H/VIcon or H/VMenuIcon respectively,
depending on the value of vertical.getBaseStyle in class ButtonCSSStyleName,
Appearance overview and related methodspublic RibbonButton setEditProxyConstructor(java.lang.String editProxyConstructor) throws java.lang.IllegalStateException
EditProxy for this component when the component is
first placed into edit mode.setEditProxyConstructor in class StatefulCanvaseditProxyConstructor - New editProxyConstructor value. Default value is "RibbonButtonEditProxy"RibbonButton instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdSCClassNamepublic java.lang.String getEditProxyConstructor()
EditProxy for this component when the component is
first placed into edit mode.getEditProxyConstructor in class StatefulCanvasSCClassNamepublic RibbonButton setIcon(java.lang.String icon)
orientation. When specifying vertical = true,
this icon will be stretched to the largeIconSize
unless a largeIcon is specified.
If this method is called after the component has been drawn/initialized:
Sets a new Icon for this button after initialization.
setIcon in class Buttonicon - URL of new icon. Default value is nullRibbonButton instance, for chaining setter callsSCImgURLpublic java.lang.String getIcon()
orientation. When specifying vertical = true,
this icon will be stretched to the largeIconSize
unless a largeIcon is specified.
public RibbonButton setIconAlign(java.lang.String iconAlign)
setIconAlign in class ButtoniconAlign - New iconAlign value. Default value is nullRibbonButton instance, for chaining setter callsButtonIcon overview and related methodspublic java.lang.String getIconAlign()
getIconAlign in class ButtonButtonIcon overview and related methodspublic RibbonButton setIconOrientation(java.lang.String iconOrientation)
setIconOrientation in class ButtoniconOrientation - New iconOrientation value. Default value is nullRibbonButton instance, for chaining setter callsButtonIcon overview and related methods,
Icons Examplepublic java.lang.String getIconOrientation()
getIconOrientation in class ButtonButtonIcon overview and related methods,
Icons Examplepublic RibbonButton setIconStyle(java.lang.String iconStyle)
icon. If unset, defaults
to baseStyle suffixed with VIcon or
HIcon depending on the value of vertical.setIconStyle in class ButtoniconStyle - New iconStyle value. Default value is nullRibbonButton instance, for chaining setter callsCSSStyleName,
Appearance overview and related methodspublic java.lang.String getIconStyle()
icon. If unset, defaults
to baseStyle suffixed with VIcon or
HIcon depending on the value of vertical.getIconStyle in class ButtonCSSStyleName,
Appearance overview and related methodspublic RibbonButton setLargeIcon(java.lang.String largeIcon)
Orientation is "vertical". If a largeIcon is not
specified, the normal icon will be stretched to the largeIconSize.
If this method is called after the component has been drawn/initialized:
Sets a new Large-Icon for vertical buttons after initialization - synonymous with setIcon for normal horizontal buttons.
largeIcon - New largeIcon value. Default value is nullRibbonButton instance, for chaining setter callsSCImgURLpublic java.lang.String getLargeIcon()
Orientation is "vertical". If a largeIcon is not
specified, the normal icon will be stretched to the largeIconSize.
SCImgURLpublic RibbonButton setLargeIconSize(int largeIconSize)
largeIcon
is not specified, the normal icon will be stretched to this
size.largeIconSize - New largeIconSize value. Default value is 32RibbonButton instance, for chaining setter callspublic int getLargeIconSize()
largeIcon
is not specified, the normal icon will be stretched to this
size.public RibbonButton setMenu(Menu menu)
menu-icon is clicked. For
a menu button with no menu (menu: null) the up/down arrow image can be suppressed by setting showMenuIcon: false.
If this method is called after the component has been drawn/initialized:
The menu to show when the menu-icon is clicked.
For a menu button with no menu (menu: null) the up/down arrow image can be suppressed by setting showMenuIcon: false. Note that showMenuIcon is updated automatically by calls to setMenu().
menu - a menu to assign to this button. Default value is nullRibbonButton instance, for chaining setter callspublic Menu getMenu()
menu-icon is clicked. For
a menu button with no menu (menu: null) the up/down arrow image can be suppressed by setting showMenuIcon: false.
public RibbonButton setMenuAlign(Alignment menuAlign) throws java.lang.IllegalStateException
menuAlign - New menuAlign value. Default value is nullRibbonButton instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic Alignment getMenuAlign()
public RibbonButton setMenuAnimationEffect(java.lang.String menuAnimationEffect)
menu.showAnimationEffect
Note : This is an advanced setting
menuAnimationEffect - New menuAnimationEffect value. Default value is nullRibbonButton instance, for chaining setter callspublic java.lang.String getMenuAnimationEffect()
menu.showAnimationEffectpublic RibbonButton setMenuIconHeight(int menuIconHeight)
menuIconHeight - New menuIconHeight value. Default value is 13RibbonButton instance, for chaining setter callspublic int getMenuIconHeight()
public RibbonButton setMenuIconSrc(java.lang.String menuIconSrc)
menu when clicked. See also showMenuIconDisabled and showMenuIconOver.menuIconSrc - New menuIconSrc value. Default value is "[SKINIMG]/Menu/submenu_down.png"RibbonButton instance, for chaining setter callsSCImgURLpublic java.lang.String getMenuIconSrc()
menu when clicked. See also showMenuIconDisabled and showMenuIconOver.SCImgURLpublic RibbonButton setMenuIconStyle(java.lang.String menuIconStyle)
menu-icon. If unset, defaults to baseStyle suffixed with VMenuIcon or
HMenuIcon depending on the value of vertical.menuIconStyle - New menuIconStyle value. Default value is nullRibbonButton instance, for chaining setter callsCSSStyleName,
Appearance overview and related methodspublic java.lang.String getMenuIconStyle()
menu-icon. If unset, defaults to baseStyle suffixed with VMenuIcon or
HMenuIcon depending on the value of vertical.CSSStyleName,
Appearance overview and related methodspublic RibbonButton setMenuIconWidth(int menuIconWidth)
menuIconWidth - New menuIconWidth value. Default value is 14RibbonButton instance, for chaining setter callspublic int getMenuIconWidth()
public RibbonButton setOrientation(java.lang.String orientation)
vertical which, if set, takes precendence over
this settingicon, title and potentially menuIcon, from top to bottom: "horizontal" does the same from
top to bottom.orientation - New orientation value. Default value is "vertical"RibbonButton instance, for chaining setter callspublic java.lang.String getOrientation()
vertical which, if set, takes precendence over
this settingicon, title and potentially menuIcon, from top to bottom: "horizontal" does the same from
top to bottom.public RibbonButton setRowSpan(int rowSpan)
rowSpan - New rowSpan value. Default value is 1RibbonButton instance, for chaining setter callspublic int getRowSpan()
public RibbonButton setShowButtonTitle(java.lang.Boolean showButtonTitle)
showButtonTitle - New showButtonTitle value. Default value is trueRibbonButton instance, for chaining setter callspublic java.lang.Boolean getShowButtonTitle()
public RibbonButton setShowIcon(java.lang.Boolean showIcon)
showIcon - New showIcon value. Default value is nullRibbonButton instance, for chaining setter callspublic java.lang.Boolean getShowIcon()
public RibbonButton setShowMenuBelow(java.lang.Boolean showMenuBelow)
showMenuBelow - New showMenuBelow value. Default value is trueRibbonButton instance, for chaining setter callspublic java.lang.Boolean getShowMenuBelow()
public RibbonButton setShowMenuIcon(java.lang.Boolean showMenuIcon)
menu-icon which fires the RibbonButton.menuIconClick() notification method when
clicked.showMenuIcon - New showMenuIcon value. Default value is nullRibbonButton instance, for chaining setter callspublic java.lang.Boolean getShowMenuIcon()
menu-icon which fires the RibbonButton.menuIconClick() notification method when
clicked.public RibbonButton setShowMenuIconDisabled(java.lang.Boolean showMenuIconDisabled)
menuIcon.showMenuIconDisabled - New showMenuIconDisabled value. Default value is trueRibbonButton instance, for chaining setter callspublic java.lang.Boolean getShowMenuIconDisabled()
menuIcon.public RibbonButton setShowMenuIconDown(java.lang.Boolean showMenuIconDown)
menuIcon.showMenuIconDown - New showMenuIconDown value. Default value is falseRibbonButton instance, for chaining setter callspublic java.lang.Boolean getShowMenuIconDown()
menuIcon.public RibbonButton setShowMenuIconOver(java.lang.Boolean showMenuIconOver)
menuIcon.showMenuIconOver - New showMenuIconOver value. Default value is trueRibbonButton instance, for chaining setter callspublic java.lang.Boolean getShowMenuIconOver()
menuIcon.public RibbonButton setShowMenuOnClick(java.lang.Boolean showMenuOnClick)
menu when a user clicks anywhere in
the button, rather than specifically on the menuIcon.
Note that this property has a different meaning than showMenuOnClick in the ancestor class StatefulCanvas.
setShowMenuOnClick in class StatefulCanvasshowMenuOnClick - New showMenuOnClick value. Default value is falseRibbonButton instance, for chaining setter callspublic java.lang.Boolean getShowMenuOnClick()
menu when a user clicks anywhere in
the button, rather than specifically on the menuIcon.
Note that this property has a different meaning than showMenuOnClick in the ancestor class StatefulCanvas.
getShowMenuOnClick in class StatefulCanvaspublic RibbonButton setShowTitle(java.lang.Boolean showTitle)
showButtonTitle instead.showTitle - New showTitle value. Default value is nullRibbonButton instance, for chaining setter callspublic java.lang.Boolean getShowTitle()
showButtonTitle instead.public RibbonButton setValign(VerticalAlignment valign)
vertical buttons are top-aligned and horizontal buttons center-aligned by default.setValign in class Buttonvalign - New valign value. Default value is nullRibbonButton instance, for chaining setter callsAppearance overview and related methodspublic VerticalAlignment getValign()
vertical buttons are top-aligned and horizontal buttons center-aligned by default.getValign in class ButtonAppearance overview and related methodspublic RibbonButton setVertical(boolean vertical)
icon,
title and potentially menuIcon from top to bottom, when true, and from left to right
when false.vertical - New vertical value. Default value is falseRibbonButton instance, for chaining setter callspublic boolean getVertical()
icon,
title and potentially menuIcon from top to bottom, when true, and from left to right
when false.public java.lang.Boolean click()
icon or the menuIcon, the related notifications iconClick and menuIconClick are fired first and must return false to
prevent this notification from firing. If a menu is installed then, by
default, it is only displayed when a user clicks on the menuIcon. This can be altered via showMenuOnClick.
public java.lang.Boolean iconClick()
icon in
this RibbonButton. call event.cancel() to suppress the standard click handling code.public com.google.gwt.event.shared.HandlerRegistration addMenuIconClickHandler(MenuIconClickHandler handler)
Notification method fired when a user clicks on the menuIcon on this RibbonButton. call event.cancel()
to suppress the standard click handling code.
addMenuIconClickHandler in interface HasMenuIconClickHandlershandler - the menuIconClick handlerHandlerRegistration used to remove this handlerpublic java.lang.Boolean showMenu()
public static void setDefaultProperties(RibbonButton ribbonButtonProperties)
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.
ribbonButtonProperties - properties that should be used as new defaults when instances of this class are createdSGWTPropertiespublic com.smartgwt.logicalstructure.core.LogicalStructureObject setLogicalStructure(com.smartgwt.logicalstructure.widgets.RibbonButtonLogicalStructure 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 Button