de.must.markup

Class MustToolBar

java.lang.Object

de.must.markup.MustToolBar

public abstract class MustToolBar
extends java.lang.Object

Tool bar to be marked up.

Constructor Summary

Constructors

Constructor and Description
MustToolBar(SessionData sessionData) Constructs a new tool bar.

Method Summary

Modifier and Type	Method and Description
protected abstract void	addIndividualItems() Adds individual items to the tool bar.
void	addItem(java.lang.String label, java.lang.Class<? extends Invokable> invokeable) Adds an item to the tool bar using text.
void	addItem(java.lang.String label, java.lang.Class<Invokable> invokeable, java.lang.String toolTipText) Adds an item to the tool bar using text.
void	addItem(ToolBarIcon toolBarIcon, java.lang.Class<? extends Invokable> invokeable) Adds an item to the tool bar using an icon.
void	addItem(ToolBarIcon toolBarIcon, java.lang.Class<? extends Invokable> invokeable, java.lang.String toolTipText) Adds an item to the tool bar using an icon.
void	addItem(ToolbarText toolTextButton, java.lang.Class<? extends Invokable> invokeable)
java.lang.Class<? extends Invokable>	getActionClass(GeneralizedRequest request) Checks if the request is caused by choosing a toolbar options and returns the action class if so.
MustMenu	getItems() Returns the toolbar's items.
protected java.lang.String	getResourceString(java.lang.String resourceKey) Returns the individual application resource of the specified key, which has to be a string.
boolean	isEntitled(MustMenuItem menuItem) Returns true if the current user is entitled to use the specified item.

Methods inherited from class java.lang.Object

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

Constructor Detail

MustToolBar

public MustToolBar(SessionData sessionData)

Constructs a new tool bar.

Parameters:

sessionData - the session's public data

Method Detail

addIndividualItems

protected abstract void addIndividualItems()

Adds individual items to the tool bar.

See Also:

addItem(de.must.markup.ToolBarIcon, java.lang.Class<? extends de.must.markup.Invokable>)

getResourceString

protected java.lang.String getResourceString(java.lang.String resourceKey)

Returns the individual application resource of the specified key, which has to be a string.

Parameters:

resourceKey - the key of the resource to retrieve

Returns:

the found resource

addItem

public void addItem(ToolBarIcon toolBarIcon,
                    java.lang.Class<? extends Invokable> invokeable)

Adds an item to the tool bar using an icon.

Parameters:

toolBarIcon - the tool bar's icon

invokeable - the invokeable to be associated with the icon

addItem

public void addItem(ToolBarIcon toolBarIcon,
                    java.lang.Class<? extends Invokable> invokeable,
                    java.lang.String toolTipText)

Adds an item to the tool bar using an icon.

Parameters:

toolBarIcon - the tool bar's icon

invokeable - the invokeable to be associated with the button

toolTipText - the tool tip text of the button

addItem

public void addItem(ToolbarText toolTextButton,
                    java.lang.Class<? extends Invokable> invokeable)

addItem

public void addItem(java.lang.String label,
                    java.lang.Class<? extends Invokable> invokeable)

Adds an item to the tool bar using text.

Parameters:

label - the information to show

invokeable - the invokeable to be associated with the button

addItem

public void addItem(java.lang.String label,
                    java.lang.Class<Invokable> invokeable,
                    java.lang.String toolTipText)

Adds an item to the tool bar using text.

Parameters:

label - the label of the button to use

invokeable - the invokeable to be associated with the button

toolTipText - the tool tip text of the button

getItems

public MustMenu getItems()

Returns the toolbar's items.

Returns:

the toolbar's items

isEntitled

public boolean isEntitled(MustMenuItem menuItem)

Returns true if the current user is entitled to use the specified item.

Parameters:

menuItem - the menu item to check

Returns:

true if the current user is entitled to use the specified item

getActionClass

public java.lang.Class<? extends Invokable> getActionClass(GeneralizedRequest request)

Checks if the request is caused by choosing a toolbar options and returns the action class if so.

Parameters:

request - the request to check

Returns:

a toolbar action class or null if the request isn't caused by choosing a toolbar option