|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.jetspeed.om.page.ContentFragmentImpl
public class ContentFragmentImpl
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 Fragment s |
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 |
---|
public ContentFragmentImpl(Fragment fragment, java.util.Map cachedFagments)
public ContentFragmentImpl(Fragment fragment, java.util.Map cachedFagments, boolean instantlyRendered)
Method Detail |
---|
public java.util.List getContentFragments()
ContentFragment
getContentFragments
in interface ContentFragment
public java.util.List getFragments()
ContentFragment
List
returned MUST ContentFragments and not
just regular Fragment
s
getFragments
in interface ContentFragment
getFragments
in interface Fragment
public java.lang.String getOverriddenContent()
getOverriddenContent
in interface ContentFragment
public java.lang.String getRenderedContent() throws java.lang.IllegalStateException
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.
getRenderedContent
in interface ContentFragment
java.lang.IllegalStateException
- if the content has not yet been set.public void overrideRenderedContent(java.lang.String contnent)
ContentFragment
overrideRenderedContent
Can be used to store errors that may have occurred during the rendering process.
overrideRenderedContent
in interface ContentFragment
public void setPortletContent(PortletContent portletContent)
ContentFragment
setPortletContent
setPortletContent
in interface ContentFragment
public java.lang.String getDecorator()
Fragment
getDecorator
in interface Fragment
public java.lang.String getName()
Fragment
getName
in interface Fragment
public java.util.Map getProperties()
Fragment
getProperties
in interface Fragment
public java.lang.String getProperty(java.lang.String propName)
Fragment
getProperty
in interface Fragment
propName
- property name
public int getIntProperty(java.lang.String propName)
Fragment
getIntProperty
in interface Fragment
propName
- property name
public float getFloatProperty(java.lang.String propName)
Fragment
getFloatProperty
in interface Fragment
propName
- property name
public java.lang.String getSkin()
Fragment
getSkin
in interface Fragment
public java.lang.String getState()
Fragment
getState
in interface Fragment
public java.lang.String getMode()
Fragment
getMode
in interface Fragment
public java.lang.String getType()
Fragment
getType
in interface Fragment
public boolean isReference()
Fragment
isReference
in interface Fragment
public void setDecorator(java.lang.String decoratorName)
Fragment
setDecorator
in interface Fragment
decoratorName
- the name of the decorator applied to this fragmentpublic void setName(java.lang.String name)
Fragment
setName
in interface Fragment
name
- the administrative namepublic int getLayoutRow()
Fragment
getLayoutRow
in interface Fragment
public int getLayoutColumn()
Fragment
getLayoutColumn
in interface Fragment
public java.lang.String getLayoutSizes()
Fragment
getLayoutSizes
in interface Fragment
public float getLayoutX()
Fragment
getLayoutX
in interface Fragment
public float getLayoutY()
Fragment
getLayoutY
in interface Fragment
public float getLayoutZ()
Fragment
getLayoutZ
in interface Fragment
public float getLayoutWidth()
Fragment
getLayoutWidth
in interface Fragment
public float getLayoutHeight()
Fragment
getLayoutHeight
in interface Fragment
public void setLayoutRow(int row)
Fragment
setLayoutRow
in interface Fragment
public void setLayoutColumn(int column)
Fragment
setLayoutColumn
in interface Fragment
public void setLayoutSizes(java.lang.String sizes)
Fragment
setLayoutSizes
in interface Fragment
public void setLayoutX(float x)
Fragment
setLayoutX
in interface Fragment
x
- the coordinate valuepublic void setLayoutY(float y)
Fragment
setLayoutY
in interface Fragment
y
- the coordinate valuepublic void setLayoutZ(float z)
Fragment
setLayoutZ
in interface Fragment
z
- the coordinate valuepublic void setLayoutWidth(float width)
Fragment
setLayoutWidth
in interface Fragment
width
- the valuepublic void setLayoutHeight(float height)
Fragment
setLayoutHeight
in interface Fragment
height
- the valuepublic void setSkin(java.lang.String skinName)
Fragment
setSkin
in interface Fragment
skinName
- the name of the new skin applied to this fragmentpublic void setState(java.lang.String state)
Fragment
setState
in interface Fragment
state
- the new fragment statepublic void setMode(java.lang.String mode)
Fragment
setMode
in interface Fragment
mode
- the new fragment modepublic void setType(java.lang.String type)
Fragment
setType
in interface Fragment
type
- the typepublic 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 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 resourceprotected ContentFragment getContentFragment(Fragment f)
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.
f
-
public java.util.List getPreferences()
Fragment
getPreferences
in interface Fragment
public Decoration getDecoration()
ContentFragment
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()
getDecoration
in interface ContentFragment
public void setPreferences(java.util.List preferences)
Fragment
setPreferences
in interface Fragment
preferences
- list of FragmentPreference objectspublic void setDecoration(Decoration decoration)
setDecoration
in interface ContentFragment
public boolean isInstantlyRendered()
ContentFragment
isInstantlyRendered
in interface ContentFragment
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |