de.must.appletserver

Class RemoteUserInterface

java.lang.Object

de.must.appletserver.RemoteUserInterface

All Implemented Interfaces:

AppletTalker, Remotable, RemotableControler, AppTextResource, Exemptible, ExemptibleManager

Direct Known Subclasses:

DataListSelectionFrame, DataStructureOutlineFrame, DrawDialog, ListRemoteUserInterface, MajorRemoteUserInterface, Presentation, PresentationByDrawing, PropertyAdministration, ServerProcessControllerFrame, StandardDialog

public abstract class RemoteUserInterface
extends java.lang.Object
implements RemotableControler, AppTextResource, ExemptibleManager

A user interface to build remotely. Programmers perspective is being on the server, building the user interface in a remote applet.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Vector<AppearanceModifiable>	appearanceModifiablePool
protected java.lang.String	appellation
protected boolean	buildDone
protected ConfirmationMatter	confirmationMatter
protected ContextInfo	contextInfo
protected java.util.Vector<de.must.appletserver.RemoteUserInterface.Dependency>	dependencies
protected ConversationMatter	infoMatter
protected boolean	isToRenew
protected java.util.Vector<PopupBuilder>	popupBuilders
protected boolean	presentMessageInDialogIfRepeated
protected java.util.Vector<RemoteContent>	remoteContents
protected java.util.Vector<RemoteContent>	remoteContentsExceptionallyToSetValues
protected SessionData	sessionData

Constructor Summary

Constructors

Constructor and Description
RemoteUserInterface(SessionData sessionData, ContextInfo contextInfo)

Method Summary

Modifier and Type	Method and Description
void	addDependency(MustTextField textField, MustButton button)
void	addDependency(MustTextField textField, MustButton button1, MustButton button2)
protected void	associateDefaultButtonToInputField(MustTextField textField, MustButton button)
void	buildRemoteView(ToAppletWriter out) Build remote view.
void	destroy() Don't wait until garbage collector removed weak reference.
void	fetchValuesFromRequest(GeneralizedRequest request)
void	free() Releases external resources.
java.lang.String	getAppellation()
java.lang.String	getAppResStr(java.lang.String resourceKey) Returns a text in the corresponding language according to the locale specific resource bundle.
java.lang.String	getConcerning() Returns the type of interface.
ContextInfo	getContextInfo()
java.lang.String	getElementID()
protected static RemoteUserInterface	getInstance(SessionData sessionData, java.lang.String tabId)
int	getMessageSetSize()
java.lang.String	getTabId() Returns the ID of the tab or the window
java.lang.String	getTabLabel() Returns the label of the tab or the title of the current window.
protected java.lang.String	getTranslation(java.lang.String resourceKey)
boolean	hasVeto() Return true if input in e.g. dialog is not accepted.
boolean	isVisible()
DataObject	register(DataObject dataObject) Registers an object to free its external resources as soon as they are not needed any more.
void	register(Exemptible exemptible) Registers an object to free its external resources as soon as they are not needed any more.
protected void	registerRemotable(RemoteContent nextRemotable)
void	setAppellation(java.lang.String appellation) Sets the appellation of this user interface.
void	setElementID(java.lang.String elementID) Sets the ID of the element to be used for setVisible (instead of getTabId()).
protected void	setMessage(java.lang.String messageToKeep)
protected void	setMessageToKeep(Message message)
protected void	setMessageToKeep(java.lang.String messageToKeep) Sets the message to be read by the user, it is not reset by generalActionEnding when action completed.
void	setMessageToKeep(java.lang.String messageToKeep, java.lang.Object contextElement) Sets the message to be read by the user, it is not reset by generalActionEnding when action completed.
void	setMessageToKeep(java.lang.String messageToKeep, java.lang.Object contextElement, java.lang.String soundToPlay) Sets the message to be read by the user, it is not reset by generalActionEnding when action completed.
protected void	setMessageToKeep(java.lang.String messageToKeep, java.lang.String soundToPlay)
protected void	setSoundToPlay(java.lang.String soundToPlay)
protected void	setTitle(java.lang.String newTitle)
void	setToolTipText(java.lang.String newToolTipText) Sets the component's tool tip text.
void	setToRenewToTrue()
void	setVisible(boolean visible)

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.must.appletserver.RemotableControler

