Class RibbonGroup
- All Implemented Interfaces:
HasAttachHandlers,HasHandlers,EventListener,HasVisibility,IsWidget,LogicalStructure,HasClearHandlers,HasClickHandlers,HasDoubleClickHandlers,HasDragMoveHandlers,HasDragRepositionMoveHandlers,HasDragRepositionStartHandlers,HasDragRepositionStopHandlers,HasDragResizeMoveHandlers,HasDragResizeStartHandlers,HasDragResizeStopHandlers,HasDragStartHandlers,HasDragStopHandlers,HasDropHandlers,HasDropMoveHandlers,HasDropOutHandlers,HasDropOverHandlers,HasFocusChangedHandlers,HasHoverHandlers,HasHoverHiddenHandlers,HasKeyDownHandlers,HasKeyPressHandlers,HasMouseDownHandlers,HasMouseMoveHandlers,HasMouseOutHandlers,HasMouseOverHandlers,HasMouseStillDownHandlers,HasMouseUpHandlers,HasMouseWheelHandlers,HasMovedHandlers,HasParentMovedHandlers,HasResizedHandlers,HasRightMouseDownHandlers,HasRuleContextChangedHandlers,HasScrolledHandlers,HasShowContextMenuHandlers,HasVisibilityChangedHandlers,HasMembersChangedHandlers
RibbonButtonss for use in RibbonBars.-
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 TypeMethodDescriptionvoidaddControl(Canvas control) voidaddControl(Canvas control, Integer index) voidaddControls(Canvas... controls) static voidchangeAutoChildDefaults(String autoChildName, Canvas defaults) Changes the defaults for Canvas AutoChildren namedautoChildName.static voidchangeAutoChildDefaults(String autoChildName, FormItem defaults) Changes the defaults for FormItem AutoChildren namedautoChildName.protected JavaScriptObjectcreate()voidcreateControl(Canvas properties) Creates a new control and adds it to this RibbonGroup.voidcreateControl(Canvas properties, Integer position) Creates a new control and adds it to this RibbonGroup.By default,RibbonGroupsare assigned a minimum width that allows the entire title to be visible.getBody()HLayout autoChild that manages multipleVLayoutscontaining controls.Smart GWT class for the body.Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists.getControlColumn(Canvas control) Return thecolumn widgetthat contains the passed control.Canvas[]The array of controls to show in this group.Default class used to construct theEditProxyfor this component when the component isfirst placed into edit mode.getLabel()AutoChildLabelused to display thetitle textfor this group.Smart GWT class for thetitle labelAutoChild.HLayout autoChild that houses thelabelin which thetitle textis displayed.Getter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists.intThe number of rows of controls to display in each column.static RibbonGroupgetOrCreateRef(JavaScriptObject jsObj) intThe height of rows in each column.CSS class applied to this RibbonGroup.getTitle()The title text to display in this group'stitle label.Controls the horizontal alignment of the group'stitle-text, within itslabel.intControls the height of thetitle labelin this group.Controls thevertical orientationof this group'stitle label.Deprecated.CSS class applied to thetitle labelin this group.voidForces this group to reflow following changes to attributes that affect layout, likenumRows.voidremoveControl(Canvas control) Removes a control from thisRibbonGroup, destroying an existingcolumnif this is the last widget in that column.setAutoSizeToTitle(Boolean autoSizeToTitle) By default,RibbonGroupsare assigned a minimum width that allows the entire title to be visible.setBodyConstructor(String bodyConstructor) Smart GWT class for the body.setControls(Canvas... controls) The array of controls to show in this group.static voidsetDefaultProperties(RibbonGroup ribbonGroupProperties) 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.setLabelConstructor(String labelConstructor) Smart GWT class for thetitle labelAutoChild.Setter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.setNumRows(int numRows) The number of rows of controls to display in each column.setRowHeight(int rowHeight) The height of rows in each column.voidsetShowTitle(boolean showTitle) This method forcibly shows or hides this group'stitle labelafter initial draw.voidsetStyleName(String styleName) CSS class applied to this RibbonGroup.voidThe title text to display in this group'stitle label.setTitleAlign(Alignment titleAlign) Controls the horizontal alignment of the group'stitle-text, within itslabel.setTitleHeight(int titleHeight) Controls the height of thetitle labelin this group.setTitleOrientation(VerticalAlignment titleOrientation) Controls thevertical orientationof this group'stitle label.setTitleStyle(String titleStyle) CSS class applied to thetitle labelin this group.Methods inherited from class com.smartgwt.client.widgets.toolbar.ToolStripGroup
setDefaultProperties, setLogicalStructureMethods inherited from class com.smartgwt.client.widgets.layout.VLayout
setDefaultProperties, setLogicalStructureMethods inherited from class com.smartgwt.client.widgets.layout.Layout
addMember, addMember, addMember, addMember, addMemberPostCreate, addMemberPostCreate, addMemberPreCreate, addMemberPreCreate, addMembers, addMembers, addMembersChangedHandler, getAnimateMembers, getAnimateMemberTime, getCanDropComponents, getChildTabPosition, getDefaultResizeBars, getDropComponent, getDropLine, getDropLineThickness, getDropPosition, getEnforcePolicy, getHPolicy, getLayoutBottomMargin, getLayoutEndMargin, getLayoutLeftMargin, getLayoutMargin, getLayoutRightMargin, getLayoutStartMargin, getLayoutTopMargin, getLeaveScrollbarGap, getLocateMembersBy, getLocateMembersType, getManagePercentBreadth, getMember, getMember, getMemberDefaultBreadth, getMemberNumber, getMemberNumber, getMemberOverlap, getMembers, getMembersLength, getMembersMargin, getMinMemberLength, getMinMemberSize, getOverflow, getPaddingAsLayoutMargin, getResizeBar, getResizeBarClass, getResizeBarSize, getReverseOrder, getShowDragPlaceHolder, getShowDropLines, getStackZIndex, getVertical, getVPolicy, hasMember, hideDropLine, hideMember, hideMember, layoutIsDirty, onInit, onInit_Layout, reflow, reflow, reflowNow, removeMember, removeMembers, removeMembers, reorderMember, reorderMembers, replaceMember, revealChild, revealChild, setAlign, setAlign, setAnimateMembers, setAnimateMemberTime, setCanDropComponents, setDefaultLayoutAlign, setDefaultLayoutAlign, setDefaultProperties, setDefaultResizeBars, setDropLineProperties, setDropLineThickness, setEnforcePolicy, setHPolicy, setLayoutBottomMargin, setLayoutEndMargin, setLayoutLeftMargin, setLayoutMargin, setLayoutRightMargin, setLayoutStartMargin, setLayoutTopMargin, setLeaveScrollbarGap, setLocateMembersBy, setLocateMembersType, setLogicalStructure, setManagePercentBreadth, setMemberOverlap, setMembers, setMembersMargin, setMinBreadthMember, setMinBreadthMember, setMinBreadthMember, setMinMemberLength, setMinMemberSize, setOverflow, setPaddingAsLayoutMargin, setPlaceHolderDefaults, setPlaceHolderProperties, setResizeBarClass, setResizeBarSize, setReverseOrder, setShowDragPlaceHolder, setShowDropLines, setStackZIndex, setVertical, setVisibleMember, setVPolicy, showMember, showMemberMethods inherited from class com.smartgwt.client.widgets.Canvas
addChild, addChild, addChild, addChild, addChild, addClearHandler, addClickHandler, addDoubleClickHandler, addDragMoveHandler, addDragRepositionMoveHandler, addDragRepositionStartHandler, addDragRepositionStopHandler, addDragResizeMoveHandler, addDragResizeStartHandler, addDragResizeStopHandler, addDragStartHandler, addDragStopHandler, addDropHandler, addDropMoveHandler, addDropOutHandler, addDropOverHandler, addFocusChangedHandler, addHoverHandler, addHoverHiddenHandler, addKeyDownHandler, addKeyPressHandler, addMouseDownHandler, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseStillDownHandler, addMouseUpHandler, addMouseWheelHandler, addMovedHandler, addParentMovedHandler, addPeer, addPeer, addPeer, addPeer, addResizedHandler, addRightMouseDownHandler, addRuleContextChangedHandler, addScrolledHandler, addShowContextMenuHandler, addSnapAlignCandidate, addStyleName, addVisibilityChangedHandler, adjustForContent, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateHide, animateHide, animateHide, animateHide, animateMove, animateMove, animateMove, animateMove, animateRect, animateRect, animateRect, animateRect, animateResize, animateResize, animateResize, animateResize, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateShow, animateShow, animateShow, animateShow, animateShow, animateShow, animateShow, asSGWTComponent, blur, bringToFront, clear, clearExplicitTabIndex, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsEventTarget, containsFocus, containsPoint, containsPoint, dataContextChanged, deparent, depeer, disable, doValueDictation, doVoiceCommand, enable, encloses, focus, focusAfterGroup, focusAtEnd, focusInNextTabElement, focusInPreviousTabElement, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAdaptiveHeightPriority, getAdaptiveWidthPriority, getAlwaysManageFocusNavigation, getAlwaysShowScrollbars, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideEffect, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeLayoutMode, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaHandleID, getAriaRole, getAriaStateDefaults, getAutoMaskComponents, getAutoParent, getAutoPopulateData, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBorderRadius, getBottom, getById, getByJSObject, getByLocalId, getCanAcceptDrop, getCanAdaptHeight, getCanAdaptWidth, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanHover, getCanSelectText, getCanvasAutoChild, getCanvasItem, getChildren, getChildrenResizeSnapAlign, getChildrenSnapAlign, getChildrenSnapCenterAlign, getChildrenSnapEdgeAlign, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getClassName, getComponentMask, getComponentMaskDefaults, getContentElement, getContents, getContextMenu, getCorrectZoomOverflow, getCursor, getDataContext, getDataPath, getDefaultHeight, getDefaultWidth, getDefiningProperty, getDefiningPropertyName, getDefiningPropertyNameOptions, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDisableTouchScrollingForDrag, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragMaskType, getDragMaxHeight, getDragMaxWidth, getDragMinHeight, getDragMinWidth, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragTargetAsString, getDragType, getDropTarget, getDropTargetAsString, getDropTypes, getDropTypesAsString, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getEditNode, getEditProxy, getElement, getElement, getEnableWhen, getEndLine, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFloatingScrollbars, getFormItemAutoChild, getForwardSVGeventsToObject, getFullDataPath, getGroupBorderCSS, getGroupLabelBackgroundColor, getGroupLabelStyleName, getGroupPadding, getGroupTitle, getHeight, getHeightAsString, 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, getWidth, getWidthAsString, 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, 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, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollTo, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAdaptHeightByCustomizer, setAdaptiveHeightPriority, setAdaptiveWidthPriority, setAdaptWidthByCustomizer, setAllowExternalFilters, setAlwaysManageFocusNavigation, setAlwaysShowScrollbars, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideEffect, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeLayoutMode, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaRole, setAriaState, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setAutoHeight, setAutoMaskComponents, setAutoParent, setAutoPopulateData, setAutoResizeAutoChildAttributes, setAutoResizeIcons, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBorderRadius, setBottom, setCanAcceptDrop, setCanAdaptHeight, setCanAdaptWidth, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setChildren, setChildrenResizeSnapAlign, setChildrenSnapAlign, setChildrenSnapCenterAlign, setChildrenSnapEdgeAlign, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setComponentMaskDefaults, setContents, setContextMenu, setCorrectZoomOverflow, setCursor, setDataContext, setDataPath, setDefaultHeight, setDefaultPageSpace, setDefaultProperties, setDefaultShowCustomScrollbars, setDefaultWidth, setDefiningProperty, setDefiningPropertyNameOptions, setDisabled, setDisabledCursor, setDisableTouchScrollingForDrag, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragMaskType, setDragMaxHeight, setDragMaxWidth, setDragMinHeight, setDragMinWidth, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragTarget, setDragType, setDropTarget, setDropTarget, setDropTypes, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setEditMode, setEditMode, setEditMode, setElement, setEnableWhen, setEndLine, setExtraSpace, setFacetId, setFloatingScrollbars, setForwardSVGeventsToObject, setGroupBorderCSS, setGroupLabelBackgroundColor, setGroupLabelStyleName, setGroupPadding, setGroupTitle, setHeight, setHeight, 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, setWidth, setWidth, setWidth100, setWorkflows, setZIndex, shouldDragScroll, show, showClickMask, showComponentMask, showComponentMask, showNextTo, showNextTo, showNextTo, showNextTo, showPendingMarker, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, startDebuggingOverflow, stopDebuggingOverflow, supportsValueDictation, supportsVoiceCommands, updateChildTabPosition, updateChildTabPositions, updateEditNode, updateHover, updateHover, updateShadow, updateTabPositionForDraw, visibleAtPoint, willAcceptDropMethods inherited from class com.smartgwt.client.widgets.BaseWidget
addDrawHandler, addDynamicProperty, addDynamicProperty, addDynamicProperty, addDynamicProperty, applyFactoryProperties, clearDynamicProperty, completeCreation, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hasAutoAssignedID, hasDynamicProperty, hashCode, initNativeObject, internalSetID, internalSetID, isConfigOnly, isCreated, isDrawn, isFactoryCreated, onBind, onDestroy, onDraw, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setDefaultProperties, setDragTracker, setFactoryCreated, setID, setJavaScriptObject, setLogicalStructure, setLogicalStructure, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setScClassName, toStringMethods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEventsMethods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEventMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
-
Constructor Details
-
RibbonGroup
public RibbonGroup() -
RibbonGroup
-
-
Method Details
-
getOrCreateRef
-
changeAutoChildDefaults
Changes the defaults for Canvas AutoChildren namedautoChildName.- Parameters:
autoChildName- name of an AutoChild to customize the defaults for.defaults- Canvas defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties. For usage tips on this param, seeSGWTProperties.- See Also:
-
changeAutoChildDefaults
Changes the defaults for FormItem AutoChildren namedautoChildName.- Parameters:
autoChildName- name of an AutoChild to customize the defaults for.defaults- FormItem defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties. For usage tips on this param, seeSGWTProperties.- See Also:
-
create
- Overrides:
createin classToolStripGroup
-
setAutoSizeToTitle
By default,RibbonGroupsare assigned a minimum width that allows the entire title to be visible. To prevent this behavior and have group-titles cut off when they're wider than the buttons they contain, set this attribute to false- Parameters:
autoSizeToTitle- New autoSizeToTitle value. Default value is true- Returns:
RibbonGroupinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getAutoSizeToTitle
By default,RibbonGroupsare assigned a minimum width that allows the entire title to be visible. To prevent this behavior and have group-titles cut off when they're wider than the buttons they contain, set this attribute to false- Returns:
- Current autoSizeToTitle value. Default value is true
-
getBody
HLayout autoChild that manages multipleVLayoutscontaining controls.This component is an AutoChild named "body". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current body value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setBodyConstructor
Smart GWT class for the body.Note : This is an advanced setting
- Parameters:
bodyConstructor- New bodyConstructor value. Default value is "HLayout"- Returns:
RibbonGroupinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getBodyConstructor
Smart GWT class for the body.- Returns:
- Current bodyConstructor value. Default value is "HLayout"
-
getColumnLayout
Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists. SeeUsing AutoChildrenfor details.AutoChild VLayouts created automatically by groups. Each manages a single column of child controls in the group. Child controls that support
rowSpanmay specify it in order to occupy more than one row in a single column. SeenumRowsfor related information.- Returns:
- null
-
setControls
The array of controls to show in this group.
If this method is called after the component has been drawn/initialized: Clears the array of controls and then adds the passed array to this group, creating newcolumnsas necessary, according to each control'srowSpanattribute and the group'snumRowsattribute.- Parameters:
controls- an array of widgets to add to this group. Default value is null- Returns:
RibbonGroupinstance, for chaining setter calls
-
getControls
The array of controls to show in this group.- Returns:
- Current controls value. Default value is null
-
setEditProxyConstructor
public RibbonGroup setEditProxyConstructor(String editProxyConstructor) throws IllegalStateException Default class used to construct theEditProxyfor this component when the component isfirst placed into edit mode.- Overrides:
setEditProxyConstructorin classLayout- Parameters:
editProxyConstructor- New editProxyConstructor value. Default value is "RibbonGroupEditProxy"- Returns:
RibbonGroupinstance, 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 classLayout- Returns:
- Current editProxyConstructor value. Default value is "RibbonGroupEditProxy"
- See Also:
-
getLabel
AutoChildLabelused to display thetitle textfor this group.Can be customized via the standard
com.smartgwt.client.types.AutoChildpattern, and various convenience APIs exist for configuring it after initial draw: seesetShowTitle,setTitle,setTitleAlign,setTitleHeight,setTitleOrientationandsetTitleStyle.This component is an AutoChild named "label". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current label value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setLabelConstructor
Smart GWT class for thetitle labelAutoChild.Note : This is an advanced setting
- Parameters:
labelConstructor- New labelConstructor value. Default value is "Label"- Returns:
RibbonGroupinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getLabelConstructor
Smart GWT class for thetitle labelAutoChild.- Returns:
- Current labelConstructor value. Default value is "Label"
-
getLabelLayout
HLayout autoChild that houses thelabelin which thetitle textis displayed.This can be customized via the standard
com.smartgwt.client.types.AutoChildpattern.This component is an AutoChild named "labelLayout". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current labelLayout value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
getNewControlDefaults
Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists. SeeUsing AutoChildrenfor details.Properties used by
createControlwhen creating new controls.- Returns:
- null
-
setNumRows
The number of rows of controls to display in each column. Each control will take one row in acolumnLayoutby default, but those that support the feature may specifyrowSpanto override that.Note that settings like this, which affect the group's layout, are not applied directly if changed at runtime - a call to
reflowControlswill force the group to reflow.- Parameters:
numRows- New numRows value. Default value is 1- Returns:
RibbonGroupinstance, for chaining setter calls
-
getNumRows
public int getNumRows()The number of rows of controls to display in each column. Each control will take one row in acolumnLayoutby default, but those that support the feature may specifyrowSpanto override that.Note that settings like this, which affect the group's layout, are not applied directly if changed at runtime - a call to
reflowControlswill force the group to reflow.- Returns:
- Current numRows value. Default value is 1
-
setRowHeight
The height of rows in each column.- Parameters:
rowHeight- New rowHeight value. Default value is 26- Returns:
RibbonGroupinstance, for chaining setter calls
-
getRowHeight
public int getRowHeight()The height of rows in each column.- Returns:
- Current rowHeight value. Default value is 26
-
setStyleName
CSS class applied to this RibbonGroup.- Overrides:
setStyleNamein classCanvas- Parameters:
styleName- New styleName value. Default value is "ribbonGroup"- See Also:
-
getStyleName
CSS class applied to this RibbonGroup.- Overrides:
getStyleNamein classCanvas- Returns:
- Current styleName value. Default value is "ribbonGroup"
- See Also:
-
setTitle
The title text to display in this group'stitle label.
If this method is called after the component has been drawn/initialized: Sets thetextto display in this group'stitle labelafter initial draw. -
getTitle
The title text to display in this group'stitle label. -
setTitleAlign
Controls the horizontal alignment of the group'stitle-text, within itslabel. Setting this attribute overrides the default specified bygroupTitleAlignon the containingRibbonBar.
If this method is called after the component has been drawn/initialized: This method forcibly sets the horizontal alignment of thetitle-text, within thetitle label, after initial draw.- Parameters:
titleAlign- the new alignment for the text, left or right. Default value is "center"- Returns:
RibbonGroupinstance, for chaining setter calls
-
getTitleAlign
Controls the horizontal alignment of the group'stitle-text, within itslabel. Setting this attribute overrides the default specified bygroupTitleAlignon the containingRibbonBar.- Returns:
- Current titleAlign value. Default value is "center"
-
setTitleHeight
Controls the height of thetitle labelin this group.
If this method is called after the component has been drawn/initialized: This method forcibly sets the height of this group'stitle labelafter initial draw.- Parameters:
titleHeight- the new height for thetitle label. Default value is 18- Returns:
RibbonGroupinstance, for chaining setter calls
-
getTitleHeight
public int getTitleHeight()Controls the height of thetitle labelin this group.- Returns:
- Current titleHeight value. Default value is 18
-
setTitleOrientation
Controls thevertical orientationof this group'stitle label. Setting this attribute overrides the default specified bygroupTitleOrientationon the containingRibbonBar.
If this method is called after the component has been drawn/initialized: This method forcibly sets thevertical orientationof this group'stitle labelafter initial draw.- Parameters:
titleOrientation- the new orientation for the title, either bottom or top. Default value is "top"- Returns:
RibbonGroupinstance, for chaining setter calls
-
getTitleOrientation
Controls thevertical orientationof this group'stitle label. Setting this attribute overrides the default specified bygroupTitleOrientationon the containingRibbonBar.- Returns:
- Current titleOrientation value. Default value is "top"
-
getTitleProperties
Deprecated.set these properties directly via thelabel autoChildAutoChild properties for fine customization of thetitle label.This component is an AutoChild named "titleProperties". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current titleProperties value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setTitleStyle
CSS class applied to thetitle labelin this group.
If this method is called after the component has been drawn/initialized: This method forcibly sets theCSS class namefor this group'stitle labelafter initial draw.- Parameters:
titleStyle- the CSS class to apply to thetitle label. Default value is "ribbonGroupTitle"- Returns:
RibbonGroupinstance, for chaining setter calls- See Also:
-
getTitleStyle
CSS class applied to thetitle labelin this group.- Returns:
- Current titleStyle value. Default value is "ribbonGroupTitle"
- See Also:
-
addControl
Adds a control to thisRibbonGroup, creating a newcolumnas necessary, according to the control'srowSpanvalue and the group'snumRowsvalue.- Parameters:
control- a widget to add to this group
-
addControl
Adds a control to thisRibbonGroup, creating a newcolumnas necessary, according to the control'srowSpanvalue and the group'snumRowsvalue.- Parameters:
control- a widget to add to this groupindex- optional insertion index for this control
-
addControls
Adds an array of controls to this group, creating newcolumnsas necessary, according to each control'srowSpanvalue and the group'snumRowsvalue.- Parameters:
controls- an array of widgets to add to this group
-
createControl
Creates a new control and adds it to this RibbonGroup. The control is created using the autoChild system, according to the specifiedconstructorand the passed properties are applied to it.- Parameters:
properties- properties to apply to the new control
-
createControl
Creates a new control and adds it to this RibbonGroup. The control is created using the autoChild system, according to the specifiedconstructorand the passed properties are applied to it.- Parameters:
properties- properties to apply to the new controlposition- the index at which to insert the new control
-
getControlColumn
Return thecolumn widgetthat contains the passed control.- Parameters:
control- the control to find in this group- Returns:
- the column widget containing the passed control
-
reflowControls
public void reflowControls()Forces this group to reflow following changes to attributes that affect layout, likenumRows. -
removeControl
Removes a control from thisRibbonGroup, destroying an existingcolumnif this is the last widget in that column.- Parameters:
control- a widget to remove from this group
-
setShowTitle
public void setShowTitle(boolean showTitle) This method forcibly shows or hides this group'stitle labelafter initial draw.- Parameters:
showTitle- should the title be shown or hidden?
-
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:
ribbonGroupProperties- 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 classToolStripGroup
-
label autoChild