Module org.apache.wicket.core

Package org.apache.wicket.core.request.handler

Class ListenerRequestHandler

java.lang.Object

org.apache.wicket.core.request.handler.ListenerRequestHandler

All Implemented Interfaces:

IComponentRequestHandler, IPageClassRequestHandler, IPageRequestHandler, ILoggableRequestHandler, IRequestHandler

public class ListenerRequestHandler
extends Object
implements IPageRequestHandler, IComponentRequestHandler, ILoggableRequestHandler

Request handler that invokes an IRequestListener on component or behavior and renders page afterwards.

Author:

Matej Knopp

Constructor Summary

Constructors

Constructor	Description
ListenerRequestHandler(IPageAndComponentProvider pageComponentProvider, Integer behaviorIndex)	Construct.
ListenerRequestHandler(PageAndComponentProvider pageComponentProvider)	Construct.

Method Summary

Modifier and Type	Method	Description
void	detach(IRequestCycle requestCycle)	This method is called at the end of a request cycle to indicate that processing is done and that cleaning up of the subject(s) of this target may be done.
Integer	getBehaviorIndex()	Index of target behavior or null if component is the target.
IRequestableComponent	getComponent()	Returns the component instance.
final String	getComponentPath()	Returns the page relative path to the component instance.
ListenerLogData	getLogData()	Returns the collected log data for this request handler and should never throw an exception.
IRequestablePage	getPage()	Returns the page.
Class<? extends IRequestablePage>	getPageClass()	Returns the page class
Integer	getPageId()	Returns the page id.
PageParameters	getPageParameters()
final Integer	getRenderCount()	Returns the number of times this page has been rendered.
boolean	includeRenderCount()
final boolean	isPageInstanceCreated()	Checks if the page instance is already created or if it will be created when IPageRequestHandler.getPage() is called
void	respond(IRequestCycle requestCycle)	Generates a response.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ListenerRequestHandler

public ListenerRequestHandler(IPageAndComponentProvider pageComponentProvider,
 Integer behaviorIndex)

Construct.

Parameters:

pageComponentProvider -

behaviorIndex -

ListenerRequestHandler

public ListenerRequestHandler(PageAndComponentProvider pageComponentProvider)

Construct.

Parameters:

pageComponentProvider -

Method Details

includeRenderCount

public boolean includeRenderCount()

getComponent

public IRequestableComponent getComponent()

Description copied from interface: IComponentRequestHandler

Returns the component instance.

Specified by:

getComponent in interface IComponentRequestHandler

Returns:

component instance

getPage

public IRequestablePage getPage()

Description copied from interface: IPageRequestHandler

Returns the page. Be aware that the page can be instantiated if this wasn't the case already.

Specified by:

getPage in interface IPageRequestHandler

Returns:

page instance

getPageClass

public Class<? extends IRequestablePage> getPageClass()

Description copied from interface: IPageClassRequestHandler

Returns the page class

Specified by:

getPageClass in interface IPageClassRequestHandler

Returns:

page class

getPageId

public Integer getPageId()

Description copied from interface: IPageRequestHandler

Returns the page id.

Specified by:

getPageId in interface IPageRequestHandler

Returns:

page id

getPageParameters

public PageParameters getPageParameters()

Specified by:

getPageParameters in interface IPageClassRequestHandler

Returns:

page parameters

detach

public void detach(IRequestCycle requestCycle)

Description copied from interface: IRequestHandler

This method is called at the end of a request cycle to indicate that processing is done and that cleaning up of the subject(s) of this target may be done.

Specified by:

detach in interface IRequestHandler

Parameters:

requestCycle - the current request cycle

getBehaviorIndex

public Integer getBehaviorIndex()

Index of target behavior or null if component is the target.

Returns:

behavior index or null

respond

public void respond(IRequestCycle requestCycle)

Description copied from interface: IRequestHandler

Generates a response.

Specified by:

respond in interface IRequestHandler

Parameters:

requestCycle - the current request cycle

isPageInstanceCreated

public final boolean isPageInstanceCreated()

Description copied from interface: IPageRequestHandler

Checks if the page instance is already created or if it will be created when IPageRequestHandler.getPage() is called

Specified by:

isPageInstanceCreated in interface IPageRequestHandler

Returns:

true iff page instance is already created

getComponentPath

public final String getComponentPath()

Description copied from interface: IComponentRequestHandler

Returns the page relative path to the component instance.

Specified by:

getComponentPath in interface IComponentRequestHandler

Returns:

the page relative path to the component instance

getRenderCount

public final Integer getRenderCount()

Description copied from interface: IPageRequestHandler

Returns the number of times this page has been rendered.

Specified by:

getRenderCount in interface IPageRequestHandler

Returns:

the number of times this page has been rendered.

See Also:

• IRequestablePage.getRenderCount()

getLogData

public ListenerLogData getLogData()

Description copied from interface: ILoggableRequestHandler

Returns the collected log data for this request handler and should never throw an exception. This method is never called before the request handler is detached.

Specified by:

getLogData in interface ILoggableRequestHandler

Returns:

The collected log data.