org.gatein.mop.api.workspace
Interface Page

All Superinterfaces:

CustomizationContext, Templatized, TemplatizedObject, WorkspaceCustomizationContext, WorkspaceObject

public interface Page
extends TemplatizedObject, WorkspaceCustomizationContext

A page is a pointer with useful information pointing to a component structure.

Page can be organized as hierarchies used for the single purpose of performing property inheritance. The pages of a same hierarchy belong to the same site.

Version:

$Revision$

Author:

Julien Viet

Field Summary

Fields inherited from interface org.gatein.mop.api.workspace.WorkspaceCustomizationContext

TYPE

Method Summary

Page	addChild(String name) Create a child page and returns it.
void	destroy() Destroys the page.
Attributes	getCascadingAttributes() Returns the page attributes.
Page	getChild(String name) Returns a named child or null if it does not exist.
Collection<? extends Page>	getChildren() Returns the children.
String	getName() Returns the page name.
Collection<PageLink>	getNavigations() Returns the set of navigations pointing to this page.
ObjectType<? extends Page>	getObjectType() Returns the page type.
Page	getParent() Returns the parent page
UIContainer	getRootComponent() Returns the layout of the page.
Site	getSite() Returns the site that owns the page.
<T extends TemplatizedObject> Collection<? extends T>	getTemplatizedObjects(ObjectType<T> templatizedType) Returns the templatized objects for this page.

Methods inherited from interface org.gatein.mop.api.workspace.WorkspaceObject

getAttributes, getObjectId

Methods inherited from interface org.gatein.mop.api.workspace.Templatized

getTemplate, setTemplate

Methods inherited from interface org.gatein.mop.api.workspace.WorkspaceCustomizationContext

customize, customize, getCustomization

Methods inherited from interface org.gatein.mop.api.content.CustomizationContext

contains, getContextId, getContextType

Method Detail

getName

String getName()

Returns the page name.

Returns:

the page name

getObjectType

ObjectType<? extends Page> getObjectType()

Returns the page type.

Specified by:

getObjectType in interface WorkspaceObject

Returns:

the page type

getCascadingAttributes

Attributes getCascadingAttributes()

Returns the page attributes.

Returns:

the attributes

getSite

Site getSite()

Returns the site that owns the page.

Returns:

the owner site

getParent

Page getParent()

Returns the parent page

Returns:

the parent page

getChildren

Collection<? extends Page> getChildren()

Returns the children.

Returns:

the children

getChild

Page getChild(String name)

Returns a named child or null if it does not exist.

Parameters:

name - the child name

Returns:

a child

addChild

Page addChild(String name)
              throws NullPointerException,
                     IllegalArgumentException

Create a child page and returns it.

Parameters:

name - the child name

Returns:

the child page

Throws:

NullPointerException - if the name is null

IllegalArgumentException - if a child with such name already exists

getRootComponent

UIContainer getRootComponent()

Returns the layout of the page. A layout is automatically when the page is created and is bound to the page life cycle.

Returns:

the page layout.

getNavigations

Collection<PageLink> getNavigations()

Returns the set of navigations pointing to this page.

Returns:

the related navigations

destroy

void destroy()

Destroys the page.

getTemplatizedObjects

<T extends TemplatizedObject> Collection<? extends T> getTemplatizedObjects(ObjectType<T> templatizedType)

Returns the templatized objects for this page.

Type Parameters:

T - the templatized workspace object type parameter

Parameters:

templatizedType - the type of templatized

Returns:

the collection of templatized objects