com.vaadin.addon.touchkit.ui
Class NavigationBar

java.lang.Object
  com.vaadin.server.AbstractClientConnector
      com.vaadin.ui.AbstractComponent
          com.vaadin.ui.AbstractComponentContainer
              com.vaadin.addon.touchkit.ui.NavigationBar

All Implemented Interfaces:

com.vaadin.event.MethodEventSource, com.vaadin.server.ClientConnector, com.vaadin.server.Sizeable, com.vaadin.shared.Connector, com.vaadin.ui.Component, com.vaadin.ui.ComponentContainer, com.vaadin.ui.HasComponents, com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, Serializable, Iterable<com.vaadin.ui.Component>

public class NavigationBar
extends com.vaadin.ui.AbstractComponentContainer

The NavigationBar component sits at the top of a NavigationView and contains an XHTML caption in the middle as well as component slots (most commonly for buttons) on the left and right. A back-button is automatically shown if a previousView is available.

Commonly used in a NavigationView.

See Also:

NavigationView, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.ui.HasComponents

com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, com.vaadin.ui.HasComponents.ComponentAttachEvent, com.vaadin.ui.HasComponents.ComponentAttachListener, com.vaadin.ui.HasComponents.ComponentDetachEvent, com.vaadin.ui.HasComponents.ComponentDetachListener

Nested classes/interfaces inherited from interface com.vaadin.ui.Component

com.vaadin.ui.Component.ErrorEvent, com.vaadin.ui.Component.Event, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Component.Listener

Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

com.vaadin.server.ClientConnector.AttachEvent, com.vaadin.server.ClientConnector.AttachListener, com.vaadin.server.ClientConnector.ConnectorErrorEvent, com.vaadin.server.ClientConnector.DetachEvent, com.vaadin.server.ClientConnector.DetachListener

Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable

com.vaadin.server.Sizeable.Unit

Field Summary

Fields inherited from interface com.vaadin.server.Sizeable

SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

Constructor Summary

NavigationBar()
Constructs a new NavigationBar

Method Summary

void	addComponent(com.vaadin.ui.Component c) Deprecated. Not supported by NavigationBar.
int	getComponentCount()
Iterator<com.vaadin.ui.Component>	getComponentIterator()
com.vaadin.ui.Component	getLeftComponent()
com.vaadin.ui.Component	getPreviousView() Gets the previousView that will be navigated to when the back button is pressed.
com.vaadin.ui.Component	getRightComponent()
NavigationBarState	getState()
Iterator<com.vaadin.ui.Component>	iterator()
void	replaceComponent(com.vaadin.ui.Component oldComponent, com.vaadin.ui.Component newComponent) Deprecated. Not supported by NavigationBar.
void	setLeftComponent(com.vaadin.ui.Component c) Sets the component in the left slot.
void	setPreviousView(com.vaadin.ui.Component component) Sets which view (component) will be navigated to when the back button is pressed.
void	setRightComponent(com.vaadin.ui.Component c) Sets the component in the right slot.

Methods inherited from class com.vaadin.ui.AbstractComponentContainer

addComponentAttachListener, addComponentDetachListener, addComponents, addListener, addListener, fireComponentAttachEvent, fireComponentDetachEvent, moveComponentsFrom, removeAllComponents, removeComponent, removeComponentAttachListener, removeComponentDetachListener, removeListener, removeListener, setHeight, setWidth

Methods inherited from class com.vaadin.ui.AbstractComponent

addListener, addShortcutListener, addStyleName, attach, beforeClientResponse, detach, findAncestor, fireComponentErrorEvent, fireComponentEvent, focus, getActionManager, getCaption, getComponentError, getData, getDebugId, getDescription, getErrorMessage, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getState, getStyleName, getWidth, getWidthUnits, isConnectorEnabled, isEnabled, isImmediate, isReadOnly, isVisible, removeListener, removeShortcutListener, removeStyleName, setCaption, setComponentError, setData, setDebugId, setDescription, setEnabled, setHeight, setIcon, setId, setImmediate, setLocale, setParent, setPrimaryStyleName, setReadOnly, setSizeFull, setSizeUndefined, setStyleName, setVisible, setWidth

Methods inherited from class com.vaadin.server.AbstractClientConnector

addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addMethodInvocationToQueue, createState, encodeState, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getListeners, getResource, getRpcManager, getRpcProxy, getSession, getStateType, getUI, handleConnectorRequest, hasListeners, isAttached, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, attach, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isReadOnly, isVisible, removeListener, removeStyleName, setCaption, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setReadOnly, setStyleName, setVisible

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, beforeClientResponse, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.server.Sizeable

getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setSizeFull, setSizeUndefined, setWidth

Constructor Detail

NavigationBar

public NavigationBar()

Constructs a new NavigationBar

Method Detail

getState

public NavigationBarState getState()

Overrides:

getState in class com.vaadin.ui.AbstractComponent

setLeftComponent

public void setLeftComponent(com.vaadin.ui.Component c)

Sets the component in the left slot. This place most commonly features the back button. Setting the left component replaces any existing components, including the back button.

Parameters:

c - the component to put in the left slot.

getLeftComponent

public com.vaadin.ui.Component getLeftComponent()

Returns:

the component in the left slot or null if the none is set

setRightComponent

public void setRightComponent(com.vaadin.ui.Component c)

Sets the component in the right slot.

Parameters:

c - the component to put in the right slot.

getRightComponent

public com.vaadin.ui.Component getRightComponent()

Returns:

the component in the right slot or null if none set

setPreviousView

public void setPreviousView(com.vaadin.ui.Component component)

Sets which view (component) will be navigated to when the back button is pressed.

Parameters:

component - the previous view

getPreviousView

public com.vaadin.ui.Component getPreviousView()

Gets the previousView that will be navigated to when the back button is pressed.

Returns:

the previousView or null if none set

See Also:

setPreviousView(Component)

addComponent

@Deprecated
public void addComponent(com.vaadin.ui.Component c)

Deprecated. Not supported by NavigationBar.

Specified by:

addComponent in interface com.vaadin.ui.ComponentContainer

Overrides:

addComponent in class com.vaadin.ui.AbstractComponentContainer

Throws:

UnsupportedOperationException

replaceComponent

@Deprecated
public void replaceComponent(com.vaadin.ui.Component oldComponent,
                                        com.vaadin.ui.Component newComponent)

Deprecated. Not supported by NavigationBar.

Throws:

UnsupportedOperationException

getComponentIterator

public Iterator<com.vaadin.ui.Component> getComponentIterator()

Specified by:

getComponentIterator in interface com.vaadin.ui.ComponentContainer

Overrides:

getComponentIterator in class com.vaadin.ui.AbstractComponentContainer

iterator

public Iterator<com.vaadin.ui.Component> iterator()

getComponentCount

public int getComponentCount()