org.drombler.acp.core.action.spi

Interface ToolBarContainer<T,B>

Type Parameters:

T - the GUI-toolkit specific type of a tool bar

B - the GUI-toolkit specific base type of a tool bar button.

public interface ToolBarContainer<T,B>

A GUI-toolkit agnostic service provider interface for tool bar container. A tool bar container can contain multiple tool bars each identified by an unique id. The tool bars can be visible or hidden.

Method Summary

Modifier and Type	Method and Description
void	addToolBar(String toolBarId, PositionableAdapter<T> toolBar) Adds a tool bar to this container.
void	addToolBarButton(String toolBarId, PositionableAdapter<? extends B> toolBarButton) Adds a tool bar button to the tool bar with the specified id.
void	addToolBarContainerListener(String toolBarId, ToolBarContainerListener<T,B> containerListener) Adds a tool bar container listener only for the specified tool bar id.
void	addToolBarContainerListener(ToolBarContainerListener<T,B> containerListener) Adds a tool bar container listener.
boolean	containsToolBar(String toolBarId) Indicates if this container contains a tool bar with the specified id
boolean	isToolBarVisible(String toolBarId) Indicates if the tool bar with the specified id is visible
PositionableAdapter<T>	removeToolBar(String toolBarId) Removes the tool bar with the specified id from this container.
PositionableAdapter<? extends B>	removeToolBarButton(String toolBarId, B toolBarButton) Removes a tool bar button from the tool bar with the specified id.
void	removeToolBarContainerListener(String toolBarId, ToolBarContainerListener<T,B> containerListener) Removes a tool bar container listener only for the specified tool bar id.
void	removeToolBarContainerListener(ToolBarContainerListener<T,B> containerListener) Removes a tool bar container listener.
void	setToolBarVisible(String toolBarId, boolean visible) Sets the visible property of the tool bar with the specified id.

Method Detail

addToolBar

void addToolBar(String toolBarId,
                PositionableAdapter<T> toolBar)

Adds a tool bar to this container.

Parameters:

toolBarId - the id of the tool bar

toolBar - the tool bar with the preferred position

removeToolBar

PositionableAdapter<T> removeToolBar(String toolBarId)

Removes the tool bar with the specified id from this container.

Parameters:

toolBarId - the tool bar id

Returns:

the removed toolBar or null if not found

addToolBarButton

void addToolBarButton(String toolBarId,
                      PositionableAdapter<? extends B> toolBarButton)

Adds a tool bar button to the tool bar with the specified id.

Parameters:

toolBarId - the id of the tool bar the provided button should be added to

toolBarButton - tbe tool bar button with the preferred position

removeToolBarButton

PositionableAdapter<? extends B> removeToolBarButton(String toolBarId,
                                                     B toolBarButton)

Removes a tool bar button from the tool bar with the specified id.

Parameters:

toolBarId - the id of the tool bar the provided button should be removed from

toolBarButton - tbe tool bar button

Returns:

the removed tool bar button or null if not found

containsToolBar

boolean containsToolBar(String toolBarId)

Indicates if this container contains a tool bar with the specified id

Parameters:

toolBarId - the tool bar id

Returns:

true, if this container contains a tool bar with the specified id, else false

isToolBarVisible

boolean isToolBarVisible(String toolBarId)

Indicates if the tool bar with the specified id is visible

Parameters:

toolBarId - the tool bar id

Returns:

true, if the tool bar is visible, else false

setToolBarVisible

void setToolBarVisible(String toolBarId,
                       boolean visible)

Sets the visible property of the tool bar with the specified id.

Parameters:

toolBarId - the tool bar id

visible - the flag

addToolBarContainerListener

void addToolBarContainerListener(ToolBarContainerListener<T,B> containerListener)

Adds a tool bar container listener.

Parameters:

containerListener - a tool bar container listener

removeToolBarContainerListener

void removeToolBarContainerListener(ToolBarContainerListener<T,B> containerListener)

Removes a tool bar container listener.

Parameters:

containerListener - a tool bar container listener

addToolBarContainerListener

void addToolBarContainerListener(String toolBarId,
                                 ToolBarContainerListener<T,B> containerListener)

Adds a tool bar container listener only for the specified tool bar id.

Parameters:

toolBarId - the tool bar id

containerListener - a tool bar container listener

removeToolBarContainerListener

void removeToolBarContainerListener(String toolBarId,
                                    ToolBarContainerListener<T,B> containerListener)

Removes a tool bar container listener only for the specified tool bar id.

Parameters:

toolBarId - the tool bar id

containerListener - a tool bar container listener