|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Fragment
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.
Field Summary | |
---|---|
static java.lang.String |
COLUMN_PROPERTY_NAME
column standard layout property name |
static java.lang.String |
HEIGHT_PROPERTY_NAME
height standard layout property name |
static java.lang.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 java.lang.String |
PORTLET
A fragment of type PORTLET is considered to be a compliant portlet in the sense of the JSR 168. |
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 |
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 |
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 |
getMode()
Returns the display mode of this fragment. |
java.lang.String |
getName()
Returns the administrative name of this fragment. |
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 |
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 |
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 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, getConstraintsEnabled, getPermissionsEnabled, getSecurityConstraints, newSecurityConstraint, newSecurityConstraints, setSecurityConstraints |
Field Detail |
---|
static final java.lang.String PORTLET
static final java.lang.String LAYOUT
static final java.lang.String ROW_PROPERTY_NAME
static final java.lang.String COLUMN_PROPERTY_NAME
static final java.lang.String SIZES_PROPERTY_NAME
static final java.lang.String X_PROPERTY_NAME
static final java.lang.String Y_PROPERTY_NAME
static final java.lang.String Z_PROPERTY_NAME
static final java.lang.String WIDTH_PROPERTY_NAME
static final java.lang.String HEIGHT_PROPERTY_NAME
Method Detail |
---|
java.lang.String getName()
void setName(java.lang.String name)
name
- the administrative namejava.lang.String getType()
void setType(java.lang.String type)
type
- the typejava.lang.String getSkin()
void setSkin(java.lang.String skinName)
skinName
- the name of the new skin applied to this fragmentjava.lang.String getDecorator()
void setDecorator(java.lang.String decoratorName)
decoratorName
- the name of the decorator applied to this fragmentjava.lang.String getState()
void setState(java.lang.String state)
state
- the new fragment statejava.lang.String getMode()
void setMode(java.lang.String mode)
mode
- the new fragment modejava.util.List getFragments()
java.lang.String getProperty(java.lang.String propName)
propName
- property name
int getIntProperty(java.lang.String propName)
propName
- property name
float getFloatProperty(java.lang.String propName)
propName
- property name
java.util.Map getProperties()
int getLayoutRow()
void setLayoutRow(int row)
row
- int getLayoutColumn()
void setLayoutColumn(int column)
column
- java.lang.String getLayoutSizes()
void setLayoutSizes(java.lang.String sizes)
sizes
- float getLayoutX()
void setLayoutX(float x)
x
- the coordinate valuefloat getLayoutY()
void setLayoutY(float y)
y
- the coordinate valuefloat getLayoutZ()
void setLayoutZ(float z)
z
- the coordinate valuefloat getLayoutWidth()
void setLayoutWidth(float width)
width
- the valuefloat getLayoutHeight()
void setLayoutHeight(float height)
height
- the valueboolean isReference()
java.util.List getPreferences()
void setPreferences(java.util.List preferences)
preferences
- list of FragmentPreference objects
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |