net.sf.cuf.fw2

Class DialogDescription

java.lang.Object

net.sf.cuf.fw2.DialogDescription

public class DialogDescription
extends Object

Small helper class that stores the meta data about a dialog. It is used to read all known dialogs from a properties file. The format of the properties file is dialog.id.<running number>=<ID of the dialog> dialog.class.<running number>=<class name of the dialog> dialog.name.<running number>=<name of the dialog as shown to the user> dialog.icon.<running number>=<icon of the dialog as shown to the user> dialog.<myKey>.<running number>=<value for myKey> The dialog.icon and dialog.name properties are optional, as well as the individual key value definitions. <myKey> may contain '.', as long as there is the identifying running number at the end. The individual key value definitions are stored in mParameters.

The class optionally stores a dialog instance of a dialog, this is usefull if the same dialog should be re-used.

Constructor Summary

Constructors

Constructor and Description
DialogDescription()

Method Summary

Methods

Modifier and Type	Method and Description
void	addParameter(String pKey, Object pValue) Add a paraemter to the dialog
Dc	getDc() Return the dialog of this description
Class<? extends Dc>	getDialogClass() Retrun the dialog class.
String	getDialogIcon() Return the dialog icon name.
String	getDialogId() Return the dialog id.
String	getDialogName() Return the dialog name.
Map<String,Object>	getParameters() Return the parameters or null if there are none.
static void	initDialogs(Map<String,DialogDescription> pKnownDialogs, Application pApp, Dc pParent, Map<String,? super Object> pArgs) Initialize the Dc's for a map of dialog descriptions.
boolean	isComplete() Returns true if we have a id and class
static Map<String,DialogDescription>	loadKnownDialogs(String pFileName) Load known dialogs from a properties file.
void	setDc(Dc pDc) Set the dialog for this description
void	setDialogClass(Class<? extends Dc> pDialogClass) Set the dialog class
void	setDialogClassName(String pDialogClassName) Set the dialog class name.
void	setDialogIcon(String pDialogIcon) Set the dialog icon name.
void	setDialogId(String pDialogId) Set the dialog id.
void	setDialogName(String pDialogName) Set the dialog name.
void	setParameters(Map<String,Object> pParameters) Set the parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

DialogDescription

public DialogDescription()

Method Detail

loadKnownDialogs

public static Map<String,DialogDescription> loadKnownDialogs(String pFileName)

Load known dialogs from a properties file.

Parameters:

pFileName - the name of the properties file

Returns:

a Map of DialogDescription objects, never null, key= DialogID, value= DialogDescription object

initDialogs

public static void initDialogs(Map<String,DialogDescription> pKnownDialogs,
               Application pApp,
               Dc pParent,
               Map<String,? super Object> pArgs)

Initialize the Dc's for a map of dialog descriptions.

The custom parameters from the DialogDescription are added to those provided by the pArgs:
First, the getParameters() is used,
then the parameters from pArgs are added,
and finally the Application is added with the key Application.APPLICATION_KEY.
This means that pArgs may overwrite the custom parameters in the dialog description but may not overwrite the application parameter.

Parameters:

pKnownDialogs - a Map of DialogDescription objects, never null, key= DialogID, value= DialogDescription object

pApp - the application, must not be null

pParent - the parent Dc for the init call, may be null

pArgs - arguments for the init call, may be null

isComplete

public boolean isComplete()

Returns true if we have a id and class

Returns:

true if we are complete

getDialogId

public String getDialogId()

Return the dialog id.

Returns:

the dialog id, may be null

setDialogId

public void setDialogId(String pDialogId)

Set the dialog id.

Parameters:

pDialogId - the dialog id, must not be null

getDialogClass

public Class<? extends Dc> getDialogClass()

Retrun the dialog class.

Returns:

the dialog class, may be null

setDialogClass

public void setDialogClass(Class<? extends Dc> pDialogClass)

Set the dialog class

Parameters:

pDialogClass - the dialog class, must not be null

setDialogClassName

public void setDialogClassName(String pDialogClassName)

Set the dialog class name.

Parameters:

pDialogClassName - the dialog class, must not be null and must be a Dc derivate

getDialogName

public String getDialogName()

Return the dialog name.

Returns:

null or the dialog name

setDialogName

public void setDialogName(String pDialogName)

Set the dialog name.

Parameters:

pDialogName - the dialog name, may be null

getDialogIcon

public String getDialogIcon()

Return the dialog icon name.

Returns:

null or the dialog icon name.

setDialogIcon

public void setDialogIcon(String pDialogIcon)

Set the dialog icon name.

Parameters:

pDialogIcon - the dialog icon name, may be null

addParameter

public void addParameter(String pKey,
                Object pValue)

Add a paraemter to the dialog

Parameters:

pKey - the parameter to add, must not be null

pValue - the value, must not be null

getParameters

public Map<String,Object> getParameters()

Return the parameters or null if there are none.

Returns:

null or our parameters

setParameters

public void setParameters(Map<String,Object> pParameters)

Set the parameters.

Parameters:

pParameters - the parameter map, may be nul

getDc

public Dc getDc()

Return the dialog of this description

Returns:

null or the dialog Dc

setDc

public void setDc(Dc pDc)

Set the dialog for this description

Parameters:

pDc - the dialog, may be null