org.apache.wicket.settings.def
Class PageSettings

java.lang.Object
  extended by org.apache.wicket.settings.def.PageSettings
All Implemented Interfaces:
IPageSettings

public class PageSettings
extends Object
implements IPageSettings

Author:
Jonathan Locke, Chris Turner, Eelco Hillenius, Juergen Donnerstag, Johan Compagner, Igor Vaynberg (ivaynberg), Martijn Dashorst, James Carman

Constructor Summary
PageSettings()
           
 
Method Summary
 void addComponentResolver(IComponentResolver resolver)
          Adds a component resolver to the list.
 List<IComponentResolver> getComponentResolvers()
          Get the (modifiable) list of IComponentResolvers.
 boolean getRecreateMountedPagesAfterExpiry()
          When enabled (default), urls on mounted pages will contain the full mount path, including PageParameters, allowing wicket to reinstantiate the page if got expired.
 boolean getVersionPagesByDefault()
           
 void setRecreateMountedPagesAfterExpiry(boolean recreateMountedPagesAfterExpiry)
          Sets the recreateMountedPagesAfterExpiry setting
 void setVersionPagesByDefault(boolean pagesVersionedByDefault)
          A global setting that tells the pages to update their page id if their component hierarchy changes somehow.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PageSettings

public PageSettings()
Method Detail

addComponentResolver

public void addComponentResolver(IComponentResolver resolver)
Description copied from interface: IPageSettings
Adds a component resolver to the list.

Specified by:
addComponentResolver in interface IPageSettings
Parameters:
resolver - The IComponentResolver that is added
See Also:
IPageSettings.addComponentResolver(org.apache.wicket.markup.resolver.IComponentResolver)

getComponentResolvers

public List<IComponentResolver> getComponentResolvers()
Description copied from interface: IPageSettings
Get the (modifiable) list of IComponentResolvers.

Specified by:
getComponentResolvers in interface IPageSettings
Returns:
List of ComponentResolvers
See Also:
IPageSettings.getComponentResolvers()

getVersionPagesByDefault

public boolean getVersionPagesByDefault()
Specified by:
getVersionPagesByDefault in interface IPageSettings
Returns:
whether all pages should should update their page id when their component hierarchy changes somehow
See Also:
IPageSettings.getVersionPagesByDefault()

setVersionPagesByDefault

public void setVersionPagesByDefault(boolean pagesVersionedByDefault)
Description copied from interface: IPageSettings
A global setting that tells the pages to update their page id if their component hierarchy changes somehow. This way versioned pages can have several versions stored in the page stores and the user can go back and forth through the different versions. If a page is not versioned then only its last state is keep in the page stores and going back will lead the user to the page before the current one, not to the previous state of the current one.

Specified by:
setVersionPagesByDefault in interface IPageSettings
Parameters:
pagesVersionedByDefault - a flag that indicates whether pages should increase their page id when their component hierarchy changes somehow.
See Also:
IPageSettings.setVersionPagesByDefault(boolean)

getRecreateMountedPagesAfterExpiry

public boolean getRecreateMountedPagesAfterExpiry()
Description copied from interface: IPageSettings
When enabled (default), urls on mounted pages will contain the full mount path, including PageParameters, allowing wicket to reinstantiate the page if got expired. When disabled, urls only use the page id. If this setting is enabled, you should take care that names form fields on mounted pages do not clash with the page parameters.

Specified by:
getRecreateMountedPagesAfterExpiry in interface IPageSettings
Returns:
if urls on mounted pages should be the full mount path
See Also:
WICKET-4014, WICKET-4290

setRecreateMountedPagesAfterExpiry

public void setRecreateMountedPagesAfterExpiry(boolean recreateMountedPagesAfterExpiry)
Description copied from interface: IPageSettings
Sets the recreateMountedPagesAfterExpiry setting

Specified by:
setRecreateMountedPagesAfterExpiry in interface IPageSettings


Copyright © 2006-2013 Apache Software Foundation. All Rights Reserved.