de.must.markup

Class Layout

java.lang.Object

de.must.markup.Layout

Direct Known Subclasses:

HostLayout

public abstract class Layout
extends java.lang.Object

Liberal creator of the markup tag sequence. Collects information from all actually active components including their state and layouts them. The layout may be replaced during the execution and may differ from session to session. Implement your own Layout. It's more simple then designing many JSP! And you cannot fail the links or get any other individually wrong code.

See Also:

HostLayout

Field Summary

Fields

Modifier and Type	Field and Description
protected Dialog	dialog
protected java.lang.String	footerTagSequence
protected HelpContext	helpContext
protected Invokable	invokable
protected SessionData	sessionData

Constructor Summary

Constructors

Constructor and Description
Layout()

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	getBackButtonIfAvailable(Dialog dialog) Returns the markup tag sequence of a back button if available.
protected java.lang.String	getCloseScript() Return the closing script.
protected java.lang.String	getFooter() Returns the footer's tag sequence.
java.lang.String	getGoodByeTagSequence(SessionData sessionData) Returns the markup tag sequence of the page to say good bye
protected java.lang.String	getHeader() Returns the header.
protected java.lang.String	getHeader(boolean uploadFunctionality) Returns the header.
protected java.lang.String	getHeader(java.lang.String styleSheetName) Returns the header for the specified style sheet.
protected java.lang.String	getHeader(java.lang.String styleSheetName, boolean uploadFunctionality) Returns the header for the specified style sheet.
protected java.lang.String	getHelpButtonIfAvailable() Returns the markup tag sequence of a help button, if context help is available.
java.lang.String	getJavaScriptMenuBarTagSequence() Returns the java script menu bar tag sequence.
protected java.lang.String	getScriptToExecute() Returns the script to execute.
protected abstract java.lang.String	getSpecialTagSequence(ColumnDataList columnDataList) Gets the markup tag sequence from the invokable as specified.
protected abstract java.lang.String	getSpecialTagSequence(DataPropertyAdministration dataPropertyAdministration) Gets the markup tag sequence from the invokable as specified.
protected abstract java.lang.String	getSpecialTagSequence(DataPropertyPresentation dataPropertyPresentation) Gets the markup tag sequence from the invokable as specified.
protected abstract java.lang.String	getSpecialTagSequence(DataTableAdministration dataTableAdministration) Gets the markup tag sequence from the invokable as specified.
protected abstract java.lang.String	getSpecialTagSequence(Dialog dialog) Gets the markup tag sequence from the invokable as specified.
protected abstract java.lang.String	getSpecialTagSequence(Enquiry enquiry) Gets the markup tag sequence from the invokable as specified.
protected abstract java.lang.String	getSpecialTagSequence(List list) Gets the markup tag sequence from the invokable as specified.
protected abstract java.lang.String	getSpecialTagSequence(MustMenuBar menuBar) Gets the markup tag sequence from the invokable as specified.
protected abstract java.lang.String	getSpecialTagSequence(PropertyAdministration propertyAdministration) Gets the markup tag sequence from the invokable as specified.
protected abstract java.lang.String	getSpecialTagSequence(SimpleDataList simpleDataList) Gets the markup tag sequence from the invokable as specified.
java.lang.String	getStaticScriptReferences() Returns static script references as tag sequence.
java.lang.String	getTagSequence(SessionData sessionData, Invokable invokable) Returns the markup tag sequence of the specified invokable.
protected java.lang.String	getToolBarTag() Returns the tool bar's markup tag sequence.
protected boolean	hasAnyInputFields()
protected boolean	isFocusOnFirstButton()
void	setFooterTagSequence(java.lang.String footerTagSequence) Sets the footer tag sequence.

Methods inherited from class java.lang.Object

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

Field Detail

sessionData

protected SessionData sessionData

invokable

protected Invokable invokable

helpContext

protected HelpContext helpContext

dialog

protected Dialog dialog

footerTagSequence

protected java.lang.String footerTagSequence

Constructor Detail

Layout

public Layout()

Method Detail

setFooterTagSequence

public void setFooterTagSequence(java.lang.String footerTagSequence)

Sets the footer tag sequence.

Parameters:

footerTagSequence - the footer tag sequence

getTagSequence

public java.lang.String getTagSequence(SessionData sessionData,
                                       Invokable invokable)

Returns the markup tag sequence of the specified invokable. Wishes to find a special layout method in subclass. If not found, it uses the component's default layout informations.

Parameters:

sessionData - the session's public data

invokable - the invokable to be laid-out

Returns:

the markup tag sequence

hasAnyInputFields

protected boolean hasAnyInputFields()

isFocusOnFirstButton

protected boolean isFocusOnFirstButton()

getHeader

protected java.lang.String getHeader()

Returns the header.

Returns:

the header

getHeader

