Contact us
Create app
com.vaadin.ui.

Class Label

    • Constructor Detail

      • Label

        public Label()

        Creates an empty Label.

      • Label

        public Label​(String text)

        Creates a new instance with text content mode and the given text.

        Parameters:

        text - the text to set

      • Label

        public Label​(String text,
             ContentMode contentMode)

        Creates a new instance with the given text and content mode.

        Parameters:

        text - the text to set

        contentMode - the content mode to use

        Since:

        8.0

    • Method Detail

      • getState

        protected LabelState 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 AbstractComponent

        Returns:

        updated component shared state

      • getContentMode

        public ContentMode getContentMode()

        Gets the content mode of the label.

        Returns:

        the content mode of the label

        Since:

        8.0

        See Also:

        ContentMode

      • setContentMode

        public void setContentMode​(ContentMode contentMode)

        Sets the content mode of the label.

        Parameters:

        contentMode - the content mode to set

        Since:

        8.0

        See Also:

        ContentMode

      • setValue

        public void setValue​(String value)

        Sets the text to be shown in the label.

        Parameters:

        value - the text to show in the label, null is converted to an empty string

      • getValue

        public String getValue()

        Gets the text shown in the label.

        Returns:

        the text shown in the label, not null

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

        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 AbstractComponent

        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