| java.lang.Object
 org.apache.jetspeed.layout.impl.PortletPlacementContextImpl
| PortletPlacementContextImpl | | public class PortletPlacementContextImpl implements PortletPlacementContext(Code) | | Portal Placement Context
The purpose of the object is to provide an API that
can be used to move a portlet fragment on the page.
This includes moving, adding, removing and getting
information about portlets that are on the page and
portlets that are available to be added to the page.
This object represents the fragment contents of a
single layout fragment (i.e. nested depth cannot
be captured by this object).
An important note about this object:
This object is really only intended to be used to do
a single operation such as "moveabs" or "add". After
performing the operation, the hashmap data structures
are not correct and should not be used for subsequent
operations. The reason they are incorrect is that when
a fragment is moved, the coordinate of fragments below
it are now different. These could be updated, but it
really doesn't serve a purpose since this is a short
lived object.
author:
David Gurney
author:
David Sean Taylor
author:
Steve Milek
version:
$Id: $ |
| Inner Class :class FragmentLinkedListInfo | |
| Inner Class :class FragmentLinkedListEntry | |
| Method Summary | |
| public Coordinate | add(Fragment fragment, Coordinate coordinate)
| | public Fragment | debugFragments(String debug)
| | public String | dumpFragments(String debug)
| | public static int | getColumnCountAndSizes(Fragment layoutFragment, PortletRegistry registry, Map fragSizes)
| | public static int | getColumnCountAndSizes(Fragment layoutFragment, PortletRegistry registry, Map fragSizes, boolean suppressErrorLogging)
| | public Fragment | getFragment(String fragmentId)
| | protected Fragment | getFragmentAtCoordinate(Coordinate coordinate, boolean useOldCoordinateValues, boolean suppressExceptions)
| | public Fragment | getFragmentAtNewCoordinate(Coordinate coordinate)
| | public Fragment | getFragmentAtOldCoordinate(Coordinate coordinate)
| | public Fragment | getFragmentById(String fragmentId)
| | public int | getFragmentCol(Fragment fragment)
| | public int | getFragmentRow(Fragment fragment)
| | protected int | getLatestColumn(Coordinate coordinate)
| | protected int | getLatestRow(Coordinate coordinate)
| | public int | getNumberColumns()
| | public int | getNumberRows(int col)
| | protected void | init(Fragment container)
| | public Coordinate | moveAbsolute(Fragment fragment, Coordinate newCoordinate)
| | public Coordinate | moveAbsolute(Fragment fragment, Coordinate newCoordinate, boolean okToAddFragment)
| | protected Coordinate | moveDirection(Fragment fragment, int deltaCol, int deltaRow)
| | public Coordinate | moveDown(Fragment fragment)
| | public Coordinate | moveLeft(Fragment fragment)
| | public Coordinate | moveRight(Fragment fragment)
| | public Coordinate | moveUp(Fragment fragment)
| | public Coordinate | remove(Fragment fragment)
| | protected void | syncFragments(boolean updateFragmentObjects, int onlyForColumnIndex)
| | public Page | syncPageFragments()
Takes the internal portlet placement state and stores back
out to fragment state
the managed page layout with updated fragment state. | | protected Fragment | verifyFragmentAtExpectedCoordinate(int colIndex, int rowIndex, Fragment fragment, String sourceDesc)
|
| fragmentCoordinateMap | | protected Map fragmentCoordinateMap(Code) | | |
| layoutContainerFragment | | protected Fragment layoutContainerFragment(Code) | | |
| numberOfColumns | | protected int numberOfColumns(Code) | | |
| getColumnCountAndSizes | | public static int getColumnCountAndSizes(Fragment layoutFragment, PortletRegistry registry, Map fragSizes, boolean suppressErrorLogging)(Code) | | |
| syncFragments | | protected void syncFragments(boolean updateFragmentObjects, int onlyForColumnIndex)(Code) | | |
| syncPageFragments | | public Page syncPageFragments()(Code) | | Takes the internal portlet placement state and stores back
out to fragment state
the managed page layout with updated fragment state. |
|
|