org.apache.wicket
Interface IPageMap

All Superinterfaces:

IClusterable, java.io.Serializable

All Known Implementing Classes:

AccessStackPageMap, PageMap

public interface IPageMap
extends IClusterable

FIXME IPageMap javadoc

Author:

eelcohillenius, Johan Compagner

Method Summary

java.lang.String	attributeForId(int id)
void	clear() Removes all pages from this map
boolean	containsPage(int id, int versionNumber) Returns true if the PageMap contains page with given id and versonNumber
boolean	continueToOriginalDestination() Redirects to any intercept page previously specified by a call to redirectToInterceptPage.
Page	get(int id, int versionNumber) Retrieves page with given id.
IPageMapEntry	getEntry(int id) Retrieves entry with given id.
java.lang.String	getName()
long	getSizeInBytes()
boolean	isDefault()
int	nextId()
void	put(Page page)
<T extends Page> void	redirectToInterceptPage(java.lang.Class<T> pageClazz) Redirects browser to an intermediate page such as a sign-in page.
void	redirectToInterceptPage(Page page) Redirects browser to an intermediate page such as a sign-in page.
void	remove() Removes this PageMap from the Session.
void	remove(Page page) Removes the page from the pagemap
void	removeEntry(IPageMapEntry entry)

Method Detail

attributeForId

java.lang.String attributeForId(int id)

Parameters:

id - The page id to create an attribute for

Returns:

The session attribute for the given page (for replication of state)

clear

void clear()

Removes all pages from this map

continueToOriginalDestination

boolean continueToOriginalDestination()

Redirects to any intercept page previously specified by a call to redirectToInterceptPage.

Returns:

True if an original destination was redirected to

See Also:

Component.redirectToInterceptPage(Page)

get

Page get(int id,
         int versionNumber)

Retrieves page with given id.

Parameters:

id - The page identifier

versionNumber - The version to get

Returns:

Any page having the given id

getEntry

IPageMapEntry getEntry(int id)

Retrieves entry with given id.

Parameters:

id - The page identifier

Returns:

Any entry having the given id

getName

java.lang.String getName()

Returns:

Returns the name.

getSizeInBytes

long getSizeInBytes()

Returns:

Size of this page map in bytes, including a sum of the sizes of all the pages it contains.

isDefault

boolean isDefault()

Returns:

True if this is the default page map

nextId

int nextId()

Returns:

The next id for this pagemap

put

void put(Page page)

Parameters:

page - The page to put into this map

redirectToInterceptPage

<T extends Page> void redirectToInterceptPage(java.lang.Class<T> pageClazz)

Redirects browser to an intermediate page such as a sign-in page. The current request's URL is saved exactly as it was requested for future use by continueToOriginalDestination(); Only use this method when you plan to continue to the current URL at some later time; otherwise just use setResponsePage or, when you are in a constructor, redirectTo.

Type Parameters:

T -

Parameters:

pageClazz - The page clazz to temporarily redirect to

redirectToInterceptPage

void redirectToInterceptPage(Page page)

Redirects browser to an intermediate page such as a sign-in page. The current request's url is saved for future use by method continueToOriginalDestination(); Only use this method when you plan to continue to the current url at some later time; otherwise just use setResponsePage or - when you are in a constructor or checkAccessMethod, call redirectTo.

Parameters:

page - The sign in page

See Also:

Component.continueToOriginalDestination()

remove

void remove()

Removes this PageMap from the Session.

remove

void remove(Page page)

Removes the page from the pagemap

Parameters:

page - page to be removed from the pagemap

removeEntry

void removeEntry(IPageMapEntry entry)

Parameters:

entry - The entry to remove

containsPage

boolean containsPage(int id,
                     int versionNumber)

Returns true if the PageMap contains page with given id and versonNumber

Parameters:

id -

versionNumber -

Returns:

true if the PageMap contains a page with the given id and versionNumber