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

java.lang.Object
  org.apache.jetspeed.om.page.psml.AbstractBaseElement
      org.apache.jetspeed.page.document.psml.AbstractNode
          org.apache.jetspeed.om.page.psml.DocumentImpl
              org.apache.jetspeed.om.page.psml.PageImpl

All Implemented Interfaces:

Serializable, org.apache.jetspeed.om.common.SecuredResource, org.apache.jetspeed.om.page.BaseElement, org.apache.jetspeed.om.page.Document, org.apache.jetspeed.om.page.Page, org.apache.jetspeed.page.document.Node

public class PageImpl
extends DocumentImpl
implements org.apache.jetspeed.om.page.Page

Version:

$Id: PageImpl.java 550655 2007-06-26 01:41:35Z taylor $

See Also:

Serialized Form

Field Summary

private DefaultsImpl	defaults
private int	hashCode
private List	menuDefinitions menuDefinitions - menu definitions for page
private org.apache.jetspeed.om.page.Fragment	root

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

boolean	equals(Object obj) equals
String	getDefaultDecorator(String fragmentType)
DefaultsImpl	getDefaults()
String	getEffectiveDefaultDecorator(String fragmentType)
org.apache.jetspeed.om.page.Fragment	getFragmentById(String id)
List	getFragmentsByName(String name)
List	getMenuDefinitions() getMenuDefinitions - get list of menu definitions
org.apache.jetspeed.om.page.Fragment	getRootFragment()
String	getSkin()
String	getType() getType
int	hashCode() hashCode
void	marshalling() marshalling - notification that this instance is to be saved to the persistent store
org.apache.jetspeed.om.folder.MenuDefinition	newMenuDefinition() newMenuDefinition - creates a new empty menu definition
org.apache.jetspeed.om.folder.MenuExcludeDefinition	newMenuExcludeDefinition() newMenuExcludeDefinition - creates a new empty menu exclude definition
org.apache.jetspeed.om.folder.MenuIncludeDefinition	newMenuIncludeDefinition() newMenuIncludeDefinition - creates a new empty menu include definition
org.apache.jetspeed.om.folder.MenuOptionsDefinition	newMenuOptionsDefinition() newMenuOptionsDefinition - creates a new empty menu options definition
org.apache.jetspeed.om.folder.MenuSeparatorDefinition	newMenuSeparatorDefinition() newMenuSeparatorDefinition - creates a new empty menu separator definition
org.apache.jetspeed.om.page.Fragment	removeFragmentById(String id)
void	setDefaultDecorator(String decoratorName, String fragmentType)
void	setDefaults(DefaultsImpl defaults)
void	setId(String id) setId
void	setMenuDefinitions(List definitions) setMenuDefinitions - set list of menu definitions
void	setRootFragment(org.apache.jetspeed.om.page.Fragment root)
void	setSkin(String skinName)
void	unmarshalled() unmarshalled - notification that this instance has been loaded from the persistent store

Methods inherited from class org.apache.jetspeed.om.page.psml.DocumentImpl

getVersion, isDirty, setDirty, setVersion

Methods inherited from class org.apache.jetspeed.page.document.psml.AbstractNode

checkConstraints, checkPermissions, getEffectivePageSecurity, getLogicalPermissionPath, getMetadata, getMetadataFields, getName, getParent, getParent, getPath, getPhysicalPermissionPath, getProfiledPath, getShortTitle, getTitle, getTitleName, getUrl, isHidden, setHidden, setMetadata, setMetadataFields, setParent, setPath, setProfiledPath, setUrl

Methods inherited from class org.apache.jetspeed.om.page.psml.AbstractBaseElement

checkAccess, checkAccess, checkConstraints, checkPermissions, checkPermissions, getConstraintsEnabled, getHandlerFactory, getId, getPermissionsEnabled, getSecurityConstraints, getShortTitle, getTitle, grantViewActionAccess, newSecurityConstraint, newSecurityConstraints, setConstraintsEnabled, setHandlerFactory, setPermissionsEnabled, setSecurityConstraints, setShortTitle, setTitle, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, 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

Field Detail

defaults

private DefaultsImpl defaults

root

private org.apache.jetspeed.om.page.Fragment root

hashCode

private int hashCode

menuDefinitions

private List menuDefinitions

menuDefinitions - menu definitions for page

Constructor Detail

PageImpl

public PageImpl()

Method Detail

setId

public void setId(String id)

setId

Overrides:

setId in class AbstractBaseElement

Parameters:

id -

See Also:

AbstractBaseElement.setId(java.lang.String)

equals

public boolean equals(Object obj)

equals

Overrides:

equals in class AbstractBaseElement

Parameters:

obj -

Returns:

