org.apache.jetspeed.om.page.impl
Class PageImpl

java.lang.Object
  org.apache.jetspeed.om.page.impl.BaseElementImpl
      org.apache.jetspeed.page.document.impl.NodeImpl
          org.apache.jetspeed.page.document.impl.DocumentImpl
              org.apache.jetspeed.om.page.impl.PageImpl

All Implemented Interfaces:

java.io.Serializable, SecuredResource, BaseElement, Document, Page, Node

public class PageImpl
extends DocumentImpl
implements Page

PageImpl

Version:

$Id$

Author:

Randy Watler

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.apache.jetspeed.om.page.Page

DOCUMENT_TYPE

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

PATH_SEPARATOR, PATH_SEPARATOR_CHAR

Constructor Summary

PageImpl()

Method Summary

java.lang.String	getDefaultDecorator(java.lang.String fragmentType) Returns the name of the default decorator that applies in this page to fragments of the specified type
java.lang.String	getEffectiveDefaultDecorator(java.lang.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(java.lang.String id) Retrieves the fragment contained within this page, with the specified Id.
java.util.List	getFragmentsByName(java.lang.String name) Retrieves the fragments contained within this page, with the specified name.
java.util.List	getMenuDefinitions() getMenuDefinitions - get list of menu definitions
Fragment	getRootFragment() Retrieves the top level fragment of this page.
java.lang.String	getSkin() Returns the name of the default skin that applies to this page.
java.lang.String	getType() getType
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
PageMetadataImpl	newPageMetadata(java.util.Collection fields) newPageMetadata Construct page manager specific metadata implementation.
Fragment	removeFragmentById(java.lang.String id) Removes the fragment contained within this page, with the specified Id.
void	resetCachedSecurityConstraints() resetCachedSecurityConstraints
void	setDefaultDecorator(java.lang.String decoratorName, java.lang.String fragmentType) Modifies the default decorator for the specified fragment type.
void	setMenuDefinitions(java.util.List definitions) setMenuDefinitions - set list of menu definitions
void	setRootFragment(Fragment fragment) Sets the top level fragment of this page.
void	setSkin(java.lang.String skinName) Modifies the skin for this page.

Methods inherited from class org.apache.jetspeed.page.document.impl.DocumentImpl

getTitle, getVersion, isDirty, setDirty, setVersion

Methods inherited from class org.apache.jetspeed.page.document.impl.NodeImpl

checkConstraints, checkPermissions, defaultTitleFromName, getCanonicalNodePath, getEffectivePageSecurity, getLogicalPermissionPath, getMetadata, getName, getPageMetadata, getParent, getPath, getPhysicalPermissionPath, getShortTitle, getTitle, getUrl, isHidden, setHidden, setName, setParent, setPath

Methods inherited from class org.apache.jetspeed.om.page.impl.BaseElementImpl

checkAccess, checkConstraints, checkPermissions, checkPermissions, equals, getConstraintsEnabled, getId, getPermissionsEnabled, getSecurityConstraints, getShortTitle, grantViewActionAccess, hashCode, newSecurityConstraint, newSecurityConstraints, setConstraintsEnabled, setPermissionsEnabled, setSecurityConstraints, setShortTitle, setTitle

Methods inherited from class java.lang.Object

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

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

Constructor Detail

PageImpl

public PageImpl()

Method Detail

resetCachedSecurityConstraints

public void resetCachedSecurityConstraints()

Description copied from class: BaseElementImpl

resetCachedSecurityConstraints

Overrides:

resetCachedSecurityConstraints in class BaseElementImpl

newPageMetadata

public PageMetadataImpl newPageMetadata(java.util.Collection fields)

Description copied from class: NodeImpl

newPageMetadata Construct page manager specific metadata implementation.

Overrides:

newPageMetadata in class NodeImpl

Parameters:

fields - mutable fields collection

Returns:

page metadata

getSkin

public java.lang.String getSkin()

Description copied from interface: Page

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

Specified by:

getSkin in interface Page

Returns:

the page default skin name

setSkin

public void setSkin(java.lang.String skinName)

Description copied from interface: Page

Modifies the skin for this page.

Specified by:

setSkin in interface Page

Parameters:

skinName - the name of the new skin for the page

getEffectiveDefaultDecorator

public java.lang.String getEffectiveDefaultDecorator(java.lang.String fragmentType)

Description copied from interface: Page

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.

Specified by:

getEffectiveDefaultDecorator in interface Page

Parameters:

fragmentType - the type of fragment considered

Returns:

the decorator name for the selected type

getDefaultDecorator

public java.lang.String getDefaultDecorator(java.lang.String fragmentType)

Description copied from interface: Page

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

Specified by:

getDefaultDecorator in interface Page

Parameters:

fragmentType - the type of fragment considered

Returns:

the decorator name for the selected type

setDefaultDecorator

public void setDefaultDecorator(java.lang.String decoratorName,
                                java.lang.String fragmentType)

Description copied from interface: Page

Modifies the default decorator for the specified fragment type.

Specified by:

setDefaultDecorator in interface Page

Parameters:

decoratorName - the name of the new decorator for the type

fragmentType - the type of fragment considered

getRootFragment

public Fragment getRootFragment()

Description copied from interface: Page

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

Specified by:

getRootFragment in interface Page

Returns:

the base Fragment object for this page.

setRootFragment

public void setRootFragment(Fragment fragment)

Description copied from interface: Page

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

Specified by:

setRootFragment in interface Page

getFragmentById

public Fragment getFragmentById(java.lang.String id)

Description copied from interface: Page

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

Specified by:

getFragmentById in interface Page

Parameters:

id - the fragment id to look for

Returns:

the found Fragment object or null if not found

removeFragmentById

public Fragment removeFragmentById(java.lang.String id)

Description copied from interface: Page

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

Specified by:

removeFragmentById in interface Page

Parameters:

id - the fragment id to remove

Returns:

the removed Fragment object or null if not found

getFragmentsByName

public java.util.List getFragmentsByName(java.lang.String name)

Description copied from interface: Page

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

Specified by:

getFragmentsByName in interface Page

Parameters:

name - the fragment name to look for

Returns:

the list of found Fragment objects or null if not found

getMenuDefinitions

public java.util.List getMenuDefinitions()

Description copied from interface: Page

getMenuDefinitions - get list of menu definitions

Specified by:

getMenuDefinitions in interface Page

Returns:

definition list

newMenuDefinition

public MenuDefinition newMenuDefinition()

Description copied from interface: Page

newMenuDefinition - creates a new empty menu definition

Specified by:

newMenuDefinition in interface Page

Returns:

a newly created MenuDefinition object for use in Page

newMenuExcludeDefinition

public MenuExcludeDefinition newMenuExcludeDefinition()

Description copied from interface: Page

newMenuExcludeDefinition - creates a new empty menu exclude definition

Specified by:

newMenuExcludeDefinition in interface Page

Returns:

a newly created MenuExcludeDefinition object for use in Page

newMenuIncludeDefinition

public MenuIncludeDefinition newMenuIncludeDefinition()

Description copied from interface: Page

newMenuIncludeDefinition - creates a new empty menu include definition

Specified by:

newMenuIncludeDefinition in interface Page

Returns:

a newly created MenuIncludeDefinition object for use in Page

newMenuOptionsDefinition

public MenuOptionsDefinition newMenuOptionsDefinition()

Description copied from interface: Page

newMenuOptionsDefinition - creates a new empty menu options definition

Specified by:

newMenuOptionsDefinition in interface Page

Returns:

a newly created MenuOptionsDefinition object for use in Page

newMenuSeparatorDefinition

public MenuSeparatorDefinition newMenuSeparatorDefinition()

Description copied from interface: Page

newMenuSeparatorDefinition - creates a new empty menu separator definition

Specified by:

newMenuSeparatorDefinition in interface Page

Returns:

a newly created MenuSeparatorDefinition object for use in Page

setMenuDefinitions

public void setMenuDefinitions(java.util.List definitions)

Description copied from interface: Page

setMenuDefinitions - set list of menu definitions

Specified by:

setMenuDefinitions in interface Page

Parameters:

definitions - definition list

getType

public java.lang.String getType()

Description copied from interface: Node

getType

Specified by:

getType in interface Node

Specified by:

getType in class NodeImpl

Returns: