net.sf.cuf.fw2

Class MenuToolBarEvent

java.lang.Object

java.util.EventObject

net.sf.cuf.appevent.AppEvent

net.sf.cuf.fw2.MenuToolBarEvent

All Implemented Interfaces:

Serializable

public class MenuToolBarEvent
extends AppEvent

A MenuToolBaarEvent can be used by a DialogPc to change the Menu/Toolbar.
The key in the menu map is hierarchical name starting with a /. The name of a menu is not the displayed name but the widget name. The value in the menu map is either JMenuItem or a List of JMenuItem objects. A fine tuning of the insertion point is possible with an additional map that contains positive (starting from the front, +1= left most menu) or negative (starting from the end, -1= right most menu) position indices for the used menu keys.

Note that if you add a menu entry with the same logical menu name as an existing menu, the add request will be ignored. Thus, if two dialogs share entries in a menu that is not created outside of those dialogs but implicitly from within the dialogs, you must separate the JMenu and the JMenuItem in the event. If you add a JMenu that already contains the JMenuItem only one of the dialogs will "win". Also note that deleting a shared menu is not (yet) clearly defined.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
MenuToolBarEvent(Object pSource) Create a non-consumed event with no menu/toolbar to add.
MenuToolBarEvent(Object pSource, List<Component> pToolBarButtons) Create a non-consumed event with toolbar buttons to add.
MenuToolBarEvent(Object pSource, List<Component> pToolBarButtons, boolean pDelete) Create a non-consumed event with toolbar buttons to add/delete.
MenuToolBarEvent(Object pSource, List<Component> pToolBarButtons, Map<String,Object> pMenus) Create a non-consumed event with toolbar buttons and menus to add.
MenuToolBarEvent(Object pSource, List<Component> pToolBarButtons, Map<String,Object> pMenus, boolean pDelete) Create a non-consumed event with toolbar buttons and menus to add/delete.
MenuToolBarEvent(Object pSource, List<Component> pToolBarButtons, Map<String,Object> pMenus, Map<String,Integer> pMenuInsertionIndeces) Create a non-consumed event with toolbar buttons and menus to add.
MenuToolBarEvent(Object pSource, List<Component> pToolBarButtons, Map<String,Object> pMenus, Map<String,Integer> pMenuInsertionIndeces, boolean pDelete) Create a non-consumed event with toolbar buttons and menus to add/delete.
MenuToolBarEvent(Object pSource, Map<String,Object> pMenus) Create a non-consumed event with menus to add.
MenuToolBarEvent(Object pSource, Map<String,Object> pMenus, boolean pDelete) Create a non-consumed event with menus to add/delete.
MenuToolBarEvent(Object pSource, Map<String,Object> pMenus, Map<String,Integer> pMenuInsertionIndeces) Create a non-consumed event with menus to add.
MenuToolBarEvent(Object pSource, Map<String,Object> pMenus, Map<String,Integer> pMenuInsertionIndeces, boolean pDelete) Create a non-consumed event with menus to add.

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,Integer>	getMenuInsertionIndeces() Returns the menu insertion map.
Map<String,Object>	getMenus() Returns the menu map.
List<Component>	getToolBarButtons() Return the toolbar buttons.
boolean	isDelete() Check if this event adds or removes stuff.

Methods inherited from class net.sf.cuf.appevent.AppEvent

consume, forward, isConsumed, toString

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Constructor Detail

MenuToolBarEvent

public MenuToolBarEvent(Object pSource,
                List<Component> pToolBarButtons,
                Map<String,Object> pMenus,
                Map<String,Integer> pMenuInsertionIndeces,
                boolean pDelete)

Create a non-consumed event with toolbar buttons and menus to add/delete.

Parameters:

pSource - null or event source

pToolBarButtons - list of tool bar buttons, must not be null

pMenus - map of menus, must not be null

pMenuInsertionIndeces - map of menu insertion indices, must not be null

pDelete - flag, if true we delete the toolbar buttons/menus

