Package com.vaadin.ui

Class Link

    • Constructor Detail

      • Link

        public Link()
        Creates a new link.

      • Link

        public Link​(String caption,
            Resource resource)
        Creates a new instance of Link.
        Parameters:
        caption -
        resource -

      • Link

        public Link​(String caption,
            Resource resource,
            String targetName,
            int width,
            int height,
            BorderStyle border)
        Creates a new instance of Link that opens a new window.
        Parameters:
        caption - the Link text.
        targetName - the name of the target window where the link opens to. Empty name of null implies that the target is opened to the window containing the link.
        width - the Width of the target window.
        height - the Height of the target window.
        border - the Border style of the target window.

    • Method Detail

      • getState

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

      • getTargetBorder

        public BorderStyle getTargetBorder()
        Returns the target window border.
        Returns:
        the target window border.

      • getTargetHeight

        public int getTargetHeight()
        Returns the target window height or -1 if not set.
        Returns:
        the target window height.

      • getTargetName

        public String getTargetName()
        Returns the target window name. Empty name of null implies that the target is opened to the window containing the link.
        Returns:
        the target window name.

      • getTargetWidth

        public int getTargetWidth()
        Returns the target window width or -1 if not set.
        Returns:
        the target window width.

      • setTargetBorder

        public void setTargetBorder​(BorderStyle targetBorder)
        Sets the border of the target window.
        Parameters:
        targetBorder - the targetBorder to set.

      • setTargetHeight

        public void setTargetHeight​(int targetHeight)
        Sets the target window height.
        Parameters:
        targetHeight - the targetHeight to set.

      • setTargetName

        public void setTargetName​(String targetName)
        Sets the target window name.
        Parameters:
        targetName - the targetName to set.

      • setTargetWidth

        public void setTargetWidth​(int targetWidth)
        Sets the target window width.
        Parameters:
        targetWidth - the targetWidth to set.

      • getResource

        public Resource getResource()
        Returns the resource this link opens.
        Returns:
        the Resource.

      • setResource

        public void setResource​(Resource resource)
        Sets the resource this link opens.
        Parameters:
        resource - the resource to set.

      • 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