net.sf.mmm.client.ui.gwt.widgets

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

net.sf.mmm.client.ui.gwt.widgets.Toolbar

All Implemented Interfaces:

com.google.gwt.event.dom.client.FocusHandler, com.google.gwt.event.dom.client.HasAllFocusHandlers, com.google.gwt.event.dom.client.HasBlurHandlers, com.google.gwt.event.dom.client.HasFocusHandlers, com.google.gwt.event.dom.client.KeyUpHandler, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.EventHandler, 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, Iterable<com.google.gwt.user.client.ui.Widget>, ButtonContainer

Direct Known Subclasses:

RichTextToolbar

public class Toolbar
extends com.google.gwt.user.client.ui.FlowPanel
implements ButtonContainer, com.google.gwt.event.dom.client.HasAllFocusHandlers, com.google.gwt.event.dom.client.FocusHandler, com.google.gwt.event.dom.client.KeyUpHandler

This is a Widget representing a toolbar. It renders a horizontal bar that is supposed to contain buttons with icons. You can directly add buttons. To put buttons into a ButtonGroup you may also use startGroup() and endGroup().

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

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

Modifier and Type	Field and Description
private List<com.google.gwt.user.client.ui.ButtonBase>	buttonList
private ButtonGroup	currentButtonGroup The current ButtonGroup or null.
private com.google.gwt.user.client.ui.ButtonBase	focusButton

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
Toolbar() The constructor.

Method Summary

Modifier and Type	Method and Description
void	add(com.google.gwt.user.client.ui.Widget widget)
com.google.gwt.event.shared.HandlerRegistration	addBlurHandler(com.google.gwt.event.dom.client.BlurHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addFocusHandler(com.google.gwt.event.dom.client.FocusHandler handler)
boolean	endGroup() This method ends a previously started group.
void	onFocus(com.google.gwt.event.dom.client.FocusEvent event)
void	onKeyUp(com.google.gwt.event.dom.client.KeyUpEvent event)
private void	setFocusButton(com.google.gwt.user.client.ui.ButtonBase button)
void	startGroup() This method starts a new button-group and adds it to this container.
private void	updateFocus(com.google.gwt.user.client.ui.ButtonBase button) Updates the focus to the given button.

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

clear, insert, insert

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

add, 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, 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, unsinkEvents

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

buttonList

private final List<com.google.gwt.user.client.ui.ButtonBase> buttonList

See Also:

add(Widget)

focusButton

private com.google.gwt.user.client.ui.ButtonBase focusButton

See Also:

add(Widget)

currentButtonGroup

private ButtonGroup currentButtonGroup

The current ButtonGroup or null.

Constructor Detail

Toolbar

public Toolbar()

The constructor.

Method Detail

addBlurHandler

public com.google.gwt.event.shared.HandlerRegistration addBlurHandler(com.google.gwt.event.dom.client.BlurHandler handler)

Specified by:

addBlurHandler in interface com.google.gwt.event.dom.client.HasBlurHandlers

addFocusHandler

public com.google.gwt.event.shared.HandlerRegistration addFocusHandler(com.google.gwt.event.dom.client.FocusHandler handler)

Specified by:

addFocusHandler in interface com.google.gwt.event.dom.client.HasFocusHandlers

onFocus

public void onFocus(com.google.gwt.event.dom.client.FocusEvent event)

Specified by:

onFocus in interface com.google.gwt.event.dom.client.FocusHandler

updateFocus

private void updateFocus(com.google.gwt.user.client.ui.ButtonBase button)

Updates the focus to the given button.

Parameters:

button - is the button to focus.

onKeyUp

public void onKeyUp(com.google.gwt.event.dom.client.KeyUpEvent event)

Specified by:

onKeyUp in interface com.google.gwt.event.dom.client.KeyUpHandler

add

public void add(com.google.gwt.user.client.ui.Widget widget)

Specified by:

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

Specified by:

add in interface com.google.gwt.user.client.ui.InsertPanel

Overrides:

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

setFocusButton

private void setFocusButton(com.google.gwt.user.client.ui.ButtonBase button)

Parameters:

button - is the button to set a active descendant and receiver of the focus (via tab).

startGroup

public void startGroup()
                throws IllegalStateException

This method starts a new button-group and adds it to this container. All buttons (or widgets) added to this container until the button-group was ended will be added to the current button-group. A button-group is realized by ButtonGroup.

Specified by:

startGroup in interface ButtonContainer

Throws:

IllegalStateException - if the previous button-group has NOT been ended.

See Also:

ButtonContainer.endGroup()

endGroup

public boolean endGroup()

This method ends a previously started group.

Specified by:

endGroup in interface ButtonContainer

Returns:

true if the current button-group has successfully been ended, false otherwise (if there was no such button-group).