org.apache.jetspeed.om.page
Class ContentFragmentImpl

java.lang.Object
  org.apache.jetspeed.om.page.ContentFragmentImpl

All Implemented Interfaces:

java.io.Serializable, SecuredResource, BaseElement, ContentFragment, Fragment

public class ContentFragmentImpl
extends java.lang.Object
implements ContentFragment

See Also:

Serialized Form

Nested Class Summary

protected class

ContentFragmentImpl.ContentFragmentList

Field Summary

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

COLUMN_PROPERTY_NAME, HEIGHT_PROPERTY_NAME, LAYOUT, PORTLET, ROW_PROPERTY_NAME, SIZES_PROPERTY_NAME, WIDTH_PROPERTY_NAME, X_PROPERTY_NAME, Y_PROPERTY_NAME, Z_PROPERTY_NAME

Constructor Summary

ContentFragmentImpl(Fragment fragment, java.util.Map cachedFagments)

ContentFragmentImpl(Fragment fragment, java.util.Map cachedFagments, boolean instantlyRendered)

Method Summary

void	checkAccess(java.lang.String actions) checkAccess
void	checkConstraints(java.lang.String actions) checkConstraints
void	checkPermissions(int mask) checkPermissions
boolean	getConstraintsEnabled() getConstraintsEnabled
protected ContentFragment	getContentFragment(Fragment f) Checks the ContentFragment cache for a ContentFragment that matches the Id of this fragment.
java.util.List	getContentFragments() Provides a list of of child ContentFragments that wrap the actual Fragment metadata objects.
Decoration	getDecoration() Retrieves the actual org.apache.jetspeed.decoration.decorator object for this content fragment.
java.lang.String	getDecorator() Returns the name of the decorator bound to this fragment
float	getFloatProperty(java.lang.String propName) getFloatProperty Get named property value as float.
java.util.List	getFragments() Overridden to make it clear to the implemetor the List returned MUST ContentFragments and not just regular Fragments
java.lang.String	getId() Returns the unique Id of this element.
int	getIntProperty(java.lang.String propName) getIntProperty Get named property value as integer.
int	getLayoutColumn() get layout column property
float	getLayoutHeight() get layout height property
int	getLayoutRow() get layout row property
java.lang.String	getLayoutSizes() get layout sizes property, (i.e.
float	getLayoutWidth() get layout width property
float	getLayoutX() get layout x coordinate property
float	getLayoutY() get layout y coordinate property
float	getLayoutZ() get layout z coordinate property
java.lang.String	getMode() Returns the display mode of this fragment.
java.lang.String	getName() Returns the administrative name of this fragment.
java.lang.String	getOverriddenContent()
boolean	getPermissionsEnabled() getPermissionsEnabled
java.util.List	getPreferences() Get collection of fragment preference objects used to initialize user preferences
java.util.Map	getProperties() getProperties Get writable Map of properties by name.
java.lang.String	getProperty(java.lang.String propName) getProperty Get named property value.
java.lang.String	getRenderedContent() getRenderedContent
SecurityConstraints	getSecurityConstraints() getSecurityConstraints
java.lang.String	getShortTitle() Returns the short title in the default Locale
java.lang.String	getSkin() Returns the name of the skin associated to this fragment
java.lang.String	getState() Returns the display state of this fragment.
java.lang.String	getTitle() Returns the title in the default Locale
java.lang.String	getType() Returns the type of the class bound to this fragment
boolean	isInstantlyRendered() Checks if the content is instantly rendered from JPT.
boolean	isReference() Test if this fragment is actually a reference to an external fragment.
SecurityConstraint	newSecurityConstraint() newSecurityConstraint
SecurityConstraints	newSecurityConstraints() newSecurityConstraints
void	overrideRenderedContent(java.lang.String contnent) overrideRenderedContent
void	setDecoration(Decoration decoration)
void	setDecorator(java.lang.String decoratorName) Defines the decorator for this fragment.
void	setLayoutColumn(int column) set the layout column property
void	setLayoutHeight(float height) set the layout height property
void	setLayoutRow(int row) set the layout row property
void	setLayoutSizes(java.lang.String sizes) set the layout sizes
void	setLayoutWidth(float width) set the layout width property
void	setLayoutX(float x) set the layout x coordinate property
void	setLayoutY(float y) set the layout y coordinate property
void	setLayoutZ(float z) set the layout z coordinate property
void	setMode(java.lang.String mode) Sets the display mode of this fragment.
void	setName(java.lang.String name) Binds an administrative name to this fragment
void	setPortletContent(PortletContent portletContent) setPortletContent
void	setPreferences(java.util.List preferences) Set collection of fragment preference objects
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) Defines the skin for this fragment.
void	setState(java.lang.String state) Sets the display state of this fragment.
void	setTitle(java.lang.String title) Sets the title for the default Locale
void	setType(java.lang.String type) Binds a type to this fragment

