de.must.markup

Class Dialog

java.lang.Object

de.must.markup.Dialog

All Implemented Interfaces:

Invokable

Direct Known Subclasses:

DataTableAdministration, Enquiry, List, MustMenuBar, PropertyAdministration, PropertyPresentation

public abstract class Dialog
extends java.lang.Object
implements Invokable

A Dialog is an invokable that can produce a markup language user interface, read user input and process user request.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Vector<MustButton>	additionalButtons
protected MustButton	backButton
protected MustButton	cancelButton
static java.lang.String	NAME_FOR_BACK_ACTION
static java.lang.String	NAME_FOR_CANCEL_ACTION
static java.lang.String	NAME_FOR_CLOSE_ACTION
static java.lang.String	NAME_FOR_DIALOG_NBR
static java.lang.String	NAME_FOR_HELP_ACTION
static java.lang.String	NAME_FOR_LIST_ACTION
static java.lang.String	NAME_FOR_NEW_ENTRY_ACTION
static java.lang.String	NAME_FOR_OK_ACTION
protected MustButton	okButton
protected boolean	processComplete
protected SessionData	sessionData
protected int	stackMovement

Constructor Summary

Constructors

Constructor and Description
Dialog(SessionData sessionData) Constructs a new dialog.

Method Summary

Modifier and Type	Method and Description
void	afterOutput() Called by SessionStd after the servlet response is written.
void	appendAdditionalButton(MustButton button) Appends an additional button next to the standard buttons.
void	beforeOutput() Called by SessionStd before the servlet response is written.
void	destroy() Destroys the frame.
void	fetchValuesFromRequest(GeneralizedRequest request) Causes the invokable to delegate this function to all embedded markupables to fetch their current value as edited by the user from the request.
protected void	finalize()
protected void	free() Frees (releases) references caused by this frame, particularly static register entries.
java.util.Vector<MustButton>	getAdditionalButtons() Returns additional buttons to be displayed from the layout manager
java.lang.String	getBackButtonTagSequence() Returns the tag sequence to represent the back button.
java.lang.String	getCancelButtonTagSequence() Returns the tag sequence to represent the cancel button.
protected java.lang.String	getFooter() Returns the footer as a markup tag sequence.
protected java.lang.String	getHeader() Returns the header as a markup tag sequence.
HelpContext	getHelpContext() Returns the component's help context.
java.lang.Class<? extends Invokable>	getInvokableInAdvance() Returns a Invokable class which is to be invoked before this Invokable can be shown.
java.lang.String	getOkButtonTagSequence() Returns the tag sequence to represent the OK button.
java.lang.String	getScriptToExecute() Returns the script to be executed at the next user contact.
protected java.lang.String	getScriptToExecuteSequence() Returns the script to execute as a markup tag sequence.
int	getStackMovement() Returns the stack movement.
java.lang.String	getSubTitle() Returns the dialogs's title.
java.lang.String	getTitle() Returns the dialogs's title.
void	init() Initializes the invokable in order to reuse the component without garbage from the previous use.
boolean	isCancelable() Returns true if the dialog accepts to be canceled.
protected boolean	isPost(GeneralizedRequest request) Returns true if the request is of method "POST" - useful to check default Buttons.
boolean	isSuitableDialog(GeneralizedRequest request) Returns true if the dialog fits to the qualification set in the previous output.
void	process(GeneralizedRequest request) Processes the user's request.
void	setHelpContext(java.lang.String helpTopic) Sets the component's context help.
void	setHelpContext(java.lang.String helpTopic, java.lang.String helpTarget) Sets the component's context help.
void	setMessageToKeep(java.lang.String messageToKeep) Sets the message to be read by the user.
protected void	setMessageToKeepIfNotAlreadySet(java.lang.String messageToKeep) Sets the message to be read by the user if there is no message, yet.
void	setScriptToExecute(java.lang.String newScriptToExecute) Sets the script to be executed at the next user contact.
void	setStackMovement(int newStackMovement) Sets the stack movement. 0 means stay in the same tier, -1 means go one step back in stack, 1 means go one step deeper in stack.
void	setSubTitle(java.lang.String newSubTitle) Sets the dialogs's subtitle.
void	setTitle(java.lang.String newTitle) Sets the dialogs's title.

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.must.markup.Invokable

