Package org.apache.empire.jsf2.pages

Class PageDefinitions

java.lang.Object

org.apache.empire.jsf2.pages.PageDefinitions

public abstract class PageDefinitions
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected String	pageUriExtension

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PageDefinitions()
protected	PageDefinitions(String pageUriExtension)

Method Summary

Modifier and Type	Method	Description
boolean	containsView(String viewId)	returns true if the view exists in the page map or false otherwise
PageDefinition	getDefaultPage()	returns the default (welcome) page definition.
static PageDefinitions	getInstance()
PageDefinition	getPageFromViewId(String viewId)	returns a page definition for a given viewId
String	getPageUri(PageDefinition pageDef)	returns the page uri (without contextRoot!)
String	getPageUriExtension()	returns the page uri extension
protected static void	registerPage(PageDefinition pageDef)	register a page.
void	registerPageBeans(FacesImplementation facesImpl)	Register page beans with the BeanManager

Methods inherited from class java.lang.Object

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

Field Details

pageUriExtension

protected String pageUriExtension

Constructor Details

PageDefinitions

protected PageDefinitions(String pageUriExtension)

PageDefinitions

protected PageDefinitions()

Method Details

getInstance

public static PageDefinitions getInstance()

registerPageBeans

public void registerPageBeans(FacesImplementation facesImpl)

Register page beans with the BeanManager

Parameters:

facesImpl - the faces implementation

getPageUriExtension

public String getPageUriExtension()

returns the page uri extension

Returns:

the page uri extension

getPageUri

public String getPageUri(PageDefinition pageDef)

returns the page uri (without contextRoot!) for given page definition

Parameters:

pageDef - the page definition

Returns:

the page uri

containsView

public boolean containsView(String viewId)

returns true if the view exists in the page map or false otherwise

Parameters:

viewId - the view id

Returns:

true if the view exists in the page map or false otherwise

getDefaultPage

public PageDefinition getDefaultPage()

returns the default (welcome) page definition. By default this is the first page in the PageMap

Returns:

the default (welcome) page definition.

getPageFromViewId

public PageDefinition getPageFromViewId(String viewId)

returns a page definition for a given viewId

Parameters:

viewId - the view id

Returns:

the page definition

registerPage

protected static void registerPage(PageDefinition pageDef)

register a page. Called internally from PageDefinition constructor! Do not call yourself.

Parameters:

pageDef - the page definition