de.must.appletserver

Class MustTextField

java.lang.Object

de.must.appletserver.RemoteElement

de.must.appletserver.MustInputField

de.must.appletserver.MustTextField

All Implemented Interfaces:

ActionInterpreter, AppletTalker, Remotable, RemoteContent, Exemptible, ExemptibleManager

Direct Known Subclasses:

DataTextField, FileStreamField, MustDateField, MustIntField, MustLongField, MustPasswordField, MustTextArea, ParamTextField, TemplateLink

public class MustTextField
extends MustInputField
implements ActionInterpreter

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	additionalTagFragments
protected boolean	capitalization
protected java.lang.String	className
protected ContentChangeListener	contentChangeListener
protected boolean	controlLength
protected java.lang.String	enterAction
protected static int	maxColumns
protected int	maxlength
protected boolean	registerFlag
protected boolean	required
protected int	size

Fields inherited from class de.must.appletserver.RemoteElement

context, editable, enabled, lastEditability, lastVisibility, name, nonstandardPanel, nonstandardPosition, sessionData, toolTipText, visible

Constructor Summary

Constructors

Constructor and Description
MustTextField(SessionData sessionData) Constructs a new text field with a default length of 20 characters.
MustTextField(SessionData sessionData, int length) Constructs a new text field with the length as specified.
MustTextField(SessionData sessionData, int size, int maxlength) Constructs a new text field with the specified size and max length.
MustTextField(SessionData sessionData, int size, int maxlength, boolean controlLength) Constructs a new text field with length, max chars and length control as specified.

Method Summary

Modifier and Type	Method and Description
void	addContentChangeListener(ContentChangeListener l) Sets the contentChangeListener - package private, access via e.g.
protected void	addMoreCreationAspects(ToAppletWriter out) Override to add more creation aspects in inherited class.
void	buildRemoteView(ToAppletWriter out) Build remote view.
void	fetchValuesFromRequest(GeneralizedRequest request) Causes the component to read user input by calling request.getParameter and update the internal mirrored value.
java.lang.String	getApplication()
protected java.lang.String	getCreateTagElement()
java.lang.String	getText() Return the text of the text field.
java.lang.String	getTextOrNullIfEmpty() Return the text of the field or null if the text field is empty or contains spaces only.
boolean	hasFocus()
boolean	isFilled()
boolean	isModified() Indicates whether the component's value differs from its initial value.
boolean	isRequirementUnfulfilled() Returns true if the component's value is mandatory but not filled.
boolean	isValid() Returns true the text field is valid.
boolean	perform(java.lang.String action) Performs this action if the passed action ID is equal to the action ID of the class that implements this interface.
void	setApplication(java.lang.String application)
void	setCapitalization(boolean capitalization)
void	setColumns(int columns) Sets the number of columns.
void	setEditable(boolean editable) Sets the specified boolean to indicate whether or not this component should be editable.
void	setEnterAction(java.lang.String enterAction)
void	setOnChoice(java.lang.String table, java.lang.String column)
void	setRegisterFlag(boolean registerFlag) Sets the flag that this field is to be registered by id.
void	setRequired(boolean required) Sets the fact that user input is requested (mandatory)
void	setText(java.lang.String newText) Sets the text.
void	setTextAsUserInput(java.lang.String newText) Sets the text as if it was entered by user to force modified flag for data saving.
void	setValues(ToAppletWriter out)

Methods inherited from class de.must.appletserver.MustInputField

destroy

Methods inherited from class de.must.appletserver.RemoteElement

beginAction, endAction, free, getContext, getName, getTranslation, isEnabled, isVisible, register, requestFocusInWindow, resetLastStatus, selectAll, setEnabled, setToolTipText, setVisible

Methods inherited from class java.lang.Object

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

Field Detail

maxColumns

protected static final int maxColumns

See Also:

Constant Field Values

className

protected java.lang.String className

additionalTagFragments

protected java.lang.String additionalTagFragments

size

protected int size

maxlength

protected int maxlength

controlLength

protected boolean controlLength

capitalization

protected boolean capitalization

required

protected boolean required

registerFlag

protected boolean registerFlag

contentChangeListener

protected ContentChangeListener contentChangeListener

enterAction

protected java.lang.String enterAction

Constructor Detail

MustTextField

public MustTextField(SessionData sessionData)

Constructs a new text field with a default length of 20 characters.

MustTextField

public MustTextField(SessionData sessionData,
                     int length)

Constructs a new text field with the length as specified.

Parameters:

sessionData - session data

length - the length of the text field

MustTextField

public MustTextField(SessionData sessionData,
                     int size,
                     int maxlength)

Constructs a new text field with the specified size and max length.

Parameters:

size - rendering relevant size of the text field

maxlength - input control relevant max length of the text field

MustTextField

public MustTextField(SessionData sessionData,
                     int size,
                     int maxlength,
                     boolean controlLength)

Constructs a new text field with length, max chars and length control as specified. length control.

Parameters:

sessionData - session data

size - the length (size) of the text field

maxlength - the max characters to be inserted

controlLength - if true, characters are removed, if they exceed the max char specification above

Method Detail

setApplication

public void setApplication(java.lang.String application)

getApplication

public java.lang.String getApplication()

setRegisterFlag

public void setRegisterFlag(boolean registerFlag)

Sets the flag that this field is to be registered by id. Needed e.g. to associate this field as target field of selected choice.

Parameters:

registerFlag - whether or not this field is to be registered by id

setCapitalization

public void setCapitalization(boolean capitalization)

setEditable

public void setEditable(boolean editable)

Sets the specified boolean to indicate whether or not this component should be editable.

Overrides:

setEditable in class RemoteElement

Parameters:

editable - indicates whether or not this component is editable

See Also:

#setEditableForUserTyping

setColumns

public void setColumns(int columns)

Sets the number of columns.

Parameters:

columns - the number of columns >= 0

setEnterAction

public void setEnterAction(java.lang.String enterAction)

setOnChoice

public void setOnChoice(java.lang.String table,
                        java.lang.String column)

addContentChangeListener

public void addContentChangeListener(ContentChangeListener l)

Sets the contentChangeListener - package private, access via e.g. UniversalCenterGUI.addContentChangeListener(MustTextField, de.must.util.Callback) (package private)

Parameters:

l - the listener for content change

fetchValuesFromRequest

public void fetchValuesFromRequest(GeneralizedRequest request)

Causes the component to read user input by calling request.getParameter and update the internal mirrored value.

Specified by:

fetchValuesFromRequest in interface Remotable

Parameters:

request - the current request

hasFocus

public boolean hasFocus()

getText

public java.lang.String getText()

Return the text of the text field.

Returns:

the text of the text field

getTextOrNullIfEmpty

public java.lang.String getTextOrNullIfEmpty()

Return the text of the field or null if the text field is empty or contains spaces only.

Returns:

the text of the field or null if the text field is empty or contains spaces only

setText

public void setText(java.lang.String newText)

Sets the text.

Parameters:

newText - the new text

setTextAsUserInput

public void setTextAsUserInput(java.lang.String newText)

Sets the text as if it was entered by user to force modified flag for data saving.

Parameters:

newText - the new text

setRequired

public void setRequired(boolean required)

Sets the fact that user input is requested (mandatory)

Parameters:

required - whether this input is mandatory or not.

buildRemoteView

public void buildRemoteView(ToAppletWriter out)

Description copied from interface: AppletTalker

Build remote view.

Specified by:

buildRemoteView in interface AppletTalker

Overrides:

buildRemoteView in class RemoteElement

Parameters:

out - the writer which will be read by the applet

addMoreCreationAspects

protected void addMoreCreationAspects(ToAppletWriter out)

Override to add more creation aspects in inherited class.

getCreateTagElement

protected java.lang.String getCreateTagElement()

setValues

public void setValues(ToAppletWriter out)

Specified by:

setValues in interface RemoteContent

Overrides:

setValues in class RemoteElement

isFilled

public boolean isFilled()

Returns:

true if the component has a value

isValid

public boolean isValid()

Returns true the text field is valid.

Returns:

true the text field is valid

isRequirementUnfulfilled

public boolean isRequirementUnfulfilled()

Returns true if the component's value is mandatory but not filled.

Returns:

if mandatory input is unfulfilled

isModified

public boolean isModified()

Indicates whether the component's value differs from its initial value.

Returns:

true if the component's value differs from its initial value

perform

public boolean perform(java.lang.String action)

Description copied from interface: ActionInterpreter

Performs this action if the passed action ID is equal to the action ID of the class that implements this interface.

Specified by:

perform in interface ActionInterpreter

Parameters:

action - the action to perform

Returns:

true if the class that implements this interface was fitting the given action