org.olat.core.gui.formelements
Class AbstractFormElement

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

All Implemented Interfaces:

FormElement

Direct Known Subclasses:

AbstractTextElement, CheckBoxElement, LinkElement, SpacerElement, StaticMultipleSelectionElement, StaticSingleSelectionElement, TitleElement

public abstract class AbstractFormElement
extends java.lang.Object
implements FormElement

enclosing_type Description:

Author:

Felix Jost

Constructor Summary

AbstractFormElement()

Method Summary

void	clearError() Clear the error message.
java.lang.String	getError(Translator translator)
java.lang.String	getExample() Returns an optional element example
java.lang.String	getLabelKey()
java.lang.String	getName()
boolean	getVisualMarked()
boolean	isError()
boolean	isMandatory() Returns the mandatory.
boolean	isReadOnly() Returns the readOnly.
void	setError(java.lang.String error) Set a translated error message.
void	setErrorKey(java.lang.String errorKey) Set an error translation key.
void	setErrorKeyWithParams(java.lang.String errorKey, java.lang.String[] params) Error translation key with parameters to be set in the translation.
void	setExample(java.lang.String string) Sets the optional element example
void	setLabelKey(java.lang.String labelKey) Sets the labelKey.
void	setMandatory(boolean mandatory) Sets the mandatory.
void	setName(java.lang.String name)
void	setReadOnly(boolean readOnly) Sets the readOnly.
void	setVisualMarked(boolean on)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.olat.core.gui.formelements.FormElement

isDirty, setValues

Constructor Detail

AbstractFormElement

public AbstractFormElement()

Method Detail

setName

public void setName(java.lang.String name)

Specified by:

setName in interface FormElement

See Also:

FormElement.setName(java.lang.String)

getName

public java.lang.String getName()

Specified by:

getName in interface FormElement

Returns:

See Also:

FormElement.getName()

setError

public void setError(java.lang.String error)

Set a translated error message.

Specified by:

setError in interface FormElement

Parameters:

error -

getError

public java.lang.String getError(Translator translator)

Specified by:

getError in interface FormElement

Returns:

a translated error message.

See Also:

FormElement.getError(org.olat.core.gui.translator.Translator)

setErrorKey

public void setErrorKey(java.lang.String errorKey)

Set an error translation key.

Specified by:

setErrorKey in interface FormElement

Parameters:

errorKey -

See Also:

FormElement.setErrorKey(java.lang.String)

setErrorKeyWithParams

public void setErrorKeyWithParams(java.lang.String errorKey,
                                  java.lang.String[] params)

Error translation key with parameters to be set in the translation.

Specified by:

setErrorKeyWithParams in interface FormElement

Parameters:

errorKey -

params -

See Also:

FormElement.setErrorKeyWithParams(java.lang.String, java.lang.String[])

isError

public boolean isError()

Specified by:

isError in interface FormElement

Returns:

true if an error or error key was set.

See Also:

FormElement.isError()

clearError

public void clearError()

Clear the error message. After that isError() returns false.

Specified by:

clearError in interface FormElement

See Also:

FormElement.clearError()

getLabelKey

public java.lang.String getLabelKey()

Specified by:

getLabelKey in interface FormElement

Returns:

String

setLabelKey

public void setLabelKey(java.lang.String labelKey)

Sets the labelKey.

Specified by:

setLabelKey in interface FormElement

Parameters:

labelKey - The labelKey to set

isReadOnly

public boolean isReadOnly()

Returns the readOnly.

Specified by:

isReadOnly in interface FormElement

Returns:

boolean

setReadOnly

public void setReadOnly(boolean readOnly)

Sets the readOnly.

Specified by:

setReadOnly in interface FormElement

Parameters:

readOnly - The readOnly to set

isMandatory

public boolean isMandatory()

Returns the mandatory.

Specified by:

isMandatory in interface FormElement

Returns:

boolean

setMandatory

public void setMandatory(boolean mandatory)

Sets the mandatory.

Specified by:

setMandatory in interface FormElement

Parameters:

mandatory - The mandatory to set

getExample

public java.lang.String getExample()

Returns an optional element example

Specified by:

getExample in interface FormElement

Returns:

The example

setExample

public void setExample(java.lang.String string)

Sets the optional element example

Parameters:

string - The example

getVisualMarked

public boolean getVisualMarked()

Specified by:

getVisualMarked in interface FormElement

See Also:

FormElement.getVisualMarked()

setVisualMarked

public void setVisualMarked(boolean on)

Specified by:

setVisualMarked in interface FormElement

See Also:

FormElement.setVisualMarked(boolean)