de.must.markup

Class PropertyAdministration

java.lang.Object

de.must.markup.Dialog

de.must.markup.PropertyAdministration

All Implemented Interfaces:

Invokable

Direct Known Subclasses:

DataPropertyAdministration, LoginDialog, PasswordChangeDialogStd

public abstract class PropertyAdministration
extends Dialog

A frame-like container to layout components in labeled lines to administrate properties.

Field Summary

Fields

Modifier and Type	Field and Description
protected AttributeList	currentAttributeList
protected int	dialogNbr
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
PropertyAdministration(SessionData sessionData) Constructs a new property administration object.

Method Summary

Modifier and Type	Method and Description
protected void	creationEnding() Conclusion of the construction process.
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.
AttributeList	getAttributeList() Returns the used attribute list.
java.lang.String	getTabbedPaneTagSequence() Returns the tabbed pane tag sequence.
boolean	hasMultiplePanels() Returns true if the property frame has multiple panels.
protected void	newPanel(java.lang.String tabLabel, int lineCapacity) Creates a new panel with an attribute list and adds it to the tabbed pane.
protected void	newPanel(java.lang.String tabLabel, int lineCapacity, java.lang.String toolTipText) Creates a new panel with an attribute list and adds it to the tabbed pane.
protected void	newPanel(TabImage tabImage, int lineCapacity) Creates a new panel with an attribute list and adds it to the tabbed pane.
protected void	newPanel(TabImage tabImage, int lineCapacity, java.lang.String toolTipText) Creates a new panel with an attribute list and adds it to the tabbed pane.
void	process(GeneralizedRequest request) Allows the invokable to react to the request.
protected void	setTabSize(int size) Sets the size of the previously to build tabbed pane via method newPanel
void	setToolTipText(java.lang.String toolTipText) Sets the tool tip text of the last added component.
boolean	wantToBeFinalized() Returns true if the invokable wants to be finalized after request is worked off.

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, getTitle, init, isCancelable, isPost, isSuitableDialog, setHelpContext, setHelpContext, setMessageToKeep, setMessageToKeepIfNotAlreadySet, setScriptToExecute, setStackMovement, setSubTitle, setTitle

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

Field Detail

currentAttributeList

protected AttributeList currentAttributeList

dialogNbr

protected int dialogNbr

wantToBeFinalized

protected boolean wantToBeFinalized

Constructor Detail

PropertyAdministration

public PropertyAdministration(SessionData sessionData)

Constructs a new property administration object.

Parameters:

sessionData - the session's public data

Method Detail

setToolTipText

public void setToolTipText(java.lang.String toolTipText)

Sets the tool tip text of the last added component.

Parameters:

toolTipText - the tool tip text

setTabSize

protected void setTabSize(int size)

Sets the size of the previously to build tabbed pane via method newPanel

Parameters:

size - the number of tabs to build

hasMultiplePanels

public boolean hasMultiplePanels()

Returns true if the property frame has multiple panels.

Returns:

true if the property frame has multiple panels

newPanel

protected void newPanel(java.lang.String tabLabel,
                        int lineCapacity)

Creates a new panel with an attribute list and adds it to the tabbed pane. All following data components will be placed upon until this panel.

Parameters:

tabLabel - the label of the new tab

lineCapacity - the number of rows of the attribute list to be created

See Also:

AttributeList, setTabSize(int)

newPanel

protected void newPanel(java.lang.String tabLabel,
                        int lineCapacity,
                        java.lang.String toolTipText)

Creates a new panel with an attribute list and adds it to the tabbed pane. All following data components will be placed upon until this panel.

Parameters:

tabLabel - the label of the new tab

lineCapacity - the number of rows of the attribute list to be created

toolTipText - the tool tip text to show

See Also:

AttributeList, setTabSize(int)

newPanel

protected void newPanel(TabImage tabImage,
                        int lineCapacity)

Creates a new panel with an attribute list and adds it to the tabbed pane. All following data components will be placed upon until this panel.

Parameters:

tabImage - the image of the new tab

lineCapacity - the number of rows of the attribute list to be created

See Also:

AttributeList, setTabSize(int)

newPanel

protected void newPanel(TabImage tabImage,
                        int lineCapacity,
                        java.lang.String toolTipText)

Creates a new panel with an attribute list and adds it to the tabbed pane. All following data components will be placed upon until this panel.

Parameters:

tabImage - the image of the new tab

lineCapacity - the number of rows of the attribute list to be created

toolTipText - the tool tip text to show

See Also:

AttributeList, setTabSize(int)

creationEnding

protected void creationEnding()

Conclusion of the construction process. Allows to do construction details in the sequence "super class" - "this" - "super class", which is a benefit for easy layouting.

getTabbedPaneTagSequence

public java.lang.String getTabbedPaneTagSequence()

Returns the tabbed pane tag sequence. Null is returned if only one panel is used.

Returns:

the tabbed pane tag sequence

getAttributeList

public AttributeList getAttributeList()

Returns the used attribute list.

Returns:

the used attribute list

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

Overrides:

fetchValuesFromRequest in class Dialog

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.

Specified by:

process in interface Invokable

Overrides:

process in class Dialog

Parameters:

the - requestet to react to

wantToBeFinalized

public boolean wantToBeFinalized()

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

Returns:

true if the invokable wants to be finalized