Package org.eclipse.jface.text.hyperlink

Class URLHyperlink

  • All Implemented Interfaces:
    IHyperlink
    public class URLHyperlink
extends java.lang.Object
implements IHyperlink
    URL hyperlink.
    Since:
    3.1

    • Constructor Summary

      Constructors 
      Constructor Description
      URLHyperlink​(IRegion region, java.lang.String urlString)
      Creates a new URL hyperlink.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      IRegion getHyperlinkRegion()
      The region covered by this type of hyperlink.
      java.lang.String getHyperlinkText()
      Optional text for this hyperlink.
      java.lang.String getTypeLabel()
      Optional label for this type of hyperlink.
      java.lang.String getURLString()
      Returns the URL string of this hyperlink.
      void open()
      Opens the given hyperlink.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • URLHyperlink

        public URLHyperlink​(IRegion region,
                    java.lang.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 java.lang.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 java.lang.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 java.lang.String getURLString()
        Returns the URL string of this hyperlink.
        Returns:
        the URL string
        Since:
        3.2