com.sencha.gxt.widget.core.client.toolbar

Class ToolBar

java.lang.Object

Widget

com.sencha.gxt.widget.core.client.Component

com.sencha.gxt.widget.core.client.container.Container

com.sencha.gxt.widget.core.client.container.ResizeContainer

com.sencha.gxt.widget.core.client.container.InsertResizeContainer

com.sencha.gxt.widget.core.client.container.BoxLayoutContainer

com.sencha.gxt.widget.core.client.container.HBoxLayoutContainer

com.sencha.gxt.widget.core.client.toolbar.ToolBar

All Implemented Interfaces:

HasGestureRecognizers, HasLayout, AddEvent.HasAddHandlers, BeforeAddEvent.HasBeforeAddHandlers, BeforeHideEvent.HasBeforeHideHandlers, BeforeRemoveEvent.HasBeforeRemoveHandlers, BeforeShowContextMenuEvent.HasBeforeShowContextMenuHandler, BeforeShowEvent.HasBeforeShowHandlers, BlurEvent.HasBlurHandlers, ContainerHandler.HasContainerHandlers, DisableEvent.HasDisableHandlers, EnableEvent.HasEnableHandlers, FocusEvent.HasFocusHandlers, HideEvent.HasHideHandlers, MoveEvent.HasMoveHandlers, OverflowEvent.HasOverflowHandlers, RemoveEvent.HasRemoveHandlers, ShowContextMenuEvent.HasShowContextMenuHandler, ShowEvent.HasShowHandlers, HasFocusSupport, HasItemId

Direct Known Subclasses:

ButtonBar, PagingToolBar

public class ToolBar
extends HBoxLayoutContainer

A standard tool bar.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ToolBar.ToolBarAppearance

Nested classes/interfaces inherited from class com.sencha.gxt.widget.core.client.container.HBoxLayoutContainer

HBoxLayoutContainer.HBoxLayoutAlign, HBoxLayoutContainer.HBoxLayoutContainerAppearance

Nested classes/interfaces inherited from class com.sencha.gxt.widget.core.client.container.BoxLayoutContainer

BoxLayoutContainer.BoxLayoutContainerAppearance, BoxLayoutContainer.BoxLayoutData, BoxLayoutContainer.BoxLayoutPack

Field Summary

Fields

Modifier and Type	Field and Description
protected int	horizontalSpacing
protected int	minButtonWidth
protected int	verticalSpacing

Fields inherited from class com.sencha.gxt.widget.core.client.container.HBoxLayoutContainer

enableOverflow, handlerRegistration, hasOverflow, hBoxLayoutAlign, hiddens, logger, loopHeightMap, loopWidthMap, more, moreMenu, moreMenuEnableScrolling, moreMenuItems, PROVIDE_MENU_TEXT_DATA_KEY, triggerWidth, widthMap

Fields inherited from class com.sencha.gxt.widget.core.client.container.BoxLayoutContainer

adjustForFlexRemainder, appearance, pack, padding, scrollOffset

Fields inherited from class com.sencha.gxt.widget.core.client.container.ResizeContainer

forceLayoutCommand, forceLayoutOnResize, hadLayoutRunning, layoutCommand, layoutRequiredThisEventLoop, layoutRunning

Fields inherited from class com.sencha.gxt.widget.core.client.container.Container

children, widgetMap

Fields inherited from class com.sencha.gxt.widget.core.client.Component

adjustSize, allowTextSelection, cacheSizes, contextMenu, contextMenuGestureRecognizer, dataMap, deferHeight, disableContextMenu, disabled, disabledStyle, disableEvents, ensureVisibilityOnSizing, focusManagerSupport, gestureRecognizers, height, hidden, hideMode, itemId, lastSize, layer, left, mask, maskMessage, monitorWindowResize, overElements, pageX, pageY, resizeHandler, shadow, shadowPosition, shim, stateful, stateId, tabIndex, toolTip, toolTipConfig, top, width, windowResizeDelay, windowResizeTask

