com.extjs.gxt.ui.client.widget.toolbar
Class ToolBar

java.lang.Object
  extended by com.google.gwt.user.client.ui.UIObject
      extended by com.google.gwt.user.client.ui.Widget
          extended by com.extjs.gxt.ui.client.widget.Component
              extended by com.extjs.gxt.ui.client.widget.BoxComponent
                  extended by com.extjs.gxt.ui.client.widget.Container<Component>
                      extended by com.extjs.gxt.ui.client.widget.toolbar.ToolBar
All Implemented Interfaces:
Observable, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.IsWidget
Direct Known Subclasses:
ButtonBar, PagingToolBar

public class ToolBar
extends Container<Component>

A standard tool bar.

Events:
BeforeAdd : ToolBarEvent(container, item, index)
Fires before a item is added or inserted. Listeners can cancel the action by calling BaseEvent.setCancelled(boolean).
BeforeRemove : ToolBarEvent(container, item)
Fires before a item is removed. Listeners can cancel the action by calling BaseEvent.setCancelled(boolean).
Add : ToolBarEvent(container, item, index)
Fires after a item has been added or inserted.
Remove : ToolBarEvent(container, item)
Fires after a item has been removed.
Inherited Events:
BoxComponent Move
BoxComponent Resize
Component Enable
Component Disable
Component BeforeHide
Component Hide
Component BeforeShow
Component Show
Component Attach
Component Detach
Component BeforeRender
Component Render
Component BrowserEvent
Component BeforeStateRestore
Component StateRestore
Component BeforeStateSave
Component SaveState
CSS:
x-toolbar (the tool bar)


Nested Class Summary
 
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled
 
Field Summary
 
Fields inherited from class com.extjs.gxt.ui.client.widget.Container
attachChildren, enableLayout, layoutExecuted, layoutNeeded, layoutOnAttach, layoutOnChange
 
Fields inherited from class com.extjs.gxt.ui.client.widget.BoxComponent
adjustSize, cacheSizes, ensureVisibilityOnSizing, height, lastSize, layer, shim, width
 
Fields inherited from class com.extjs.gxt.ui.client.widget.Component
afterRender, attachables, baseStyle, disabled, disabledStyle, disableTextSelection, dummy, focusable, hidden, mask, maskMessage, maskMessageStyleName, monitorWindowResize, rendered, resizeHandler, setElementRender, stateId, swallowEvents, toolTip, windowResizeDelay, windowResizeTask
 
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
 
Constructor Summary
ToolBar()
          Creates a new tool bar.
 
Method Summary
 boolean add(Component item)
          Adds a item to the tool bar.
protected  ComponentEvent createComponentEvent(com.google.gwt.user.client.Event event)
           
protected  ContainerEvent createContainerEvent(Component item)
           
 Style.HorizontalAlignment getAlignment()
          Returns the alignment of the items.
 ToolBarLayout getLayout()
           
 int getMinButtonWidth()
          Returns the min button width.
 int getSpacing()
          Returns the child component spacing.
 boolean insert(Component item, int index)
          Inserts a item into the tool bar.
 boolean isEnableOverflow()
          Returns true if overflow is enabled.
 boolean layout()
          Executes the container's layout.
 void onComponentEvent(ComponentEvent ce)
          Any events a component receives will be forwarded to this method.
protected  void onFocus(ComponentEvent ce)
           
protected  void onRender(com.google.gwt.user.client.Element target, int index)
          Subclasses must override and ensure setElement is called for lazy rendered components.
 boolean remove(Component item)
          Removes a component from the tool bar.
 void setAlignment(Style.HorizontalAlignment alignment)
          Sets the alignment of the items.
 void setEnableOverflow(boolean enableOverflow)
          True to show a drop down icon when the available width is less than the required width (defaults to true).
 void setMinButtonWidth(int minButtonWidth)
          Sets the minWidth for any Component of type Button
 void setSpacing(int spacing)
          Sets the spacing between child items (defaults to 0).
 
Methods inherited from class com.extjs.gxt.ui.client.widget.Container
adjustIndex, adopt, disable, doAttachChildren, doDetachChildren, doLayout, doLayout, enable, findItem, getItem, getItemByItemId, getItemCount, getItems, getLayoutTarget, getWidget, indexOf, isLayoutNeeded, iterator, layout, notifyHide, notifyShow, onAfterLayout, onAttach, onBeforeLayoutExcecuted, onInsert, onLayoutExcecuted, onRemove, orphan, remove, removeAll, removeAll, scrollIntoView, setLayout, setLayoutNeeded, setLayoutOnChange, wrapWidget
 
Methods inherited from class com.extjs.gxt.ui.client.widget.BoxComponent
adjustPosition, adjustSize, afterRender, getBounds, getHeight, getHeight, getPosition, getPositionEl, getResizeEl, getShadow, getShadowOffset, getShadowPosition, getSize, getWidth, getWidth, hideShadow, hideShim, hideUnders, isAutoHeight, isAutoWidth, isDeferHeight, isShim, onHide, onPosition, onResize, onShow, onUnload, setAutoHeight, setAutoWidth, setBounds, setBounds, setDeferHeight, setHeight, setHeight, setPagePosition, setPagePosition, setPixelSize, setPosition, setShadow, setShadowOffset, setShadowPosition, setShim, setSize, setSize, setWidth, setWidth, sync, syncSize
 
Methods inherited from class com.extjs.gxt.ui.client.widget.Component
addAttachable, addListener, addPlugin, addStyleName, addStyleOnOver, addWidgetListener, applyState, assertAfterRender, assertPreRender, beforeRender, blur, clearState, createObservable, createStyles, disableContextMenu, disableEvents, disableTextSelection, el, enableEvents, fireEvent, fireEvent, fireEvent, fly, focus, frame, getAriaSupport, getBaseStyle, getBorders, getContextMenu, getData, getElement, getFocusEl, getFocusSupport, getHideMode, getId, getItemId, getListeners, getModel, getObservable, getPlugins, getState, getStateId, getTabIndex, getTitle, getToolTip, getWindowResizeDelay, hasListeners, hasListeners, hide, hideToolTip, initState, isDisabledEvents, isDisableTextSelection, isEnabled, isMasked, isMonitorWindowResize, isRendered, isStateful, isVisible, isVisible, mask, mask, mask, onBrowserEvent, onDetach, onDetachHelper, onDisable, onEnable, onEnsureDebugId, onHideContextMenu, onLoad, onRightClick, onShowContextMenu, onWindowResize, previewEvent, recalculate, removeAllListeners, removeAttachagle, removeFromParent, removeListener, removeStyleName, removeStyleOnOver, removeSwallow, removeToolTip, removeWidgetListener, render, render, repaint, saveState, setAriaRole, setAriaState, setAriaSupport, setBorders, setContextMenu, setData, setEl, setElement, setElement, setEnabled, setFiresEvents, setHideMode, setId, setIntStyleAttribute, setItemId, setModel, setMonitorWindowResize, setParent, setStateful, setStateId, setStyleAttribute, setStyleName, setTabIndex, setTitle, setToolTip, setToolTip, setVisible, setWindowResizeDelay, setZIndex, show, sinkEvents, swallowEvent, swallowEvent, toString, unframe, unmask
 
Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, setLayoutData
 
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, removeStyleDependentName, setElement, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent, unsinkEvents
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ToolBar

public ToolBar()
Creates a new tool bar.

Method Detail

add

public boolean add(Component item)
Adds a item to the tool bar.

Overrides:
add in class Container<Component>
Parameters:
item - the item to add

getAlignment

public Style.HorizontalAlignment getAlignment()
Returns the alignment of the items.

Returns:
the alignment

getLayout

public ToolBarLayout getLayout()
Overrides:
getLayout in class Container<Component>

getMinButtonWidth

public int getMinButtonWidth()
Returns the min button width.

Returns:
the min button width

getSpacing

public int getSpacing()
Returns the child component spacing.

Returns:
the spacing

insert

public boolean insert(Component item,
                      int index)
Inserts a item into the tool bar.

Overrides:
insert in class Container<Component>
Parameters:
item - the item to add
index - the insert location

isEnableOverflow

public boolean isEnableOverflow()
Returns true if overflow is enabled.

Returns:
the overflow state

layout

public boolean layout()
Description copied from class: Container
Executes the container's layout. If a layout has not been set a FlowLayout will be used.

Overrides:
layout in class Container<Component>
Returns:
true if layout was executed.

onComponentEvent

public void onComponentEvent(ComponentEvent ce)
Description copied from class: Component
Any events a component receives will be forwarded to this method. Subclasses should override as needed. The Component.onBrowserEvent(com.google.gwt.user.client.Event) method should not be overridden or modified.

Overrides:
onComponentEvent in class Component
Parameters:
ce - the base event

remove

public boolean remove(Component item)
Removes a component from the tool bar.

Overrides:
remove in class Container<Component>
Parameters:
item - the item to be removed
Returns:
true if the item was removed

setAlignment

public void setAlignment(Style.HorizontalAlignment alignment)
Sets the alignment of the items. (defaults to LEFT, pre-render).

Parameters:
alignment - the alignment to set

setEnableOverflow

public void setEnableOverflow(boolean enableOverflow)
True to show a drop down icon when the available width is less than the required width (defaults to true).

Parameters:
enableOverflow - true to enable overflow support

setMinButtonWidth

public void setMinButtonWidth(int minButtonWidth)
Sets the minWidth for any Component of type Button

Parameters:
minButtonWidth - the min button width to set

setSpacing

public void setSpacing(int spacing)
Sets the spacing between child items (defaults to 0).

Parameters:
spacing - the spacing

createComponentEvent

protected ComponentEvent createComponentEvent(com.google.gwt.user.client.Event event)
Overrides:
createComponentEvent in class BoxComponent

createContainerEvent

protected ContainerEvent createContainerEvent(Component item)
Overrides:
createContainerEvent in class Container<Component>

onFocus

protected void onFocus(ComponentEvent ce)

onRender

protected void onRender(com.google.gwt.user.client.Element target,
                        int index)
Description copied from class: Component
Subclasses must override and ensure setElement is called for lazy rendered components.

Overrides:
onRender in class Component
Parameters:
target - the target element
index - the insert location