|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.jetspeed.om.page.ContentPageImpl
public class ContentPageImpl
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 | |
---|---|
ContentPageImpl(Page page)
|
Method Summary | |
---|---|
void |
checkAccess(java.lang.String actions)
checkAccess |
void |
checkConstraints(java.lang.String actions)
checkConstraints |
void |
checkPermissions(int mask)
checkPermissions |
boolean |
getConstraintsEnabled()
getConstraintsEnabled |
ContentFragment |
getContentFragmentById(java.lang.String id)
Returns a ContentFragment that wraps the actual Fragment metadata represented by the id argument. |
java.util.List |
getContentFragmentsByName(java.lang.String name)
Returns a list of ContentFragment that wrap the actual Fragment metadata represented by the name argument. |
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)
Overridden to to indicate that the Fragment returned
must also be an instance of ContentFragment. |
java.util.List |
getFragmentsByName(java.lang.String name)
Overridden to to indicate that the list of Fragment
instances returned must also be instances of ContentFragment. |
java.lang.String |
getId()
Returns the unique Id of this element. |
java.util.List |
getMenuDefinitions()
getMenuDefinitions - get list of menu definitions |
GenericMetadata |
getMetadata()
getMetadata |
java.lang.String |
getName()
getName |
Page |
getPage()
getPage - access wrapped page |
Node |
getParent()
getParent |
java.lang.String |
getPath()
getPath |
boolean |
getPermissionsEnabled()
getPermissionsEnabled |
ContentFragment |
getRootContentFragment()
Provides access to a per-request safe ContentFragment. |
Fragment |
getRootFragment()
Overridden to to indicate that the Fragment returned
must also be an instance of ContentFragment. |
SecurityConstraints |
getSecurityConstraints()
getSecurityConstraints |
java.lang.String |
getShortTitle()
Returns the short title in the default Locale |
java.lang.String |
getShortTitle(java.util.Locale locale)
getShortTitle |
java.lang.String |
getSkin()
Returns the name of the default skin that applies to this page. |
java.lang.String |
getTitle()
Returns the title in the default Locale |
java.lang.String |
getTitle(java.util.Locale locale)
getTitle |
java.lang.String |
getType()
getType |
java.lang.String |
getUrl()
getUrl |
java.lang.String |
getVersion()
Gets the version number |
boolean |
isDirty()
isDirty |
boolean |
isHidden()
isHidden |
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 |
SecurityConstraint |
newSecurityConstraint()
newSecurityConstraint |
SecurityConstraints |
newSecurityConstraints()
newSecurityConstraints |
Fragment |
removeFragmentById(java.lang.String id)
Removes the fragment contained within this page, with the specified Id. |
void |
setDefaultDecorator(java.lang.String decoratorName,
java.lang.String fragmentType)
Modifies the default decorator for the specified fragment type. |
void |
setDirty(boolean dirty)
setDirty |
void |
setHidden(boolean hidden)
setHidden |
void |
setMenuDefinitions(java.util.List definitions)
setMenuDefinitions - set list of menu definitions |
void |
setParent(Node parent)
setParent |
void |
setPath(java.lang.String path)
setPath |
void |
setRootContentFragment(ContentFragment frag)
|
void |
setRootFragment(Fragment fragment)
Sets the top level fragment of this page. |
void |
setSecurityConstraints(SecurityConstraints constraints)
setSecurityConstraints |
void |
setShortTitle(java.lang.String title)
Sets the short title for the default Locale |
void |
setSkin(java.lang.String skinName)
Modifies the skin for this page. |
void |
setTitle(java.lang.String title)
Sets the title for the default Locale |
void |
setVersion(java.lang.String version)
Sets the version number |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public ContentPageImpl(Page page)
Method Detail |
---|
public void setRootContentFragment(ContentFragment frag)
setRootContentFragment
in interface ContentPage
public java.lang.String toString()
toString
in class java.lang.Object
public ContentFragment getContentFragmentById(java.lang.String id)
ContentPage
getContentFragmentById
in interface ContentPage
id
- unique id of the Fragment we want to retrieve.
public Fragment getFragmentById(java.lang.String id)
ContentPage
Fragment
returned
must also be an instance of ContentFragment.
getFragmentById
in interface ContentPage
getFragmentById
in interface Page
id
- the fragment id to look for
public Fragment removeFragmentById(java.lang.String id)
Page
removeFragmentById
in interface Page
id
- the fragment id to remove
public java.util.List getContentFragmentsByName(java.lang.String name)
ContentPage
getContentFragmentsByName
in interface ContentPage
name
- name of the Fragments we want to retrieve.
public java.util.List getFragmentsByName(java.lang.String name)
ContentPage
Fragment
instances returned must also be instances of ContentFragment.
getFragmentsByName
in interface ContentPage
getFragmentsByName
in interface Page
name
- the fragments name to look for
public ContentFragment getRootContentFragment()
ContentPage
getRootContentFragment
in interface ContentPage
public Fragment getRootFragment()
ContentPage
Fragment
returned
must also be an instance of ContentFragment.
getRootFragment
in interface ContentPage
getRootFragment
in interface Page
public java.lang.String getEffectiveDefaultDecorator(java.lang.String fragmentType)
Page
getEffectiveDefaultDecorator
in interface Page
fragmentType
- the type of fragment considered
public java.lang.String getDefaultDecorator(java.lang.String fragmentType)
Page
getDefaultDecorator
in interface Page
fragmentType
- the type of fragment considered
public java.lang.String getSkin()
Page
getSkin
in interface Page
public void setDefaultDecorator(java.lang.String decoratorName, java.lang.String fragmentType)
Page
setDefaultDecorator
in interface Page
decoratorName
- the name of the new decorator for the typefragmentType
- the type of fragment consideredpublic void setSkin(java.lang.String skinName)
Page
setSkin
in interface Page
skinName
- the name of the new skin for the pagepublic void setRootFragment(Fragment fragment)
Page
setRootFragment
in interface Page
public java.util.List getMenuDefinitions()
Page
getMenuDefinitions
in interface Page
public MenuDefinition newMenuDefinition()
Page
newMenuDefinition
in interface Page
public MenuExcludeDefinition newMenuExcludeDefinition()
Page
newMenuExcludeDefinition
in interface Page
public MenuIncludeDefinition newMenuIncludeDefinition()
Page
newMenuIncludeDefinition
in interface Page
public MenuOptionsDefinition newMenuOptionsDefinition()
Page
newMenuOptionsDefinition
in interface Page
public MenuSeparatorDefinition newMenuSeparatorDefinition()
Page
newMenuSeparatorDefinition
in interface Page
public void setMenuDefinitions(java.util.List definitions)
Page
setMenuDefinitions
in interface Page
definitions
- definition listpublic GenericMetadata getMetadata()
Node
getMetadata
getMetadata
in interface Node
public java.lang.String getName()
Node
getName
Returns the name of this node relative toNode.getParent().getPath()
getName
in interface Node
public Node getParent()
Node
getParent
getParent
in interface Node
public java.lang.String getPath()
Node
getPath
getPath
in interface Node
public java.lang.String getShortTitle(java.util.Locale locale)
Node
getShortTitle
Returns the short title for the specified locale.
getShortTitle
in interface Node
public java.lang.String getTitle(java.util.Locale locale)
Node
getTitle
Returns the title for the specified locale.
getTitle
in interface Node
public java.lang.String getType()
Node
getType
getType
in interface Node
public java.lang.String getUrl()
Node
getUrl
getUrl
in interface Node
public boolean isHidden()
Node
isHidden
Whether or not this Node should be hidden in terms of the view. This MUST NOT restrict
the presence of this node in terms of being returned in
org.apache.jetspeed.page.document.NodeSet
.
isHidden
in interface Node
public void setHidden(boolean hidden)
Node
setHidden
Whether or not this Node should be hidden in terms of the view.
setHidden
in interface Node
hidden
- flagpublic void setParent(Node parent)
Node
setParent
setParent
in interface Node
public void setPath(java.lang.String path)
Node
setPath
Sets the full-qualified path of this node.
setPath
in interface Node
public void checkAccess(java.lang.String actions) throws java.lang.SecurityException
SecuredResource
checkAccess
checkAccess
in interface SecuredResource
actions
- list to be checked against in CSV string form
java.lang.SecurityException
public void checkConstraints(java.lang.String actions) throws java.lang.SecurityException
SecuredResource
checkConstraints
checkConstraints
in interface SecuredResource
actions
- list to be checked against in CSV string form
java.lang.SecurityException
public void checkPermissions(int mask) throws java.lang.SecurityException
SecuredResource
checkPermissions
checkPermissions
in interface SecuredResource
mask
- Mask of actions to be checked
java.lang.SecurityException
public boolean getConstraintsEnabled()
SecuredResource
getConstraintsEnabled
getConstraintsEnabled
in interface SecuredResource
public boolean getPermissionsEnabled()
SecuredResource
getPermissionsEnabled
getPermissionsEnabled
in interface SecuredResource
public SecurityConstraints getSecurityConstraints()
SecuredResource
getSecurityConstraints
getSecurityConstraints
in interface SecuredResource
public SecurityConstraints newSecurityConstraints()
SecuredResource
newSecurityConstraints
newSecurityConstraints
in interface SecuredResource
public SecurityConstraint newSecurityConstraint()
SecuredResource
newSecurityConstraint
newSecurityConstraint
in interface SecuredResource
public void setSecurityConstraints(SecurityConstraints constraints)
SecuredResource
setSecurityConstraints
setSecurityConstraints
in interface SecuredResource
constraints
- security constraints for resourcepublic java.lang.String getId()
BaseElement
getId
in interface BaseElement
public java.lang.String getShortTitle()
BaseElement
getShortTitle
in interface BaseElement
public java.lang.String getTitle()
BaseElement
getTitle
in interface BaseElement
public void setShortTitle(java.lang.String title)
BaseElement
setShortTitle
in interface BaseElement
title
- the new titlepublic void setTitle(java.lang.String title)
BaseElement
setTitle
in interface BaseElement
title
- the new titlepublic Page getPage()
public java.lang.String getVersion()
Document
getVersion
in interface Document
public void setVersion(java.lang.String version)
Document
setVersion
in interface Document
version
- version number is a string composed of optional point separated digitspublic boolean isDirty()
Document
isDirty
Whether this node is dirty, i.e. should be updated in the persistent store.
isDirty
in interface Document
public void setDirty(boolean dirty)
Document
setDirty
Flag the node as dirty / clean, i.e. should be resp. should not be updated in the persistent store
setDirty
in interface Document
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |