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, SectionGeneratorListener, 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: 8ee1e835a02c274ed86ccae81909ce934aaed336 $

See Also:

Listener

Method Summary

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

Method Detail

beginLink

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

Start of a link.

Parameters:

reference - the link reference

freestanding - 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(ResourceReference reference,
             boolean freestanding,
             @Default(value="")
             Map<String,String> parameters)

End of a link.

Parameters:

reference - the link reference

freestanding - 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