org.apache.jetspeed.om.page
Interface BaseFragmentElement

All Superinterfaces:

BaseElement, SecuredResource

All Known Subinterfaces:

Fragment, FragmentReference, PageFragment

public interface BaseFragmentElement
extends BaseElement

A BaseFragmentElement is the basic element handled by the aggregation engine to compose the final portal page. It represents a reserved screen area whose layout is managed by a specified component. The fragment also holds layout and rendering properties/preferences.

Version:

$Id:$

Field Summary

static java.lang.String	COLUMN_PROPERTY_NAME column standard layout property name
static java.lang.String	DECORATOR_PROPERTY_NAME decorator standard layout property name
static java.lang.String	GLOBAL_PROPERTY_SCOPE global standard property scope
static boolean	GROUP_AND_ROLE_PROPERTY_SCOPES_ENABLED group and role standard property scopes enabled flag
static java.lang.String	GROUP_PROPERTY_SCOPE group standard property scope
static java.lang.String	HEIGHT_PROPERTY_NAME height standard layout property name
static java.lang.String	MODE_PROPERTY_NAME mode standard layout property name
static java.lang.String	ROLE_PROPERTY_SCOPE role standard property scope
static java.lang.String	ROW_PROPERTY_NAME row standard layout property name
static java.lang.String	SIZES_PROPERTY_NAME sizes standard layout property name
static java.lang.String	SKIN_PROPERTY_NAME skin standard layout property name
static java.lang.String	STATE_PROPERTY_NAME state standard layout property name
static java.lang.String	USER_PROPERTY_SCOPE user standard property scope
static java.lang.String	WIDTH_PROPERTY_NAME width standard layout property name
static java.lang.String	X_PROPERTY_NAME x coordinate standard layout property name
static java.lang.String	Y_PROPERTY_NAME y coordinate standard layout property name
static java.lang.String	Z_PROPERTY_NAME z coordinate standard layout property name

Method Summary

