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

All Superinterfaces:

FormBaseComponentIdProvider, FormItem, TextElement

All Known Implementing Classes:

RichTextElementImpl

public interface RichTextElement
extends TextElement

Description:
The rich text flexi form element is a text area that can be formatted using WYSIWYG techniques.The formatting is limited to what is possible in a browser.

Initial Date: 21.04.2009

Author:

gnaegi

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

RichTextConfiguration	getEditorConfiguration() Get the rich text editor configuration object
java.lang.String	getRawValue() Get the raw value of the text element as submitted by the user.

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

getValue, getValue, isEmpty, isEmpty, setDisplaySize, setIsEqualCheck, setItemValidatorProvider, setMaxLength, setNewOriginalValue, setNotEmptyCheck, setNotLongerThanCheck, setRegexMatchCheck, setValue

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

getEditorConfiguration

RichTextConfiguration getEditorConfiguration()

Get the rich text editor configuration object

Returns:

getRawValue

java.lang.String getRawValue()

Get the raw value of the text element as submitted by the user. Be aware that this method does NOT filter against XSS attacks! Use this only when you manually check for XSS attacks or you allow users at this point to add unsave data including javascript code.

Returns: