Package com.vaadin.ui

Class AbstractTextField

    • Constructor Detail

      • AbstractTextField

        protected AbstractTextField()

    • Method Detail

      • getState

        protected AbstractTextFieldState 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

      • beforeClientResponse

        public void beforeClientResponse​(boolean initial)
        Description copied from interface: ClientConnector
        Called before the shared state and RPC invocations are sent to the client. Gives the connector an opportunity to set computed/dynamic state values or to invoke last minute RPC methods depending on other component features.
        Specified by:
        beforeClientResponse in interface ClientConnector
        Overrides:
        beforeClientResponse in class AbstractField<String>
        Parameters:
        initial - true if the client-side connector will be created and initialized after this method has been invoked. false if there is already an initialized client-side connector.

      • 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.

      • 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:
        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:
        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:
        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 representation always be converted to null-values.
        See Also:
        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

      • getMaxLength

        public int getMaxLength()
        Returns the maximum number of characters in the field. Value -1 is considered unlimited. Terminal may however have some technical limits.
        Returns:
        the maxLength

      • setMaxLength

        public void setMaxLength​(int maxLength)
        Sets the maximum number of characters in the field. Value -1 is considered unlimited. Terminal may however have some technical limits.
        Parameters:
        maxLength - the maxLength to set

      • getColumns

        public int getColumns()
        Gets the number of columns in the editor. If the number of columns is set 0, the actual number of displayed columns is determined implicitly by the adapter.
        Returns:
        the number of columns in the editor.

      • setColumns

        public void setColumns​(int columns)
        Sets the number of columns in the editor. If the number of columns is set 0, the actual number of displayed columns is determined implicitly by the adapter.
        Parameters:
        columns - the number of columns to set.

      • getInputPrompt

        public String getInputPrompt()
        Gets the current input prompt.
        Returns:
        the current input prompt, or null if not enabled
        See Also:
        setInputPrompt(String)

      • setInputPrompt

        public void setInputPrompt​(String inputPrompt)
        Sets the input prompt - a textual prompt that is displayed when the field would otherwise be empty, to prompt the user for input.
        Parameters:
        inputPrompt -

      • setInternalValue

        protected void setInternalValue​(String newValue)
        Description copied from class: AbstractField
        Sets the internal field value. This is purely used by AbstractField to change the internal Field value. It does not trigger valuechange events. It can be overridden by the inheriting classes to update all dependent variables. Subclasses can also override AbstractField.getInternalValue() if necessary.
        Overrides:
        setInternalValue in class AbstractField<String>
        Parameters:
        newValue - the new value to be set.

      • selectAll

        public void selectAll()
        Selects all text in the field.
        Since:
        6.4

      • setSelectionRange

        public void setSelectionRange​(int pos,
                              int length)
        Sets the range of text to be selected. As a side effect the field will become focused.
        Parameters:
        pos - the position of the first character to be selected
        length - the number of characters to be selected
        Since:
        6.4

      • setCursorPosition

        public void setCursorPosition​(int pos)
        Sets the cursor position in the field. As a side effect the field will become focused.
        Parameters:
        pos - the position for the cursor
        Since:
        6.4

      • getCursorPosition

        public int getCursorPosition()
        Returns the last known cursor position of the field.

        Note that due to the client server nature or the GWT terminal, Vaadin cannot provide the exact value of the cursor position in most situations. The value is updated only when the client side terminal communicates to TextField, like on Field.ValueChangeEvents and FieldEvents.TextChangeEvent s. This may change later if a deep push integration is built to Vaadin.

        Returns:
        the cursor position

      • 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