de.must.markup

Class Back

java.lang.Object

de.must.markup.Back

All Implemented Interfaces:

Invokable

public class Back
extends java.lang.Object
implements Invokable

Constructor Summary

Constructors

Constructor and Description
Back()

Method Summary

Modifier and Type	Method and Description
void	afterOutput() Called by SessionStd after the servlet response is written.
void	beforeOutput() Called by SessionStd before the servlet response is written.
void	destroy() Destroy this object in order to free resources and weak references more early than garbage collector.
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.
java.lang.Class<? extends Invokable>	getInvokableInAdvance() Returns a Invokable class which is to be invoked before this Invokable can be shown.
int	getStackMovement() Returns the wished stack movement.
Submission	getSubmission() Informs the next invokable in stack about the submission details.
java.lang.String	getTagSequence() Returns the default tag sequence (as HTML).
void	init() Initializes the invokable in order to reuse the component without garbage from the previous use.
boolean	isCancelable() Indicates whether the invokable accepts to be canceled.
boolean	isSuitableDialog(GeneralizedRequest request) Indicates whether the request fits to this dialog.
void	process(GeneralizedRequest request) Allows the invokable to react to the request.
void	setSubmitter(Invokable submitter) Informs this invokable, from which previous invokable it is submitted.
boolean	wantToBeFinalized() Returns true if the invokable wants to be finalized after request is worked off.

Methods inherited from class java.lang.Object

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

Constructor Detail

Back

public Back()

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

getTagSequence

public java.lang.String getTagSequence()

Returns the default tag sequence (as HTML). Normally you should not call this method directly. Use Layout implementing classes instead.

Returns:

the default tag sequence (as HTML)

See Also:

Layout

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

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

isCancelable

public boolean isCancelable()

Indicates whether the invokable accepts to be canceled. E.g. if properties are edited and jumping to another function is requested by using a toolbar option, this may be stopped here.

Specified by:

isCancelable in interface Invokable

Returns:

true if the invokable accepts to be canceled

isSuitableDialog

public boolean isSuitableDialog(GeneralizedRequest request)

Indicates whether the request fits to this dialog. Useful to stop the user to use any back functions of the browser.

Specified by:

isSuitableDialog in interface Invokable

Parameters:

request - the request to check

Returns:

true if the request fits to this dialog

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

process

public void process(GeneralizedRequest request)

Allows the invokable to react to the request. Sample: saving data when Ok button was pressed.

Specified by:

process in interface Invokable

Parameters:

request - the requeset to react to

setSubmitter

public void setSubmitter(Invokable submitter)

Informs this invokable, from which previous invokable it is submitted. Technique to establish a bilateral communication between invokables.

Specified by:

setSubmitter in interface Invokable

Parameters:

submitter - the invokable that submitted this invokable

getSubmission

public Submission getSubmission()

Informs the next invokable in stack about the submission details. E.g. a PropertyAdminstration may call this method to receive the primary key of the entry to be edited.

Specified by:

getSubmission in interface Invokable

Returns:

the submission details

getStackMovement

public int getStackMovement()

Returns the wished stack movement. E.g this if this invokable's work is done it return -1 to return to the previous invokable in the stack.

Specified by:

getStackMovement in interface Invokable

wantToBeFinalized

public boolean wantToBeFinalized()

Returns true if the invokable wants to be finalized after request is worked off.

Specified by:

wantToBeFinalized in interface Invokable

Returns:

true if the invokable wants to be finalized

destroy

public void destroy()

Description copied from interface: Invokable

Destroy this object in order to free resources and weak references more early than garbage collector.

Specified by:

destroy in interface Invokable