Package org.xwiki.rendering.listener

Interface ListenerProvider

@Role
@Unstable
public interface ListenerProvider

Allows to access listener instances.

Since:

15.3RC1, 14.10.8

Version:

$Id: 401cfff9e41523437c22a2d34861728ba54cfb3c $

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PARSE_ACTION	Parse action identifier.
static final String	RENDER_ACTION	Render action identifier.

Method Summary

Modifier and Type	Method	Description
boolean	accept(String action, Syntax syntax)
ChainingListener	getListener(ListenerChain listenerChain)

Field Details

PARSE_ACTION

static final String PARSE_ACTION

Parse action identifier.

See Also:

• Constant Field Values

RENDER_ACTION

static final String RENDER_ACTION

Render action identifier.

See Also:

• Constant Field Values

Method Details

accept

boolean accept(String action,
 Syntax syntax)

Parameters:

action - the action performed by the listener ("render" or "parse")

syntax - the hint of the syntax using for the action

Returns:

true when the listener provider can return a listener for the given action and syntaxHint

getListener

ChainingListener getListener(ListenerChain listenerChain)

Parameters:

listenerChain - the listener chain in which the listener will be included

Returns:

the listener to add to the listener chain