de.must.markup

Class MustTextField

java.lang.Object

de.must.markup.MustInputField

de.must.markup.MustTextField

All Implemented Interfaces:

Markupable, ValueFetcher

Direct Known Subclasses:

DataTextField, MustDateField, MustDecimalField, MustIntField, MustTimeField

public class MustTextField
extends MustInputField

Text input field analogous to JTextField to be represent by markup languages.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	additionalTagFragments
protected java.lang.String	className
protected boolean	editable
protected boolean	enabled
protected int	fontSize
protected int	maxlength
protected boolean	required
protected int	size

Fields inherited from class de.must.markup.MustInputField

comment, focus, name, placeholder, toolTipText

Constructor Summary

Constructors

Constructor and Description
MustTextField() Constructs a new text field with a default length of 20 characters.
MustTextField(int length) Constructs a new text field with the length as specified.
MustTextField(int size, int maxlength) Constructs a new text field with the specified size and max length.
MustTextField(java.lang.String name, int length) Constructs a new text field with the specified name and value.
MustTextField(java.lang.String name, java.lang.String value, int size, int maxlength) Constructs a new text field with the specified name, value, size and max length.

Method Summary

Modifier and Type	Method and Description
void	fetchYourValueFromRequest(GeneralizedRequest request) Causes the component to read user input by calling request.getParameter and update the internal mirrored value.
java.lang.String	getCreationTag() Returns the tag sequence that's needed to show this object in the user interface.
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	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.
void	setAdditionalTagFragments(java.lang.String additionalTagFragments) Sets the component's additional tag fragments.
void	setClassName(java.lang.String className) Sets the component's class name - may be used to assign formatting via stylesheets.
void	setColumns(int columns) Sets the component's size via number of columns to be displayed.
static void	setDefaultAdditionalTagFragments(java.lang.String newDefaultAdditionalTagFragments) Sets the component's default additional tag fragments.
static void	setDefaultClassName(java.lang.String newDefaultClassName) Sets the component's default class name - may be used to assign formatting via stylesheets.
void	setEditable(boolean editable) Sets the specified boolean to indicate whether or not this component should be editable.
void	setEnabled(boolean enabled) Sets the specified boolean to indicate whether or not this component is enabled.
void	setFontSize(int fontSize)
void	setMaxlength(int maxlength) Sets the maximum string length to be entered.
void	setRequired(boolean required) Sets the fact that user input is requested (mandatory)
void	setText(java.lang.String newText) Sets the text.
java.lang.String	toString() Returns the tag sequence that's needed to show this object in the user interface.

Methods inherited from class de.must.markup.MustInputField

destroy, getName, setComment, setFocus, setPlaceHolder, setToolTipText

Methods inherited from class java.lang.Object

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

Field Detail

className

protected java.lang.String className

additionalTagFragments

protected java.lang.String additionalTagFragments

size

protected int size

maxlength

protected int maxlength

fontSize

protected int fontSize

required

protected boolean required

editable

protected boolean editable

enabled

protected boolean enabled

Constructor Detail

MustTextField

public MustTextField()

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

MustTextField

public MustTextField(int length)

Constructs a new text field with the length as specified.

Parameters:

length - the length of the text field

MustTextField

public MustTextField(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(java.lang.String name,
                     int length)

Constructs a new text field with the specified name and value.

Parameters:

name - the name of the field to be used for markup parameters

length - rendering relevant length of the text field

MustTextField

public MustTextField(java.lang.String name,
                     java.lang.String value,
                     int size,
                     int maxlength)

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

Parameters:

name - the name of the field to be used for markup parameters

value - the initial value of the text field

size - rendering relevant size of the text field

maxlength - input control relevant max length of the text field

Method Detail

setMaxlength

public void setMaxlength(int maxlength)

Sets the maximum string length to be entered.

Parameters:

maxlength - input control relevant max length of the text field

setDefaultClassName

public static void setDefaultClassName(java.lang.String newDefaultClassName)

Sets the component's default class name - may be used to assign formatting via stylesheets.

Parameters:

newDefaultClassName - the component's default class name

setClassName

public void setClassName(java.lang.String className)

Sets the component's class name - may be used to assign formatting via stylesheets.

Parameters:

newDefaultClassName - the component's class name

setDefaultAdditionalTagFragments

public static void setDefaultAdditionalTagFragments(java.lang.String newDefaultAdditionalTagFragments)

Sets the component's default additional tag fragments. E.g. JavaScript like onChange may be added.

Parameters:

newDefaultClassName - the component's default additional tag fragments.

setAdditionalTagFragments

public void setAdditionalTagFragments(java.lang.String additionalTagFragments)

Sets the component's additional tag fragments. E.g. JavaScript like onChange may be added.

Parameters:

newDefaultClassName - the component's additional tag fragments.

setColumns

public void setColumns(int columns)

Sets the component's size via number of columns to be displayed.

Parameters:

columns - the number of columns to be displayed

setFontSize

public void setFontSize(int fontSize)

setEditable

public void setEditable(boolean editable)

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

Parameters:

editable - indicates whether or not this component is editable

setEnabled

public void setEnabled(boolean enabled)

Sets the specified boolean to indicate whether or not this component is enabled.

Parameters:

enabled - indicates whether or not this component is enabled

toString

public java.lang.String toString()

Returns the tag sequence that's needed to show this object in the user interface. Useful to minimize instructions in JavaServerPages - only the markupable object is to be named.

Overrides:

toString in class MustInputField

Returns:

the tag sequence to show the component

getCreationTag

public java.lang.String getCreationTag()

Returns the tag sequence that's needed to show this object in the user interface.

Returns:

the tag sequence to show the component

fetchYourValueFromRequest

public void fetchYourValueFromRequest(GeneralizedRequest request)

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

Specified by:

fetchYourValueFromRequest in interface ValueFetcher

Specified by:

fetchYourValueFromRequest in class MustInputField

Parameters:

request - the current request

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

setRequired

public void setRequired(boolean required)

Sets the fact that user input is requested (mandatory)

Parameters:

required - whether this inuput is mandatory or not.

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