org.apache.jetspeed.om.page

Interface BasePageElement

All Superinterfaces:

BaseElement, BaseFragmentsElement, Document, Node, SecuredResource

All Known Subinterfaces:

BaseConcretePageElement, Dashboard, DynamicPage, Page, PageTemplate

public interface BasePageElement
extends BaseFragmentsElement

This interface represents a generic page document used by Jetspeed to layout a portal page.

Version:

$Id:$

Author:

Randy Watler

Field Summary

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

PATH_SEPARATOR, PATH_SEPARATOR_CHAR

Method Summary

Methods

Modifier and Type	Method and Description
String	getDefaultDecorator(String fragmentType) Returns the name of the default decorator that applies in this page to fragments of the specified type
List<MenuDefinition>	getMenuDefinitions() getMenuDefinitions - get list of menu definitions
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
void	setDefaultDecorator(String decoratorName, String fragmentType) Modifies the default decorator for the specified fragment type.
void	setMenuDefinitions(List<MenuDefinition> definitions) setMenuDefinitions - set list of menu definitions
void	setSkin(String skinName) Modifies the skin for this page.

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

getFragmentById, getFragmentsByInterface, getFragmentsByName, getRootFragment, removeFragmentById, setRootFragment

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, isStale, setShortTitle, setTitle

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

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

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

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

getMenuDefinitions

List<MenuDefinition> 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<MenuDefinition> definitions)

setMenuDefinitions - set list of menu definitions

Parameters:

definitions - definition list