org.gatein.mop.api.workspace

Interface Page

All Superinterfaces:

Adaptable, WorkspaceObject

public interface Page
extends WorkspaceObject

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

Method Summary

Methods

Modifier and Type	Method and Description
Page	addChild(String name) Create a child page and returns it.
void	destroy() Destroys the page.
Page	getChild(String name) Returns a named child or null if it does not exist.
Collection<Page>	getChildren() Returns the children.
WorkspaceCustomizationContext	getCustomizationContext() Returns the customization context of this object;
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.
Templatized	templatize(WorkspaceObject object) Templatize the provided object.

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

getAttributes, getObjectId

Methods inherited from interface org.gatein.mop.api.Adaptable

adapt, isAdapted, removeAdapter

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

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<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.

templatize

Templatized templatize(WorkspaceObject object)
                       throws IllegalArgumentException

Templatize the provided object.

Parameters:

object - the object to templatize

Returns:

the templatized aspect of the object

Throws:

IllegalArgumentException - if the object cannot be templatized for a particular reason

getCustomizationContext

WorkspaceCustomizationContext getCustomizationContext()

Returns the customization context of this object;

Returns:

the customization context