Class RichTextArea
-
- All Implemented Interfaces:
Action.ShortcutNotifier
,ConnectorEventListener
,ContextClickEvent.ContextClickNotifier
,MethodEventSource
,SerializableEventListener
,ClientConnector
,Sizeable
,VariableOwner
,com.vaadin.shared.Connector
,Component
,Component.Focusable
,LegacyComponent
,Buffered
,BufferedValidatable
,Property<String>
,Property.Editor
,Property.ReadOnlyStatusChangeListener
,Property.ReadOnlyStatusChangeNotifier
,Property.ValueChangeListener
,Property.ValueChangeNotifier
,Property.Viewer
,Validatable
,Field<String>
,Serializable
,EventListener
@Deprecated public class RichTextArea extends AbstractField<String> implements LegacyComponent
Deprecated.As of 8.0 replaced byRichTextArea
based on the new data binding APIA simple RichTextArea to edit HTML format text. Note, that usingAbstractTextField.setMaxLength(int)
method inRichTextArea
may produce unexpected results as formatting is counted into length of field.- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.vaadin.v7.ui.AbstractField
AbstractField.FocusShortcut, AbstractField.ReadOnlyStatusChangeEvent
-
Nested classes/interfaces inherited from interface com.vaadin.v7.data.Buffered
Buffered.SourceException
-
Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector
ClientConnector.AttachEvent, ClientConnector.AttachListener, ClientConnector.ConnectorErrorEvent, ClientConnector.DetachEvent, ClientConnector.DetachListener
-
Nested classes/interfaces inherited from interface com.vaadin.ui.Component
Component.ErrorEvent, Component.Event, Component.Focusable, Component.Listener
-
Nested classes/interfaces inherited from interface com.vaadin.v7.ui.Field
Field.ValueChangeEvent
-
Nested classes/interfaces inherited from interface com.vaadin.v7.data.Property
Property.Editor, Property.ReadOnlyException, Property.ReadOnlyStatusChangeListener, Property.ReadOnlyStatusChangeNotifier, Property.Transactional<T>, Property.ValueChangeListener, Property.ValueChangeNotifier, Property.Viewer
-
Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable
Sizeable.Unit
-
-
Field Summary
-
Fields inherited from class com.vaadin.ui.AbstractComponent
DESIGN_ATTR_PLAIN_TEXT
-
Fields inherited from interface com.vaadin.server.Sizeable
SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS
-
-
Constructor Summary
Constructors Constructor Description RichTextArea()
Deprecated.Constructs an emptyRichTextArea
with no caption.RichTextArea(Property dataSource)
Deprecated.Constructs a newRichTextArea
that's bound to the specifiedProperty
and has no caption.RichTextArea(String caption)
Deprecated.Constructs an emptyRichTextArea
with the given caption.RichTextArea(String caption, Property dataSource)
Deprecated.Constructs a newRichTextArea
that's bound to the specifiedProperty
and has the given caption.RichTextArea(String caption, String value)
Deprecated.Constructs a newRichTextArea
with the given caption and initial text contents.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
changeVariables(Object source, Map<String,Object> variables)
Deprecated.void
clear()
Deprecated.Clears the value of the field.String
getNullRepresentation()
Deprecated.Gets the null-string representation.protected RichTextAreaState
getState()
Deprecated.Class<String>
getType()
Deprecated.Returns the type of the Field.boolean
isEmpty()
Deprecated.Is the field empty? In general, "empty" state is same as null.boolean
isNullSettingAllowed()
Deprecated.Is setting nulls with null-string representation allowed.void
paintContent(PaintTarget target)
Deprecated.void
readDesign(org.jsoup.nodes.Element design, DesignContext designContext)
Deprecated.void
selectAll()
Deprecated.Selects all text in the rich text area.void
setNullRepresentation(String nullRepresentation)
Deprecated.Sets the null-string representation.void
setNullSettingAllowed(boolean nullSettingAllowed)
Deprecated.Sets the null conversion mode.void
setReadOnly(boolean readOnly)
Deprecated.Changes the readonly state and throw read-only status change events.void
writeDesign(org.jsoup.nodes.Element design, DesignContext designContext)
Deprecated.-
Methods inherited from class com.vaadin.v7.ui.AbstractField
addListener, addListener, addReadOnlyStatusChangeListener, addValidator, addValueChangeListener, attach, beforeClientResponse, commit, detach, discard, fireReadOnlyStatusChange, fireValueChange, focus, getConversionError, getConversionError, getConvertedValue, getConverter, getCurrentBufferedSourceException, getCustomAttributes, getErrorMessage, getInternalValue, getModelType, getPropertyDataSource, getRequiredError, getState, getTabIndex, getValidators, getValue, isBuffered, isInvalidAllowed, isInvalidCommitted, isModified, isReadOnly, isRequired, isValid, isValidationVisible, readOnlyStatusChange, removeAllValidators, removeListener, removeListener, removeReadOnlyStatusChangeListener, removeValidator, removeValueChangeListener, setBuffered, setConversionError, setConvertedValue, setConverter, setConverter, setCurrentBufferedSourceException, setInternalValue, setInvalidAllowed, setInvalidCommitted, setLocale, setPropertyDataSource, setRequired, setRequiredError, setTabIndex, setValidationVisible, setValue, setValue, setValue, shouldHideErrors, validate, validate, valueChange
-
Methods inherited from class com.vaadin.v7.ui.AbstractLegacyComponent
getExplicitImmediateValue, isImmediate, setImmediate
-
Methods inherited from class com.vaadin.ui.AbstractComponent
addContextClickListener, addListener, addShortcutListener, addStyleName, findAncestor, fireComponentErrorEvent, fireComponentEvent, getActionManager, getCaption, getComponentError, getData, getDebugId, getDescription, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isEnabled, isOrHasAncestor, isRequiredIndicatorVisible, isResponsive, isVisible, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setDescription, setEnabled, setHeight, setHeight, setHeightFull, setHeightUndefined, setIcon, setId, setParent, setPrimaryStyleName, setRequiredIndicatorVisible, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setVisible, setWidth, setWidth, setWidthFull, setWidthUndefined
-
Methods inherited from class com.vaadin.server.AbstractClientConnector
addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addListener, addListener, addListener, addMethodInvocationToQueue, createState, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getListeners, getResource, getRpcManager, getRpcProxy, getSession, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource, updateDiffstate
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.vaadin.event.Action.ShortcutNotifier
addShortcutListener, removeShortcutListener
-
Methods inherited from interface com.vaadin.server.ClientConnector
addAttachListener, addDetachListener, beforeClientResponse, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler
-
Methods inherited from interface com.vaadin.ui.Component
addListener, addStyleName, addStyleNames, attach, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isVisible, removeListener, removeStyleName, removeStyleNames, setCaption, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setStyleName, setStyleName, setVisible
-
Methods inherited from interface com.vaadin.ui.LegacyComponent
markAsDirty
-
Methods inherited from interface com.vaadin.server.Sizeable
getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightFull, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull, setWidthUndefined
-
Methods inherited from interface com.vaadin.server.VariableOwner
isEnabled
-
-
-
-
Constructor Detail
-
RichTextArea
public RichTextArea()
Deprecated.Constructs an emptyRichTextArea
with no caption.
-
RichTextArea
public RichTextArea(String caption)
Deprecated.Constructs an emptyRichTextArea
with the given caption.- Parameters:
caption
- the caption for the editor.
-
RichTextArea
public RichTextArea(Property dataSource)
Deprecated.Constructs a newRichTextArea
that's bound to the specifiedProperty
and has no caption.- Parameters:
dataSource
- the data source for the editor value
-
RichTextArea
public RichTextArea(String caption, Property dataSource)
Deprecated.Constructs a newRichTextArea
that's bound to the specifiedProperty
and has the given caption.- Parameters:
caption
- the caption for the editor.dataSource
- the data source for the editor value
-
-
Method Detail
-
paintContent
public void paintContent(PaintTarget target) throws PaintException
Deprecated.- Specified by:
paintContent
in interfaceLegacyComponent
- Throws:
PaintException
-
setReadOnly
public void setReadOnly(boolean readOnly)
Deprecated.Description copied from class:AbstractField
Changes the readonly state and throw read-only status change events.- Specified by:
setReadOnly
in interfaceProperty<String>
- Overrides:
setReadOnly
in classAbstractField<String>
- Parameters:
readOnly
- a boolean value specifying whether the component is put read-only mode or not- See Also:
AbstractLegacyComponent.setReadOnly(boolean)
-
selectAll
public void selectAll()
Deprecated.Selects all text in the rich text area. As a side effect, focuses the rich text area.- Since:
- 6.5
-
changeVariables
public void changeVariables(Object source, Map<String,Object> variables)
Deprecated.- Specified by:
changeVariables
in interfaceVariableOwner
-
getType
public Class<String> getType()
Deprecated.Description copied from class:AbstractField
Returns the type of the Field. The methodsgetValue
andsetValue
must be compatible with this type: one must be able to safely cast the value returned fromgetValue
to the given type and pass any variable assignable to this type as an argument tosetValue
.
-
getNullRepresentation
public String getNullRepresentation()
Deprecated.Gets the null-string representation.The null-valued strings are represented on the user interface by replacing the null value with this string. If the null representation is set null (not 'null' string), painting null value throws exception.
The default value is string 'null'.
- Returns:
- the String Textual representation for null strings.
- See Also:
AbstractTextField.isNullSettingAllowed()
-
isNullSettingAllowed
public boolean isNullSettingAllowed()
Deprecated.Is setting nulls with null-string representation allowed.If this property is true, writing null-representation string to text field always sets the field value to real null. If this property is false, null setting is not made, but the null values are maintained. Maintenance of null-values is made by only converting the textfield contents to real null, if the text field matches the null-string representation and the current value of the field is null.
By default this setting is false
- Returns:
- boolean Should the null-string represenation be always converted to null-values.
- See Also:
AbstractTextField.getNullRepresentation()
-
setNullRepresentation
public void setNullRepresentation(String nullRepresentation)
Deprecated.Sets the null-string representation.The null-valued strings are represented on the user interface by replacing the null value with this string. If the null representation is set null (not 'null' string), painting null value throws exception.
The default value is string 'null'
- Parameters:
nullRepresentation
- Textual representation for null strings.- See Also:
AbstractTextField.setNullSettingAllowed(boolean)
-
setNullSettingAllowed
public void setNullSettingAllowed(boolean nullSettingAllowed)
Deprecated.Sets the null conversion mode.If this property is true, writing null-representation string to text field always sets the field value to real null. If this property is false, null setting is not made, but the null values are maintained. Maintenance of null-values is made by only converting the textfield contents to real null, if the text field matches the null-string representation and the current value of the field is null.
By default this setting is false.
- Parameters:
nullSettingAllowed
- Should the null-string represenation be always converted to null-values.- See Also:
AbstractTextField.getNullRepresentation()
-
isEmpty
public boolean isEmpty()
Deprecated.Description copied from interface:Field
Is the field empty? In general, "empty" state is same as null. As an exception, TextField also treats empty string as "empty".
-
clear
public void clear()
Deprecated.Description copied from interface:Field
Clears the value of the field.The field value is typically reset to the initial value of the field. Calling
Field.isEmpty()
on a cleared field must always returns true.
-
readDesign
public void readDesign(org.jsoup.nodes.Element design, DesignContext designContext)
Deprecated.- Specified by:
readDesign
in interfaceComponent
- Overrides:
readDesign
in classAbstractField<String>
-
writeDesign
public void writeDesign(org.jsoup.nodes.Element design, DesignContext designContext)
Deprecated.- Specified by:
writeDesign
in interfaceComponent
- Overrides:
writeDesign
in classAbstractField<String>
-
getState
protected RichTextAreaState getState()
Deprecated.- Overrides:
getState
in classAbstractField<String>
-
-