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

Klasse HtmlLinkInfo

java.lang.Object
org.jdrupes.mdoclet.internal.doclets.formats.html.HtmlLinkInfo
public class HtmlLinkInfo extends Object
HTML-specific information about a link.

  • Konstruktordetails

  • Methodendetails

    • forType

      public HtmlLinkInfo forType(TypeMirror type)
      Creates a copy of this HtmlLinkInfo instance with a different TypeMirror.

      This is used for contained types such as type parameters or array components.

      Parameter:
      type - the type mirror
      Gibt zurück:
      the new link info

    • setTypeElement

      public void setTypeElement(TypeElement typeElement)
      Sets the typeElement
      Parameter:
      typeElement - the new typeElement object

    • getTypeElement

      public TypeElement getTypeElement()
      The class we want to link to.

      Null if we are not linking to a class.

    • getExecutableElement

      public ExecutableElement getExecutableElement()
      The executable element we want to link to.

      Null if we are not linking to an executable element.

    • getType

      public TypeMirror getType()
      The Type we want to link to.

      Null if we are not linking to a type.

    • label

      public HtmlLinkInfo label(CharSequence label)
      Set the label for the link.
      Parameter:
      label - plain-text label for the link
      Gibt zurück:
      this object

    • label

      public HtmlLinkInfo label(Content label)
      Set the label for the link.
      Parameter:
      label - the new value
      Gibt zurück:
      this object

    • getLabel

      public Content getLabel()
      Gibt the label for the link zurück.
      Gibt zurück:
      the label for the link

    • style

      public HtmlLinkInfo style(HtmlStyle style)
      Sets the style to be used for the link.
      Parameter:
      style - the new style value
      Gibt zurück:
      this object

    • getStyle

      public HtmlStyle getStyle()
      Gibt the optional style for the link zurück.
      Gibt zurück:
      the optional style for the link

    • varargs

      public HtmlLinkInfo varargs(boolean varargs)
      Set whether or not this is a link to a varargs parameter.
      Parameter:
      varargs - the new value
      Gibt zurück:
      this object

    • isVarArg

      public boolean isVarArg()
      Gibt true if this is a link to a vararg member zurück.
      Gibt zurück:
      true if this is a link to a vararg member

    • fragment

      public HtmlLinkInfo fragment(String fragment)
      Set the fragment specifier for the link.
      Parameter:
      fragment - the new fragment value
      Gibt zurück:
      this object

    • getFragment

      public String getFragment()
      Gibt the fragment of the link zurück.
      Gibt zurück:
      the fragment of the link

    • addLineBreaksInTypeParameters

      public HtmlLinkInfo addLineBreaksInTypeParameters(boolean addLineBreaksInTypeParameters)
      Sets the addLineBreaksInTypeParameters flag for this link.
      Parameter:
      addLineBreaksInTypeParameters - the new value
      Gibt zurück:
      this object

    • addLineBreaksInTypeParameters

      public boolean addLineBreaksInTypeParameters()
      Gibt true if type parameters should be separated by line breaks zurück.
      Gibt zurück:
      true if type parameters should be separated by line breaks

    • addLineBreakOpportunitiesInTypeParameters

      public HtmlLinkInfo addLineBreakOpportunitiesInTypeParameters(boolean addLineBreakOpportunities)
      Sets the addLineBreakOpportunitiesInTypeParameters flag for this link.
      Parameter:
      addLineBreakOpportunities - the new value
      Gibt zurück:
      this object

    • addLineBreakOpportunitiesInTypeParameters

      public boolean addLineBreakOpportunitiesInTypeParameters()
      Gibt true if line break opportunities should be added to type parameters zurück.
      Gibt zurück:
      true if line break opportunities should be added to type parameters

    • linkToSelf

      public HtmlLinkInfo linkToSelf(boolean linkToSelf)
      Set the linkToSelf flag for this link.
      Parameter:
      linkToSelf - the new value
      Gibt zurück:
      this object

    • linkToSelf

      public boolean linkToSelf()
      Gibt true if we should generate links to the current page zurück.
      Gibt zurück:
      true if we should generate links to the current page

    • linkTypeParameters

      public boolean linkTypeParameters()
      Gibt true if type parameters should be rendered as links zurück.
      Gibt zurück:
      true if type parameters should be rendered as links

    • showTypeBounds

      public void showTypeBounds(boolean showTypeBounds)
      Set the showTypeBounds flag for this link
      Parameter:
      showTypeBounds - the new value

    • showTypeBounds

      public boolean showTypeBounds()
      Gibt true if we should print the type bounds for the type parameter zurück.
      Gibt zurück:
      true if we should print the type bounds for the type parameter

    • showTypeParameterAnnotations

      public HtmlLinkInfo showTypeParameterAnnotations(boolean showTypeParameterAnnotations)
      Set the showTypeParameterAnnotations flag for this link.
      Parameter:
      showTypeParameterAnnotations - the new value
      Gibt zurück:
      this object

    • showTypeParameterAnnotations

      public boolean showTypeParameterAnnotations()
      Gibt true if annotations on type parameters should be shown zurück.
      Gibt zurück:
      true if annotations on type parameters should be shown

    • targetMember

      public HtmlLinkInfo targetMember(Element el)
      Set the member this link points to (if any).
      Parameter:
      el - the new member value
      Gibt zurück:
      this object

    • getTargetMember

      public Element getTargetMember()
      Gibt the member this link points to (if any) zurück.
      Gibt zurück:
      the member this link points to (if any)

    • skipPreview

      public HtmlLinkInfo skipPreview(boolean skipPreview)
      Set whether or not the preview flags should be skipped for this link.
      Parameter:
      skipPreview - the new value
      Gibt zurück:
      this object

    • isSkipPreview

      public boolean isSkipPreview()
      Gibt true iff the preview flags should be skipped for this link zurück.
      Gibt zurück:
      true iff the preview flags should be skipped for this link

    • getContext

      public HtmlLinkInfo.Kind getContext()
      Gibt the link context zurück.
      Gibt zurück:
      the link context

    • isLinkable

      public boolean isLinkable()
      Return true if this link is linkable and false if we can’t link to the desired place.
      Gibt zurück:
      true if this link is linkable and false if we can’t link to the desired place.

    • showTypeParameters

      public boolean showTypeParameters()
      Returns true if links to declared types should include type parameters.
      Gibt zurück:
      true if type parameter links should be included

    • getClassLinkLabel

      public Content getClassLinkLabel(BaseConfiguration configuration)
      Return the label for this class link.
      Parameter:
      configuration - the current configuration of the doclet.
      Gibt zurück:
      the label for this class link.

    • newContent

      protected Content newContent()
      Gibt a new instance of a content object zurück.
      Gibt zurück:
      a new instance of a content object

    • toString

      public String toString()
      Setzt außer Kraft:
      toString in Klasse Object