org.olat.core.gui.formelements
Class TextElement

java.lang.Object
  org.olat.core.gui.formelements.AbstractFormElement
      org.olat.core.gui.formelements.AbstractTextElement
          org.olat.core.gui.formelements.TextElement

All Implemented Interfaces:

FormElement

Direct Known Subclasses:

DateElement, IntegerElement, PasswordElement, StaticHTMLTextElement, StaticTextElement

public class TextElement
extends AbstractTextElement

Author:

Felix Jost

Constructor Summary

TextElement(java.lang.String labelKey, int maxLength)
Constructor for TextElement.

TextElement(java.lang.String labelKey, java.lang.String value, boolean mandatory, int maxLength)

TextElement(java.lang.String labelKey, java.lang.String value, boolean mandatory, int size, int maxLength)

TextElement(java.lang.String labelKey, java.lang.String value, int maxLength)
Constructor for TextElement

Method Summary

java.lang.String	getDateChooserDateFormat()
int	getMaxLength()
int	getSize()
boolean	isDateChooserTimeEnabled()
boolean	isUseDateChooser()
void	setDateChooserDateFormat(java.lang.String dateChooserDateFormat)
void	setDateChooserTimeEnabled(boolean dateChooserTimeEnabled)
void	setMaxLength(int maxLength)
void	setSize(int size)
void	setUseDateChooser(boolean useDateChooser)
void	setValue(java.lang.String value) Sets the value.

Methods inherited from class org.olat.core.gui.formelements.AbstractTextElement

getPopupData, getValue, isDirty, isEmpty, isEmpty, isEqual, matches, notEmpty, notLongerThan, setPopupData, setValues

Methods inherited from class org.olat.core.gui.formelements.AbstractFormElement

clearError, getError, getExample, getLabelKey, getName, getVisualMarked, isError, isMandatory, isReadOnly, setError, setErrorKey, setErrorKeyWithParams, setExample, setLabelKey, setMandatory, setName, setReadOnly, setVisualMarked

Methods inherited from class java.lang.Object

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

Constructor Detail

TextElement

public TextElement(java.lang.String labelKey,
                   int maxLength)

Constructor for TextElement. use the constructor TextElement(String labelKey, String value) instead by giving the inital value

Parameters:

labelKey - the lable key

maxLength -

TextElement

public TextElement(java.lang.String labelKey,
                   java.lang.String value,
                   int maxLength)

Constructor for TextElement

Parameters:

labelKey - The lable key

value - The initial value

maxLength -

TextElement

public TextElement(java.lang.String labelKey,
                   java.lang.String value,
                   boolean mandatory,
                   int maxLength)

Parameters:

labelKey -

value -

mandatory -

maxLength -

TextElement

public TextElement(java.lang.String labelKey,
                   java.lang.String value,
                   boolean mandatory,
                   int size,
                   int maxLength)

Parameters:

labelKey -

value -

mandatory -

size -

maxLength -

Method Detail

setValue

public void setValue(java.lang.String value)

Sets the value. if null is given, empty string is assumed. If the value ha a length longer than maxLenth a OLATRuntimeException is thrown

Overrides:

setValue in class AbstractTextElement

Parameters:

value - The value to set

Throws:

OLATRuntimeException - if value.length > maxLength

getMaxLength

public int getMaxLength()

Returns:

Returns the maxLength.

setMaxLength

public void setMaxLength(int maxLength)

Parameters:

maxLength - The maxLength to set.

getSize

public int getSize()

Returns:

Returns the size.

setSize

public void setSize(int size)

Parameters:

size - The size to set.

isUseDateChooser

public boolean isUseDateChooser()

Returns:

true if date chooser should be used

setUseDateChooser

public void setUseDateChooser(boolean useDateChooser)

Parameters:

useDateChooser - true if date chooser should be used

getDateChooserDateFormat

public java.lang.String getDateChooserDateFormat()

Returns:

setDateChooserDateFormat

public void setDateChooserDateFormat(java.lang.String dateChooserDateFormat)

Parameters:

dateChooserDateFormat -

isDateChooserTimeEnabled

public boolean isDateChooserTimeEnabled()

Returns:

setDateChooserTimeEnabled

public void setDateChooserTimeEnabled(boolean dateChooserTimeEnabled)

Parameters:

dateChooserTimeEnabled -