net.sf.cuf.fw2

Class AbstractSwingAppPc

java.lang.Object

net.sf.cuf.fw2.AbstractSwingAppPc

All Implemented Interfaces:

AppEventSupport, Pc, AppPc, Disposable

public abstract class AbstractSwingAppPc
extends Object
implements AppPc

The AbstractSwingAppPc implements the common stuff of the AppPc interface. The abstract implementation supports the handling of

• a menu bar,
• a button bar,
• a status line and
• the blocking/unblocking of the UI

via the

• MenuToolBarEvent,
• BlockEvent and
• ShowStatusEvent

AppEvent's. A project specific AppPc is usually derived from AbstractSwingAppPc and must only (optionally) set the mMenuBar, mToolBar and mStatusLabel members in its init() method.

Field Summary

Fields

Modifier and Type	Field and Description
protected AppEventSupport	mAppEventSupport The next object in the AppEvent responder chain.
protected Object	mFrameOrDialog Null or the JFrame/JDialog container to manage for block/unblock events (must be set by the derived class).
protected JMenuBar	mMenuBar Null or the menubar we manage (must be set by the derived class).
protected Map<String,JMenuItem>	mMenuMap Maps between a menu name (this is the component name, not the displayed text!) and the actual menu.
protected JLabel	mStatusLabel Null or the label we use for status text events (must be set by the derived class).
protected JToolBar	mToolBar Null or the toolbar we manage (must be set by the derived class).
static String	SEPARATOR The separator of menu names

Constructor Summary

Constructors

Constructor and Description
AbstractSwingAppPc()

Method Summary

Methods

Modifier and Type	Method and Description
void	blockChanged(BlockEvent pEvent) Handling of BlockEvent's.
void	dispose(Map<String,? super Object> pArgs) Called from the AppDc peer to cleanup all resources.
void	init(Dc pDc, Map<String,? super Object> pArgs) This method is called by the dialog controller peer during the initialisation phase of an application.
void	menuToolbarChanged(MenuToolBarEvent pEvent) Handling of the MenuToolBarEvent.
void	postAppEvent(AppEvent pAppEvent) Process/Dispatch an AppEvent.
void	statusChanged(ShowStatusEvent pEvent) Handling of ShowStatusEvent 's.

Methods inherited from class java.lang.Object

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

Field Detail

SEPARATOR

public static final String SEPARATOR

The separator of menu names

See Also:

Constant Field Values

mAppEventSupport

protected AppEventSupport mAppEventSupport

The next object in the AppEvent responder chain.

mToolBar

protected JToolBar mToolBar

Null or the toolbar we manage (must be set by the derived class).

mMenuBar

protected JMenuBar mMenuBar

Null or the menubar we manage (must be set by the derived class).

mMenuMap

protected Map<String,JMenuItem> mMenuMap

Maps between a menu name (this is the component name, not the displayed text!) and the actual menu. key: hierarchical menu name as String, value: MenuElement object

mFrameOrDialog

protected Object mFrameOrDialog

Null or the JFrame/JDialog container to manage for block/unblock events (must be set by the derived class).

mStatusLabel

protected JLabel mStatusLabel

Null or the label we use for status text events (must be set by the derived class).

Constructor Detail

AbstractSwingAppPc

public AbstractSwingAppPc()

Method Detail

init

public void init(Dc pDc,
        Map<String,? super Object> pArgs)

This method is called by the dialog controller peer during the initialisation phase of an application.

Specified by:

init in interface Pc

Parameters:

pDc - our peer dialog controller, must implement AppEventSupport

pArgs - variable argument list modeled as a key/value map, never null.

postAppEvent

public void postAppEvent(AppEvent pAppEvent)

Process/Dispatch an AppEvent.

Specified by:

postAppEvent in interface AppEventSupport

Parameters:

pAppEvent - event that should be routed/processes

Throws:

IllegalArgumentException - if pAppEvent is null

menuToolbarChanged

public void menuToolbarChanged(MenuToolBarEvent pEvent)

Handling of the MenuToolBarEvent. We assume that the derived class has initialized mToolBar, mMenuBar and mMenuMap.

Parameters:

pEvent - the event with added/removed toolbar/menu entries

blockChanged

public void blockChanged(BlockEvent pEvent)

Handling of BlockEvent's. We assume that the derived class has initialized mFrame, otherwise we do nothing.

Parameters:

pEvent - the event with the block information

statusChanged

public void statusChanged(ShowStatusEvent pEvent)

Handling of ShowStatusEvent 's. We assume that the derived class has initialized mStatusLabel, otherwise we do nothing.

Parameters:

pEvent - the event with the status text information

dispose

public void dispose(Map<String,? super Object> pArgs)

Called from the AppDc peer to cleanup all resources. The base implementation does nothing.

Specified by:

dispose in interface Disposable

Parameters:

pArgs - arguments, key is a String, value is any suitable objekt for the key