Module org.apache.wicket.core

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

Class BookmarkableListenerRequestHandler

java.lang.Object

org.apache.wicket.core.request.handler.BookmarkableListenerRequestHandler

All Implemented Interfaces:

IComponentRequestHandler, IPageClassRequestHandler, IPageRequestHandler, IRequestHandler

public class BookmarkableListenerRequestHandler
extends Object
implements IPageRequestHandler, IComponentRequestHandler

Request handler for bookmarkable pages with an IRequestListener. This handler is only used to generate URLs. Rendering is always handled by ListenerRequestHandler.

Author:

Matej Knopp

Constructor Summary

Constructors

Constructor	Description
BookmarkableListenerRequestHandler(IPageAndComponentProvider pageComponentProvider, Integer behaviorIndex)	Construct.
BookmarkableListenerRequestHandler(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()	Returns index of behavior this listener is targeted on 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.
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

BookmarkableListenerRequestHandler

public BookmarkableListenerRequestHandler(IPageAndComponentProvider pageComponentProvider,
 Integer behaviorIndex)

Construct.

Parameters:

pageComponentProvider -

behaviorIndex -

BookmarkableListenerRequestHandler

public BookmarkableListenerRequestHandler(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

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

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()

Returns index of behavior this listener is targeted on 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

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 render count of the page

See Also:

• IRequestablePage.getRenderCount()