See Also:

Object.equals(java.lang.Object)

hashCode

public int hashCode()

hashCode

Overrides:

hashCode in class AbstractBaseElement

Returns:

See Also:

Object.hashCode()

getSkin

public String getSkin()

Specified by:

getSkin in interface org.apache.jetspeed.om.page.Page

setSkin

public void setSkin(String skinName)

Specified by:

setSkin in interface org.apache.jetspeed.om.page.Page

getEffectiveDefaultDecorator

public String getEffectiveDefaultDecorator(String fragmentType)

Specified by:

getEffectiveDefaultDecorator in interface org.apache.jetspeed.om.page.Page

getDefaultDecorator

public String getDefaultDecorator(String fragmentType)

Specified by:

getDefaultDecorator in interface org.apache.jetspeed.om.page.Page

setDefaultDecorator

public void setDefaultDecorator(String decoratorName,
                                String fragmentType)

Specified by:

setDefaultDecorator in interface org.apache.jetspeed.om.page.Page

getRootFragment

public org.apache.jetspeed.om.page.Fragment getRootFragment()

Specified by:

getRootFragment in interface org.apache.jetspeed.om.page.Page

setRootFragment

public void setRootFragment(org.apache.jetspeed.om.page.Fragment root)

Specified by:

setRootFragment in interface org.apache.jetspeed.om.page.Page

getFragmentById

public org.apache.jetspeed.om.page.Fragment getFragmentById(String id)

Specified by:

getFragmentById in interface org.apache.jetspeed.om.page.Page

removeFragmentById

public org.apache.jetspeed.om.page.Fragment removeFragmentById(String id)

Specified by:

removeFragmentById in interface org.apache.jetspeed.om.page.Page

getFragmentsByName

public List getFragmentsByName(String name)

Specified by:

getFragmentsByName in interface org.apache.jetspeed.om.page.Page

getDefaults

public DefaultsImpl getDefaults()

setDefaults

public void setDefaults(DefaultsImpl defaults)

getType

public String getType()

getType

Specified by:

getType in interface org.apache.jetspeed.page.document.Node

Returns:

See Also:

Node.getType()

getMenuDefinitions

public List getMenuDefinitions()

getMenuDefinitions - get list of menu definitions

Specified by:

getMenuDefinitions in interface org.apache.jetspeed.om.page.Page

Returns:

definition list

newMenuDefinition

public org.apache.jetspeed.om.folder.MenuDefinition newMenuDefinition()

newMenuDefinition - creates a new empty menu definition

Specified by:

newMenuDefinition in interface org.apache.jetspeed.om.page.Page

Returns:

a newly created MenuDefinition object for use in Page

newMenuExcludeDefinition

public org.apache.jetspeed.om.folder.MenuExcludeDefinition newMenuExcludeDefinition()

newMenuExcludeDefinition - creates a new empty menu exclude definition

Specified by:

newMenuExcludeDefinition in interface org.apache.jetspeed.om.page.Page

Returns:

a newly created MenuExcludeDefinition object for use in Page

newMenuIncludeDefinition

public org.apache.jetspeed.om.folder.MenuIncludeDefinition newMenuIncludeDefinition()

newMenuIncludeDefinition - creates a new empty menu include definition

Specified by:

newMenuIncludeDefinition in interface org.apache.jetspeed.om.page.Page

Returns:

a newly created MenuIncludeDefinition object for use in Page

newMenuOptionsDefinition

public org.apache.jetspeed.om.folder.MenuOptionsDefinition newMenuOptionsDefinition()

newMenuOptionsDefinition - creates a new empty menu options definition

Specified by:

newMenuOptionsDefinition in interface org.apache.jetspeed.om.page.Page

Returns:

a newly created MenuOptionsDefinition object for use in Page

newMenuSeparatorDefinition

public org.apache.jetspeed.om.folder.MenuSeparatorDefinition newMenuSeparatorDefinition()

newMenuSeparatorDefinition - creates a new empty menu separator definition

Specified by:

newMenuSeparatorDefinition in interface org.apache.jetspeed.om.page.Page

Returns:

a newly created MenuSeparatorDefinition object for use in Page

setMenuDefinitions

public void setMenuDefinitions(List definitions)

setMenuDefinitions - set list of menu definitions

Specified by:

setMenuDefinitions in interface org.apache.jetspeed.om.page.Page

Parameters:

definitions - definition list

unmarshalled

public void unmarshalled()

unmarshalled - notification that this instance has been loaded from the persistent store

Overrides:

unmarshalled in class DocumentImpl

marshalling

public void marshalling()

marshalling - notification that this instance is to be saved to the persistent store

Overrides:

marshalling in class AbstractBaseElement