org.activiti.explorer.ui.custom

Class ToolBar

java.lang.Object

com.vaadin.ui.AbstractComponent

com.vaadin.ui.AbstractComponentContainer

com.vaadin.ui.AbstractLayout

com.vaadin.ui.AbstractOrderedLayout

com.vaadin.ui.HorizontalLayout

org.activiti.explorer.ui.custom.ToolBar

All Implemented Interfaces:

com.vaadin.event.LayoutEvents.LayoutClickNotifier, com.vaadin.event.MethodEventSource, com.vaadin.terminal.Paintable, com.vaadin.terminal.Sizeable, com.vaadin.terminal.VariableOwner, com.vaadin.ui.Component, com.vaadin.ui.ComponentContainer, com.vaadin.ui.Layout, com.vaadin.ui.Layout.AlignmentHandler, com.vaadin.ui.Layout.MarginHandler, com.vaadin.ui.Layout.SpacingHandler, Serializable, EventListener

Direct Known Subclasses:

ManagementMenuBar, ProcessMenuBar, ReportsMenuBar, TaskMenuBar

public class ToolBar
extends com.vaadin.ui.HorizontalLayout

Container for holding ToolbarEntrys.

Author:

Frederik Heremans, Joram Barrez

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.ui.AbstractComponent

com.vaadin.ui.AbstractComponent.ComponentErrorEvent, com.vaadin.ui.AbstractComponent.ComponentErrorHandler

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

com.vaadin.ui.Layout.AlignmentHandler, com.vaadin.ui.Layout.MarginHandler, com.vaadin.ui.Layout.MarginInfo, com.vaadin.ui.Layout.SpacingHandler

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

com.vaadin.ui.ComponentContainer.ComponentAttachEvent, com.vaadin.ui.ComponentContainer.ComponentAttachListener, com.vaadin.ui.ComponentContainer.ComponentDetachEvent, com.vaadin.ui.ComponentContainer.ComponentDetachListener

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

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

Nested classes/interfaces inherited from interface com.vaadin.terminal.Paintable

com.vaadin.terminal.Paintable.RepaintRequestEvent, com.vaadin.terminal.Paintable.RepaintRequestListener

Field Summary

Fields

Modifier and Type	Field and Description
protected List<com.vaadin.ui.Button>	actionButtons
protected List<com.vaadin.ui.Component>	additionalComponents
protected ToolbarEntry	currentEntry
protected String	currentEntryKey
protected Map<String,ToolbarEntry>	entryMap

Fields inherited from class com.vaadin.ui.AbstractOrderedLayout

ALIGNMENT_DEFAULT, components

Fields inherited from class com.vaadin.ui.AbstractLayout

margins

Fields inherited from interface com.vaadin.ui.Layout.AlignmentHandler

ALIGNMENT_BOTTOM, ALIGNMENT_HORIZONTAL_CENTER, ALIGNMENT_LEFT, ALIGNMENT_RIGHT, ALIGNMENT_TOP, ALIGNMENT_VERTICAL_CENTER

Fields inherited from interface com.vaadin.terminal.Sizeable

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

Constructor Summary

Constructors

Constructor and Description
ToolBar()

Method Summary

Methods

Modifier and Type	Method and Description
void	addAdditionalComponent(com.vaadin.ui.Component component)
void	addButton(com.vaadin.ui.Button button) Add a button to the toolbar.
protected void	addEntryComponent(ToolbarEntry entry)
ToolbarPopupEntry	addPopupEntry(String key, String title) Add a new entry, which displays a pop-up-list when clicked.
ToolbarEntry	addToolbarEntry(String key, String title, ToolbarEntry.ToolbarCommand command) Add a new entry to the tool bar.
long	getCount(String key)
String	getCurrentEntryKey()
ToolbarEntry	getEntry(String key) Gets the entry for the given key.
void	removeAllAdditionalComponents()
void	removeAllButtons()
void	setActiveEntry(String key) Set the entry active with the given key.
void	setCount(String key, Long count) Update the count field on the entry with the given key.

Methods inherited from class com.vaadin.ui.AbstractOrderedLayout

