org.apache.jetspeed.om.page
Interface Page

All Superinterfaces:
BaseElement, Cloneable, Document, Node, SecuredResource, Serializable
All Known Subinterfaces:
ContentPage

public interface Page
extends Document, Serializable, Cloneable

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

Version:
$Id: Page.java 233239 2005-08-17 18:52:21Z weaver $

Field Summary
static String DOCUMENT_TYPE
           
 
Fields inherited from interface org.apache.jetspeed.page.document.Node
PATH_SEPARATOR, PATH_SEPARATOR_CHAR
 
Fields inherited from interface org.apache.jetspeed.om.common.SecuredResource
EDIT_ACTION, VIEW_ACTION
 
Method Summary
 Object clone()
          Create a clone of this object
 String getDefaultDecorator(String fragmentType)
          Returns the name of the default decorator that applies in this page to fragments of the specified type
 Defaults getDefaults()
          Returns the defaults object defined for this page.
 String getDefaultSkin()
          Returns the name of the default skin that applies to this page.
 Fragment getFragmentById(String id)
          Retrieves the fragment contained within this page, with the specified Id.
 List getMenuDefinitions()
          getMenuDefinitions - get list of menu definitions
 Fragment getRootFragment()
          Retrieves the top level fragment of this page.
 void setDefaultDecorator(String decoratorName, String fragmentType)
          Modifies the default decorator for the specified fragment type.
 void setDefaultSkin(String skinName)
          Modifies the default skin for this page.
 void setMenuDefinitions(List definitions)
          setMenuDefinitions - set list of menu definitions
 void setRootFragment(Fragment fragment)
          Sets the top level fragment of this page.
 
Methods inherited from interface org.apache.jetspeed.page.document.Node
getMetadata, getName, getParent, getPath, getShortTitle, getTitle, getType, getUrl, isHidden, setParent, setPath
 
Methods inherited from interface org.apache.jetspeed.om.page.BaseElement
getId, getShortTitle, getTitle, setId, setShortTitle, setTitle
 
Methods inherited from interface org.apache.jetspeed.om.common.SecuredResource
checkAccess, checkConstraints, checkPermissions, getConstraintsEnabled, getPermissionsEnabled, getSecurityConstraints, setSecurityConstraints
 

Field Detail

DOCUMENT_TYPE

public static final String DOCUMENT_TYPE
See Also:
Constant Field Values
Method Detail

getDefaultSkin

public String getDefaultSkin()
Returns the name of the default skin that applies to this page. This name should reference an entry in the Skin registry

Returns:
the page default skin name

setDefaultSkin

public void setDefaultSkin(String skinName)
Modifies the default skin for this page. This new skin must reference an entry in the Skin registry. Additionnally, replacing the default skin will not affect any children fragments with their own specific skins

Parameters:
skinName - the name of the new skin for the page

getDefaultDecorator

public 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

public 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

public 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

public void setRootFragment(Fragment fragment)
Sets the top level fragment of this page. This Fragment should never be null.

Returns:
the base Fragment object for this page.

getFragmentById

public 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

clone

public Object clone()
             throws CloneNotSupportedException
Create a clone of this object

Throws:
CloneNotSupportedException

getMenuDefinitions

public List getMenuDefinitions()
getMenuDefinitions - get list of menu definitions

Returns:
definition list

setMenuDefinitions

public void setMenuDefinitions(List definitions)
setMenuDefinitions - set list of menu definitions

Parameters:
definitions - definition list

getDefaults

public Defaults getDefaults()
Returns the defaults object defined for this page.

Returns:


Copyright © 1999-2005 Apache Software Foundation. All Rights Reserved.