Package com.cloudofficeprint.RenderElements

Class HyperLink

  • public class HyperLink
extends RenderElement
    Class representing a hyperlink for templates.

    • Constructor Summary

      Constructors 
      Constructor Description
      HyperLink​(java.lang.String name, java.lang.String text, java.lang.String url)
      Element to insert a footnote in a template.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.google.gson.JsonObject getJSON()  
      java.util.Set<java.lang.String> getTemplateTags()  
      java.lang.String getUrl()
      Note : In Excel you can hyperlink to a cell.
      void setUrl​(java.lang.String url)
      Note : In Excel you can hyperlink to a cell.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • HyperLink

        public HyperLink​(java.lang.String name,
                 java.lang.String text,
                 java.lang.String url)
        Element to insert a footnote in a template.
        Parameters:
        name - Name of this footnote for the tag.
        text - Text of the hyperlink (will replace the tag in the template). (Optional: if null the URL will replace the tag)
        url - URL to hyperlink to. Note : In Excel you can hyperlink to a cell. The URLshould then be of structure: "SheetName!Cell".

    • Method Detail

      • getUrl

        public java.lang.String getUrl()
        Note : In Excel you can hyperlink to a cell. The URLshould then be of structure: "SheetName!Cell".
        Returns:
        URL to hyperlink to.

      • setUrl

        public void setUrl​(java.lang.String url)
        Note : In Excel you can hyperlink to a cell. The URLshould then be of structure: "SheetName!Cell".
        Parameters:
        url - URL to hyperlink to.

      • getJSON

        public com.google.gson.JsonObject getJSON()
        Specified by:
        getJSON in class RenderElement
        Returns:
        JSONObject with the tags for this element for the Cloud Office Print server.

      • getTemplateTags

        public java.util.Set<java.lang.String> getTemplateTags()
        Specified by:
        getTemplateTags in class RenderElement
        Returns:
        An immutable set containing all available template tags this element can replace.