Methods inherited from class java.lang.Object

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

Constructor Detail

ContentFragmentImpl

public ContentFragmentImpl(Fragment fragment,
                           java.util.Map cachedFagments)

ContentFragmentImpl

public ContentFragmentImpl(Fragment fragment,
                           java.util.Map cachedFagments,
                           boolean instantlyRendered)

Method Detail

getContentFragments

public java.util.List getContentFragments()

Description copied from interface: ContentFragment

Provides a list of of child ContentFragments that wrap the actual Fragment metadata objects.

Specified by:

getContentFragments in interface ContentFragment

Returns:

getFragments

public java.util.List getFragments()

Description copied from interface: ContentFragment

Overridden to make it clear to the implemetor the List returned MUST ContentFragments and not just regular Fragments

Specified by:

getFragments in interface ContentFragment

Specified by:

getFragments in interface Fragment

Returns:

a collection containing ContentFragment objects

getOverriddenContent

public java.lang.String getOverriddenContent()

Specified by:

getOverriddenContent in interface ContentFragment

Returns:

the overridden content set by overrideRenderedContent

getRenderedContent

public java.lang.String getRenderedContent()
                                    throws java.lang.IllegalStateException

Description copied from interface: ContentFragment

getRenderedContent

Returns the raw,undecorated content of this fragment. If overridenContent has been set and portlet content has not, overridden content should be returned.

Specified by:

getRenderedContent in interface ContentFragment

Returns:

The raw,undecorated content of this fragment.

Throws:

java.lang.IllegalStateException - if the content has not yet been set.

overrideRenderedContent

public void overrideRenderedContent(java.lang.String contnent)

Description copied from interface: ContentFragment

overrideRenderedContent

Can be used to store errors that may have occurred during the rendering process.

Specified by:

overrideRenderedContent in interface ContentFragment

setPortletContent

public void setPortletContent(PortletContent portletContent)

Description copied from interface: ContentFragment

setPortletContent

Specified by:

setPortletContent in interface ContentFragment

getDecorator

public java.lang.String getDecorator()

Description copied from interface: Fragment

Returns the name of the decorator bound to this fragment

Specified by:

getDecorator in interface Fragment

getName

public java.lang.String getName()

Description copied from interface: Fragment

Returns the administrative name of this fragment. This name should map to a component name in the component repository defined by the type attribute. If the name is not mapped to any component, the fragment is discarded from the rendering process, as well as any inner fragment.

Specified by:

getName in interface Fragment

Returns:

the administrative name

getProperties

public java.util.Map getProperties()

Description copied from interface: Fragment

getProperties Get writable Map of properties by name.

Specified by:

getProperties in interface Fragment

Returns:

properties map

getProperty

public java.lang.String getProperty(java.lang.String propName)

Description copied from interface: Fragment

getProperty Get named property value.

Specified by:

getProperty in interface Fragment

Parameters:

propName - property name

Returns:

value

getIntProperty

public int getIntProperty(java.lang.String propName)

Description copied from interface: Fragment

getIntProperty Get named property value as integer.

Specified by:

getIntProperty in interface Fragment

Parameters:

propName - property name

Returns:

int value

getFloatProperty

public float getFloatProperty(java.lang.String propName)

Description copied from interface: Fragment

getFloatProperty Get named property value as float.

Specified by:

getFloatProperty in interface Fragment

Parameters:

propName - property name

Returns:

float value

getSkin

public java.lang.String getSkin()

Description copied from interface: Fragment

Returns the name of the skin associated to this fragment

Specified by:

getSkin in interface Fragment

getState

public java.lang.String getState()

Description copied from interface: Fragment

Returns the display state of this fragment. The state may have the following values: "Normal","Minimized","Maximized","Hidden"

Specified by:

getState in interface Fragment

getMode

public java.lang.String getMode()

Description copied from interface: Fragment

Returns the display mode of this fragment. The mode may have the following values: "View","Edit","Help","Config","Print","Custom"

Specified by:

getMode in interface Fragment

getType

public java.lang.String getType()

Description copied from interface: Fragment

Returns the type of the class bound to this fragment

Specified by:

getType in interface Fragment

isReference

public boolean isReference()

Description copied from interface: Fragment

Test if this fragment is actually a reference to an external fragment.

Specified by:

isReference in interface Fragment

Returns:

true is this element is a reference

setDecorator

public void setDecorator(java.lang.String decoratorName)

Description copied from interface: Fragment

Defines the decorator for this fragment. This decorator should be known by the portal.

Specified by:

setDecorator in interface Fragment

Parameters:

decoratorName - the name of the decorator applied to this fragment

setName

public void setName(java.lang.String name)

Description copied from interface: Fragment

Binds an administrative name to this fragment

Specified by:

setName in interface Fragment

Parameters:

name - the administrative name

getLayoutRow

public int getLayoutRow()

Description copied from interface: Fragment

get layout row property

Specified by:

getLayoutRow in interface Fragment

Returns:

row layout property

getLayoutColumn

public int getLayoutColumn()

Description copied from interface: Fragment

get layout column property

Specified by:

getLayoutColumn in interface Fragment

Returns:

column layout property

getLayoutSizes

public java.lang.String getLayoutSizes()

Description copied from interface: Fragment

get layout sizes property, (i.e. "25%,75%")

Specified by:

getLayoutSizes in interface Fragment

Returns:

sizes layout property

getLayoutX

public float getLayoutX()

Description copied from interface: Fragment

get layout x coordinate property

Specified by:

getLayoutX in interface Fragment

Returns:

the x coordinate value

getLayoutY

public float getLayoutY()

Description copied from interface: Fragment

get layout y coordinate property

Specified by:

getLayoutY in interface Fragment

Returns:

the y coordinate value

getLayoutZ

public float getLayoutZ()

Description copied from interface: Fragment

get layout z coordinate property

Specified by:

getLayoutZ in interface Fragment

Returns:

the z coordinate value

getLayoutWidth

public float getLayoutWidth()

Description copied from interface: Fragment

get layout width property

Specified by:

getLayoutWidth in interface Fragment

Returns:

the width value

getLayoutHeight

public float getLayoutHeight()

Description copied from interface: Fragment

get layout height property

Specified by:

getLayoutHeight in interface Fragment

Returns:

the height value

setLayoutRow

public void setLayoutRow(int row)

Description copied from interface: Fragment

set the layout row property

Specified by:

setLayoutRow in interface Fragment

setLayoutColumn

public void setLayoutColumn(int column)

Description copied from interface: Fragment

set the layout column property

Specified by:

setLayoutColumn in interface Fragment

setLayoutSizes

public void setLayoutSizes(java.lang.String sizes)

Description copied from interface: Fragment

set the layout sizes

Specified by:

setLayoutSizes in interface Fragment

setLayoutX

public void setLayoutX(float x)

Description copied from interface: Fragment

set the layout x coordinate property

Specified by:

setLayoutX in interface Fragment

Parameters:

x - the coordinate value

setLayoutY

public void setLayoutY(float y)

Description copied from interface: Fragment

set the layout y coordinate property

Specified by:

setLayoutY in interface Fragment

Parameters:

y - the coordinate value

setLayoutZ

public void setLayoutZ(float z)

Description copied from interface: Fragment

set the layout z coordinate property

Specified by:

setLayoutZ in interface Fragment

Parameters:

z - the coordinate value

setLayoutWidth

public void setLayoutWidth(float width)

Description copied from interface: Fragment

set the layout width property

Specified by:

setLayoutWidth in interface Fragment

Parameters:

width - the value

setLayoutHeight

public void setLayoutHeight(float height)

Description copied from interface: Fragment

set the layout height property

Specified by:

setLayoutHeight in interface Fragment

Parameters:

height - the value

setSkin

public void setSkin(java.lang.String skinName)

Description copied from interface: Fragment

Defines the skin for this fragment. This skin should be known by the portal.

Specified by:

setSkin in interface Fragment

Parameters:

skinName - the name of the new skin applied to this fragment

setState

public void setState(java.lang.String state)

Description copied from interface: Fragment

Sets the display state of this fragment. Valid states are: "Normal","Minimized","Maximized","Hidden"

Specified by:

setState in interface Fragment

Parameters:

state - the new fragment state

setMode

public void setMode(java.lang.String mode)

Description copied from interface: Fragment

Sets the display mode of this fragment. Valid modes are: "View","Edit","Help","Config","Print","Custom"

Specified by:

setMode in interface Fragment

Parameters:

mode - the new fragment mode

setType

public void setType(java.lang.String type)

Description copied from interface: Fragment

Binds a type to this fragment

Specified by:

setType in interface Fragment

Parameters:

type - the type

getId

public java.lang.String getId()

Description copied from interface: BaseElement

Returns the unique Id of this element. This id is guaranteed to be unique from the complete portal and is suitable to be used as a unique key.

Specified by:

getId in interface BaseElement

Returns:

the unique id of this element.

getShortTitle

public java.lang.String getShortTitle()

Description copied from interface: BaseElement

Returns the short title in the default Locale

Specified by:

getShortTitle in interface BaseElement

Returns:

the page short title

getTitle

public java.lang.String getTitle()

Description copied from interface: BaseElement

Returns the title in the default Locale

Specified by:

getTitle in interface BaseElement

Returns:

the page title

setShortTitle

public void setShortTitle(java.lang.String title)

Description copied from interface: BaseElement

Sets the short title for the default Locale

Specified by:

setShortTitle in interface BaseElement

Parameters:

title - the new title

setTitle

public void setTitle(java.lang.String title)

Description copied from interface: BaseElement

Sets the title for the default Locale

Specified by:

setTitle in interface BaseElement

Parameters:

title - the new title

checkAccess

public void checkAccess(java.lang.String actions)
                 throws java.lang.SecurityException

Description copied from interface: SecuredResource

checkAccess

Specified by:

checkAccess in interface SecuredResource

Parameters:

actions - list to be checked against in CSV string form

Throws:

java.lang.SecurityException

checkConstraints

public void checkConstraints(java.lang.String actions)
                      throws java.lang.SecurityException

Description copied from interface: SecuredResource

checkConstraints

Specified by:

checkConstraints in interface SecuredResource

Parameters:

actions - list to be checked against in CSV string form

Throws:

java.lang.SecurityException

checkPermissions

public void checkPermissions(int mask)
                      throws java.lang.SecurityException

Description copied from interface: SecuredResource

checkPermissions

Specified by:

checkPermissions in interface SecuredResource

Parameters:

mask - Mask of actions to be checked

Throws:

java.lang.SecurityException

getConstraintsEnabled

public boolean getConstraintsEnabled()

Description copied from interface: SecuredResource

getConstraintsEnabled

Specified by:

getConstraintsEnabled in interface SecuredResource

Returns:

enabled indicator

getPermissionsEnabled

public boolean getPermissionsEnabled()

Description copied from interface: SecuredResource

getPermissionsEnabled

Specified by:

getPermissionsEnabled in interface SecuredResource

Returns:

enabled indicator

getSecurityConstraints

public SecurityConstraints getSecurityConstraints()

Description copied from interface: SecuredResource

getSecurityConstraints

Specified by:

getSecurityConstraints in interface SecuredResource

Returns:

security constraints for resource

newSecurityConstraints

public SecurityConstraints newSecurityConstraints()

Description copied from interface: SecuredResource

newSecurityConstraints

Specified by:

newSecurityConstraints in interface SecuredResource

Returns:

a newly created SecurityConstraints object for use in SecuredResource

newSecurityConstraint

public SecurityConstraint newSecurityConstraint()

Description copied from interface: SecuredResource

newSecurityConstraint

Specified by:

newSecurityConstraint in interface SecuredResource

Returns:

a newly created SecurityConstraint object for use in SecuredResource

setSecurityConstraints

public void setSecurityConstraints(SecurityConstraints constraints)

Description copied from interface: SecuredResource

setSecurityConstraints

Specified by:

setSecurityConstraints in interface SecuredResource

Parameters:

constraints - security constraints for resource

getContentFragment

protected ContentFragment getContentFragment(Fragment f)

Checks the ContentFragment cache for a ContentFragment that matches the Id of this fragment. If one is found, it returned. If no matches are found, a new ContentFragment represnentive of the Fragment argument is subsequently created, stored into the cahce and returned.

Parameters:

f -

Returns:

ContentFrament

getPreferences

public java.util.List getPreferences()

Description copied from interface: Fragment

Get collection of fragment preference objects used to initialize user preferences

Specified by:

getPreferences in interface Fragment

Returns:

list of FragmentPreference objects

getDecoration

public Decoration getDecoration()

Description copied from interface: ContentFragment

Retrieves the actual org.apache.jetspeed.decoration.decorator object for this content fragment. TODO: Re-evaluate the naming as this is somewhat confusing due to the existence of Fragment.getDecorator()

Specified by:

getDecoration in interface ContentFragment

Returns:

setPreferences

public void setPreferences(java.util.List preferences)

Description copied from interface: Fragment

Set collection of fragment preference objects

Specified by:

setPreferences in interface Fragment

Parameters:

preferences - list of FragmentPreference objects

setDecoration

public void setDecoration(Decoration decoration)

Specified by:

setDecoration in interface ContentFragment

isInstantlyRendered

public boolean isInstantlyRendered()

Description copied from interface: ContentFragment

Checks if the content is instantly rendered from JPT.

Specified by:

isInstantlyRendered in interface ContentFragment