getSubmission, setSubmitter, wantToBeFinalized

Field Detail

NAME_FOR_OK_ACTION

public static final java.lang.String NAME_FOR_OK_ACTION

See Also:

Constant Field Values

NAME_FOR_CANCEL_ACTION

public static final java.lang.String NAME_FOR_CANCEL_ACTION

See Also:

Constant Field Values

NAME_FOR_BACK_ACTION

public static final java.lang.String NAME_FOR_BACK_ACTION

See Also:

Constant Field Values

NAME_FOR_LIST_ACTION

public static final java.lang.String NAME_FOR_LIST_ACTION

See Also:

Constant Field Values

NAME_FOR_NEW_ENTRY_ACTION

public static final java.lang.String NAME_FOR_NEW_ENTRY_ACTION

See Also:

Constant Field Values

NAME_FOR_HELP_ACTION

public static final java.lang.String NAME_FOR_HELP_ACTION

See Also:

Constant Field Values

NAME_FOR_CLOSE_ACTION

public static final java.lang.String NAME_FOR_CLOSE_ACTION

See Also:

Constant Field Values

NAME_FOR_DIALOG_NBR

public static final java.lang.String NAME_FOR_DIALOG_NBR

See Also:

Constant Field Values

sessionData

protected SessionData sessionData

okButton

protected MustButton okButton

cancelButton

protected MustButton cancelButton

backButton

protected MustButton backButton

additionalButtons

protected java.util.Vector<MustButton> additionalButtons

processComplete

protected boolean processComplete

stackMovement

protected int stackMovement

Constructor Detail

Dialog

public Dialog(SessionData sessionData)

Constructs a new dialog.

Parameters:

sessionData - the session's public data

Method Detail

getInvokableInAdvance

public java.lang.Class<? extends Invokable> getInvokableInAdvance()

Description copied from interface: Invokable

Returns a Invokable class which is to be invoked before this Invokable can be shown. Sample: if a function needs a login, this login is to be done in advance.

Specified by:

getInvokableInAdvance in interface Invokable

Returns:

a Invokable class which is to be invoked before this Invokable can be shown

init

public void init()

Initializes the invokable in order to reuse the component without garbage from the previous use.

Specified by:

init in interface Invokable

appendAdditionalButton

public void appendAdditionalButton(MustButton button)

Appends an additional button next to the standard buttons.

Parameters:

button - the button to append

getAdditionalButtons

public java.util.Vector<MustButton> getAdditionalButtons()

Returns additional buttons to be displayed from the layout manager

Returns:

additional buttons to be displayed from the layout manager

getHeader

protected java.lang.String getHeader()

Returns the header as a markup tag sequence.

Returns:

the header as a markup tag sequence

getFooter

protected java.lang.String getFooter()

Returns the footer as a markup tag sequence.

Returns:

the footer as a markup tag sequence

getOkButtonTagSequence

public java.lang.String getOkButtonTagSequence()

Returns the tag sequence to represent the OK button.

Returns:

the tag sequence to represent the OK button

getCancelButtonTagSequence

public java.lang.String getCancelButtonTagSequence()

Returns the tag sequence to represent the cancel button.

Returns:

the tag sequence to represent the cancel button

getBackButtonTagSequence

public java.lang.String getBackButtonTagSequence()

Returns the tag sequence to represent the back button.

Returns:

the tag sequence to represent the back button

getScriptToExecuteSequence

protected java.lang.String getScriptToExecuteSequence()

Returns the script to execute as a markup tag sequence.

Returns:

the script to execut as a markup tag sequence

isCancelable

public boolean isCancelable()

Returns true if the dialog accepts to be canceled.

Specified by:

isCancelable in interface Invokable

Returns:

true if the dialog accepts to be canceled

isSuitableDialog

public boolean isSuitableDialog(GeneralizedRequest request)

Returns true if the dialog fits to the qualification set in the previous output. Technique to avoid desynchronization, e.g. via used browser back functions.

