de.swm.commons.mobile.client.widgets.toolbar

Class ToolbarPanel

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.google.gwt.user.client.ui.Composite

de.swm.commons.mobile.client.widgets.SWMMobileWidgetBase

de.swm.commons.mobile.client.widgets.toolbar.ToolbarPanel

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.IsRenderable, com.google.gwt.user.client.ui.IsWidget, IsSWMMobileWidget, Iterable<com.google.gwt.user.client.ui.Widget>

public class ToolbarPanel
extends SWMMobileWidgetBase
implements com.google.gwt.user.client.ui.HasWidgets

A Toolbar can be places on the bottom of an IPage. Typically a toolbar contains typical use cases of a mobile application.

 
                        
                                
                                
                                        
                                                Tab1 Content
                                        
                                
                        
                        
                                
                                
                                        
                                                Tab2 Content
                                        
                                
                        
                        
                                
                                
                                        
                                                Tab3 Content
                                        
                                
                        
                
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ToolbarPanel.ToolbarSelectionHandler Tool bas selection handler.

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.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

Constructors

Constructor and Description
ToolbarPanel() Default constructor.
ToolbarPanel(int indexToSelectOnInit) Constructor using a selection index.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(com.google.gwt.user.client.ui.Widget w)
void	addSelectionHandler(ToolbarPanel.ToolbarSelectionHandler handler) Adds a selection handler.
void	clear() Removes all child widgets.
void	fireSelectionChangeUpdate(int index) Fires an selection changed update.
ToolbarContent	getContent() Returns the content of the first element in the toolbar.
com.google.gwt.user.client.ui.HasWidgets	getContentArea()
int	getSelectedToolIndex()
Iterator<com.google.gwt.user.client.ui.Widget>	iterator()
void	onInitialLoad() When the widget is initially loaded.
boolean	remove(com.google.gwt.user.client.ui.Widget w)
void	removeSelectionHandler(ToolbarPanel.ToolbarSelectionHandler handler) Removes the selection handler.
void	selectTool(int index) Selects a tool on index position
void	selectTool(int index, boolean enforceSelection) Selects a tool on index position
void	selectTool(int index, boolean enforceSelection, boolean fireUpdate) Selects a tool on index position
void	setBadgeValue(int index, String badgeValue) Sets the text to be displayed in form of a 'badge' on top of the header image of a tool.
void	setHeaderVisible(boolean visible) True if the header should be visible.
void	unselectAllElements()

Methods inherited from class de.swm.commons.mobile.client.widgets.SWMMobileWidgetBase

onLoad, onTransitionEnd, setSecondaryStyle

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

claimElement, getWidget, initializeClaimedElement, initWidget, isAttached, onAttach, onBrowserEvent, onDetach, render, render, resolvePotentialElement, setWidget

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

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isOrWasAttached, 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, 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

Constructor Detail

ToolbarPanel

public ToolbarPanel()

Default constructor.

ToolbarPanel

@UiConstructor
public ToolbarPanel(int indexToSelectOnInit)

Constructor using a selection index.

Parameters:

indexToSelectOnInit - the selected tab (tool)

Method Detail

unselectAllElements

public void unselectAllElements()

add

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

Specified by:

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

clear

public void clear()

Removes all child widgets.

Specified by:

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

onInitialLoad

public void onInitialLoad()

Description copied from class: SWMMobileWidgetBase

When the widget is initially loaded.

Specified by:

onInitialLoad in interface IsSWMMobileWidget

Overrides:

onInitialLoad in class SWMMobileWidgetBase

addSelectionHandler

public void addSelectionHandler(ToolbarPanel.ToolbarSelectionHandler handler)

Adds a selection handler.

Parameters:

handler - the selection handler.

removeSelectionHandler

public void removeSelectionHandler(ToolbarPanel.ToolbarSelectionHandler handler)

Removes the selection handler.

Parameters:

handler - the handler.

getContent

public ToolbarContent getContent()

Returns the content of the first element in the toolbar.

Returns:

the content.

getContentArea

public com.google.gwt.user.client.ui.HasWidgets getContentArea()

selectTool

public void selectTool(int index)

Selects a tool on index position

Parameters:

index - the index position

selectTool

public void selectTool(int index,
              boolean enforceSelection)

Selects a tool on index position

Parameters:

index - the index position

enforceSelection - the selection will always be updated

selectTool

public void selectTool(int index,
              boolean enforceSelection,
              boolean fireUpdate)

Selects a tool on index position

Parameters:

index - the index position

enforceSelection - the selection will always be updated

fireUpdate - if true event handlers will be notified

fireSelectionChangeUpdate

public void fireSelectionChangeUpdate(int index)

Fires an selection changed update.

Parameters:

index - the selected index

getSelectedToolIndex

public int getSelectedToolIndex()

setBadgeValue

public void setBadgeValue(int index,
                 String badgeValue)

Sets the text to be displayed in form of a 'badge' on top of the header image of a tool.

Parameters:

index - the index position

badgeValue - text to be displayed as badge. If badgeValue is null, the badge is hidden.

iterator

public Iterator<com.google.gwt.user.client.ui.Widget> iterator()

Specified by:

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

Specified by:

iterator in interface Iterable<com.google.gwt.user.client.ui.Widget>

remove

public boolean remove(com.google.gwt.user.client.ui.Widget w)

Specified by:

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

setHeaderVisible

public void setHeaderVisible(boolean visible)

True if the header should be visible.

Parameters:

visible - true if visible