Module org.apache.wicket.core

Package org.apache.wicket.pageStore

Class GroupingPageStore

java.lang.Object

org.apache.wicket.pageStore.DelegatingPageStore

org.apache.wicket.pageStore.GroupingPageStore

All Implemented Interfaces:

IPageStore

public abstract class GroupingPageStore
extends DelegatingPageStore

An IPageStore that groups pages.

By default all pages are stored in a single group, you'll have to override getGroup(IManageablePage) to provide the actual group for a stored page, e.g. using a single group for all pages inside a single browser tab.

Constructor Summary

Constructors

Constructor	Description
GroupingPageStore(IPageStore delegate, int maxGroups)

Method Summary

Modifier and Type	Method	Description
void	addPage(IPageContext context, IManageablePage page)	Stores the page-
protected String	getGroup(IManageablePage page)	Get the group of a page, default is "default"
IManageablePage	getPage(IPageContext context, int id)	Restores a page from storage.
void	removeAllPages(IPageContext context)	All pages should be removed from storage for the given context.
void	removePage(IPageContext context, IManageablePage page)	Removes a page from storage.
GroupingPageStore	withStableGroups()	Indicate that groups are stable, i.e. the group of a page never changes.

Methods inherited from class org.apache.wicket.pageStore.DelegatingPageStore

destroy, detach, end, getDelegate, revertPage, supportsVersioning

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.wicket.pageStore.IPageStore

canBeAsynchronous

Constructor Details

GroupingPageStore

public GroupingPageStore(IPageStore delegate,
 int maxGroups)

Parameters:

delegate - store to delegate to

maxGroups - maximum groups to keep

Method Details

withStableGroups

public GroupingPageStore withStableGroups()

Indicate that groups are stable, i.e. the group of a page never changes.

getGroup

protected String getGroup(IManageablePage page)

Get the group of a page, default is "default"

Returns:

group of page, must not be empty

addPage

public void addPage(IPageContext context,
 IManageablePage page)

Description copied from interface: IPageStore

Stores the page-

Specified by:

addPage in interface IPageStore

Overrides:

addPage in class DelegatingPageStore

Parameters:

context - the context of the page

page - the page.

removePage

public void removePage(IPageContext context,
 IManageablePage page)

Description copied from interface: IPageStore

Removes a page from storage.

Specified by:

removePage in interface IPageStore

Overrides:

removePage in class DelegatingPageStore

Parameters:

context - the context of the page

page - the page.

removeAllPages

public void removeAllPages(IPageContext context)

Description copied from interface: IPageStore

All pages should be removed from storage for the given context.

Specified by:

removeAllPages in interface IPageStore

Overrides:

removeAllPages in class DelegatingPageStore

Parameters:

context - the context of the pages

getPage

public IManageablePage getPage(IPageContext context,
 int id)

Description copied from interface: IPageStore

Restores a page from storage.

Specified by:

getPage in interface IPageStore

Overrides:

getPage in class DelegatingPageStore

Parameters:

context - the context of the page

id - the id of the page.

Returns:

the page