Package com.vaadin.ui

Class RichTextArea

    • Constructor Detail

      • RichTextArea

        public RichTextArea()
        Constructs an empty RichTextArea with no caption.

      • RichTextArea

        public RichTextArea​(String caption)
        Constructs an empty RichTextArea with the given caption.
        Parameters:
        caption - the caption for the editor.

      • RichTextArea

        public RichTextArea​(Property dataSource)
        Constructs a new RichTextArea that's bound to the specified Property and has no caption.
        Parameters:
        dataSource - the data source for the editor value

      • RichTextArea

        public RichTextArea​(String caption,
                    Property dataSource)
        Constructs a new RichTextArea that's bound to the specified Property and has the given caption.
        Parameters:
        caption - the caption for the editor.
        dataSource - the data source for the editor value

      • RichTextArea

        public RichTextArea​(String caption,
                    String value)
        Constructs a new RichTextArea with the given caption and initial text contents.
        Parameters:
        caption - the caption for the editor.
        value - the initial text content of the editor.

    • Method Detail

      • paintContent

        public void paintContent​(PaintTarget target)
                  throws PaintException
        Description copied from interface: LegacyComponent

        Paints the Paintable into a UIDL stream. This method creates the UIDL sequence describing it and outputs it to the given UIDL stream.

        It is called when the contents of the component should be painted in response to the component first being shown or having been altered so that its visual representation is changed.

        Specified by:
        paintContent in interface LegacyComponent
        Parameters:
        target - the target UIDL stream where the component should paint itself to.
        Throws:
        PaintException - if the paint operation failed.

      • selectAll

        public void selectAll()
        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)
        Description copied from interface: VariableOwner
        Called when one or more variables handled by the implementing class are changed.
        Specified by:
        changeVariables in interface VariableOwner
        Parameters:
        source - the Source of the variable change. This is the origin of the event. For example in Web Adapter this is the request.
        variables - the Mapping from variable names to new variable values.

      • getType

        public Class<String> getType()
        Description copied from class: AbstractField
        Returns the type of the Field. The methods getValue and setValue must be compatible with this type: one must be able to safely cast the value returned from getValue to the given type and pass any variable assignable to this type as an argument to setValue.
        Specified by:
        getType in interface Property<String>
        Specified by:
        getType in class AbstractField<String>
        Returns:
        the type of the Field

      • getNullRepresentation

        public String getNullRepresentation()
        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()
        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)
        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)
        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()
        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".
        Specified by:
        isEmpty in interface Field<String>
        Overrides:
        isEmpty in class AbstractField<String>
        Returns:
        true if the field is empty, false otherwise

      • clear

        public void clear()
        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.

        Specified by:
        clear in interface Field<String>
        Overrides:
        clear in class AbstractField<String>

      • readDesign

        public void readDesign​(org.jsoup.nodes.Element design,
                       DesignContext designContext)
        Description copied from interface: Component
        Reads the component state from the given design.

        The component is responsible not only for updating its own state but also for ensuring that its children update their state based on the design.

        It is assumed that the component is in its default state when this method is called. Reading should only take into consideration attributes specified in the design and not reset any unspecified attributes to their defaults.

        This method must not modify the design.

        Specified by:
        readDesign in interface Component
        Overrides:
        readDesign in class AbstractField<String>
        Parameters:
        design - The element to obtain the state from
        designContext - The DesignContext instance used for parsing the design

      • writeDesign

        public void writeDesign​(org.jsoup.nodes.Element design,
                        DesignContext designContext)
        Description copied from interface: Component
        Writes the component state to the given design.

        The component is responsible not only for writing its own state but also for ensuring that its children write their state to the design.

        This method must not modify the component state.

        Specified by:
        writeDesign in interface Component
        Overrides:
        writeDesign in class AbstractField<String>
        Parameters:
        design - The element to write the component state to. Any previous attributes or child nodes are not cleared.
        designContext - The DesignContext instance used for writing the design

      • getState

        protected RichTextAreaState getState()
        Description copied from class: AbstractComponent
        Returns the shared state bean with information to be sent from the server to the client. Subclasses should override this method and set any relevant fields of the state returned by super.getState().
        Overrides:
        getState in class AbstractField<String>
        Returns:
        updated component shared state