Constructor Summary

Constructors

Constructor and Description
ToolBar() Creates a new tool bar.
ToolBar(ToolBar.ToolBarAppearance appearance) Creates a new tool bar.

Method Summary

Modifier and Type	Method and Description
ToolBar.ToolBarAppearance	getAppearance() Returns the tool bar appearance.
int	getHorizontalSpacing() Returns the child widget horizontal spacing.
int	getMinButtonWidth() Returns the minimum button width.
int	getVerticalSpacing() Returns the child widget vertical spacing.
protected void	onFocus(Event event)
protected void	onInsert(int index, Widget child)
void	setHorizontalSpacing(int spacing) Sets the horizontal spacing between child items (defaults to 0).
void	setMinButtonWidth(int minWidth) Sets the minimum width for any buttons in the toolbar.
void	setSpacing(int spacing) Sets both the horizontal and vertical spacing between child items (defaults to 2).
protected void	setSpacingLayoutData(Widget child)
void	setVerticalSpacing(int spacing) Sets the vertical spacing between child items (defaults to 0).

Methods inherited from class com.sencha.gxt.widget.core.client.container.HBoxLayoutContainer

add, add, add, add, add, add, addMenuItem, addMenuItemToMoreMenu, addMenuItemToMoreMenuSeparatorItem, addOverflowHandler, addWidgetToMenu, addWidgetToMenuButtonGroup, addWidgetToMenuFromMoreMenuItemsMap, addWidgetToMenuLabelToolItem, addWidgetToMenuSplitButton, addWidgetToMenuTextButton, addWidgetToMenuToggleButton, addWithMenu, addWithMenu, addWithUiBinder, afterAddWidgetToMenu, clearMenu, doLayout, getHBoxLayoutAlign, getWidgetWidth, hideComponent, initMore, insert, isEnableOverflow, isHidden, isMoreMenuEnableScrolling, onBeforeShow, onOverflow, onRemove, onUnoverflow, remove, setEnableOverflow, setHBoxLayoutAlign, setMoreMenuEnableScrolling, unhideComponent

Methods inherited from class com.sencha.gxt.widget.core.client.container.BoxLayoutContainer

getContainerTarget, getPack, getPadding, getScrollOffset, insert, isAdjustForFlexRemainder, setAdjustForFlexRemainder, setPack, setPadding, setScrollOffset

Methods inherited from class com.sencha.gxt.widget.core.client.container.ResizeContainer

applyLayout, applyLayout, forceLayout, forceLayoutOnChildren, forceLayoutOnChildren, getLeftRightMargins, getParentLayoutWidget, getSideMargins, getTopBottomMargins, isLayoutRunning, isOrWasLayoutRunning, isParentLayoutRunning, isWidgetVisible, onBeforeDoLayout, onLoad, onResize, onResize, parentIsOrWasLayoutRunning

Methods inherited from class com.sencha.gxt.widget.core.client.container.Container

addAddHandler, addBeforeAddHandler, addBeforeRemoveHandler, addContainerHandler, addRemoveHandler, adjustIndex, adopt, checkIndexBoundsForInsertion, clear, disable, doAttachChildren, doDetachChildren, doPhysicalAttach, doPhysicalDetach, enable, ensureGroupingHandlerRegistration, findWidget, getAttachException, getChildren, getDetachException, getItemByItemId, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, iterator, onWidgetHide, onWidgetShow, orphan

Methods inherited from class com.sencha.gxt.widget.core.client.Component