java.lang.String	getDecorator() Returns the name of the decorator bound to this fragment Property value is returned for the most specific scope found, (i.e.
float	getFloatProperty(java.lang.String propName) Get named property value as float.
float	getFloatProperty(java.lang.String propName, java.lang.String propScope, java.lang.String propScopeValue) Get named property value as float.
int	getIntProperty(java.lang.String propName) Get named property value as integer.
int	getIntProperty(java.lang.String propName, java.lang.String propScope, java.lang.String propScopeValue) 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.util.List	getPreferences() Get collection of fragment preference objects used to initialize user preferences
java.util.List	getProperties() Get writable list of fragment property objects that initially returns the set of properties for all scopes found for the current user.
java.lang.String	getProperty(java.lang.String propName) Get named property value.
java.lang.String	getProperty(java.lang.String propName, java.lang.String propScope, java.lang.String propScopeValue) Get named property value.
java.lang.String	getSkin() Returns the name of the skin associated to this fragment Property value is returned for the most specific scope found, (i.e.
java.lang.String	getState() Returns the display state of this fragment.
void	setDecorator(java.lang.String decoratorName) Defines the decorator for this fragment.
void	setDecorator(java.lang.String scope, java.lang.String scopeValue, java.lang.String decoratorName) Defines the decorator for this fragment.
void	setId(java.lang.String fragmentId) Sets the unique Id of this fragment.
void	setLayoutColumn(int column) Set the layout column property.
void	setLayoutColumn(java.lang.String scope, java.lang.String scopeValue, int column) Set the layout column property.
void	setLayoutHeight(float height) Set the layout height property.
void	setLayoutHeight(java.lang.String scope, java.lang.String scopeValue, float height) Set the layout height property.
void	setLayoutRow(int row) Set the layout row property.
void	setLayoutRow(java.lang.String scope, java.lang.String scopeValue, int row) Set the layout row property.
void	setLayoutSizes(java.lang.String sizes) Set the layout sizes.
void	setLayoutSizes(java.lang.String scope, java.lang.String scopeValue, java.lang.String sizes) Set the layout sizes.
void	setLayoutWidth(float width) Set the layout width property.
void	setLayoutWidth(java.lang.String scope, java.lang.String scopeValue, float width) Set the layout width property.
void	setLayoutX(float x) Set the layout x coordinate property.
void	setLayoutX(java.lang.String scope, java.lang.String scopeValue, float x) Set the layout x coordinate property.
void	setLayoutY(float y) Set the layout y coordinate property.
void	setLayoutY(java.lang.String scope, java.lang.String scopeValue, float y) Set the layout y coordinate property.
void	setLayoutZ(float z) Set the layout z coordinate property.
void	setLayoutZ(java.lang.String scope, java.lang.String scopeValue, float z) Set the layout z coordinate property.
void	setMode(java.lang.String mode) Sets the display mode of this fragment.
void	setMode(java.lang.String scope, java.lang.String scopeValue, java.lang.String mode) Sets the display mode of this fragment.
void	setPreferences(java.util.List preferences) Set collection of fragment preference objects
void	setProperties(java.util.List properties) Set collection of fragment property objects
void	setProperty(java.lang.String propName, java.lang.String propScope, java.lang.String propScopeValue, float propValue) Set named float property value.
void	setProperty(java.lang.String propName, java.lang.String propScope, java.lang.String propScopeValue, int propValue) Set named int property value.
void	setProperty(java.lang.String propName, java.lang.String propScope, java.lang.String propScopeValue, java.lang.String propValue) Set named property value.
void	setSkin(java.lang.String skinName) Defines the skin for this fragment.
void	setSkin(java.lang.String scope, java.lang.String scopeValue, java.lang.String skinName) Defines the skin for this fragment.
void	setState(java.lang.String state) Sets the display state of this fragment.
void	setState(java.lang.String scope, java.lang.String scopeValue, java.lang.String state) Sets the display state of this fragment.

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

Field Detail

SKIN_PROPERTY_NAME

static final java.lang.String SKIN_PROPERTY_NAME

skin standard layout property name

See Also:

Constant Field Values

DECORATOR_PROPERTY_NAME

static final java.lang.String DECORATOR_PROPERTY_NAME

decorator standard layout property name

See Also:

Constant Field Values

STATE_PROPERTY_NAME

static final java.lang.String STATE_PROPERTY_NAME

state standard layout property name

See Also:

Constant Field Values

MODE_PROPERTY_NAME

static final java.lang.String MODE_PROPERTY_NAME

mode standard layout property name

See Also:

Constant Field Values

ROW_PROPERTY_NAME

static final java.lang.String ROW_PROPERTY_NAME

row standard layout property name

See Also:

Constant Field Values

COLUMN_PROPERTY_NAME

static final java.lang.String COLUMN_PROPERTY_NAME

column standard layout property name

See Also:

Constant Field Values

SIZES_PROPERTY_NAME

static final java.lang.String SIZES_PROPERTY_NAME

sizes standard layout property name

See Also:

Constant Field Values

X_PROPERTY_NAME

static final java.lang.String X_PROPERTY_NAME

x coordinate standard layout property name

See Also:

Constant Field Values

Y_PROPERTY_NAME

static final java.lang.String Y_PROPERTY_NAME

y coordinate standard layout property name

See Also:

Constant Field Values

Z_PROPERTY_NAME

static final java.lang.String Z_PROPERTY_NAME

z coordinate standard layout property name

See Also:

Constant Field Values

WIDTH_PROPERTY_NAME

static final java.lang.String WIDTH_PROPERTY_NAME

width standard layout property name

See Also:

Constant Field Values

HEIGHT_PROPERTY_NAME

static final java.lang.String HEIGHT_PROPERTY_NAME

height standard layout property name

See Also:

Constant Field Values

USER_PROPERTY_SCOPE

static final java.lang.String USER_PROPERTY_SCOPE

user standard property scope

See Also:

Constant Field Values

GROUP_PROPERTY_SCOPE

static final java.lang.String GROUP_PROPERTY_SCOPE

group standard property scope

See Also:

Constant Field Values

ROLE_PROPERTY_SCOPE

static final java.lang.String ROLE_PROPERTY_SCOPE

role standard property scope

See Also:

Constant Field Values

GLOBAL_PROPERTY_SCOPE

static final java.lang.String GLOBAL_PROPERTY_SCOPE

global standard property scope

GROUP_AND_ROLE_PROPERTY_SCOPES_ENABLED

static final boolean GROUP_AND_ROLE_PROPERTY_SCOPES_ENABLED

group and role standard property scopes enabled flag

See Also:

Constant Field Values

Method Detail

setId

void setId(java.lang.String fragmentId)

Sets the unique Id of this fragment. This id must be unique from the complete portal and must be suitable as a unique key.

Parameters:

fragmentId - the unique id of this fragment.

getSkin

java.lang.String getSkin()

Returns the name of the skin associated to this fragment Property value is returned for the most specific scope found, (i.e. user, group, role, or global scopes).

setSkin

void setSkin(java.lang.String skinName)

Defines the skin for this fragment. This skin should be known by the portal. The default, (GLOBAL), scope value is set or removed.

Parameters:

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

setSkin

void setSkin(java.lang.String scope,
             java.lang.String scopeValue,
             java.lang.String skinName)

Defines the skin for this fragment. This skin should be known by the portal. Setting the property value to null removes the scoped property.

Parameters:

scope - the name of the property scope for setting

scopeValue - the scope discriminator value, (unless scope is GLOBAL or USER where the default user name is used if null)

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

getDecorator

java.lang.String getDecorator()

Returns the name of the decorator bound to this fragment Property value is returned for the most specific scope found, (i.e. user, group, role, or global scopes).

setDecorator

void setDecorator(java.lang.String decoratorName)

Defines the decorator for this fragment. This decorator should be known by the portal. The default, (GLOBAL), scope value is set or removed.

Parameters:

decoratorName - the name of the decorator applied to this fragment

setDecorator

void setDecorator(java.lang.String scope,
                  java.lang.String scopeValue,
                  java.lang.String decoratorName)

Defines the decorator for this fragment. This decorator should be known by the portal. Setting the property value to null removes the scoped property.

Parameters:

scope - the name of the property scope for setting

scopeValue - the scope discriminator value, (unless scope is GLOBAL or USER where the default user name is used if null)

decoratorName - the name of the decorator applied to this fragment

getState

java.lang.String getState()

Returns the display state of this fragment. The state may have the following values: "Normal","Minimized","Maximized","Hidden" Property value is returned for the most specific scope found, (i.e. user, group, role, or global scopes).

setState

void setState(java.lang.String state)

Sets the display state of this fragment. Valid states are: "Normal","Minimized","Maximized","Hidden" The default, (GLOBAL), scope value is set or removed.

Parameters:

state - the new fragment state

setState

void setState(java.lang.String scope,
              java.lang.String scopeValue,
              java.lang.String state)

Sets the display state of this fragment. Valid states are: "Normal","Minimized","Maximized","Hidden". Setting the property value to null removes the scoped property.

Parameters:

scope - the name of the property scope for setting

scopeValue - the scope discriminator value, (unless scope is GLOBAL or USER where the default user name is used if null)

state - the new fragment state

getMode

java.lang.String getMode()

Returns the display mode of this fragment. The mode may have the following values: "View","Edit","Help","Config","Print","Custom" Property value is returned for the most specific scope found, (i.e. user, group, role, or global scopes).

setMode

void setMode(java.lang.String mode)

Sets the display mode of this fragment. Valid modes are: "View","Edit","Help","Config","Print","Custom" The default, (GLOBAL), scope value is set or removed.

Parameters:

mode - the new fragment mode

setMode

void setMode(java.lang.String scope,
             java.lang.String scopeValue,
             java.lang.String mode)

Sets the display mode of this fragment. Valid modes are: "View","Edit","Help","Config","Print","Custom". Setting the property value to null removes the scoped property.

Parameters:

scope - the name of the property scope for setting

scopeValue - the scope discriminator value, (unless scope is GLOBAL or USER where the default user name is used if null)

mode - the new fragment mode

getProperty

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

Get named property value. Property value is returned for the most specific scope found, (i.e. user, group, role, or global scopes).

Parameters:

propName - property name

Returns:

value

getProperty

java.lang.String getProperty(java.lang.String propName,
                             java.lang.String propScope,
                             java.lang.String propScopeValue)

Get named property value.

Parameters:

propName - property name

propScope - the name of the property scope to retrieve

propScopeValue - the scope discriminator value, (unless scope is GLOBAL or USER where the default user name is used if null)

Returns:

value

getIntProperty

int getIntProperty(java.lang.String propName)

Get named property value as integer. Property value is returned for the most specific scope found, (i.e. user, group, role, or global scopes).

Parameters:

propName - property name

Returns:

int value

getIntProperty

int getIntProperty(java.lang.String propName,
                   java.lang.String propScope,
                   java.lang.String propScopeValue)

Get named property value as integer.

Parameters:

propName - property name

propScope - the name of the property scope to retrieve

propScopeValue - the scope discriminator value, (unless scope is GLOBAL or USER where the default user name is used if null)

Returns:

int value

getFloatProperty

float getFloatProperty(java.lang.String propName)

Get named property value as float. Property value is returned for the most specific scope found, (i.e. user, group, role, or global scopes).

Parameters:

propName - property name

Returns:

float value

getFloatProperty

float getFloatProperty(java.lang.String propName,
                       java.lang.String propScope,
                       java.lang.String propScopeValue)

Get named property value as float.

Parameters:

propName - property name

propScope - the name of the property scope to retrieve

propScopeValue - the scope discriminator value, (unless scope is GLOBAL or USER where the default user name is used if null)

Returns:

float value

setProperty

void setProperty(java.lang.String propName,
                 java.lang.String propScope,
                 java.lang.String propScopeValue,
                 java.lang.String propValue)

Set named property value.

Parameters:

propName - property name

propScope - the name of the property scope to retrieve

propScopeValue - the scope discriminator value, (unless scope is GLOBAL or USER where the default user name is used if null)

propValue - property value

setProperty

void setProperty(java.lang.String propName,
                 java.lang.String propScope,
                 java.lang.String propScopeValue,
                 int propValue)

Set named int property value.

Parameters:

propName - property name

propScope - the name of the property scope to retrieve

propScopeValue - the scope discriminator value, (unless scope is GLOBAL or USER where the default user name is used if null)

propValue - property value

setProperty

void setProperty(java.lang.String propName,
                 java.lang.String propScope,
                 java.lang.String propScopeValue,
                 float propValue)

Set named float property value.

Parameters:

propName - property name

propScope - the name of the property scope to retrieve

propScopeValue - the scope discriminator value, (unless scope is GLOBAL or USER where the default user name is used if null)

propValue - property value

getProperties

java.util.List getProperties()

Get writable list of fragment property objects that initially returns the set of properties for all scopes found for the current user.

Returns:

list of FragmentProperty instances

setProperties

void setProperties(java.util.List properties)

Set collection of fragment property objects

Parameters:

preferences - list of FragmentPreference objects

getLayoutRow

int getLayoutRow()

Get layout row property. Property value is returned for the most specific scope found, (i.e. user, group, role, or global scopes).

Returns:

row layout property

setLayoutRow

void setLayoutRow(int row)

Set the layout row property. The default, (GLOBAL), scope value is set or removed.

Parameters:

row -

setLayoutRow

void setLayoutRow(java.lang.String scope,
                  java.lang.String scopeValue,
                  int row)

Set the layout row property. Setting the property value to a negative value removes the scoped property.

Parameters:

scope - the name of the property scope for setting

scopeValue - the scope discriminator value, (unless scope is GLOBAL or USER where the default user name is used if null)

row -

getLayoutColumn

int getLayoutColumn()

Get layout column property. Property value is returned for the most specific scope found, (i.e. user, group, role, or global scopes).

Returns:

column layout property

setLayoutColumn

void setLayoutColumn(int column)

Set the layout column property. The default, (GLOBAL), scope value is set or removed.

Parameters:

column -

setLayoutColumn

void setLayoutColumn(java.lang.String scope,
                     java.lang.String scopeValue,
                     int column)

Set the layout column property. Setting the property value to a negative value removes the scoped property.

Parameters:

scope - the name of the property scope for setting

scopeValue - the scope discriminator value, (unless scope is GLOBAL or USER where the default user name is used if null)

column -

getLayoutSizes

java.lang.String getLayoutSizes()

Get layout sizes property, (i.e. "25%,75%"). Property value is returned for the most specific scope found, (i.e. user, group, role, or global scopes).

Returns:

sizes layout property

setLayoutSizes

void setLayoutSizes(java.lang.String sizes)

Set the layout sizes. The default, (GLOBAL), scope value is set or removed.

Parameters:

sizes -

setLayoutSizes

void setLayoutSizes(java.lang.String scope,
                    java.lang.String scopeValue,
                    java.lang.String sizes)

Set the layout sizes. Setting the property value to null removes the scoped property.

Parameters:

scope - the name of the property scope for setting

scopeValue - the scope discriminator value, (unless scope is GLOBAL or USER where the default user name is used if null)

sizes -

getLayoutX

float getLayoutX()

Get layout x coordinate property. Property value is returned for the most specific scope found, (i.e. user, group, role, or global scopes).

Returns:

the x coordinate value

setLayoutX

void setLayoutX(float x)

Set the layout x coordinate property. The default, (GLOBAL), scope value is set or removed.

Parameters:

x - the coordinate value

setLayoutX

void setLayoutX(java.lang.String scope,
                java.lang.String scopeValue,
                float x)

Set the layout x coordinate property. Setting the property value to a negative value removes the scoped property.

Parameters:

scope - the name of the property scope for setting

scopeValue - the scope discriminator value, (unless scope is GLOBAL or USER where the default user name is used if null)

x - the coordinate value

getLayoutY

float getLayoutY()

Get layout y coordinate property. Property value is returned for the most specific scope found, (i.e. user, group, role, or global scopes).

Returns:

the y coordinate value

setLayoutY

void setLayoutY(float y)

Set the layout y coordinate property. The default, (GLOBAL), scope value is set or removed.

Parameters:

y - the coordinate value

setLayoutY

void setLayoutY(java.lang.String scope,
                java.lang.String scopeValue,
                float y)

Set the layout y coordinate property. Setting the property value to a negative value removes the scoped property.

Parameters:

scope - the name of the property scope for setting

scopeValue - the scope discriminator value, (unless scope is GLOBAL or USER where the default user name is used if null)

y - the coordinate value

getLayoutZ

float getLayoutZ()

Get layout z coordinate property. Property value is returned for the most specific scope found, (i.e. user, group, role, or global scopes).

Returns:

the z coordinate value

setLayoutZ

void setLayoutZ(float z)

Set the layout z coordinate property. The default, (GLOBAL), scope value is set or removed.

Parameters:

z - the coordinate value

setLayoutZ

void setLayoutZ(java.lang.String scope,
                java.lang.String scopeValue,
                float z)

Set the layout z coordinate property. Setting the property value to a negative value removes the scoped property.

Parameters:

scope - the name of the property scope for setting

scopeValue - the scope discriminator value, (unless scope is GLOBAL or USER where the default user name is used if null)

z - the coordinate value

getLayoutWidth

float getLayoutWidth()

Get layout width property. Property value is returned for the most specific scope found, (i.e. user, group, role, or global scopes).

Returns:

the width value

setLayoutWidth

void setLayoutWidth(float width)

Set the layout width property. The default, (GLOBAL), scope value is set or removed.

Parameters:

width - the value

setLayoutWidth

void setLayoutWidth(java.lang.String scope,
                    java.lang.String scopeValue,
                    float width)

Set the layout width property. Setting the property value to a negative value removes the scoped property.

Parameters:

scope - the name of the property scope for setting

scopeValue - the scope discriminator value, (unless scope is GLOBAL or USER where the default user name is used if null)

width - the value

getLayoutHeight

float getLayoutHeight()

Get layout height property. Property value is returned for the most specific scope found, (i.e. user, group, role, or global scopes).

Returns:

the height value

setLayoutHeight

void setLayoutHeight(float height)

Set the layout height property. The default, (GLOBAL), scope value is set or removed.

Parameters:

height - the value

setLayoutHeight

void setLayoutHeight(java.lang.String scope,
                     java.lang.String scopeValue,
                     float height)

Set the layout height property. Setting the property value to a negative value removes the scoped property.

Parameters:

scope - the name of the property scope for setting

scopeValue - the scope discriminator value, (unless scope is GLOBAL or USER where the default user name is used if null)

height - the value

getPreferences

java.util.List getPreferences()

Get collection of fragment preference objects used to initialize user preferences

Returns:

list of FragmentPreference objects

setPreferences

void setPreferences(java.util.List preferences)

Set collection of fragment preference objects

Parameters:

preferences - list of FragmentPreference objects