Package com.vaadin.ui

Class TextField

    • Constructor Detail

      • TextField

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

      • TextField

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

      • TextField

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

      • TextField

        public TextField​(HasValue.ValueChangeListener<String> valueChangeListener)
        Constructs a new TextField with a value change listener. The listener is called when the value of this TextField is changed either by the user or programmatically.
        Parameters:
        valueChangeListener - the value change listener, not null

      • TextField

        public TextField​(String caption,
                 HasValue.ValueChangeListener<String> valueChangeListener)
        Constructs a new TextField with the given caption and a value change listener.

        The listener is called when the value of this TextField is changed either by the user or programmatically.

        Parameters:
        caption - the caption String for the editor.
        valueChangeListener - the value change listener, not null

      • TextField

        public TextField​(String caption,
                 String value,
                 HasValue.ValueChangeListener<String> valueChangeListener)
        Constructs a new TextField with the given caption, initial text contents and a value change listener.

        The listener is called when the value of this TextField is changed either by the user or programmatically.

        Parameters:
        caption - the caption String for the editor.
        value - the initial text content of the editor, not null
        valueChangeListener - the value change listener, not null

    • Method Detail

      • getState

        protected TextFieldState 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 AbstractTextField
        Returns:
        updated component shared state

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