| org.apache.jetspeed.om.page.Fragment
All known Subclasses: org.apache.jetspeed.om.page.impl.FragmentImpl, org.apache.jetspeed.om.page.psml.FragmentImpl, org.apache.jetspeed.components.portletentity.ContentFragmentTestImpl, org.apache.jetspeed.aggregator.impl.PortletAggregatorFragmentImpl,
| Fragment | | public interface Fragment extends BaseElement,java.io.Serializable(Code) | | 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:
- type: defines the general class of layout component, enabling
the engine to retrieve its exact defintion from its component
repository.
- name: this is the exact name of the component. This name must
be unique within a portal instance for a specific component type.
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.
version:
$Id: Fragment.java 516448 2007-03-09 16:25:47Z ate $ |
| COLUMN_PROPERTY_NAME | | public String COLUMN_PROPERTY_NAME(Code) | | column standard layout property name
|
| HEIGHT_PROPERTY_NAME | | public String HEIGHT_PROPERTY_NAME(Code) | | height standard layout property name
|
| LAYOUT | | public String LAYOUT(Code) | | 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.
|
| PORTLET | | public String PORTLET(Code) | | A fragment of type PORTLET is considered to be a compliant portlet
in the sense of the JSR 168.
|
| ROW_PROPERTY_NAME | | public String ROW_PROPERTY_NAME(Code) | | row standard layout property name
|
| SIZES_PROPERTY_NAME | | public String SIZES_PROPERTY_NAME(Code) | | sizes standard layout property name
|
| WIDTH_PROPERTY_NAME | | public String WIDTH_PROPERTY_NAME(Code) | | width standard layout property name
|
| X_PROPERTY_NAME | | public String X_PROPERTY_NAME(Code) | | x coordinate standard layout property name
|
| Y_PROPERTY_NAME | | public String Y_PROPERTY_NAME(Code) | | y coordinate standard layout property name
|
| Z_PROPERTY_NAME | | public String Z_PROPERTY_NAME(Code) | | z coordinate standard layout property name
|
| getDecorator | | public String getDecorator()(Code) | | Returns the name of the decorator bound to this fragment
|
| getFloatProperty | | public float getFloatProperty(String propName)(Code) | | getFloatProperty
Get named property value as float.
Parameters:
propName - property name float value |
| getFragments | | public List getFragments()(Code) | | Returns all fragments used in this node. This may be
a page fragment or even directly a portlet fragment
a collection containing Fragment objects |
| getIntProperty | | public int getIntProperty(String propName)(Code) | | getIntProperty
Get named property value as integer.
Parameters:
propName - property name int value |
| getLayoutColumn | | public int getLayoutColumn()(Code) | | get layout column property
column layout property |
| getLayoutHeight | | public float getLayoutHeight()(Code) | | get layout height property
the height value |
| getLayoutRow | | public int getLayoutRow()(Code) | | get layout row property
row layout property |
| getLayoutSizes | | public String getLayoutSizes()(Code) | | get layout sizes property, (i.e. "25%,75%")
sizes layout property |
| getLayoutWidth | | public float getLayoutWidth()(Code) | | get layout width property
the width value |
| getLayoutX | | public float getLayoutX()(Code) | | get layout x coordinate property
the x coordinate value |
| getLayoutY | | public float getLayoutY()(Code) | | get layout y coordinate property
the y coordinate value |
| getLayoutZ | | public float getLayoutZ()(Code) | | get layout z coordinate property
the z coordinate value |
| getMode | | public String getMode()(Code) | | Returns the display mode of this fragment. The mode may have the
following values: "View","Edit","Help","Config","Print","Custom"
|
| getName | | public String getName()(Code) | | 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.
the administrative name |
| getPreferences | | public List getPreferences()(Code) | | Get collection of fragment preference objects used
to initialize user preferences
list of FragmentPreference objects |
| getProperties | | public Map getProperties()(Code) | | getProperties
Get writable Map of properties by name.
properties map |
| getProperty | | public String getProperty(String propName)(Code) | | getProperty
Get named property value.
Parameters:
propName - property name value |
| getSkin | | public String getSkin()(Code) | | Returns the name of the skin associated to this fragment
|
| getState | | public String getState()(Code) | | Returns the display state of this fragment. The state may have the
following values: "Normal","Minimized","Maximized","Hidden"
|
| getType | | public String getType()(Code) | | Returns the type of the class bound to this fragment
|
| isReference | | public boolean isReference()(Code) | | Test if this fragment is actually a reference to an external fragment.
true is this element is a reference |
| setDecorator | | public void setDecorator(String decoratorName)(Code) | | Defines the decorator for this fragment. This decorator should be
known by the portal.
Parameters:
decoratorName - the name of the decorator applied to this fragment |
| setLayoutColumn | | public void setLayoutColumn(int column)(Code) | | set the layout column property
Parameters:
column - |
| setLayoutHeight | | public void setLayoutHeight(float height)(Code) | | set the layout height property
Parameters:
height - the value |
| setLayoutRow | | public void setLayoutRow(int row)(Code) | | set the layout row property
Parameters:
row - |
| setLayoutSizes | | public void setLayoutSizes(String sizes)(Code) | | set the layout sizes
Parameters:
sizes - |
| setLayoutWidth | | public void setLayoutWidth(float width)(Code) | | set the layout width property
Parameters:
width - the value |
| setLayoutX | | public void setLayoutX(float x)(Code) | | set the layout x coordinate property
Parameters:
x - the coordinate value |
| setLayoutY | | public void setLayoutY(float y)(Code) | | set the layout y coordinate property
Parameters:
y - the coordinate value |
| setLayoutZ | | public void setLayoutZ(float z)(Code) | | set the layout z coordinate property
Parameters:
z - the coordinate value |
| setMode | | public void setMode(String mode)(Code) | | Sets the display mode of this fragment.
Valid modes are: "View","Edit","Help","Config","Print","Custom"
Parameters:
mode - the new fragment mode |
| setName | | public void setName(String name)(Code) | | Binds an administrative name to this fragment
Parameters:
name - the administrative name |
| setPreferences | | public void setPreferences(List preferences)(Code) | | Set collection of fragment preference objects
Parameters:
preferences - list of FragmentPreference objects |
| setSkin | | public void setSkin(String skinName)(Code) | | Defines the skin for this fragment. This skin should be
known by the portal.
Parameters:
skinName - the name of the new skin applied to this fragment |
| setState | | public void setState(String state)(Code) | | Sets the display state of this fragment.
Valid states are: "Normal","Minimized","Maximized","Hidden"
Parameters:
state - the new fragment state |
| setType | | public void setType(String type)(Code) | | Binds a type to this fragment
Parameters:
type - the type |
|
|