MenuToolBarEvent

public MenuToolBarEvent(Object pSource)

Create a non-consumed event with no menu/toolbar to add.

Parameters:

pSource - null or event source

MenuToolBarEvent

public MenuToolBarEvent(Object pSource,
                List<Component> pToolBarButtons)

Create a non-consumed event with toolbar buttons to add.

Parameters:

pSource - null or event source

pToolBarButtons - list of tool bar buttons, must not be null

MenuToolBarEvent

public MenuToolBarEvent(Object pSource,
                List<Component> pToolBarButtons,
                boolean pDelete)

Create a non-consumed event with toolbar buttons to add/delete.

Parameters:

pSource - null or event source

pToolBarButtons - list of tool bar buttons, must not be null

pDelete - flag, if true we delete the buttons

MenuToolBarEvent

public MenuToolBarEvent(Object pSource,
                Map<String,Object> pMenus)

Create a non-consumed event with menus to add.

Parameters:

pSource - null or event source

pMenus - map of menus, must not be null

MenuToolBarEvent

public MenuToolBarEvent(Object pSource,
                Map<String,Object> pMenus,
                Map<String,Integer> pMenuInsertionIndeces)

Create a non-consumed event with menus to add.

Parameters:

pSource - null or event source

pMenus - map of menus, must not be null

pMenuInsertionIndeces - map of menu insertion indeces, must not be null

MenuToolBarEvent

public MenuToolBarEvent(Object pSource,
                Map<String,Object> pMenus,
                Map<String,Integer> pMenuInsertionIndeces,
                boolean pDelete)

Create a non-consumed event with menus to add.

Parameters:

pSource - null or event source

pMenus - map of menus, must not be null

pMenuInsertionIndeces - map of menu insertion indeces, must not be null

pDelete - flag, if true we delete the menus

MenuToolBarEvent

public MenuToolBarEvent(Object pSource,
                Map<String,Object> pMenus,
                boolean pDelete)

Create a non-consumed event with menus to add/delete.

Parameters:

pSource - null or event source

pMenus - map of menus, must not be null

pDelete - flag, if true we delete the menus

MenuToolBarEvent

public MenuToolBarEvent(Object pSource,
                List<Component> pToolBarButtons,
                Map<String,Object> pMenus)

Create a non-consumed event with toolbar buttons and menus to add.

Parameters:

pSource - null or event source

pToolBarButtons - list of tool bar buttons, must not be null

pMenus - map of menus, must not be null

MenuToolBarEvent

public MenuToolBarEvent(Object pSource,
                List<Component> pToolBarButtons,
                Map<String,Object> pMenus,
                boolean pDelete)

Create a non-consumed event with toolbar buttons and menus to add/delete.

Parameters:

pSource - null or event source

pToolBarButtons - list of tool bar buttons, must not be null

pMenus - map of menus, must not be null

pDelete - flag, if true we delete the toolbar buttons/menus

MenuToolBarEvent

public MenuToolBarEvent(Object pSource,
                List<Component> pToolBarButtons,
                Map<String,Object> pMenus,
                Map<String,Integer> pMenuInsertionIndeces)

Create a non-consumed event with toolbar buttons and menus to add.

Parameters:

pSource - null or event source

pToolBarButtons - list of tool bar buttons, must not be null

pMenus - map of menus, must not be null

pMenuInsertionIndeces - map of menu insertion indeces, must not be null

Method Detail

getToolBarButtons

public List<Component> getToolBarButtons()

Return the toolbar buttons.

Returns:

list of toolbar buttons, never null

getMenus

public Map<String,Object> getMenus()

Returns the menu map.

Returns:

map of logical position/list of menus or menu, never null

getMenuInsertionIndeces

public Map<String,Integer> getMenuInsertionIndeces()

Returns the menu insertion map.

Returns:

map of logical position/insertion point, never null

isDelete

public boolean isDelete()

Check if this event adds or removes stuff.

Returns:

true if the menu/toolbar entries should be removed.