Specified by:

isSuitableDialog in interface Invokable

Parameters:

request - the request to compare dialog steps

Returns:

true if the dialog fits to the qualification set in the previous output

beforeOutput

public void beforeOutput()

Description copied from interface: Invokable

Called by SessionStd before the servlet response is written.

Specified by:

beforeOutput in interface Invokable

See Also:

SessionStd

afterOutput

public void afterOutput()

Description copied from interface: Invokable

Called by SessionStd after the servlet response is written.

Specified by:

afterOutput in interface Invokable

See Also:

SessionStd

fetchValuesFromRequest

public void fetchValuesFromRequest(GeneralizedRequest request)

Causes the invokable to delegate this function to all embedded markupables to fetch their current value as edited by the user from the request.

Specified by:

fetchValuesFromRequest in interface Invokable

Parameters:

request - the request from where the values are to be fetched

See Also:

Markupable#fetchYourValueFromRequest

isPost

protected boolean isPost(GeneralizedRequest request)

Returns true if the request is of method "POST" - useful to check default Buttons.

Parameters:

request - the request to check

Returns:

true if the request is of method "POST"

process

public void process(GeneralizedRequest request)

Processes the user's request.

Specified by:

process in interface Invokable

Parameters:

request -

setHelpContext

public void setHelpContext(java.lang.String helpTopic)

Sets the component's context help.

Parameters:

helpTopic - the context help's topic

setTitle

public void setTitle(java.lang.String newTitle)

Sets the dialogs's title.

Parameters:

newTitle - the title of the dialog

getTitle

public java.lang.String getTitle()

Returns the dialogs's title.

Returns:

the dialogs's title.

setSubTitle

public void setSubTitle(java.lang.String newSubTitle)

Sets the dialogs's subtitle.

Parameters:

newTitle - the subtitle of the dialog

getSubTitle

public java.lang.String getSubTitle()

Returns the dialogs's title.

Returns:

the dialogs's title.

setHelpContext

public void setHelpContext(java.lang.String helpTopic,
                           java.lang.String helpTarget)

Sets the component's context help.

Parameters:

helpTopic - the context help's topic

helpTarget - the context help's target

getHelpContext

public HelpContext getHelpContext()

Returns the component's help context.

Returns:

the component's help context

setMessageToKeep

public void setMessageToKeep(java.lang.String messageToKeep)

Sets the message to be read by the user.

Parameters:

messageToKeep - the message for the user

setMessageToKeepIfNotAlreadySet

protected void setMessageToKeepIfNotAlreadySet(java.lang.String messageToKeep)

Sets the message to be read by the user if there is no message, yet. Does nothing if a message is already set.

Parameters:

messageToKeep - the message for the user

setScriptToExecute

public void setScriptToExecute(java.lang.String newScriptToExecute)

Sets the script to be executed at the next user contact.

Parameters:

newScriptToExecute - the script to execute

getScriptToExecute

public java.lang.String getScriptToExecute()

Returns the script to be executed at the next user contact.

Returns:

the script to be executed

setStackMovement

public void setStackMovement(int newStackMovement)

Sets the stack movement. 0 means stay in the same tier, -1 means go one step back in stack, 1 means go one step deeper in stack. Last one needs SessionData.classToInvokeNext

Parameters:

newStackMovement -

See Also:

SessionData.classToInvokeNext

getStackMovement

public int getStackMovement()

Returns the stack movement.

Specified by:

getStackMovement in interface Invokable

Returns:

the stack movement

destroy

public final void destroy()

Destroys the frame. This may include

• deregistering as main instance of a frame of this class
• freeing used data components especially those with listeners, particularly those which are registered in static vectors

After the frame has been destroyed, it is not usable any more! Override free to add further destruction and don't forget to call super.free() at the end.

Specified by:

destroy in interface Invokable

See Also:

free()

free

protected void free()

Frees (releases) references caused by this frame, particularly static register entries. To be called via destroy() to prevent multiple call. Override it to do additional releases and don't forget to call super.free() at the end.

See Also:

destroy()

finalize

protected final void finalize()
                       throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable