org.exoplatform.gwtframework.ui.client.component
Class Toolbar

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.google.gwt.user.client.ui.Panel
              com.google.gwt.user.client.ui.ComplexPanel
                  com.google.gwt.user.client.ui.FlowPanel
                      org.exoplatform.gwtframework.ui.client.component.Toolbar

All Implemented Interfaces:

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.HasVisibility, com.google.gwt.user.client.ui.HasWidgets, com.google.gwt.user.client.ui.HasWidgets.ForIsWidget, com.google.gwt.user.client.ui.IndexedPanel, com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget, com.google.gwt.user.client.ui.InsertPanel, com.google.gwt.user.client.ui.InsertPanel.ForIsWidget, com.google.gwt.user.client.ui.IsWidget, java.lang.Iterable<com.google.gwt.user.client.ui.Widget>

public class Toolbar
extends com.google.gwt.user.client.ui.FlowPanel

Created by The eXo Platform SAS .

Version:

$

Author:

Vitaliy Gulyy

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

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.InsertPanel

com.google.gwt.user.client.ui.InsertPanel.ForIsWidget

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets

com.google.gwt.user.client.ui.HasWidgets.ForIsWidget

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Toolbar()
Create instance of this Toolbar.

Toolbar(java.lang.String id)
Create instance of Toolbar with specified ID.

Method Summary

void	add(ToolbarItem item) Add ToolbarItem to this Toolbar.
ToolbarItem	addDelimiter() Add delimiter to the left
ToolbarItem	addDelimiter(boolean rightDocking) Add delimiter to the specified side.
ToolbarItem	addItem(com.google.gwt.user.client.ui.Widget widget) Adds a new item to the left of the toolbar.
ToolbarItem	addItem(com.google.gwt.user.client.ui.Widget widget, boolean rightDocking) Adds a new item to the specified side of the toolbar.
void	clear() Remove all items from toolbar.
java.lang.String	getId() Get toolbar's id.
void	hideDuplicatedDelimiters() Hide duplicated delimiters.
void	setBackgroundImage(java.lang.String imageURL) Set background image URL.
void	setItemsTopPadding(int itemsTopPadding) Set padding of toolbar items from the top.
void	showAllItems() Show all items.

Methods inherited from class com.google.gwt.user.client.ui.FlowPanel

add, insert, insert

Methods inherited from class com.google.gwt.user.client.ui.ComplexPanel

add, adjustIndex, checkIndexBoundsForAccess, checkIndexBoundsForInsertion, getChildren, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, insert, insert, iterator, remove, remove

Methods inherited from class com.google.gwt.user.client.ui.Panel

add, adopt, adopt, disown, doAttachChildren, doDetachChildren, orphan, remove

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, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString, unsinkEvents

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.gwt.user.client.ui.InsertPanel.ForIsWidget

add

Methods inherited from interface com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget

getWidgetIndex

Methods inherited from interface com.google.gwt.user.client.ui.IndexedPanel

getWidget, getWidgetCount, getWidgetIndex, remove

Constructor Detail

Toolbar

public Toolbar()

Create instance of this Toolbar.

Toolbar

public Toolbar(java.lang.String id)

Create instance of Toolbar with specified ID.

Parameters:

id - toolbar's id

Method Detail

addDelimiter

public ToolbarItem addDelimiter()

Add delimiter to the left

Returns:

new instance of ToolbarItem, which represents an toolbar delimiter.

addDelimiter

public ToolbarItem addDelimiter(boolean rightDocking)

Add delimiter to the specified side.

Parameters:

rightDocking - true to add delimiter to the right, false to add delimiter to the left.

Returns:

new instance of ToolbarItem, which represents an toolbar delimiter.

addItem

public ToolbarItem addItem(com.google.gwt.user.client.ui.Widget widget)

Adds a new item to the left of the toolbar.

Parameters:

widget - widget of new item

Returns:

new instance of ToolbarItem, which is represents a wrapper over added widget.

addItem

public ToolbarItem addItem(com.google.gwt.user.client.ui.Widget widget,
                           boolean rightDocking)

Adds a new item to the specified side of the toolbar.

Parameters:

widget - widget of new item

rightDocking - true to add new item to the right, false to add new item to the left.

Returns:

new instance of ToolbarItem, which is represents a wrapper over added widget.

add

public void add(ToolbarItem item)

Add ToolbarItem to this Toolbar.

Parameters:

item -

clear

public void clear()

Remove all items from toolbar.

Specified by:

clear in interface com.google.gwt.user.client.ui.HasWidgets

Overrides:

clear in class com.google.gwt.user.client.ui.FlowPanel

getId

public java.lang.String getId()

Get toolbar's id.

Returns:

toolbar's id

hideDuplicatedDelimiters

public void hideDuplicatedDelimiters()

Hide duplicated delimiters.

setBackgroundImage

public void setBackgroundImage(java.lang.String imageURL)

Set background image URL.

Parameters:

imageURL - background image URL

setItemsTopPadding

public void setItemsTopPadding(int itemsTopPadding)

Set padding of toolbar items from the top.

Parameters:

itemsTopPadding - padding of toolbar items from the top.

showAllItems

public void showAllItems()

Show all items.