addBeforeHideHandler, addBeforeShowContextMenuHandler, addBeforeShowHandler, addBlurHandler, addDisableHandler, addEnableHandler, addFocusHandler, addGestureRecognizer, addHideHandler, addMoveHandler, addResizeHandler, addShowContextMenuHandler, addShowHandler, addStyleDependentName, addStyleOnOver, adjustPosition, adjustSize, applyState, assertAfterRender, assertPreRender, blur, clearSizeCache, disableContextMenu, disableEvents, enableEvents, fireCancellableEvent, fireEvent, focus, getData, getElement, getFocusEl, getFocusSupport, getGestureRecognizer, getGestureRecognizerCount, getHideMode, getId, getItemId, getOffsetHeight, getOffsetWidth, getPositionEl, getShadow, getShadowPosition, getStateId, getTabIndex, getToolTip, hide, hideShadow, hideToolTip, isAdjustSize, isAllowTextSelection, isAutoHeight, isAutoWidth, isDeferHeight, isEnabled, isMonitorWindowResize, isRendered, isStateful, isVisible, isVisible, makeVisible, mask, mask, notifyHide, notifyShow, onAfterFirstAttach, onAttach, onBlur, onBrowserEvent, onDetach, onDisable, onEnable, onHide, onHideContextMenu, onPosition, onRightClick, onShow, onShowContextMenu, onTouch, onUnload, onWindowResize, removeGestureRecognizer, removeStyleDependentName, removeStyleOnOver, removeToolTip, restoreVisible, setAdjustSize, setAllowTextSelection, setBorders, setBounds, setBounds, setContextMenu, setData, setDeferHeight, setEnabled, setHeight, setHeight, setHideMode, setId, setItemId, setMonitorWindowResize, setPagePosition, setPixelSize, setPosition, setShadow, setShadowPosition, setSize, setStateful, setStateId, setStyleDependentName, setTabIndex, setToolTip, setToolTipConfig, setVisible, setWidth, setWidth, show, sync, syncSize, unmask

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

minButtonWidth

protected int minButtonWidth

verticalSpacing

protected int verticalSpacing

horizontalSpacing

protected int horizontalSpacing

Constructor Detail

ToolBar

public ToolBar()

Creates a new tool bar.

ToolBar

public ToolBar(ToolBar.ToolBarAppearance appearance)

Creates a new tool bar.

Parameters:

appearance - the tool bar appearance

Method Detail

getAppearance

public ToolBar.ToolBarAppearance getAppearance()

Returns the tool bar appearance.

Overrides:

getAppearance in class HBoxLayoutContainer

Returns:

the appearance

getHorizontalSpacing

public int getHorizontalSpacing()

Returns the child widget horizontal spacing.

Returns:

the spacing in pixels

getMinButtonWidth

public int getMinButtonWidth()

Returns the minimum button width.

Returns:

the minimum button width

getVerticalSpacing

public int getVerticalSpacing()

Returns the child widget vertical spacing.

Returns:

the spacing in pixels

setMinButtonWidth

public void setMinButtonWidth(int minWidth)

Sets the minimum width for any buttons in the toolbar.

Parameters:

minWidth - the minimum button width to set

setVerticalSpacing

public void setVerticalSpacing(int spacing)

Sets the vertical spacing between child items (defaults to 0). Spacing is implemented using layout data margins. Margins will be overridden by layout if spacing >= 0. Set spacing to -1 to prevent margin calculations.

Parameters:

spacing - the spacing

setHorizontalSpacing

public void setHorizontalSpacing(int spacing)

Sets the horizontal spacing between child items (defaults to 0). Spacing is implemented using layout data margins. Margins will be overridden by layout if spacing >= 0. Set spacing to -1 to prevent margin calculations.

Parameters:

spacing - the spacing

setSpacing

public void setSpacing(int spacing)

Sets both the horizontal and vertical spacing between child items (defaults to 2). Spacing is implemented using layout data margins. Margins will be overridden by layout if spacing >= 0. Set spacing to -1 to prevent margin calculations.

Parameters:

spacing - the spacing

onFocus

protected void onFocus(Event event)

Overrides:

onFocus in class Component

onInsert

protected void onInsert(int index,
                        Widget child)

Overrides:

onInsert in class HBoxLayoutContainer

setSpacingLayoutData

protected void setSpacingLayoutData(Widget child)