flexmark-all 0.64.8 · com.vladsch.flexmark.html.renderer.LinkResolverContext

Method Summary

Modifier and Type	Method and Description
public @NotNull String	Returns: an encoded URL (depending on the configuration) encodeUrl(@NotNull CharSequence to be encoded url)
public @NotNull Node	Returns: the current node being rendered getCurrentNode()
public @NotNull Document	Returns: the `Document` node of the current context getDocument() Redeclares com.vladsch.flexmark.html.renderer.LinkResolverBasicContext.getDocument.
public @NotNull DataHolder	Returns: the current renderer options `DataHolder` getOptions() Redeclares com.vladsch.flexmark.html.renderer.LinkResolverBasicContext.getOptions. Get the current rendering context `DataHolder`.
public void	render(@NotNull Node the node to render node) Render the specified node and its children using the configured renderers.
public void	renderChildren(@NotNull Node node the children of which are to be rendered parent) Render the children of the node, used by custom renderers
public default @NotNull ResolvedLink	Returns: resolved link url for this link and its resolved status resolveLink(@NotNull LinkType type of link being rendered. Core defined links are Link, Image. Extensions can define their own linkType, @NotNull CharSequence link url text url, @Nullable Boolean whether the link should be url encoded, if null then the value of `HtmlRenderer#PERCENT_ENCODE_URLS` will be used to determine whether the resolved URL is to be encoded. urlEncode) Resolve link for rendering.
public @NotNull ResolvedLink	Returns: resolved link url for this link and its resolved status resolveLink(@NotNull LinkType type of link being rendered. Core defined links are Link, Image. Extensions can define their own linkType, @NotNull CharSequence link url text url, @Nullable Attributes link attributes attributes, @Nullable Boolean whether the link should be url encoded, if null then the value of `HtmlRenderer#PERCENT_ENCODE_URLS` will be used to determine whether the resolved URL is to be encoded. urlEncode) Resolve link for rendering.

Method Detail

encodeUrl	back to summary
public @NotNull String encodeUrl(@NotNull CharSequence url) Parameters url:@NotNull CharSequence to be encoded Returns:@NotNull String an encoded URL (depending on the configuration) Annotations @NotNull

getCurrentNode	back to summary
public @NotNull Node getCurrentNode() Returns:@NotNull Node the current node being rendered Annotations @NotNull

getDocument back to summary

getDocument	back to summary
public @NotNull Document getDocument() Redeclares com.vladsch.flexmark.html.renderer.LinkResolverBasicContext.getDocument. Returns:@NotNull Document the `Document` node of the current context Annotations @NotNull

public @NotNull Document getDocument()

Redeclares com.vladsch.flexmark.html.renderer.LinkResolverBasicContext.getDocument.

Returns:@NotNull Document

the Document node of the current context

Annotations

@NotNull

getOptions back to summary

getOptions	back to summary
public @NotNull DataHolder getOptions() Redeclares com.vladsch.flexmark.html.renderer.LinkResolverBasicContext.getOptions. Get the current rendering context `DataHolder`. These are the options passed or set on the `HtmlRenderer#builder()` or passed to `HtmlRenderer#builder(DataHolder)`. To get the document options you should use `getDocument()` as the data holder. Returns:@NotNull DataHolder the current renderer options `DataHolder` Annotations @NotNull

public @NotNull DataHolder getOptions()

Redeclares com.vladsch.flexmark.html.renderer.LinkResolverBasicContext.getOptions.

Get the current rendering context DataHolder. These are the options passed or set on the HtmlRenderer#builder() or passed to HtmlRenderer#builder(DataHolder). To get the document options you should use getDocument() as the data holder.

Returns:@NotNull DataHolder

the current renderer options DataHolder

Annotations

@NotNull

render	back to summary
public void render(@NotNull Node node) Render the specified node and its children using the configured renderers. This should be used to render child nodes; be careful not to pass the node that is being rendered, that would result in an endless loop. Parameters node:@NotNull Node the node to render

render

back to summary

public void render(@NotNull Node node)

Render the specified node and its children using the configured renderers. This should be used to render child nodes; be careful not to pass the node that is being rendered, that would result in an endless loop.

Parameters

node:@NotNull Node: the node to render

renderChildren	back to summary
public void renderChildren(@NotNull Node parent) Render the children of the node, used by custom renderers Parameters parent:@NotNull Node node the children of which are to be rendered

renderChildren

back to summary

public void renderChildren(@NotNull Node parent)

Render the children of the node, used by custom renderers

Parameters

parent:@NotNull Node: node the children of which are to be rendered

resolveLink back to summary

resolveLink	back to summary
public default @NotNull ResolvedLink resolveLink(@NotNull LinkType linkType, @NotNull CharSequence url, @Nullable Boolean urlEncode) Resolve link for rendering. Link Resolvers are going to be called until one returns ResolvedLink with getStatus() != LinkStatus.Unknown A resolver can replace the url but not change the status letting downstream resolvers handle the rest. This is useful when a resolver does partial processing like macro expansion but does not know how to handle the rest. Core processing will simply pass the link as is. It is up to extension LinkResolvers and AttributeProviders to make sense of the link and applicable attributes based on status. Parameters linkType:@NotNull LinkType type of link being rendered. Core defined links are Link, Image. Extensions can define their own url:@NotNull CharSequence link url text urlEncode:@Nullable Boolean whether the link should be url encoded, if null then the value of `HtmlRenderer#PERCENT_ENCODE_URLS` will be used to determine whether the resolved URL is to be encoded. Returns:@NotNull ResolvedLink resolved link url for this link and its resolved status Annotations @NotNull

public default @NotNull ResolvedLink resolveLink(@NotNull LinkType linkType, @NotNull CharSequence url, @Nullable Boolean urlEncode)

Resolve link for rendering. Link Resolvers are going to be called until one returns ResolvedLink with getStatus() != LinkStatus.Unknown

A resolver can replace the url but not change the status letting downstream resolvers handle the rest. This is useful when a resolver does partial processing like macro expansion but does not know how to handle the rest.

Core processing will simply pass the link as is. It is up to extension LinkResolvers and AttributeProviders to make sense of the link and applicable attributes based on status.

Parameters

linkType:@NotNull LinkType: type of link being rendered. Core defined links are Link, Image. Extensions can define their own
url:@NotNull CharSequence: link url text
urlEncode:@Nullable Boolean: whether the link should be url encoded, if null then the value of HtmlRenderer#PERCENT_ENCODE_URLS will be used to determine whether the resolved URL is to be encoded.

Returns:@NotNull ResolvedLink

resolved link url for this link and its resolved status

Annotations

@NotNull

resolveLink back to summary

resolveLink	back to summary
public @NotNull ResolvedLink resolveLink(@NotNull LinkType linkType, @NotNull CharSequence url, @Nullable Attributes attributes, @Nullable Boolean urlEncode) Resolve link for rendering. Link Resolvers are going to be called until one returns ResolvedLink with getStatus() != LinkStatus.Unknown A resolver can replace the url but not change the status letting downstream resolvers handle the rest. This is useful when a resolver does partial processing like macro expansion but does not know how to handle the rest. Core processing will simply pass the link as is. It is up to extension LinkResolvers and AttributeProviders to make sense of the link and applicable attributes based on status. Parameters linkType:@NotNull LinkType type of link being rendered. Core defined links are Link, Image. Extensions can define their own url:@NotNull CharSequence link url text attributes:@Nullable Attributes link attributes urlEncode:@Nullable Boolean whether the link should be url encoded, if null then the value of `HtmlRenderer#PERCENT_ENCODE_URLS` will be used to determine whether the resolved URL is to be encoded. Returns:@NotNull ResolvedLink resolved link url for this link and its resolved status Annotations @NotNull

public @NotNull ResolvedLink resolveLink(@NotNull LinkType linkType, @NotNull CharSequence url, @Nullable Attributes attributes, @Nullable Boolean urlEncode)

Resolve link for rendering. Link Resolvers are going to be called until one returns ResolvedLink with getStatus() != LinkStatus.Unknown

Core processing will simply pass the link as is. It is up to extension LinkResolvers and AttributeProviders to make sense of the link and applicable attributes based on status.

Parameters

linkType:@NotNull LinkType: type of link being rendered. Core defined links are Link, Image. Extensions can define their own
url:@NotNull CharSequence: link url text
attributes:@Nullable Attributes: link attributes
urlEncode:@Nullable Boolean: whether the link should be url encoded, if null then the value of HtmlRenderer#PERCENT_ENCODE_URLS will be used to determine whether the resolved URL is to be encoded.

Returns:@NotNull ResolvedLink

resolved link url for this link and its resolved status

Annotations

@NotNull

public Interface LinkResolverContext

Method Summary

Method Detail