addComponent, addComponent, addComponentAsFirst, addListener, getComponent, getComponentAlignment, getComponentCount, getComponentIndex, getComponentIterator, getExpandRatio, isSpacing, isSpacingEnabled, paintContent, removeComponent, removeListener, replaceComponent, setComponentAlignment, setComponentAlignment, setComponentAlignment, setExpandRatio, setSpacing

Methods inherited from class com.vaadin.ui.AbstractLayout

changeVariables, fireClick, getMargin, setMargin, setMargin, setMargin

Methods inherited from class com.vaadin.ui.AbstractComponentContainer

addListener, addListener, attach, detach, fireComponentAttachEvent, fireComponentDetachEvent, moveComponentsFrom, removeAllComponents, removeListener, removeListener, requestRepaintAll, setEnabled, setHeight, setWidth

Methods inherited from class com.vaadin.ui.AbstractComponent

addListener, addListener, addListener, addListener, addListener, addStyleName, childRequestedRepaint, fireComponentErrorEvent, fireComponentEvent, fireEvent, focus, getApplication, getCaption, getComponentError, getData, getDebugId, getDescription, getErrorHandler, getErrorMessage, getHeight, getHeightUnits, getIcon, getListeners, getLocale, getParent, getStyle, getStyleName, getWidth, getWidthUnits, getWindow, handleError, hasListeners, isEnabled, isImmediate, isReadOnly, isVisible, paint, removeListener, removeListener, removeListener, removeListener, removeListener, removeListener, removeStyleName, requestRepaint, requestRepaintRequests, setCaption, setComponentError, setData, setDebugId, setDescription, setErrorHandler, setHeight, setHeight, setHeightUnits, setIcon, setImmediate, setLocale, setParent, setReadOnly, setSizeFull, setSizeUndefined, setStyle, setStyleName, setVisible, setWidth, setWidth, setWidthUnits

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

addListener, addListener, moveComponentsFrom, removeAllComponents, removeListener, removeListener, requestRepaintAll

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, attach, childRequestedRepaint, detach, getApplication, getCaption, getIcon, getLocale, getParent, getStyleName, getWindow, isEnabled, isReadOnly, isVisible, removeListener, removeStyleName, setCaption, setEnabled, setIcon, setParent, setReadOnly, setStyleName, setVisible

Methods inherited from interface com.vaadin.terminal.Paintable

addListener, getDebugId, paint, removeListener, requestRepaint, requestRepaintRequests, setDebugId

Methods inherited from interface com.vaadin.terminal.VariableOwner

isImmediate

Methods inherited from interface com.vaadin.terminal.Sizeable

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

Field Detail

entryMap

protected Map<String,ToolbarEntry> entryMap

currentEntryKey

protected String currentEntryKey

currentEntry

protected ToolbarEntry currentEntry

actionButtons

protected List<com.vaadin.ui.Button> actionButtons

additionalComponents

protected List<com.vaadin.ui.Component> additionalComponents

Constructor Detail

ToolBar

public ToolBar()

Method Detail

addToolbarEntry

public ToolbarEntry addToolbarEntry(String key,
                           String title,
                           ToolbarEntry.ToolbarCommand command)

Add a new entry to the tool bar.

addPopupEntry

public ToolbarPopupEntry addPopupEntry(String key,
                              String title)

Add a new entry, which displays a pop-up-list when clicked. Items of that list can be added on returned ToolbarPopupEntry instance.

addButton

public void addButton(com.vaadin.ui.Button button)

Add a button to the toolbar. The buttons are rendered on the right of the toolbar.

removeAllButtons

public void removeAllButtons()

addAdditionalComponent

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

removeAllAdditionalComponents

public void removeAllAdditionalComponents()

getCount

public long getCount(String key)

setCount

public void setCount(String key,
            Long count)

Update the count field on the entry with the given key.

getEntry

public ToolbarEntry getEntry(String key)

Gets the entry for the given key. Returns null when entry is not present for the given key.

setActiveEntry

public void setActiveEntry(String key)

Set the entry active with the given key. Active entries will have alternative style applied to them.

addEntryComponent

protected void addEntryComponent(ToolbarEntry entry)

getCurrentEntryKey

public String getCurrentEntryKey()