Package com.microstrategy.web.objects

Interface WebHyperLinks

  • public interface WebHyperLinks
    The WebHyperLinks interface represents the collection of WebHyperLink associated with grid report cell or RWD text field.
    Since:
    MicroStrategy Web 8.1.2

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      WebHyperLink add()
      add a Hyperlink to this link collection
      void clear()
      clear all Hyperlinks in this link collection.
      java.util.Iterator<WebHyperLink> elements()
      Returns an iterator over the Hyperlinks collection
      WebHyperLink get​(int i)
      Returns the i-th hyperlink in this collection
      WebHyperLink getDefault()
      Returns default HyperLink or null if there is no Hyperlink set as default
      boolean getOpenInNewWindow()
      Returns true if target URL or report or document shall be displayed in the new window.
      void setOpenInNewWindow​(boolean b)
      Sets/Unsets whether target URL or report or document shall be displayed in the new window.
      int size()
      Returns the number of Hyeprlinks in link collection.

    • Method Detail

      • size

        int size()
        Returns the number of Hyeprlinks in link collection.
        Returns:
        the number of Hyperlinks in link collection.

      • elements

        java.util.Iterator<WebHyperLink> elements()
        Returns an iterator over the Hyperlinks collection
        Returns:
        Iterator over the Hyperlinks collection

      • get

        WebHyperLink get​(int i)
        Returns the i-th hyperlink in this collection
        Parameters:
        i - the index (starting from 0)
        Returns:
        the i-th hyperlink
        Throws:
        java.lang.IllegalArgumentException - thrown if there is no hyperlink at the given index.

      • getDefault

        WebHyperLink getDefault()
        Returns default HyperLink or null if there is no Hyperlink set as default
        Returns:
        WebHyperLink the default Hyperlink or null if there is no Hyperlink set as default

      • getOpenInNewWindow

        boolean getOpenInNewWindow()
        Returns true if target URL or report or document shall be displayed in the new window.
        Returns:
        true if target URL or report or document shall be displayed in the new window.

      • setOpenInNewWindow

        void setOpenInNewWindow​(boolean b)
        Sets/Unsets whether target URL or report or document shall be displayed in the new window.
        Parameters:
        b - the flag to open a new window if b is true, the target Hyperlink will be opened in a new window if b is false, the target Hyperlink will be opened in current window
        Since:
        MicroStrategy Web 9.0.0

      • clear

        void clear()
        clear all Hyperlinks in this link collection.