process

Field Detail

sessionData

protected SessionData sessionData

contextInfo

protected ContextInfo contextInfo

appellation

protected java.lang.String appellation

remoteContents

protected java.util.Vector<RemoteContent> remoteContents

remoteContentsExceptionallyToSetValues

protected java.util.Vector<RemoteContent> remoteContentsExceptionallyToSetValues

dependencies

protected java.util.Vector<de.must.appletserver.RemoteUserInterface.Dependency> dependencies

appearanceModifiablePool

protected java.util.Vector<AppearanceModifiable> appearanceModifiablePool

popupBuilders

protected java.util.Vector<PopupBuilder> popupBuilders

buildDone

protected boolean buildDone

isToRenew

protected boolean isToRenew

confirmationMatter

protected ConfirmationMatter confirmationMatter

infoMatter

protected ConversationMatter infoMatter

presentMessageInDialogIfRepeated

protected boolean presentMessageInDialogIfRepeated

Constructor Detail

RemoteUserInterface

public RemoteUserInterface(SessionData sessionData,
                           ContextInfo contextInfo)

Method Detail

getInstance

protected static RemoteUserInterface getInstance(SessionData sessionData,
                                                 java.lang.String tabId)

setElementID

public void setElementID(java.lang.String elementID)

Sets the ID of the element to be used for setVisible (instead of getTabId()). Defines the remote user interface to be a dependent part of a superior frame.

getElementID

public java.lang.String getElementID()

getContextInfo

public ContextInfo getContextInfo()

getConcerning

public java.lang.String getConcerning()

Returns the type of interface.

Returns:

the type of interface

See Also:

ConstantsD.TOOLBAR, ConstantsD.SEARCH_LIST_DETAIL_GUI, ConstantsD.FREE_CENTER_GUI, ConstantsD.DIALOG_FOR_PROPERTIES, ConstantsD.DIALOG_FOR_OPTIONS_WITH_LIST_SELECTION, ConstantsD.DIALOG_FOR_CHOOSING

getTabId

public java.lang.String getTabId()

Returns the ID of the tab or the window

Returns:

the ID of the tab or the window

getTabLabel

public java.lang.String getTabLabel()

Returns the label of the tab or the title of the current window.

Returns:

the label of the tab or the title of the current window

getAppResStr

public java.lang.String getAppResStr(java.lang.String resourceKey)

Description copied from interface: AppTextResource

Returns a text in the corresponding language according to the locale specific resource bundle.

Specified by:

getAppResStr in interface AppTextResource

Parameters:

resourceKey - the key of the resource to retrieve

Returns:

a text in the corresponding language according to the locale specific resource bundle

setAppellation

public void setAppellation(java.lang.String appellation)

Sets the appellation of this user interface. In case of applet inlay this appellation will cause a subhead. In case of dialog this appellation will appear in window title.

Parameters:

appellation - the appellation of the user interface

getAppellation

public java.lang.String getAppellation()

register

public void register(Exemptible exemptible)

Description copied from interface: ExemptibleManager

Registers an object to free its external resources as soon as they are not needed any more. The purpose of this registration is to ensure that already during the construction of this object, that certain resources are automatically released at a suitable later moment.

Specified by:

register in interface ExemptibleManager

Parameters:

exemptible - the exemptible object to register

register

public DataObject register(DataObject dataObject)

Registers an object to free its external resources as soon as they are not needed any more. The purpose of this registration is to ensure that already during the construction of this object, that certain resources are automatically released at a suitable later moment.

