net.sf.mmm.client.ui.api.widget.field

Interface UiWidgetRichTextField

All Superinterfaces:

AbstractValidatableObject, Accessibility, AttributeReadAccessKey, AttributeReadAriaRole, AttributeReadDisposed, AttributeReadEnabled, AttributeReadFocused, AttributeReadHeightInRows, AttributeReadHtmlId, AttributeReadId<String>, AttributeReadKeyboardFilter, AttributeReadLabel, AttributeReadMaximumTextLength, AttributeReadMode, AttributeReadModeFixed, AttributeReadModified, AttributeReadPrimaryStyle, AttributeReadStyles, AttributeReadStylesAdvanced, AttributeReadTooltip, AttributeReadTrimValue, AttributeReadValidationFailure, AttributeReadValue<String>, AttributeReadValueAdvanced<String>, AttributeReadValueAsString, AttributeReadVisible, AttributeReadVisibleRecursive, AttributeWriteAccessKey, AttributeWriteDisposed, AttributeWriteEnabled, AttributeWriteFocused, AttributeWriteHeightInRows, AttributeWriteHtmlId, AttributeWriteId<String>, AttributeWriteKeyboardFilter, AttributeWriteLabel, AttributeWriteMaximumTextLength, AttributeWriteMode, AttributeWriteModeFixed, AttributeWriteOnlyFocused, AttributeWritePrimaryStyle, AttributeWriteStyles, AttributeWriteStylesAdvanced, AttributeWriteTooltip, AttributeWriteTrimValue, AttributeWriteValidationFailure, AttributeWriteValue<String>, AttributeWriteValueAdvanced<String>, AttributeWriteValueAsString, AttributeWriteVisible, AttributeWriteVisibleAdvanced, HasValueValidators<String>, UiFeature, UiFeatureEvent, UiFeatureFocus, UiFeatureMessages, UiFeatureMode, UiFeatureValidation<String>, UiFeatureValue<String>, UiFeatureValueAndValidation<String>, UiWidget, UiWidgetAbstractComposite, UiWidgetAbstractWithValue<String>, UiWidgetActive, UiWidgetComposite<UiWidget>, UiWidgetField<String>, UiWidgetNative, UiWidgetRegular, UiWidgetRegularComposite<UiWidget>, UiWidgetTextualInputField<String>, UiWidgetWithValue<String>, ValidatableObject<String>

All Known Implementing Classes:

AbstractUiWidgetRichTextField, UiWidgetRichTextFieldGwt, UiWidgetRichTextFieldTestImpl

public interface UiWidgetRichTextField
extends UiWidgetTextualInputField<String>, AttributeWriteKeyboardFilter, AttributeWriteHeightInRows, UiWidgetNative

This is the interface for a input field widget that represents a rich text area field. Such field is like UiWidgetTextAreaField but allows to enter rich text with markup. It should support the user with a nice toolbar that allows to apply styles to the selected text (e.g. bold, italic, blockquote, etc.). It should also support unordered and ordered lists as well as headings (at least four levels). Also insertion of hyperlinks and images should be possible.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
static String	STYLE_RICH_TEXT_AREA The primary style of the internal widget with the rich text area.

Fields inherited from interface net.sf.mmm.client.ui.api.widget.field.UiWidgetField

STYLE_FIELD, STYLE_LABEL, STYLE_MANDATORY, STYLE_VIEW

Fields inherited from interface net.sf.mmm.client.ui.api.widget.UiWidget

STYLE_HEADER

Fields inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadHtmlId

HTML_ATTRIBUTE_ID, ID_SEPARATOR, PROPERTY_ID

Fields inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadStyles

PROPERTY_STYLES, STYLE_PATTERN_MULTIPLE, STYLE_PATTERN_SINGLE

Fields inherited from interface net.sf.mmm.util.lang.api.concern.Accessibility

WAI_ARIA

Fields inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadLabel

PROPERTY_LABEL

Fields inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadAccessKey

ACCESS_KEY_NONE, HTML_ATTRIBUTE_ACCESS_KEY

Method Summary

Modifier and Type	Method and Description
void	setAvailableFeatures(RichTextFeature... features) This method sets the RichTextFeature that should be available for the end-user.
void	setValue(String value) This method sets the value.

Methods inherited from interface net.sf.mmm.client.ui.api.widget.field.UiWidgetField

getLabel, getLabelWidget, setLabel

Methods inherited from interface net.sf.mmm.client.ui.api.widget.UiWidgetComposite

getChild, getChild

Methods inherited from interface net.sf.mmm.client.ui.api.widget.UiWidgetAbstractComposite

getChildCount, getChildIndex

Methods inherited from interface net.sf.mmm.client.ui.api.widget.UiWidget

getContext, getParent, getSize

Methods inherited from interface net.sf.mmm.client.ui.api.feature.UiFeatureMessages

clearMessages

Methods inherited from interface net.sf.mmm.client.ui.api.feature.UiFeatureEvent

addEventHandler, removeEventHandler

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteMode

setMode

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadMode

getMode

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteModeFixed

setModeFixed

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadModeFixed

getModeFixed

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteHtmlId

setId

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadHtmlId

getId

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteTooltip

setTooltip

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadTooltip

getTooltip

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteVisibleAdvanced

getVisibleFlag, isVisible, setVisible, setVisible

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadVisibleRecursive

isVisibleRecursive

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteEnabled

setEnabled

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadEnabled

isEnabled

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteStylesAdvanced

addStyle, removeStyle

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadStylesAdvanced

hasStyle

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteStyles

setStyles

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadStyles

getStyles

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWritePrimaryStyle

setPrimaryStyle

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadPrimaryStyle

getPrimaryStyle

Methods inherited from interface net.sf.mmm.util.lang.api.attribute.AttributeWriteDisposed

dispose

Methods inherited from interface net.sf.mmm.util.lang.api.attribute.AttributeReadDisposed

isDisposed

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadModified

isModified

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadAriaRole

getAriaRole

Methods inherited from interface net.sf.mmm.client.ui.api.widget.UiWidgetWithValue

getValue

Methods inherited from interface net.sf.mmm.client.ui.api.feature.UiFeatureValueAndValidation

getValueAndValidate, getValueDirect

Methods inherited from interface net.sf.mmm.client.ui.api.feature.UiFeatureValue

addChangeHandler, removeChangeHandler

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteValueAdvanced

resetValue, setValue, setValueForUser

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadValueAdvanced

getOriginalValue, getValueOrException

Methods inherited from interface net.sf.mmm.client.ui.api.feature.UiFeatureValidation

addValidatorMandatory, isMandatory

Methods inherited from interface net.sf.mmm.util.validation.api.HasValueValidators

addValidator, removeValidator

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteValueAsString

setValueAsString

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadValueAsString

getValueAsString

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteValidationFailure

setValidationFailure

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadValidationFailure

getValidationFailure

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteTrimValue

setTrimValue

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadTrimValue

isTrimValue

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteAccessKey

setAccessKey

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadAccessKey

getAccessKey

Methods inherited from interface net.sf.mmm.client.ui.api.feature.UiFeatureFocus

addFocusHandler, removeFocusHandler

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadFocused

isFocused

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteOnlyFocused

setFocused

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteMaximumTextLength

setMaximumTextLength

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadMaximumTextLength

getMaximumTextLength

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteKeyboardFilter

setKeyboardFilter

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadKeyboardFilter

getKeyboardFilter

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteHeightInRows

setHeightInRows

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadHeightInRows

getHeightInRows

Field Detail

STYLE_RICH_TEXT_AREA

static final String STYLE_RICH_TEXT_AREA

The primary style of the internal widget with the rich text area.

See Also:

Constant Field Values

Method Detail

setValue

void setValue(String value)

This method sets the value. It will also set the modified flag to false.
ATTENTION:
This method will accept markup (html-fragment). Be careful to prevent XSS attacks by only providing verified markup. This can be achieved in the following ways:

• The value was entered using a UiWidgetRichTextField (and NOT any other widget) in the same client instance.
• The value was received from a trusted server on a reliable path (using TLS) and that server strictly validates all markup.
• The value itself was verified to contain safe HTML or escaped to do so in the client before calling this method (safest way).

It is generally forbidden that the value contains JavasSript or CSS.
TODO: It would be nice to have a way that this method does the latter strategy automatically.

Specified by:

setValue in interface AttributeWriteValue<String>

Specified by:

setValue in interface AttributeWriteValueAdvanced<String>

Parameters:

value - is the new value. May be null unless otherwise stated.

setAvailableFeatures

void setAvailableFeatures(RichTextFeature... features)

This method sets the RichTextFeature that should be available for the end-user. By default all RichTextFeatures are active. This method allows to reduce the offered features to those explicitly specified to this method. Then only these features are visible in the toolbar of this rich-text field and accessibly via keyboard shortcuts.

Parameters:

features - are the RichTextFeatures that shall be available.