org.xwiki.rendering.listener

Interface LinkListener

All Known Subinterfaces:

ChainingListener, ContentHandlerStreamRenderer, Listener, PrintRenderer, Renderer, StackableChainingListener

All Known Implementing Classes:

AbstractChainingListener, AbstractChainingPrintRenderer, BlockStateChainingListener, CompositeListener, ConsecutiveNewLineStateChainingListener, EmptyBlockChainingListener, GroupStateChainingListener, InlineFilterListener, LookaheadChainingListener, MetaDataStateChainingListener, QueueListener, VoidListener, WrappingListener

public interface LinkListener

Contains callback events for Links, called when a document has been parsed and when it needs to be modified or rendered.

Since:

1.8RC3

Version:

$Id: a1f2c84c75fd4b1a18d110c856a8d47a2ef597d8 $

See Also:

Listener

Method Summary

Methods

Modifier and Type	Method and Description
void	beginLink(ResourceReference reference, boolean isFreeStandingURI, Map<String,String> parameters) Start of a link.
void	endLink(ResourceReference reference, boolean isFreeStandingURI, Map<String,String> parameters) End of a link.

Method Detail

beginLink

void beginLink(@Name(value="reference")
             ResourceReference reference,
             @Name(value="freestanding")
             boolean isFreeStandingURI,
             @Default(value="")@Name(value="parameters")
             Map<String,String> parameters)

Start of a link.

Parameters:

reference - the link reference

isFreeStandingURI - if true then the link is a free standing URI directly in the text

parameters - a generic list of parameters. Example: style="background-color: blue"

Since:

2.5RC1

See Also:

ResourceReference

endLink

void endLink(@Name(value="reference")
           ResourceReference reference,
           @Name(value="freestanding")
           boolean isFreeStandingURI,
           @Default(value="")@Name(value="parameters")
           Map<String,String> parameters)

End of a link.

Parameters:

reference - the link reference

isFreeStandingURI - if true then the link is a free standing URI directly in the text

parameters - a generic list of parameters. Example: style="background-color: blue"

Since:

2.5RC1

See Also:

ResourceReference