Package org.xwiki.rendering.listener

Interface ImageListener

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 ImageListener

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

Since:

1.8RC3

Version:

$Id: 1339e3e9f9b49daec9642f79c4743fe9ceb460e8 $

See Also:

Listener

Method Summary

Modifier and Type	Method	Description
default void	onImage(ResourceReference reference, boolean freestanding, String id, Map<String,String> parameters)	An image.
void	onImage(ResourceReference reference, boolean freestanding, Map<String,String> parameters)	An image.

Method Detail

onImage

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

An image.

Parameters:

reference - the image reference

freestanding - if true then the image is defined directly as a URI in the text

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

onImage

@Unstable
default void onImage(ResourceReference reference,
                     boolean freestanding,
                     String id,
                     @Default("")
                     Map<String,String> parameters)

An image.

Parameters:

reference - the image reference

freestanding - if true then the image is defined directly as a URI in the text

id - the (generated) id of the image

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

Since:

14.2RC1