OpenJDK 27 · jdk.javadoc.internal.doclets.formats.html.markup.Links

Modifier and Type	Field and Description
private final DocPath	file

Access	Constructor and Description
public	Links(DocPath the file file) Creates a `Links` object for a specific file.

Method Summary

Modifier and Type	Method and Description
public HtmlTree	Returns: the link createExternalLink(DocLink the details for the link link, Content the content for the link label) Creates an external link.
public HtmlTree	Returns: the link createLink(HtmlId the position of the link in the file id, Content the content for the link label) Creates a link of the form `<a href="#id">label</a>`.
public HtmlTree	Returns: the link createLink(HtmlId the id to which the link will be created id, Content the content for the link label, String the title for the link title) Creates a link of the form `<a href="#id" title="title">label</a>`.
public HtmlTree	Returns: the link createLink(DocPath the path for the link path, String the content for the link label) Creates a link of the form `<a href="path">label</a>`.
public HtmlTree	Returns: the link createLink(DocPath the path for the link path, Content the content for the link label) Creates a link of the form `<a href="path">label</a>`.
public HtmlTree	Returns: the link createLink(DocPath the path for the link path, Content the content for the link label, HtmlStyle the style for the link, or null style, String the title for the link title) Creates a link of the form `<a href="path" title="title">label</a>`.
public HtmlTree	Returns: the link createLink(DocPath the path for the link path, Content the content for the link label, String the title for the link title) Creates a link of the form `<a href="path" title="title">label</a>`.
public Content	Returns: the link createLink(DocLink the details for the link link, Content the content for the link label) Creates a link of the form `<a href="link">label</a>`.
public HtmlTree	Returns: the link createLink(DocLink the details for the link link, Content the content for the link label, String the title for the link title) Creates a link of the form `<a href="path" title="title">label</a>`.
public HtmlTree	Returns: the link createLink(DocLink the details for the link link, Content the content for the link label, HtmlStyle the style for the link, or null style, String the title for the link title) Creates a link of the form `<a href="link" title="title" >label</a>`.
public HtmlTree	Returns: the link createLink(DocLink the details for the link link, Content the content for the link label, HtmlStyle the style for the link, or null style, String the title for the link title, boolean is the link external to the generated documentation isExternal) Creates a link of the form `<a href="link" title="title">label</a>`.
public Content	Returns: the link or just the label createLinkOrLabel(HtmlId the position of the link in the file id, Content the content for the link label, boolean whether to create a link or just return the label link) Creates a link of the form `<a href="#id">label</a>` if `link` is `true`, or else just returns `label`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

file	back to summary
private final DocPath file

Links	back to summary
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. Parameters file:DocPath the file

Method Detail

createExternalLink	back to summary
public HtmlTree createExternalLink(DocLink link, Content label) Creates an external link. Parameters link:DocLink the details for the link label:Content the content for the link Returns:HtmlTree the link

createExternalLink

back to summary

public HtmlTree createExternalLink(DocLink link, Content label)

Creates an external link.

Parameters

link:DocLink: the details for the link
label:Content: the content for the link

Returns:HtmlTree

the link

createLink back to summary

createLink	back to summary
public HtmlTree createLink(HtmlId id, Content label) Creates a link of the form `<a href="#id">label</a>`. Parameters id:HtmlId the position of the link in the file label:Content the content for the link Returns:HtmlTree the link

public HtmlTree createLink(HtmlId id, Content label)

Creates a link of the form <a href="#id">label</a>.

Parameters

id:HtmlId: the position of the link in the file
label:Content: the content for the link

Returns:HtmlTree

the link

createLink back to summary

createLink	back to summary
public HtmlTree createLink(HtmlId id, Content label, String title) Creates a link of the form `<a href="#id" title="title">label</a>`. Parameters id:HtmlId the id to which the link will be created label:Content the content for the link title:String the title for the link Returns:HtmlTree the link

public HtmlTree createLink(HtmlId id, Content label, String title)

Creates a link of the form <a href="#id" title="title">label</a>.

Parameters

id:HtmlId: the id to which the link will be created
label:Content: the content for the link
title:String: the title for the link

Returns:HtmlTree

the link

createLink back to summary

createLink	back to summary
public HtmlTree createLink(DocPath path, String label) Creates a link of the form `<a href="path">label</a>`. Parameters path:DocPath the path for the link label:String the content for the link Returns:HtmlTree the link

public HtmlTree createLink(DocPath path, String label)

Creates a link of the form <a href="path">label</a>.

Parameters

path:DocPath: the path for the link
label:String: the content for the link

Returns:HtmlTree

the link

createLink back to summary

createLink	back to summary
public HtmlTree createLink(DocPath path, Content label) Creates a link of the form `<a href="path">label</a>`. Parameters path:DocPath the path for the link label:Content the content for the link Returns:HtmlTree the link

public HtmlTree createLink(DocPath path, Content label)

Creates a link of the form <a href="path">label</a>.

Parameters

path:DocPath: the path for the link
label:Content: the content for the link

Returns:HtmlTree

the link

createLink back to summary

createLink	back to summary
public HtmlTree createLink(DocPath path, Content label, HtmlStyle style, String title) Creates a link of the form `<a href="path" title="title">label</a>`. If `style` is not null, it will be added as `class="style"` to the link. Parameters path:DocPath the path for the link label:Content the content for the link style:HtmlStyle the style for the link, or null title:String the title for the link Returns:HtmlTree the link

public HtmlTree createLink(DocPath path, Content label, HtmlStyle style, String title)

Creates a link of the form <a href="path" title="title">label</a>. If style is not null, it will be added as class="style" to the link.

Parameters

path:DocPath: the path for the link
label:Content: the content for the link
style:HtmlStyle: the style for the link, or null
title:String: the title for the link

Returns:HtmlTree

the link

createLink back to summary

createLink	back to summary
public HtmlTree createLink(DocPath path, Content label, String title) Creates a link of the form `<a href="path" title="title">label</a>`. Parameters path:DocPath the path for the link label:Content the content for the link title:String the title for the link Returns:HtmlTree the link

public HtmlTree createLink(DocPath path, Content label, String title)

Creates a link of the form <a href="path" title="title">label</a>.

Parameters

path:DocPath: the path for the link
label:Content: the content for the link
title:String: the title for the link

Returns:HtmlTree

the link

createLink back to summary

createLink	back to summary
public Content createLink(DocLink link, Content label) Creates a link of the form `<a href="link">label</a>`. Parameters link:DocLink the details for the link label:Content the content for the link Returns:Content the link

public Content createLink(DocLink link, Content label)

Creates a link of the form <a href="link">label</a>.

Parameters

link:DocLink: the details for the link
label:Content: the content for the link

Returns:Content

the link

createLink back to summary

createLink	back to summary
public HtmlTree createLink(DocLink link, Content label, String title) Creates a link of the form `<a href="path" title="title">label</a>`. Parameters link:DocLink the details for the link label:Content the content for the link title:String the title for the link Returns:HtmlTree the link

public HtmlTree createLink(DocLink link, Content label, String title)

Creates a link of the form <a href="path" title="title">label</a>.

Parameters

link:DocLink: the details for the link
label:Content: the content for the link
title:String: the title for the link

Returns:HtmlTree

the link

createLink back to summary

createLink	back to summary
public HtmlTree createLink(DocLink link, Content label, HtmlStyle style, String title) Creates a link of the form `<a href="link" title="title" >label</a>`. If `style` is not null, it will be added as `class="style"` to the link. Parameters link:DocLink the details for the link label:Content the content for the link style:HtmlStyle the style for the link, or null title:String the title for the link Returns:HtmlTree the link

public HtmlTree createLink(DocLink link, Content label, HtmlStyle style, String title)

Creates a link of the form <a href="link" title="title" >label</a>. If style is not null, it will be added as class="style" to the link.

Parameters

link:DocLink: the details for the link
label:Content: the content for the link
style:HtmlStyle: the style for the link, or null
title:String: the title for the link

Returns:HtmlTree

the link

createLink back to summary

createLink	back to summary
public HtmlTree createLink(DocLink link, Content label, HtmlStyle style, String title, boolean isExternal) Creates a link of the form `<a href="link" title="title">label</a>`. If `style` is not null, it will be added as `class="style"` to the link. Parameters link:DocLink the details for the link label:Content the content for the link style:HtmlStyle the style for the link, or null title:String the title for the link isExternal:boolean is the link external to the generated documentation Returns:HtmlTree the link

public HtmlTree createLink(DocLink link, Content label, HtmlStyle style, String title, boolean isExternal)

Creates a link of the form <a href="link" title="title">label</a>. If style is not null, it will be added as class="style" to the link.

Parameters

link:DocLink: the details for the link
label:Content: the content for the link
style:HtmlStyle: the style for the link, or null
title:String: the title for the link
isExternal:boolean: is the link external to the generated documentation

Returns:HtmlTree

the link

createLinkOrLabel back to summary

createLinkOrLabel	back to summary
public Content createLinkOrLabel(HtmlId id, Content label, boolean link) Creates a link of the form `<a href="#id">label</a>` if `link` is `true`, or else just returns `label`. Parameters id:HtmlId the position of the link in the file label:Content the content for the link link:boolean whether to create a link or just return the label Returns:Content the link or just the label

public Content createLinkOrLabel(HtmlId id, Content label, boolean link)

Creates a link of the form <a href="#id">label</a> if link is true, or else just returns label.

Parameters

id:HtmlId: the position of the link in the file
label:Content: the content for the link
link:boolean: whether to create a link or just return the label

Returns:Content

the link or just the label

public Class Links

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail