de.must.markup

Class List

java.lang.Object

de.must.markup.Dialog

de.must.markup.List

All Implemented Interfaces:

Invokable

Direct Known Subclasses:

DataList

public abstract class List
extends Dialog

Class to present lists.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	bottomText
protected java.lang.String	listCache
protected int	listedRowCounter
protected Invokable	submitter
protected java.lang.String	title
protected boolean	wantToBeFinalized

Fields inherited from class de.must.markup.Dialog

additionalButtons, backButton, cancelButton, NAME_FOR_BACK_ACTION, NAME_FOR_CANCEL_ACTION, NAME_FOR_CLOSE_ACTION, NAME_FOR_DIALOG_NBR, NAME_FOR_HELP_ACTION, NAME_FOR_LIST_ACTION, NAME_FOR_NEW_ENTRY_ACTION, NAME_FOR_OK_ACTION, okButton, processComplete, sessionData, stackMovement

Constructor Summary

Constructors

Constructor and Description
List(SessionData sessionData) Constructs a new list.

Method Summary

Modifier and Type	Method and Description
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.String	getBottomText() Returns the bottom text.
java.lang.String	getListCache() Returns the list cache.
int	getNbrOfRows() Returns the number of rows.
protected abstract java.lang.String	getRowString() Returns the information to be displayed in one row.
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	isListEmpty() Returns true if the list is empty.
protected abstract boolean	isRowToListAvailable() Returns true if a row to list is available.
void	process(GeneralizedRequest request) Processes the user's request.
void	setBottomText(java.lang.String bottomText) Sets the bottom text.
void	setListCache(java.lang.String newListCache) Sets the page cache, which should be done by layout classes to avoid unnecessarily repeated database enquiry.
void	setSubmitter(Invokable submitter) Informs this invokable, from which previous invokable it is submitted.
void	setTitle(java.lang.String title) Sets the dialogs's title.
protected abstract boolean	startListFromBeginning() Induces to start listing form beginning.

Methods inherited from class de.must.markup.Dialog

afterOutput, appendAdditionalButton, beforeOutput, destroy, finalize, free, getAdditionalButtons, getBackButtonTagSequence, getCancelButtonTagSequence, getFooter, getHeader, getHelpContext, getInvokableInAdvance, getOkButtonTagSequence, getScriptToExecute, getScriptToExecuteSequence, getStackMovement, getSubTitle, isCancelable, isPost, isSuitableDialog, setHelpContext, setHelpContext, setMessageToKeep, setMessageToKeepIfNotAlreadySet, setScriptToExecute, setStackMovement, setSubTitle

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, wantToBeFinalized

Field Detail

title

protected java.lang.String title

bottomText

protected java.lang.String bottomText

listedRowCounter

protected int listedRowCounter

listCache

protected java.lang.String listCache

submitter

protected Invokable submitter

wantToBeFinalized

protected boolean wantToBeFinalized

Constructor Detail

List

public List(SessionData sessionData)

Constructs a new list.

Parameters:

sessionData - the session's data to share

Method Detail

init

public void init()

Description copied from class: Dialog

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

Specified by:

init in interface Invokable

Overrides:

init in class Dialog

setTitle

public void setTitle(java.lang.String title)

Description copied from class: Dialog

Sets the dialogs's title.

Overrides:

setTitle in class Dialog

Parameters:

title - the title of the dialog

getTitle

public java.lang.String getTitle()

Description copied from class: Dialog

Returns the dialogs's title.

Overrides:

getTitle in class Dialog

Returns:

the dialogs's title.

setSubmitter

public void setSubmitter(Invokable submitter)

Description copied from interface: Invokable

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

Parameters:

submitter - the invokable that submitted this invokable

startListFromBeginning

protected abstract boolean startListFromBeginning()

Induces to start listing form beginning.

Returns:

true if no exception occurred

isRowToListAvailable

protected abstract boolean isRowToListAvailable()

Returns true if a row to list is available.

Returns:

true if a row to list is available

getRowString

protected abstract java.lang.String getRowString()

Returns the information to be displayed in one row. It's public so that individual layout classes in other packages may access it.

Returns:

the information to be displayed in one row

getNbrOfRows

public int getNbrOfRows()

Returns the number of rows.

Returns:

the number of rows

isListEmpty

public boolean isListEmpty()

Returns true if the list is empty.

Returns:

true if the list is empty

setBottomText

public void setBottomText(java.lang.String bottomText)

Sets the bottom text.

Parameters:

bottomText - The the bottom text to set

getBottomText

public java.lang.String getBottomText()

Returns the bottom text.

Returns:

the bottom text

getListCache

public java.lang.String getListCache()

Returns the list cache.

Returns:

the list cache

setListCache

public void setListCache(java.lang.String newListCache)

Sets the page cache, which should be done by layout classes to avoid unnecessarily repeated database enquiry.

Parameters:

newListCache - the list cache to remind

See Also:

Layout

process

public void process(GeneralizedRequest request)

Description copied from class: Dialog

Processes the user's request.

Specified by:

process in interface Invokable

Overrides:

process in class Dialog

Parameters:

request - the request to react to

fetchValuesFromRequest

public void fetchValuesFromRequest(GeneralizedRequest request)

Description copied from class: Dialog

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

Overrides:

fetchValuesFromRequest in class Dialog

Parameters:

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

See Also:

Markupable#fetchYourValueFromRequest