com.smartgwt.client.widgets.toolbar
Class ToolStrip

java.lang.Object
  extended by com.google.gwt.user.client.ui.UIObject
      extended by com.google.gwt.user.client.ui.Widget
          extended by com.smartgwt.client.widgets.BaseWidget
              extended by com.smartgwt.client.widgets.Canvas
                  extended by com.smartgwt.client.widgets.layout.Layout
                      extended by com.smartgwt.client.widgets.toolbar.ToolStrip
All Implemented Interfaces:
HasAttachHandlers, HasHandlers, EventListener, HasVisibility, IsWidget, LogicalStructure, 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, HasScrolledHandlers, HasShowContextMenuHandlers, HasVisibilityChangedHandlers, HasMembersChangedHandlers
Direct Known Subclasses:
RibbonBar

public class ToolStrip
extends Layout

Base class for creating toolstrips like those found in browsers and office applications: a mixed set of controls including icon buttons, radio button groups, menus, comboBoxes, spacers, status displays and drop-down selects.

All of the above components are placed in the members array to form a ToolStrip. Note that the FormItems mentioned above (ComboBox and drop-down selects) need to be placed within a DynamicForm as usual.

The special strings "separator" and "resizer" can be placed in the members array to create separators and resizers respectively.

Also see the ToolStrips Example example in the Feature Explorer.


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, id, nativeObject, scClassName
 
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
 
Constructor Summary
ToolStrip()
           
ToolStrip(JavaScriptObject jsObj)
           
 
Method Summary
 void addButton(ToolStripButton button)
          Add a button to the ToolStrip.
 void addButton(ToolStripButton button, int position)
          Add a button to the ToolStrip.
 void addFill()
          Adds a LayoutSpacer to the ToolStrip to take up space such like a normal member, without actually drawing anything.
 void addFormItem(FormItem formItem)
          Add a FormItem to the ToolStrip.
 void addFormItem(FormItem formItem, int position)
          Add a FormItem to the ToolStrip.
 void addMenuButton(ToolStripMenuButton button)
          Add a menu button to the ToolStrip.
 void addMenuButton(ToolStripMenuButton button, int position)
          Add a menu button to the ToolStrip.
 void addResizer()
          Add a resizer
 void addSeparator()
          Add a separator.
 void addSpacer(int space)
          Add an extra space to the right of the previously added ToolStrip element.
 void addSpacer(ToolStripSpacer toolStripSpacer)
          Add an extra space to the right of the previously added ToolStrip element.
static void changeAutoChildDefaults(String autoChildName, Canvas defaults)
          Changes the defaults for Canvas AutoChildren named autoChildName.
static void changeAutoChildDefaults(String autoChildName, FormItem defaults)
          Changes the defaults for FormItem AutoChildren named autoChildName.
protected  JavaScriptObject create()
           
 DynamicForm getFormWrapper()
          Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists.
 Alignment getGroupTitleAlign()
          If set, this attribute affects the alignment of the titles in ToolStripGroups.
 VerticalAlignment getGroupTitleOrientation()
          If set, this attribute affects the orientation of the titles in ToolStripGroups.
 com.smartgwt.logicalstructure.core.LogicalStructureObject getLogicalStructure()
           
static ToolStrip getOrCreateRef(JavaScriptObject jsObj)
           
 String getResizeBarClass()
          Customized resizeBar with typical appearance for a ToolStrip.
 int getResizeBarSize()
          Thickness of the resizeBars in pixels.
 String getSeparatorClass()
          Class to create when the string "separator" appears in members.
 int getSeparatorSize()
          Separator thickness in pixels
 Boolean getShowGroupTitle()
          If set, this attribute affects whether ToolStripGroups in this ToolStrip show their header control.
 Boolean getVertical()
          Indicates whether the components are drawn horizontally from left to right (false), or vertically from top to bottom (true).
 String getVerticalStyleName()
          Default stylename to use if this.vertical is true.
static void setDefaultProperties(ToolStrip toolStripProperties)
          Class level method to set the default properties of this class.
 void setGroupTitleAlign(Alignment groupTitleAlign)
          If set, this attribute affects the alignment of the titles in ToolStripGroups.
 void setGroupTitleOrientation(VerticalAlignment groupTitleOrientation)
          If set, this attribute affects the orientation of the titles in ToolStripGroups.
 com.smartgwt.logicalstructure.core.LogicalStructureObject setLogicalStructure(com.smartgwt.logicalstructure.widgets.toolbar.ToolStripLogicalStructure s)
           
 void setResizeBarClass(String resizeBarClass)
          Customized resizeBar with typical appearance for a ToolStrip.
 void setResizeBarSize(int resizeBarSize)
          Thickness of the resizeBars in pixels.
 void setSeparatorClass(String separatorClass)
          Class to create when the string "separator" appears in members.
 void setSeparatorSize(int separatorSize)
          Separator thickness in pixels
 void setShowGroupTitle(Boolean showGroupTitle)
          If set, this attribute affects whether ToolStripGroups in this ToolStrip show their header control.
 void setVertical(Boolean vertical)
          Indicates whether the components are drawn horizontally from left to right (false), or vertically from top to bottom (true).
 void setVerticalStyleName(String verticalStyleName)
          Default stylename to use if this.vertical is true.
 
Methods inherited from class com.smartgwt.client.widgets.layout.Layout
addMember, addMember, addMember, addMember, addMemberPostCreate, addMemberPostCreate, addMemberPreCreate, addMemberPreCreate, addMembers, addMembers, addMembersChangedHandler, getAnimateMembers, getAnimateMemberTime, getCanDropComponents, getDefaultResizeBars, getDropComponent, getDropLine, getDropLineThickness, getDropPosition, getEnforcePolicy, getHPolicy, getLayoutBottomMargin, getLayoutLeftMargin, getLayoutMargin, getLayoutRightMargin, getLayoutTopMargin, getLeaveScrollbarGap, getLocateMembersBy, getLocateMembersType, getManagePercentBreadth, getMember, getMember, getMemberDefaultBreadth, getMemberNumber, getMemberNumber, getMemberOverlap, getMembers, getMembersMargin, getMinMemberSize, getOverflow, getPaddingAsLayoutMargin, getReverseOrder, getShowDragPlaceHolder, getShowDropLines, getStackZIndex, getVPolicy, hasMember, hideDropLine, hideMember, hideMember, onInit_Layout, onInit, reflow, reflow, reflowNow, removeMember, removeMembers, removeMembers, reorderMember, reorderMembers, setAlign, setAlign, setAnimateMembers, setAnimateMemberTime, setCanDropComponents, setDefaultLayoutAlign, setDefaultLayoutAlign, setDefaultProperties, setDefaultResizeBars, setDropLineProperties, setDropLineThickness, setEnforcePolicy, setHPolicy, setLayoutBottomMargin, setLayoutLeftMargin, setLayoutMargin, setLayoutRightMargin, setLayoutTopMargin, setLeaveScrollbarGap, setLocateMembersBy, setLocateMembersType, setLogicalStructure, setManagePercentBreadth, setMemberOverlap, setMembers, setMembersMargin, setMinMemberSize, setOverflow, setPaddingAsLayoutMargin, setPlaceHolderDefaults, setPlaceHolderProperties, setReverseOrder, setShowDragPlaceHolder, setShowDropLines, setStackZIndex, setVisibleMember, setVPolicy, showMember, showMember
 
Methods inherited from class com.smartgwt.client.widgets.Canvas
addChild, addChild, addChild, addChild, addChild, 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, addScrolledHandler, addShowContextMenuHandler, addStyleName, addVisibilityChangedHandler, adjustForContent, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, 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, asSGWTComponent, blur, bringToFront, clear, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsFocus, containsPoint, containsPoint, deparent, depeer, disable, enable, focus, focusInNextTabElement, focusInPreviousTabElement, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaRole, getAutoDraw, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBottom, getById, getByJSObject, getByLocalId, getCanAcceptDrop, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanHover, getCanSelectText, getCanvasAutoChild, getCanvasItem, getChildren, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getClassName, getContentElement, getContents, getContextMenu, getCursor, getDataPath, getDefaultHeight, getDefaultWidth, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragMaskType, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragType, getDropTypes, getDropTypesAsString, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getElement, getElement, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFormItemAutoChild, getFullDataPath, getGroupBorderCSS, getGroupLabelBackgroundColor, getGroupLabelStyleName, getGroupTitle, getHeight, getHeightAsString, getHideUsingDisplayNone, getHoverAlign, getHoverAutoDestroy, getHoverComponent, getHoverDelay, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapOrigin, getHSnapOrigin, getHSnapPosition, getHSnapPosition, getHtmlElement, getHtmlPosition, getImage, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getKeepInParentRect, getLayoutAlign, getLeft, getLeftAsString, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getMargin, getMasterCanvas, getMasterElement, getMatchElement, getMaxHeight, getMaxWidth, getMenuConstructor, getMinHeight, getMinWidth, getMomentumScrollMinSpeed, getMouseStillDownDelay, getMouseStillDownInitialDelay, getNextZIndex, getNoDoubleClicks, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOuterElement, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getParentCanvas, getParentElement, getPeers, getPercentBox, getPercentSource, getPosition, getPrefix, getPrintChildrenAbsolutelyPositioned, getPrintHTML, getPrintHTML, getPrompt, getRect, getRedrawOnResize, getResizeBarTarget, getResizeFrom, getRight, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowDepth, getShadowImage, getShadowOffset, getShadowSoftness, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowHover, getShowHoverComponents, getShowResizeBar, getShowShadow, getShrinkElementOnHide, getSkinImgDir, getSnapAxis, getSnapEdge, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapResizeToGrid, getSnapTo, getSnapToGrid, getSnapVDirection, getSnapVGap, getStyleName, getTabIndex, getTestInstance, getTitle, getTooltip, getTop, getTopAsString, getTopElement, getUseBackMask, getUseDragMask, getUseNativeDrag, getUseOpacityFilter, getValuesManager, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWidth, getVSnapOrigin, getVSnapOrigin, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getZIndex, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideContextMenu, imgHTML, imgHTML, imgHTML, intersects, isDirty, isDisabled, isDrawn, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, markForDestroy, markForRedraw, markForRedraw, moveAbove, moveBelow, moveBy, moveTo, onAttach, onDetach, parentResized, printComponents, redraw, redraw, removeChild, removeChild, removePeer, removePeer, resizeBy, resizeTo, resizeTo, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAllowExternalFilters, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaRole, setAriaState, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setAutoDraw, setAutoHeight, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBottom, setCanAcceptDrop, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setChildren, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setContents, setContextMenu, setCursor, setDataPath, setDefaultHeight, setDefaultProperties, setDefaultWidth, setDisabled, setDisabledCursor, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragMaskType, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragType, setDropTypes, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setElement, setExtraSpace, setFacetId, setGroupBorderCSS, setGroupLabelBackgroundColor, setGroupLabelStyleName, setGroupTitle, setHeight, setHeight, setHeight, setHeight100, setHideUsingDisplayNone, setHoverAlign, setHoverAutoDestroy, setHoverDelay, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlElement, setHtmlPosition, setImage, setImage, setInitHandler, setIsGroup, setKeepInParentRect, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeft, setLeft, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLogicalStructure, setMargin, setMatchElement, setMaxHeight, setMaxWidth, setMenuConstructor, setMinHeight, setMinWidth, setMomentumScrollMinSpeed, setMouseStillDownDelay, setMouseStillDownInitialDelay, setNeverUseFilters, setNoDoubleClicks, setOpacity, setPadding, setPageLeft, setPageTop, setParentCanvas, setParentElement, setPeers, setPercentBox, setPercentSource, setPosition, setPrefix, setPrintChildrenAbsolutelyPositioned, setPrompt, setRect, setRect, setRedrawOnResize, setResizeBarTarget, setResizeFrom, setResizeFrom, setRight, setScrollbarConstructor, setScrollbarSize, setShadowDepth, setShadowImage, setShadowOffset, setShadowSoftness, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowHover, setShowHoverComponents, setShowResizeBar, setShowShadow, setShrinkElementOnHide, setSkinImgDir, setSmoothFade, setSnapAxis, setSnapEdge, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToGrid, setSnapTo, setSnapToGrid, setSnapVDirection, setSnapVGap, setStyleName, setTabIndex, setTitle, setTooltip, setTop, setTop, setUseBackMask, setUseDragMask, setUseNativeDrag, setUseOpacityFilter, setValuesManager, setVisibility, setVisible, setWidth, setWidth, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showClickMask, showNextTo, showNextTo, showNextTo, showNextTo, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, updateEditNode, updateHover, updateHover, updateShadow, visibleAtPoint, willAcceptDrop
 
Methods inherited from class com.smartgwt.client.widgets.BaseWidget
addDrawHandler, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hasAutoAssignedID, hashCode, initNativeObject, internalSetID, internalSetID, isConfigOnly, isCreated, 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, setDragTracker, setID, setJavaScriptObject, setLogicalStructure, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setScClassName, toString
 
Methods 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
 
Methods 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, sinkBitlessEvent, unsinkEvents
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 