Parameters:

dataObject - the data object to register to be released at a suitable later moment

Returns:

the data object - this, this method can be included in nested instructions

registerRemotable

protected void registerRemotable(RemoteContent nextRemotable)

getTranslation

protected java.lang.String getTranslation(java.lang.String resourceKey)

addDependency

public void addDependency(MustTextField textField,
                          MustButton button)

addDependency

public void addDependency(MustTextField textField,
                          MustButton button1,
                          MustButton button2)

setMessageToKeep

protected void setMessageToKeep(java.lang.String messageToKeep)

Sets the message to be read by the user, it is not reset by generalActionEnding when action completed. Thus, the user is able to notify the message without pressing a confirmation button.

Parameters:

messageToKeep - the message for the user

setMessageToKeep

public void setMessageToKeep(java.lang.String messageToKeep,
                             java.lang.Object contextElement)

Sets the message to be read by the user, it is not reset by generalActionEnding when action completed. Thus, the user is able to notify the message without pressing a confirmation button. Anyway user might overlook the message. Therefore it is good idea to popup the message if user repeats his action without changing the message context. Specifying the context of the message will help this class to force a popup if nothing has changed.

Parameters:

messageToKeep - the message for the user

contextElement - the element specifying the context of the message / the origin witch caused message - special value to suppress dialog completely

setMessageToKeep

public void setMessageToKeep(java.lang.String messageToKeep,
                             java.lang.Object contextElement,
                             java.lang.String soundToPlay)

Sets the message to be read by the user, it is not reset by generalActionEnding when action completed. Thus, the user is able to notify the message without pressing a confirmation button. Anyway user might overlook the message. Therefore it is good idea to popup the message if user repeats his action without changing the message context. Specifying the context of the message will help this class to force a popup if nothing has changed.

Parameters:

messageToKeep - the message for the user

contextElement - the element specifying the context of the message

soundToPlay - the sound to play while presenting the message

setTitle

protected void setTitle(java.lang.String newTitle)

getMessageSetSize

public int getMessageSetSize()

setMessageToKeep

protected void setMessageToKeep(Message message)

setMessageToKeep

protected void setMessageToKeep(java.lang.String messageToKeep,
                                java.lang.String soundToPlay)

setSoundToPlay

protected void setSoundToPlay(java.lang.String soundToPlay)

setMessage

protected void setMessage(java.lang.String messageToKeep)

isVisible

public boolean isVisible()

setVisible

public void setVisible(boolean visible)

Specified by:

setVisible in interface RemotableControler

setToRenewToTrue

public void setToRenewToTrue()

fetchValuesFromRequest

public void fetchValuesFromRequest(GeneralizedRequest request)

Specified by:

fetchValuesFromRequest in interface Remotable

hasVeto

public boolean hasVeto()

Return true if input in e.g. dialog is not accepted.

Returns:

true if input in e.g. dialog is not accepted

buildRemoteView

public void buildRemoteView(ToAppletWriter out)

Description copied from interface: AppletTalker

Build remote view.

Specified by:

buildRemoteView in interface AppletTalker

Parameters:

out - the writer which will be read by the applet

associateDefaultButtonToInputField

protected void associateDefaultButtonToInputField(MustTextField textField,
                                                  MustButton button)

setToolTipText

public void setToolTipText(java.lang.String newToolTipText)

Description copied from interface: Remotable

Sets the component's tool tip text.

Specified by:

setToolTipText in interface Remotable

Parameters:

newToolTipText - the component's tool tip text

free

public void free()

Description copied from interface: ExemptibleManager

Releases external resources. May be called manually without waiting for garbage collection to occur.

Specified by:

free in interface Exemptible

Specified by:

free in interface ExemptibleManager

destroy

public void destroy()

Description copied from interface: Remotable

Don't wait until garbage collector removed weak reference.

Specified by:

destroy in interface Remotable