org.apache.jetspeed.om.page.impl
Class FragmentImpl

java.lang.Object
  org.apache.jetspeed.om.page.impl.BaseElementImpl
      org.apache.jetspeed.om.page.impl.FragmentImpl

All Implemented Interfaces:

java.io.Serializable, SecuredResource, BaseElement, Fragment

public class FragmentImpl
extends BaseElementImpl
implements Fragment

FragmentImpl

Version:

$Id$

Author:

Randy Watler

See Also:

Serialized Form

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

FragmentImpl()

Method Summary

void	checkPermissions(java.lang.String path, int mask, boolean checkNodeOnly, boolean checkParentsOnly) checkPermissions
boolean	getConstraintsEnabled() getConstraintsEnabled
java.lang.String	getDecorator() Returns the name of the decorator bound to this fragment
PageSecurity	getEffectivePageSecurity() getEffectivePageSecurity
float	getFloatProperty(java.lang.String propName) getFloatProperty Get named property value as float.
java.util.List	getFragments() Returns all fragments used in this node.
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	getLogicalPermissionPath() getLogicalPermissionPath
java.lang.String	getMode() Returns the display mode of this fragment.
boolean	getPermissionsEnabled() getPermissionsEnabled
java.lang.String	getPhysicalPermissionPath() getPhysicalPermissionPath
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	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	getType() Returns the type of the class bound to this fragment
boolean	isReference() Test if this fragment is actually a reference to an external fragment.
void	resetCachedSecurityConstraints() resetCachedSecurityConstraints
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	setPreferences(java.util.List preferences) Set collection of fragment preference objects
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	setType(java.lang.String type) Binds a type to this fragment

Methods inherited from class org.apache.jetspeed.om.page.impl.BaseElementImpl

checkAccess, checkConstraints, checkConstraints, checkPermissions, checkPermissions, equals, getId, getName, getSecurityConstraints, getShortTitle, getTitle, grantViewActionAccess, hashCode, newSecurityConstraint, newSecurityConstraints, setConstraintsEnabled, setName, setPermissionsEnabled, setSecurityConstraints, setShortTitle, setTitle

Methods inherited from class java.lang.Object

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

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

getName, setName

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

getId, getShortTitle, getTitle, setShortTitle, setTitle

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

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

Constructor Detail

FragmentImpl

public FragmentImpl()

Method Detail

getEffectivePageSecurity

public PageSecurity getEffectivePageSecurity()

Description copied from class: BaseElementImpl

getEffectivePageSecurity

Overrides:

getEffectivePageSecurity in class BaseElementImpl

Returns:

effective page security object

getLogicalPermissionPath

public java.lang.String getLogicalPermissionPath()

Description copied from class: BaseElementImpl

getLogicalPermissionPath

Overrides:

getLogicalPermissionPath in class BaseElementImpl

Returns:

path used for permissions checks

getPhysicalPermissionPath

public java.lang.String getPhysicalPermissionPath()

Description copied from class: BaseElementImpl

getPhysicalPermissionPath

Overrides:

getPhysicalPermissionPath in class BaseElementImpl

Returns:

path used for permissions checks

resetCachedSecurityConstraints

public void resetCachedSecurityConstraints()

Description copied from class: BaseElementImpl

resetCachedSecurityConstraints

Overrides:

resetCachedSecurityConstraints in class BaseElementImpl

checkPermissions

public void checkPermissions(java.lang.String path,
                             int mask,
                             boolean checkNodeOnly,
                             boolean checkParentsOnly)
                      throws java.lang.SecurityException

Description copied from class: BaseElementImpl

checkPermissions

Overrides:

checkPermissions in class BaseElementImpl

Parameters:

path - permissions path to check

mask - mask of actions to check

checkNodeOnly - check node scope only

checkParentsOnly - check parent folder scope only

Throws:

java.lang.SecurityException

getConstraintsEnabled

public boolean getConstraintsEnabled()

Description copied from interface: SecuredResource

getConstraintsEnabled

Specified by:

getConstraintsEnabled in interface SecuredResource

Overrides:

getConstraintsEnabled in class BaseElementImpl

Returns:

enabled indicator

getPermissionsEnabled

public boolean getPermissionsEnabled()

Description copied from interface: SecuredResource

getPermissionsEnabled

Specified by:

getPermissionsEnabled in interface SecuredResource

Overrides:

getPermissionsEnabled in class BaseElementImpl

Returns:

enabled indicator

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

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

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

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

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

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

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

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

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

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

getFragments

public java.util.List getFragments()

Description copied from interface: Fragment

Returns all fragments used in this node. This may be a page fragment or even directly a portlet fragment

Specified by:

getFragments in interface Fragment

Returns:

a collection containing Fragment objects

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

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

getLayoutRow

public int getLayoutRow()

Description copied from interface: Fragment

get layout row property

Specified by:

getLayoutRow in interface Fragment

Returns:

row layout property

setLayoutRow

public void setLayoutRow(int row)

Description copied from interface: Fragment

set the layout row property

Specified by:

setLayoutRow in interface Fragment

getLayoutColumn

public int getLayoutColumn()

Description copied from interface: Fragment

get layout column property

Specified by:

getLayoutColumn in interface Fragment

Returns:

column layout property

setLayoutColumn

public void setLayoutColumn(int column)

Description copied from interface: Fragment

set the layout column property

Specified by:

setLayoutColumn in interface Fragment

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

setLayoutSizes

public void setLayoutSizes(java.lang.String sizes)

Description copied from interface: Fragment

set the layout sizes

Specified by:

setLayoutSizes in interface Fragment

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

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

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

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

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

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

getLayoutWidth

public float getLayoutWidth()

Description copied from interface: Fragment

get layout width property

Specified by:

getLayoutWidth in interface Fragment

Returns:

the width 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

getLayoutHeight

public float getLayoutHeight()

Description copied from interface: Fragment

get layout height property

Specified by:

getLayoutHeight in interface Fragment

Returns:

the height 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

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

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

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