Constructor Detail

ToolStrip

public ToolStrip()

ToolStrip

public ToolStrip(JavaScriptObject jsObj)
Method Detail

getOrCreateRef

public static ToolStrip getOrCreateRef(JavaScriptObject jsObj)

changeAutoChildDefaults

public static void changeAutoChildDefaults(String autoChildName,
                                           Canvas defaults)
Changes the defaults for Canvas AutoChildren named autoChildName.

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.
See Also:
AutoChildUsage

changeAutoChildDefaults

public static void changeAutoChildDefaults(String autoChildName,
                                           FormItem defaults)
Changes the defaults for FormItem AutoChildren named autoChildName.

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.
See Also:
AutoChildUsage

create

protected JavaScriptObject create()
Overrides:
create in class Layout

getFormWrapper

public DynamicForm getFormWrapper()
Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists. See Using AutoChildren for details.

DynamicForm instance created by ToolStrip.addFormItem to contain form items for display in this toolStrip. Each time addFormItem() is run, a new formWrapper autoChild will be created, picking up properties according to the standard com.smartgwt.client.types.AutoChild pattern.

Returns:
null

setGroupTitleAlign

public void setGroupTitleAlign(Alignment groupTitleAlign)
                        throws IllegalStateException
If set, this attribute affects the alignment of the titles in ToolStripGroups. You can override this at the individual ToolStripGroup level.

Parameters:
groupTitleAlign - Default value is "center"
Throws:
IllegalStateException - this property cannot be changed after the component has been created

getGroupTitleAlign

public Alignment getGroupTitleAlign()
If set, this attribute affects the alignment of the titles in ToolStripGroups. You can override this at the individual ToolStripGroup level.

Returns:
Alignment

setGroupTitleOrientation

public void setGroupTitleOrientation(VerticalAlignment groupTitleOrientation)
                              throws IllegalStateException
If set, this attribute affects the orientation of the titles in ToolStripGroups. You can override this at the individual ToolStripGroup level.

Parameters:
groupTitleOrientation - Default value is "top"
Throws:
IllegalStateException - this property cannot be changed after the component has been created

getGroupTitleOrientation

public VerticalAlignment getGroupTitleOrientation()
If set, this attribute affects the orientation of the titles in ToolStripGroups. You can override this at the individual ToolStripGroup level.

Returns:
VerticalAlignment

setResizeBarClass

public void setResizeBarClass(String resizeBarClass)
                       throws IllegalStateException
Customized resizeBar with typical appearance for a ToolStrip.

Overrides:
setResizeBarClass in class Layout
Parameters:
resizeBarClass - Default value is "ToolStripResizer"
Throws:
IllegalStateException - this property cannot be changed after the component has been created
See Also:
Splitbar, ImgSplitbar, Layout.setResizeBarSize(int)

getResizeBarClass

public String getResizeBarClass()
Customized resizeBar with typical appearance for a ToolStrip.

Overrides:
getResizeBarClass in class Layout
Returns:
String
See Also:
Splitbar, ImgSplitbar, Layout.getResizeBarSize()

setResizeBarSize

public void setResizeBarSize(int resizeBarSize)
                      throws IllegalStateException
Thickness of the resizeBars in pixels.

Note : This is an advanced setting

Overrides:
setResizeBarSize in class Layout
Parameters:
resizeBarSize - Default value is 14
Throws:
IllegalStateException - this property cannot be changed after the component has been created

getResizeBarSize

public int getResizeBarSize()
Thickness of the resizeBars in pixels.

Overrides:
getResizeBarSize in class Layout
Returns:
int

setSeparatorClass

public void setSeparatorClass(String separatorClass)
                       throws IllegalStateException
Class to create when the string "separator" appears in members.

Parameters:
separatorClass - Default value is "ToolStripSeparator"
Throws:
IllegalStateException - this property cannot be changed after the component has been created

getSeparatorClass

public String getSeparatorClass()
Class to create when the string "separator" appears in members.

Returns:
String

setSeparatorSize

public void setSeparatorSize(int separatorSize)
                      throws IllegalStateException
Separator thickness in pixels

Parameters:
separatorSize - Default value is 8
Throws:
IllegalStateException - this property cannot be changed after the component has been created

getSeparatorSize

public int getSeparatorSize()
Separator thickness in pixels

Returns:
int

setShowGroupTitle

public void setShowGroupTitle(Boolean showGroupTitle)
                       throws IllegalStateException