protected java.lang.String getHeader(java.lang.String styleSheetName)

Returns the header for the specified style sheet.

Parameters:

styleSheetName - the name of the style sheet to use

Returns:

the header

getHeader

protected java.lang.String getHeader(boolean uploadFunctionality)

Returns the header.

Parameters:

uploadFunctionality - whether or not upload elements are to provide

Returns:

the header

getHeader

protected java.lang.String getHeader(java.lang.String styleSheetName,
                                     boolean uploadFunctionality)

Returns the header for the specified style sheet.

Parameters:

styleSheetName - the name of the style sheet to use

uploadFunctionality - whether or not upload elements are to provide

Returns:

the header

getToolBarTag

protected java.lang.String getToolBarTag()

Returns the tool bar's markup tag sequence.

Returns:

the tool bar's markup tag sequence

getFooter

protected java.lang.String getFooter()

Returns the footer's tag sequence.

Returns:

the footer's tag sequence

getGoodByeTagSequence

public java.lang.String getGoodByeTagSequence(SessionData sessionData)

Returns the markup tag sequence of the page to say good bye

Parameters:

sessionData - the session's public data

Returns:

the tag sequence of the good bye page

getSpecialTagSequence

protected abstract java.lang.String getSpecialTagSequence(MustMenuBar menuBar)

Gets the markup tag sequence from the invokable as specified.

Parameters:

menuBar - the menu bar to be laid-out

Returns:

the markup tag sequence

getSpecialTagSequence

protected abstract java.lang.String getSpecialTagSequence(Enquiry enquiry)

Gets the markup tag sequence from the invokable as specified.

Parameters:

enquiry - the enquiry to be laid-out

Returns:

the markup tag sequence

getSpecialTagSequence

protected abstract java.lang.String getSpecialTagSequence(ColumnDataList columnDataList)

Gets the markup tag sequence from the invokable as specified.

Parameters:

dataList - the data list to be laid-out

Returns:

the markup tag sequence

getSpecialTagSequence

protected abstract java.lang.String getSpecialTagSequence(SimpleDataList simpleDataList)

Gets the markup tag sequence from the invokable as specified.

Parameters:

dataList - the data list to be laid-out

Returns:

the markup tag sequence

getSpecialTagSequence

protected abstract java.lang.String getSpecialTagSequence(Dialog dialog)

Gets the markup tag sequence from the invokable as specified.

Parameters:

dialog - the dialog to be laid-out

Returns:

the markup tag sequence

getSpecialTagSequence

protected abstract java.lang.String getSpecialTagSequence(List list)

Gets the markup tag sequence from the invokable as specified.

Parameters:

dataList - the data list to be laid-out

Returns:

the markup tag sequence

getSpecialTagSequence

protected abstract java.lang.String getSpecialTagSequence(DataPropertyPresentation dataPropertyPresentation)

Gets the markup tag sequence from the invokable as specified.

Parameters:

dataPropertyPresentation - the data property presentation to be laid-out

Returns:

the markup tag sequence

getSpecialTagSequence

protected abstract java.lang.String getSpecialTagSequence(DataPropertyAdministration dataPropertyAdministration)

Gets the markup tag sequence from the invokable as specified.

Parameters:

dataPropertyAdministration - the data property administration to be laid-out

Returns:

the markup tag sequence

getSpecialTagSequence

protected abstract java.lang.String getSpecialTagSequence(PropertyAdministration propertyAdministration)

Gets the markup tag sequence from the invokable as specified.

Parameters:

propertyAdministration - the property administration to be laid-out

Returns:

the markup tag sequence

getSpecialTagSequence

protected abstract java.lang.String getSpecialTagSequence(DataTableAdministration dataTableAdministration)

Gets the markup tag sequence from the invokable as specified.

Parameters:

dataTableAdministration - the data table administration to be laid-out

Returns:

the markup tag sequence

getJavaScriptMenuBarTagSequence

public java.lang.String getJavaScriptMenuBarTagSequence()

Returns the java script menu bar tag sequence. See brainjar.com

Returns:

the java script menu bar tag sequence

getBackButtonIfAvailable

protected java.lang.String getBackButtonIfAvailable(Dialog dialog)

Returns the markup tag sequence of a back button if available.

Returns:

the tag sequence of a back button

getHelpButtonIfAvailable

protected java.lang.String getHelpButtonIfAvailable()

Returns the markup tag sequence of a help button, if context help is available.

Returns:

the tag sequence of a help button

getStaticScriptReferences

public java.lang.String getStaticScriptReferences()

Returns static script references as tag sequence.

Returns:

static script references

getScriptToExecute

protected java.lang.String getScriptToExecute()

Returns the script to execute.

Returns:

the script to execute

getCloseScript

protected java.lang.String getCloseScript()

Return the closing script.

Returns:

the closing script