org.apache.jetspeed.om.page
Interface Page

All Superinterfaces:

BaseElement, Document, Node, SecuredResource, Serializable

All Known Subinterfaces:

ContentPage

public interface Page
extends Document, Serializable

This interface represents a complete page document used by Jetspeed to layout a user-customizable portal page.

Version:

$Id: Page.java 516448 2007-03-09 16:25:47Z ate $

Field Summary

static String

DOCUMENT_TYPE

Fields inherited from interface org.apache.jetspeed.page.document.Node

PATH_SEPARATOR, PATH_SEPARATOR_CHAR

Method Summary

String	getDefaultDecorator(String fragmentType) Returns the name of the default decorator that applies in this page to fragments of the specified type
String	getEffectiveDefaultDecorator(String fragmentType) Returns the name of the default decorator as set here or in parent folders that applies in this page to fragments of the specified type.
Fragment	getFragmentById(String id) Retrieves the fragment contained within this page, with the specified Id.
List	getFragmentsByName(String name) Retrieves the fragments contained within this page, with the specified name.
List	getMenuDefinitions() getMenuDefinitions - get list of menu definitions
Fragment	getRootFragment() Retrieves the top level fragment of this page.
String	getSkin() Returns the name of the default skin that applies to this page.
MenuDefinition	newMenuDefinition() newMenuDefinition - creates a new empty menu definition
MenuExcludeDefinition	newMenuExcludeDefinition() newMenuExcludeDefinition - creates a new empty menu exclude definition
MenuIncludeDefinition	newMenuIncludeDefinition() newMenuIncludeDefinition - creates a new empty menu include definition
MenuOptionsDefinition	newMenuOptionsDefinition() newMenuOptionsDefinition - creates a new empty menu options definition
MenuSeparatorDefinition	newMenuSeparatorDefinition() newMenuSeparatorDefinition - creates a new empty menu separator definition
Fragment	removeFragmentById(String id) Removes the fragment contained within this page, with the specified Id.
void	setDefaultDecorator(String decoratorName, String fragmentType) Modifies the default decorator for the specified fragment type.
void	setMenuDefinitions(List definitions) setMenuDefinitions - set list of menu definitions
void	setRootFragment(Fragment fragment) Sets the top level fragment of this page.
void	setSkin(String skinName) Modifies the skin for this page.

Methods inherited from interface org.apache.jetspeed.om.page.Document

getVersion, isDirty, setDirty, setVersion

Methods inherited from interface org.apache.jetspeed.page.document.Node

getMetadata, getName, getParent, getPath, getShortTitle, getTitle, getType, getUrl, isHidden, setHidden, setParent, setPath

Methods inherited from interface org.apache.jetspeed.om.page.BaseElement

getId, getShortTitle, getTitle, setShortTitle, setTitle

Methods inherited from interface org.apache.jetspeed.om.common.SecuredResource

checkAccess, checkConstraints, checkPermissions, getConstraintsEnabled, getPermissionsEnabled, getSecurityConstraints, newSecurityConstraint, newSecurityConstraints, setSecurityConstraints

Field Detail

DOCUMENT_TYPE

static final String DOCUMENT_TYPE

See Also:

Constant Field Values

Method Detail

getSkin

String getSkin()

Returns the name of the default skin that applies to this page.

Returns:

the page default skin name

setSkin

void setSkin(String skinName)

Modifies the skin for this page.

Parameters:

skinName - the name of the new skin for the page

getEffectiveDefaultDecorator

String getEffectiveDefaultDecorator(String fragmentType)

Returns the name of the default decorator as set here or in parent folders that applies in this page to fragments of the specified type.

Parameters:

fragmentType - the type of fragment considered

Returns:

the decorator name for the selected type

getDefaultDecorator

String getDefaultDecorator(String fragmentType)

Returns the name of the default decorator that applies in this page to fragments of the specified type

Parameters:

fragmentType - the type of fragment considered

Returns:

the decorator name for the selected type

setDefaultDecorator

void setDefaultDecorator(String decoratorName,
                         String fragmentType)

Modifies the default decorator for the specified fragment type.

Parameters:

decoratorName - the name of the new decorator for the type

fragmentType - the type of fragment considered

getRootFragment

Fragment getRootFragment()

Retrieves the top level fragment of this page. This Fragment should never be null.

Returns:

the base Fragment object for this page.

setRootFragment

void setRootFragment(Fragment fragment)

Sets the top level fragment of this page. This Fragment should never be null.

getFragmentById

Fragment getFragmentById(String id)

Retrieves the fragment contained within this page, with the specified Id.

Parameters:

id - the fragment id to look for

Returns:

the found Fragment object or null if not found

removeFragmentById

Fragment removeFragmentById(String id)

Removes the fragment contained within this page, with the specified Id.

Parameters:

id - the fragment id to remove

Returns:

the removed Fragment object or null if not found

getFragmentsByName

List getFragmentsByName(String name)

Retrieves the fragments contained within this page, with the specified name.

Parameters:

name - the fragment name to look for

Returns:

the list of found Fragment objects or null if not found

getMenuDefinitions

List getMenuDefinitions()

getMenuDefinitions - get list of menu definitions

Returns:

definition list

newMenuDefinition

MenuDefinition newMenuDefinition()

newMenuDefinition - creates a new empty menu definition

Returns:

a newly created MenuDefinition object for use in Page

newMenuExcludeDefinition

MenuExcludeDefinition newMenuExcludeDefinition()

newMenuExcludeDefinition - creates a new empty menu exclude definition

Returns:

a newly created MenuExcludeDefinition object for use in Page

newMenuIncludeDefinition

MenuIncludeDefinition newMenuIncludeDefinition()

newMenuIncludeDefinition - creates a new empty menu include definition

Returns:

a newly created MenuIncludeDefinition object for use in Page

newMenuOptionsDefinition

MenuOptionsDefinition newMenuOptionsDefinition()

newMenuOptionsDefinition - creates a new empty menu options definition

Returns:

a newly created MenuOptionsDefinition object for use in Page

newMenuSeparatorDefinition

MenuSeparatorDefinition newMenuSeparatorDefinition()

newMenuSeparatorDefinition - creates a new empty menu separator definition

Returns:

a newly created MenuSeparatorDefinition object for use in Page

setMenuDefinitions

void setMenuDefinitions(List definitions)

setMenuDefinitions - set list of menu definitions

Parameters:

definitions - definition list