If set, this attribute affects whether ToolStripGroups in this ToolStrip show their header control. You can override this at the individual ToolStripGroup level.

Parameters:
showGroupTitle - Default value is true
Throws:
IllegalStateException - this property cannot be changed after the component has been created

getShowGroupTitle

public Boolean getShowGroupTitle()
If set, this attribute affects whether ToolStripGroups in this ToolStrip show their header control. You can override this at the individual ToolStripGroup level.

Returns:
Boolean

setVertical

public void setVertical(Boolean vertical)
                 throws IllegalStateException
Indicates whether the components are drawn horizontally from left to right (false), or vertically from top to bottom (true).

Overrides:
setVertical in class Layout
Parameters:
vertical - Default value is false
Throws:
IllegalStateException - this property cannot be changed after the component has been created
See Also:
Appearance overview and related methods

getVertical

public Boolean getVertical()
Indicates whether the components are drawn horizontally from left to right (false), or vertically from top to bottom (true).

Overrides:
getVertical in class Layout
Returns:
Boolean
See Also:
Appearance overview and related methods

setVerticalStyleName

public void setVerticalStyleName(String verticalStyleName)
                          throws IllegalStateException
Default stylename to use if this.vertical is true. If unset, the standard styleName will be used for both vertical and horizontal toolstrips.

Note that this property only applies to the widget at init time. To modify the styleName after this widget has been initialized, you should simply call setStyleName() rather than updating this property.

Parameters:
verticalStyleName - See CSSClassName . Default value is null
Throws:
IllegalStateException - this property cannot be changed after the component has been created
See Also:
Appearance overview and related methods

getVerticalStyleName

public String getVerticalStyleName()
Default stylename to use if this.vertical is true. If unset, the standard styleName will be used for both vertical and horizontal toolstrips.

Note that this property only applies to the widget at init time. To modify the styleName after this widget has been initialized, you should simply call setStyleName() rather than updating this property.

Returns:
See CSSClassName
See Also:
Appearance overview and related methods

setDefaultProperties

public static void setDefaultProperties(ToolStrip toolStripProperties)
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:
toolStripProperties - properties that should be used as new defaults when instances of this class are created

addFormItem

public void addFormItem(FormItem formItem)
Add a FormItem to the ToolStrip.

Parameters:
formItem - the formItem

addFormItem

public void addFormItem(FormItem formItem,
                        int position)
Add a FormItem to the ToolStrip.

Parameters:
formItem - the FormItem
position - the position in the layout to place newMember (starts with 0); if omitted, it will be added at the last position

addButton

public void addButton(ToolStripButton button)
Add a button to the ToolStrip.

Parameters:
button - the toolstrip button

addButton

public void addButton(ToolStripButton button,
                      int position)
Add a button to the ToolStrip.

Parameters:
button - the button
position - the position in the layout to place newMember (starts with 0); if omitted, it will be added at the last position

addMenuButton

public void addMenuButton(ToolStripMenuButton button)
Add a menu button to the ToolStrip.

Parameters:
button - the toolstrip menu button

addMenuButton

public void addMenuButton(ToolStripMenuButton button,
                          int position)
Add a menu button to the ToolStrip.

Parameters:
button - the menu button
position - the position in the layout to place newMember (starts with 0); if omitted, it will be added at the last position

addSpacer

public void addSpacer(int space)
Add an extra space to the right of the previously added ToolStrip element. This is a shortcut for addSpacer(ToolStripSpacer).

Parameters:
space - space

addSpacer

public void addSpacer(ToolStripSpacer toolStripSpacer)
Add an extra space to the right of the previously added ToolStrip element.

Parameters:
toolStripSpacer - the toolstip spacer.

addFill

public void addFill()
Adds a LayoutSpacer to the ToolStrip to take up space such like a normal member, without actually drawing anything. This causes the "next" member added to the toolstip to be right / bottom justified depending on the alignment of the ToolStrip.


addSeparator

public void addSeparator()
Add a separator.


addResizer

public void addResizer()
Add a resizer


setLogicalStructure

public com.smartgwt.logicalstructure.core.LogicalStructureObject setLogicalStructure(com.smartgwt.logicalstructure.widgets.toolbar.ToolStripLogicalStructure s)

getLogicalStructure

public com.smartgwt.logicalstructure.core.LogicalStructureObject getLogicalStructure()
Specified by:
getLogicalStructure in interface LogicalStructure
Overrides:
getLogicalStructure in class Layout