Package org.jdrupes.mdoclet.internal.doclets.formats.html.markup

Klasse Links

java.lang.Object
org.jdrupes.mdoclet.internal.doclets.formats.html.markup.Links
public class Links extends Object
Factory for HTML A elements: links (with a href attribute).

  • Konstruktordetails

    • Links

      public Links(DocPath file)
      Creates a Links object for a specific file.

      Links to other files will be made relative to this file where possible.

      Parameter:
      file - the file

  • Methodendetails

    • createLink

      public Content createLink(HtmlId id, Content label)
      Creates a link of the form label.
      Parameter:
      id - the position of the link in the file
      label - the content for the link
      Gibt zurück:
      the link

    • createLink

      public Content createLink(HtmlId id, Content label, boolean link)
      Creates a link of the form label if link is true, or else just returns label.
      Parameter:
      id - the position of the link in the file
      label - the content for the link
      link - whether to create a link or just return the label
      Gibt zurück:
      the link or just the label

    • createLink

      public Content createLink(HtmlId id, Content label, String title)
      Creates a link of the form label.
      Parameter:
      id - the id to which the link will be created
      label - the content for the link
      title - the title for the link
      Gibt zurück:
      the link

    • createLink

      public Content createLink(DocPath path, String label)
      Creates a link of the form label.
      Parameter:
      path - the path for the link
      label - the content for the link
      Gibt zurück:
      the link

    • createLink

      public Content createLink(DocPath path, Content label)
      Creates a link of the form label.
      Parameter:
      path - the path for the link
      label - the content for the link
      Gibt zurück:
      the link

    • createLink

      public Content createLink(DocPath path, Content label, HtmlStyle style, String title)
      Creates a link of the form label.

      If style is not null, it will be added as class=“style” to the link.

      Parameter:
      path - the path for the link
      label - the content for the link
      style - the style for the link, or null
      title - the title for the link
      Gibt zurück:
      the link

    • createLink

      public Content createLink(DocPath path, Content label, String title)
      Creates a link of the form label.
      Parameter:
      path - the path for the link
      label - the content for the link
      title - the title for the link
      Gibt zurück:
      the link

    • createLink

      public Content createLink(DocLink link, Content label)
      Creates a link of the form label.
      Parameter:
      link - the details for the link
      label - the content for the link
      Gibt zurück:
      the link

    • createLink

      public Content createLink(DocLink link, Content label, String title)
      Creates a link of the form label.
      Parameter:
      link - the details for the link
      label - the content for the link
      title - the title for the link
      Gibt zurück:
      the link

    • createLink

      public Content createLink(DocLink link, Content label, HtmlStyle style, String title)
      Creates a link of the form label.

      If style is not null, it will be added as class=“style” to the link.

      Parameter:
      link - the details for the link
      label - the content for the link
      style - the style for the link, or null
      title - the title for the link
      Gibt zurück:
      the link

    • createLink

      public Content createLink(DocLink link, Content label, HtmlStyle style, String title, boolean isExternal)
      Creates a link of the form label.

      If style is not null, it will be added as class=“style” to the link.

      Parameter:
      link - the details for the link
      label - the content for the link
      style - the style for the link, or null
      title - the title for the link
      isExternal - is the link external to the generated documentation
      Gibt zurück:
      the link

    • createExternalLink

      public Content createExternalLink(DocLink link, Content label)
      Creates an external link.
      Parameter:
      link - the details for the link
      label - the content for the link
      Gibt zurück:
      the link