|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.jetspeed.layout.impl.PortletPlacementContextImpl
public class PortletPlacementContextImpl
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. 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.
Field Summary | |
---|---|
protected Vector[] |
columnsList
|
protected org.apache.jetspeed.om.page.Fragment |
containerFragment
|
protected Map |
fragmentCoordinateMap
|
protected Map |
fragmentMap
|
private org.apache.commons.logging.Log |
log
Logger |
private static int |
NO_DEPTH_LIMIT
|
protected int |
numberOfColumns
|
protected org.apache.jetspeed.om.page.Page |
page
|
Constructor Summary | |
---|---|
PortletPlacementContextImpl(org.apache.jetspeed.request.RequestContext requestContext)
|
|
PortletPlacementContextImpl(org.apache.jetspeed.request.RequestContext requestContext,
org.apache.jetspeed.om.page.Fragment container,
int maxdepth)
|
Method Summary | |
---|---|
org.apache.jetspeed.layout.Coordinate |
add(org.apache.jetspeed.om.page.Fragment fragment,
org.apache.jetspeed.layout.Coordinate coordinate)
|
int |
addColumns(int col)
|
protected void |
addFragmentInternal(org.apache.jetspeed.om.page.Fragment fragment,
int col,
int row)
|
protected org.apache.jetspeed.layout.Coordinate |
addInternal(org.apache.jetspeed.om.page.Fragment fragment,
org.apache.jetspeed.layout.Coordinate coordinate)
|
org.apache.jetspeed.om.page.Fragment |
debugFragments(String debug)
|
org.apache.jetspeed.om.page.Fragment |
getFragment(String fragmentId)
|
protected org.apache.jetspeed.om.page.Fragment |
getFragmentAtCoordinate(org.apache.jetspeed.layout.Coordinate coordinate,
boolean isOld)
|
org.apache.jetspeed.om.page.Fragment |
getFragmentAtNewCoordinate(org.apache.jetspeed.layout.Coordinate coordinate)
|
org.apache.jetspeed.om.page.Fragment |
getFragmentAtOldCoordinate(org.apache.jetspeed.layout.Coordinate coordinate)
|
org.apache.jetspeed.om.page.Fragment |
getFragmentById(String fragmentId)
|
protected int |
getFragmentCol(org.apache.jetspeed.om.page.Fragment fragment)
|
protected int |
getFragmentRow(org.apache.jetspeed.om.page.Fragment fragment)
|
int |
getNumberColumns()
|
int |
getNumberRows(int col)
|
protected void |
init(org.apache.jetspeed.request.RequestContext requestContext,
org.apache.jetspeed.om.page.Fragment container,
int maxdepth)
|
protected List |
makeSpace(org.apache.jetspeed.layout.Coordinate newCoordinate)
|
org.apache.jetspeed.layout.Coordinate |
moveAbsolute(org.apache.jetspeed.om.page.Fragment fragment,
org.apache.jetspeed.layout.Coordinate newCoordinate)
|
protected org.apache.jetspeed.layout.Coordinate |
moveDirection(org.apache.jetspeed.om.page.Fragment fragment,
int deltaCol,
int deltaRow)
|
org.apache.jetspeed.layout.Coordinate |
moveDown(org.apache.jetspeed.om.page.Fragment fragment)
|
org.apache.jetspeed.layout.Coordinate |
moveLeft(org.apache.jetspeed.om.page.Fragment fragment)
|
org.apache.jetspeed.layout.Coordinate |
moveRight(org.apache.jetspeed.om.page.Fragment fragment)
|
org.apache.jetspeed.layout.Coordinate |
moveUp(org.apache.jetspeed.om.page.Fragment fragment)
|
protected void |
populateArray()
Now that we know the number of columns, the array can be constructed and populated |
protected void |
prepareList(Vector list,
int row)
|
protected int |
processFragment(org.apache.jetspeed.om.page.Fragment fragment,
int remainingDepth,
int rowCount)
Evaluate each portlet fragment and populate the internal data structures |
org.apache.jetspeed.layout.Coordinate |
remove(org.apache.jetspeed.om.page.Fragment fragment)
|
org.apache.jetspeed.om.page.Page |
syncPageFragments()
Takes the internal portlet placement state and stores back out to fragment state |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private static final int NO_DEPTH_LIMIT
private org.apache.commons.logging.Log log
protected Vector[] columnsList
protected Map fragmentCoordinateMap
protected Map fragmentMap
protected int numberOfColumns
protected org.apache.jetspeed.om.page.Page page
protected org.apache.jetspeed.om.page.Fragment containerFragment
Constructor Detail |
---|
public PortletPlacementContextImpl(org.apache.jetspeed.request.RequestContext requestContext) throws org.apache.jetspeed.layout.PortletPlacementException
org.apache.jetspeed.layout.PortletPlacementException
public PortletPlacementContextImpl(org.apache.jetspeed.request.RequestContext requestContext, org.apache.jetspeed.om.page.Fragment container, int maxdepth) throws org.apache.jetspeed.layout.PortletPlacementException
org.apache.jetspeed.layout.PortletPlacementException
Method Detail |
---|
protected void init(org.apache.jetspeed.request.RequestContext requestContext, org.apache.jetspeed.om.page.Fragment container, int maxdepth) throws org.apache.jetspeed.layout.PortletPlacementException
org.apache.jetspeed.layout.PortletPlacementException
protected int processFragment(org.apache.jetspeed.om.page.Fragment fragment, int remainingDepth, int rowCount) throws org.apache.jetspeed.layout.PortletPlacementException
org.apache.jetspeed.layout.PortletPlacementException
public org.apache.jetspeed.om.page.Fragment debugFragments(String debug)
public org.apache.jetspeed.om.page.Page syncPageFragments()
syncPageFragments
in interface org.apache.jetspeed.layout.PortletPlacementContext
protected int getFragmentRow(org.apache.jetspeed.om.page.Fragment fragment)
protected int getFragmentCol(org.apache.jetspeed.om.page.Fragment fragment)
protected void addFragmentInternal(org.apache.jetspeed.om.page.Fragment fragment, int col, int row)
protected void populateArray() throws org.apache.jetspeed.layout.PortletPlacementException
org.apache.jetspeed.layout.PortletPlacementException
protected void prepareList(Vector list, int row)
protected List makeSpace(org.apache.jetspeed.layout.Coordinate newCoordinate)
public int addColumns(int col) throws org.apache.jetspeed.layout.PortletPlacementException
org.apache.jetspeed.layout.PortletPlacementException
public org.apache.jetspeed.layout.Coordinate add(org.apache.jetspeed.om.page.Fragment fragment, org.apache.jetspeed.layout.Coordinate coordinate) throws org.apache.jetspeed.layout.PortletPlacementException
add
in interface org.apache.jetspeed.layout.PortletPlacementContext
org.apache.jetspeed.layout.PortletPlacementException
protected org.apache.jetspeed.layout.Coordinate addInternal(org.apache.jetspeed.om.page.Fragment fragment, org.apache.jetspeed.layout.Coordinate coordinate) throws org.apache.jetspeed.layout.PortletPlacementException
org.apache.jetspeed.layout.PortletPlacementException
public org.apache.jetspeed.om.page.Fragment getFragment(String fragmentId) throws org.apache.jetspeed.layout.PortletPlacementException
org.apache.jetspeed.layout.PortletPlacementException
public org.apache.jetspeed.om.page.Fragment getFragmentAtOldCoordinate(org.apache.jetspeed.layout.Coordinate coordinate) throws org.apache.jetspeed.layout.PortletPlacementException
getFragmentAtOldCoordinate
in interface org.apache.jetspeed.layout.PortletPlacementContext
org.apache.jetspeed.layout.PortletPlacementException
public org.apache.jetspeed.om.page.Fragment getFragmentAtNewCoordinate(org.apache.jetspeed.layout.Coordinate coordinate) throws org.apache.jetspeed.layout.PortletPlacementException
getFragmentAtNewCoordinate
in interface org.apache.jetspeed.layout.PortletPlacementContext
org.apache.jetspeed.layout.PortletPlacementException
protected org.apache.jetspeed.om.page.Fragment getFragmentAtCoordinate(org.apache.jetspeed.layout.Coordinate coordinate, boolean isOld) throws org.apache.jetspeed.layout.PortletPlacementException
org.apache.jetspeed.layout.PortletPlacementException
public org.apache.jetspeed.om.page.Fragment getFragmentById(String fragmentId) throws org.apache.jetspeed.layout.PortletPlacementException
getFragmentById
in interface org.apache.jetspeed.layout.PortletPlacementContext
org.apache.jetspeed.layout.PortletPlacementException
public int getNumberColumns() throws org.apache.jetspeed.layout.PortletPlacementException
getNumberColumns
in interface org.apache.jetspeed.layout.PortletPlacementContext
org.apache.jetspeed.layout.PortletPlacementException
public int getNumberRows(int col) throws org.apache.jetspeed.layout.PortletPlacementException
getNumberRows
in interface org.apache.jetspeed.layout.PortletPlacementContext
org.apache.jetspeed.layout.PortletPlacementException
public org.apache.jetspeed.layout.Coordinate moveAbsolute(org.apache.jetspeed.om.page.Fragment fragment, org.apache.jetspeed.layout.Coordinate newCoordinate) throws org.apache.jetspeed.layout.PortletPlacementException
moveAbsolute
in interface org.apache.jetspeed.layout.PortletPlacementContext
org.apache.jetspeed.layout.PortletPlacementException
protected org.apache.jetspeed.layout.Coordinate moveDirection(org.apache.jetspeed.om.page.Fragment fragment, int deltaCol, int deltaRow) throws org.apache.jetspeed.layout.PortletPlacementException
org.apache.jetspeed.layout.PortletPlacementException
public org.apache.jetspeed.layout.Coordinate moveDown(org.apache.jetspeed.om.page.Fragment fragment) throws org.apache.jetspeed.layout.PortletPlacementException
moveDown
in interface org.apache.jetspeed.layout.PortletPlacementContext
org.apache.jetspeed.layout.PortletPlacementException
public org.apache.jetspeed.layout.Coordinate moveUp(org.apache.jetspeed.om.page.Fragment fragment) throws org.apache.jetspeed.layout.PortletPlacementException
moveUp
in interface org.apache.jetspeed.layout.PortletPlacementContext
org.apache.jetspeed.layout.PortletPlacementException
public org.apache.jetspeed.layout.Coordinate moveLeft(org.apache.jetspeed.om.page.Fragment fragment) throws org.apache.jetspeed.layout.PortletPlacementException
moveLeft
in interface org.apache.jetspeed.layout.PortletPlacementContext
org.apache.jetspeed.layout.PortletPlacementException
public org.apache.jetspeed.layout.Coordinate moveRight(org.apache.jetspeed.om.page.Fragment fragment) throws org.apache.jetspeed.layout.PortletPlacementException
moveRight
in interface org.apache.jetspeed.layout.PortletPlacementContext
org.apache.jetspeed.layout.PortletPlacementException
public org.apache.jetspeed.layout.Coordinate remove(org.apache.jetspeed.om.page.Fragment fragment) throws org.apache.jetspeed.layout.PortletPlacementException
remove
in interface org.apache.jetspeed.layout.PortletPlacementContext
org.apache.jetspeed.layout.PortletPlacementException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |