org.apache.jetspeed.aggregator.impl
Class PortletAggregatorFragmentImpl

java.lang.Object
  extended by org.apache.jetspeed.aggregator.impl.PortletAggregatorFragmentImpl
All Implemented Interfaces:
java.io.Serializable, SecuredResource, BaseElement, Fragment

public class PortletAggregatorFragmentImpl
extends java.lang.Object
implements Fragment

PortletAggregator Fragment implementation for rendering.

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
PortletAggregatorFragmentImpl(java.lang.String id)
           
 
Method Summary
 void checkAccess(java.lang.String actions)
           checkAccess
 void checkConstraints(java.lang.String actions)
           checkConstraints
 void checkPermissions(int mask)
           checkPermissions
 java.lang.Object clone()
           
 boolean getConstraintsEnabled()
           getConstraintsEnabled
 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()
          Returns all fragments used in this node.
 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.
 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.
 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 isReference()
          Test if this fragment is actually a reference to an external fragment.
 SecurityConstraint newSecurityConstraint()
           newSecurityConstraint
 SecurityConstraints newSecurityConstraints()
           newSecurityConstraints
 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 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
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PortletAggregatorFragmentImpl

public PortletAggregatorFragmentImpl(java.lang.String id)
Method Detail

getConstraintsEnabled

public boolean getConstraintsEnabled()
Description copied from interface: SecuredResource

getConstraintsEnabled

Specified by:
getConstraintsEnabled 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

setSecurityConstraints

public void setSecurityConstraints(SecurityConstraints constraints)
Description copied from interface: SecuredResource

setSecurityConstraints

Specified by:
setSecurityConstraints in interface SecuredResource
Parameters:
constraints - 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

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

getPermissionsEnabled

public boolean getPermissionsEnabled()
Description copied from interface: SecuredResource

getPermissionsEnabled

Specified by:
getPermissionsEnabled in interface SecuredResource
Returns:
enabled indicator

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

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

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.

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

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

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

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

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

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

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

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

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

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

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Overrides:
clone in class java.lang.Object
Throws:
java.lang.CloneNotSupportedException

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


Copyright © 1999-2009 Apache Software Foundation. All Rights Reserved.