org.olat.core.gui.components.form.flexible.elements
Interface TextElement

All Superinterfaces:

FormBaseComponentIdProvider, FormItem

All Known Subinterfaces:

DateChooser, InlineIntegerElement, InlineTextElement, IntegerElement, RichTextElement

All Known Implementing Classes:

AbstractTextElement, IntegerElementImpl, JSDateChooser, RichTextElementImpl, TextAreaElementImpl, TextElementImpl

public interface TextElement
extends FormItem

Description:
TODO: patrickb Class Description for TextElement

Initial Date: 02.02.2007

Author:

patrickb

Field Summary

Fields inherited from interface org.olat.core.gui.components.form.flexible.FormItem

ERRORC, EXAMPLEC, LABELC

Fields inherited from interface org.olat.core.gui.components.form.flexible.FormBaseComponentIdProvider

DISPPREFIX

Method Summary

java.lang.String	getValue() Get the value of the text element.
java.lang.String	getValue(Filter filter) Get the value and filter it using the given filter.
boolean	isEmpty() Check if the text element is empty
boolean	isEmpty(java.lang.String errorKey) Check if the text element is empty
void	setDisplaySize(int displaySize) defines the desired display size of the element
void	setIsEqualCheck(java.lang.String otherValue, java.lang.String errorKey) compares a text value with another value
void	setItemValidatorProvider(ItemValidatorProvider itemValidatorProvider) to be set if TextElement should be validated with its validate() method
void	setMaxLength(int maxLength)
void	setNewOriginalValue(java.lang.String value) Set a new value as the original value that is used when resetting the form.
void	setNotEmptyCheck(java.lang.String errorKey)
void	setNotLongerThanCheck(int maxLength, java.lang.String errorKey)
void	setRegexMatchCheck(java.lang.String regExp, java.lang.String errorKey)
void	setValue(java.lang.String value) Sets the value.

Methods inherited from interface org.olat.core.gui.components.form.flexible.FormItem

addActionListener, clearError, doDispatchFormRequest, evalFormRequest, getAction, getActionListenersFor, getComponent, getErrorC, getErrorText, getExampleC, getExampleText, getLabelC, getLabelText, getName, getRootForm, getTranslator, getUserObject, hasError, hasExample, hasFocus, hasLabel, isEnabled, isMandatory, isVisible, reset, setEnabled, setErrorComponent, setErrorKey, setExampleKey, setFocus, setLabel, setLabelComponent, setMandatory, setRootForm, setTranslator, setUserObject, setVisible, showError, showExample, showLabel, validate

Methods inherited from interface org.olat.core.gui.components.form.flexible.FormBaseComponentIdProvider

getFormDispatchId

Method Detail

getValue

java.lang.String getValue()

Get the value of the text element.

Returns:

String

getValue

java.lang.String getValue(Filter filter)

Get the value and filter it using the given filter. To use multiple filters, use the ChainedFilter instead of a single filter.

Parameters:

filter -

Returns:

setValue

void setValue(java.lang.String value)

Sets the value. if null is given, an empty string is assumed.

Parameters:

value - The value to set

setNewOriginalValue

void setNewOriginalValue(java.lang.String value)

Set a new value as the original value that is used when resetting the form. This can be used when a form is saved and in a later form should be resetted to the intermediate save state.

Does not change the value of the element, just the reset-value!

Parameters:

value - The new original value

setNotEmptyCheck

void setNotEmptyCheck(java.lang.String errorKey)

Parameters:

errorKey -

setNotLongerThanCheck

void setNotLongerThanCheck(int maxLength,
                           java.lang.String errorKey)

Parameters:

maxLength -

errorKey -

setIsEqualCheck

void setIsEqualCheck(java.lang.String otherValue,
                     java.lang.String errorKey)

compares a text value with another value

Parameters:

otherValue -

errorKey -

setItemValidatorProvider

void setItemValidatorProvider(ItemValidatorProvider itemValidatorProvider)

to be set if TextElement should be validated with its validate() method

Parameters:

itemValidatorProvider -

isEmpty

boolean isEmpty()

Check if the text element is empty

Returns:

boolean true if is empty, false otherwise

isEmpty

boolean isEmpty(java.lang.String errorKey)

Check if the text element is empty

Parameters:

errorKey -

Returns:

boolean true if is empty, false otherwise

setRegexMatchCheck

void setRegexMatchCheck(java.lang.String regExp,
                        java.lang.String errorKey)

Parameters:

regExp -

errorKey -

setDisplaySize

void setDisplaySize(int displaySize)

defines the desired display size of the element

setMaxLength

void setMaxLength(int maxLength)

Parameters:

maxLength - The maximum numbe of characters allowed in this field. Set -1 for no limit