|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A Fragment
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 component that is responsible for the layout policy of the fragment is defined by two properties:
In addition to specifying the component responsible for the layout, the fragment also stores contextual information used for rendering:
Finally the fragment also holds layout and rendering properties that may be used by a parent fragment to layout all its inner fragments in an appropriate fashion. These properties are always defined for a specific named component.
Field Summary | |
static String |
LAYOUT
A fragment of type LAYOUT is a specific JSR 168 compliant portlet that knows how to layout a Page and depends on the Jetspeed layout service. |
static String |
PORTLET
A fragment of type PORTLET is considered to be a compliant portlet in the sense of the JSR 168. |
Fields inherited from interface org.apache.jetspeed.om.common.SecuredResource |
EDIT_ACTION, VIEW_ACTION |
Method Summary | |
void |
addProperty(Property p)
Adds a new property to this fragment |
void |
clearProperties(String layoutName)
Clear all the properties for a specific layout, if layoutName is null, clear all properties. |
Object |
clone()
Creates a clone of this object |
String |
getDecorator()
Returns the name of the decorator bound to this fragment |
List |
getFragments()
Returns all fragments used in this node. |
List |
getLayoutProperties()
Returns all layout names for which properties have been defined. |
String |
getName()
Returns the administrative name of this fragment. |
List |
getProperties(String layoutName)
Returns a list of all properties defined for the layoutName specified. |
String |
getPropertyValue(String layout,
String propName)
getPropertyValue |
String |
getSkin()
Returns the name of the skin associated to this fragment |
String |
getState()
Returns the display state of this fragment. |
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 |
removeProperty(Property p)
Removes a new property from this fragment |
void |
setDecorator(String decoratorName)
Defines the decorator for this fragment. |
void |
setName(String name)
Binds an administrative name to this fragment |
void |
setPropertyValue(String layout,
String propName,
String value)
setPropertyValue |
void |
setSkin(String skinName)
Defines the skin for this fragment. |
void |
setState(String state)
Sets the display state of this fragment. |
void |
setType(String type)
Binds a type to this fragment |
Methods inherited from interface org.apache.jetspeed.om.page.BaseElement |
getId, getShortTitle, getTitle, setId, setShortTitle, setTitle |
Methods inherited from interface org.apache.jetspeed.om.common.SecuredResource |
checkAccess, checkConstraints, checkPermissions, getConstraintsEnabled, getPermissionsEnabled, getSecurityConstraints, setSecurityConstraints |
Field Detail |
public static final String PORTLET
public static final String LAYOUT
Method Detail |
public String getName()
public void setName(String name)
name
- the administrative namepublic String getType()
public void setType(String type)
type
- the typepublic String getSkin()
public void setSkin(String skinName)
skinName
- the name of the new skin applied to this fragmentpublic String getDecorator()
public void setDecorator(String decoratorName)
decoratorName
- the name of the decorator applied to this fragmentpublic String getState()
public void setState(String state)
public List getFragments()
public List getLayoutProperties()
public List getProperties(String layoutName)
public String getPropertyValue(String layout, String propName)
getPropertyValue
layout
- propName
-
public void setPropertyValue(String layout, String propName, String value)
setPropertyValue
layout
- propName
- value
- public void addProperty(Property p)
p
- the new Property to addpublic void removeProperty(Property p)
p
- the Property to removepublic void clearProperties(String layoutName)
layoutName
- the layout for which to remove the propertiespublic boolean isReference()
public Object clone() throws CloneNotSupportedException
CloneNotSupportedException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |