Java Doc for PortletPlacementContext.java in  » Portal » jetspeed-2.1.3 » org » apache » jetspeed » layout » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Portal » jetspeed 2.1.3 » org.apache.jetspeed.layout 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.apache.jetspeed.layout.PortletPlacementContext

All known Subclasses:   org.apache.jetspeed.layout.impl.PortletPlacementContextImpl,
PortletPlacementContext
public interface PortletPlacementContext (Code)
Handles portlet placement for client such as AJAX client side on a per request basis. The context is associated with a request context, thus it is only valid for the span of a request.
author:
   David Gurney
author:
   David Sean Taylor
version:
   $Id: $




Method Summary
public  Coordinateadd(Fragment fragment, Coordinate coordinate)
     Add a portlet to its managed page.
public  FragmentgetFragmentAtNewCoordinate(Coordinate coordinate)
     Retrieve a portlet fragment for the given coordinate.
Parameters:
  coordinate - the coordinate associated to a fragment.
public  FragmentgetFragmentAtOldCoordinate(Coordinate coordinate)
     Retrieve the old portlet fragment for the given coordinate (prior to placement).
Parameters:
  coordinate - the coordinate associated to a fragment.
public  FragmentgetFragmentById(String fragmentId)
     Retrieve a fragment by fragment id.
Parameters:
  fragmentId - a string key for a fragment managed on this layout.
public  intgetNumberColumns()
     retrieve the number of columns for the managed layout.
public  intgetNumberRows(int column)
     retrieve the number of rows for the managed layout at the given column.
public  CoordinatemoveAbsolute(Fragment fragment, Coordinate coordinate)
     Move a portlet fragment to a new absolute position as specified in the Coordinate parameter.
public  CoordinatemoveAbsolute(Fragment fragment, Coordinate coordinate, boolean addFragment)
     Move a portlet fragment to a new absolute position as specified in the Coordinate parameter.
Parameters:
  fragment - The fragment to be moved.
Parameters:
  coordinate - The specification of the new absolute coordinate
Parameters:
  addFragment - When true, the fragment is being added (i.e.
public  CoordinatemoveDown(Fragment fragment)
     Move a portlet relative to its current position DOWN one row.
Parameters:
  fragment - The fragment to be moved.
public  CoordinatemoveLeft(Fragment fragment)
     Move a portlet relative to its current position LEFT one column.
Parameters:
  fragment - The fragment to be moved.
public  CoordinatemoveRight(Fragment fragment)
     Move a portlet relative to its current position RIGHT one column.
Parameters:
  fragment - The fragment to be moved.
public  CoordinatemoveUp(Fragment fragment)
     Move a portlet relative to its current position UP one row.
Parameters:
  fragment - The fragment to be moved.
public  Coordinateremove(Fragment fragment)
     Remove the specified fragment.
public  PagesyncPageFragments()
     Takes the internal portlet placement state and writes it back out to the root fragment for the managed page layout.



Method Detail
add
public Coordinate add(Fragment fragment, Coordinate coordinate) throws PortletPlacementException(Code)
Add a portlet to its managed page.
Parameters:
  fragment - The Fragment to add
Parameters:
  coordinate - The coordinate where to place the new portlet
throws:
  PortletPlacementException -



getFragmentAtNewCoordinate
public Fragment getFragmentAtNewCoordinate(Coordinate coordinate) throws PortletPlacementException(Code)
Retrieve a portlet fragment for the given coordinate.
Parameters:
  coordinate - the coordinate associated to a fragment. the fragment associated to the given coordinate
throws:
  PortletPlacementException -



getFragmentAtOldCoordinate
public Fragment getFragmentAtOldCoordinate(Coordinate coordinate) throws PortletPlacementException(Code)
Retrieve the old portlet fragment for the given coordinate (prior to placement).
Parameters:
  coordinate - the coordinate associated to a fragment. the fragment associated to the given coordinate
throws:
  PortletPlacementException -



getFragmentById
public Fragment getFragmentById(String fragmentId) throws PortletPlacementException(Code)
Retrieve a fragment by fragment id.
Parameters:
  fragmentId - a string key for a fragment managed on this layout. The fragment associated with the given fragment id.
throws:
  PortletPlacementException -



getNumberColumns
public int getNumberColumns() throws PortletPlacementException(Code)
retrieve the number of columns for the managed layout. the number of columns in the manged layout
throws:
  PortletPlacementException -



getNumberRows
public int getNumberRows(int column) throws PortletPlacementException(Code)
retrieve the number of rows for the managed layout at the given column.
Parameters:
  column - the column to retrieve the number of rows for the number of rows for the given column
throws:
  PortletPlacementException -



moveAbsolute
public Coordinate moveAbsolute(Fragment fragment, Coordinate coordinate) throws PortletPlacementException(Code)
Move a portlet fragment to a new absolute position as specified in the Coordinate parameter.
Parameters:
  fragment - The fragment to be moved.
Parameters:
  coordinate - The specification of the new absolute coordinate new coordinate location of the portlet
throws:
  PortletPlacementException -



moveAbsolute
public Coordinate moveAbsolute(Fragment fragment, Coordinate coordinate, boolean addFragment) throws PortletPlacementException(Code)
Move a portlet fragment to a new absolute position as specified in the Coordinate parameter.
Parameters:
  fragment - The fragment to be moved.
Parameters:
  coordinate - The specification of the new absolute coordinate
Parameters:
  addFragment - When true, the fragment is being added (i.e. it is not being moved within the column) new coordinate location of the portlet
throws:
  PortletPlacementException -



moveDown
public Coordinate moveDown(Fragment fragment) throws PortletPlacementException(Code)
Move a portlet relative to its current position DOWN one row.
Parameters:
  fragment - The fragment to be moved. new coordinate location of the portlet
throws:
  PortletPlacementException -



moveLeft
public Coordinate moveLeft(Fragment fragment) throws PortletPlacementException(Code)
Move a portlet relative to its current position LEFT one column.
Parameters:
  fragment - The fragment to be moved. new coordinate location of the portlet
throws:
  PortletPlacementException -



moveRight
public Coordinate moveRight(Fragment fragment) throws PortletPlacementException(Code)
Move a portlet relative to its current position RIGHT one column.
Parameters:
  fragment - The fragment to be moved. new coordinate location of the portlet
throws:
  PortletPlacementException -



moveUp
public Coordinate moveUp(Fragment fragment) throws PortletPlacementException(Code)
Move a portlet relative to its current position UP one row.
Parameters:
  fragment - The fragment to be moved. new coordinate location of the portlet
throws:
  PortletPlacementException -



remove
public Coordinate remove(Fragment fragment) throws PortletPlacementException(Code)
Remove the specified fragment.
Parameters:
  fragment -
throws:
  PortletPlacementException -



syncPageFragments
public Page syncPageFragments()(Code)
Takes the internal portlet placement state and writes it back out to the root fragment for the managed page layout. the managed page layout with updated fragment state.



www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.