Class URLHyperlink

    • Constructor Detail

      • URLHyperlink

        public URLHyperlink​(IRegion region,
                            String urlString)
        Creates a new URL hyperlink.
        Parameters:
        region - the region
        urlString - the URL string
    • Method Detail

      • getHyperlinkRegion

        public IRegion getHyperlinkRegion()
        Description copied from interface: IHyperlink
        The region covered by this type of hyperlink.
        Specified by:
        getHyperlinkRegion in interface IHyperlink
        Returns:
        the hyperlink region
      • open

        public void open()
        Description copied from interface: IHyperlink
        Opens the given hyperlink.
        Specified by:
        open in interface IHyperlink
      • getTypeLabel

        public String getTypeLabel()
        Description copied from interface: IHyperlink
        Optional label for this type of hyperlink.

        This type label can be used by IHyperlinkPresenters which show several hyperlinks at once.

        Specified by:
        getTypeLabel in interface IHyperlink
        Returns:
        the type label or null if none
      • getHyperlinkText

        public String getHyperlinkText()
        Description copied from interface: IHyperlink
        Optional text for this hyperlink.

        This can be used in situations where there are several targets for the same hyperlink location.

        Specified by:
        getHyperlinkText in interface IHyperlink
        Returns:
        the text or null if none
      • getURLString

        public String getURLString()
        Returns the URL string of this hyperlink.
        Returns:
        the URL string
        Since:
        3.2