Java Doc for IUserLayout.java in » Portal » uPortal_rel-2-6-1-GA » org » jasig » portal » 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

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL 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 » uPortal_rel 2 6 1 GA » org.jasig.portal.layout

Source Cross Reference Class Diagram Java Document (Java Doc)

org.jasig.portal.layout .IUserLayout

All known Subclasses:   org.jasig.portal.layout.simple .SimpleLayout,
IUserLayout
public interface IUserLayout (Code)
An interface representing the user layout.
author:
   Michael Ivanov
version:
   $Revision: 35168 $

Field Summary
final public static String ROOT_NODE_NAME
     The name to use for the root node of the layout.

Method Summary
public boolean addLayoutEventListener(LayoutEventListener l)

public String getCacheKey()
     Return a cache key, uniqly corresponding to the composition and the structure of the user layout.
public Enumeration getChildIds(String nodeId)
     Returns a list of child node Ids for a given node.
public String getId()

public String getNextSiblingId(String nodeId)
     Determine an Id of a next sibling node.
public IUserLayoutNodeDescription getNodeDescription(String nodeId)
     Obtain a description of a node (channel or a folder) in a given user layout.
Parameters:
  nodeId - a String channel subscribe id or folder id.
public String getNodeId(String fname)
     Returns a node id associated with the supplied functional name.
public Enumeration getNodeIds()
     Returns a list of node Ids in the layout.
public String getParentId(String nodeId)
     Returns an Id of a parent user layout node.
public String getPreviousSiblingId(String nodeId)
     Determine an Id of a previous sibling node.
public String getRootId()
     Returns an id of the root node.
public boolean removeLayoutEventListener(LayoutEventListener l)
     Remove a registered layout event listener.
public void writeTo(ContentHandler ch)

public void writeTo(String nodeId, ContentHandler ch)

public void writeTo(Document document)

public void writeTo(String nodeId, Document document)


Field Detail
ROOT_NODE_NAME
final public static String ROOT_NODE_NAME(Code)
The name to use for the root node of the layout. This should be used with regard to rendering position within the layout tree.

Method Detail
addLayoutEventListener
public boolean addLayoutEventListener(LayoutEventListener l)(Code)
Register a layout event listener
Parameters:
  l - a LayoutEventListener object a boolean success status

getCacheKey
public String getCacheKey() throws PortalException(Code)
Return a cache key, uniqly corresponding to the composition and the structure of the user layout. a String value
exception:
  PortalException - if an error occurs

getChildIds
public Enumeration getChildIds(String nodeId) throws PortalException(Code)
Returns a list of child node Ids for a given node.
Parameters:
  nodeId - a String value a Enumeration of String child node Ids.
exception:
  PortalException - if an error occurs

getId
public String getId()(Code)
Returns a layout Id associated with this manager/ an String layout Id value;

getNextSiblingId
public String getNextSiblingId(String nodeId) throws PortalException(Code)
Determine an Id of a next sibling node.
Parameters:
  nodeId - a String value a String Id value of a next sibling node, or null if this is the last sibling.
exception:
  PortalException - if an error occurs

getNodeDescription
public IUserLayoutNodeDescription getNodeDescription(String nodeId) throws PortalException(Code)
Obtain a description of a node (channel or a folder) in a given user layout.
Parameters:
  nodeId - a String channel subscribe id or folder id. an UserLayoutNodeDescription value
exception:
  PortalException - if an error occurs

getNodeId
public String getNodeId(String fname) throws PortalException(Code)
Returns a node id associated with the supplied functional name.
Parameters:
  fname - the functional name to lookup a String subscription id
exception:
  PortalException - if an error occurs

getNodeIds
public Enumeration getNodeIds() throws PortalException(Code)
Returns a list of node Ids in the layout. a Enumeration of node Ids
exception:
  PortalException - if an error occurs

getParentId
public String getParentId(String nodeId) throws PortalException(Code)
Returns an Id of a parent user layout node. The user layout root node always has ID="root"
Parameters:
  nodeId - a String value a String value
exception:
  PortalException - if an error occurs

getPreviousSiblingId
public String getPreviousSiblingId(String nodeId) throws PortalException(Code)
Determine an Id of a previous sibling node.
Parameters:
  nodeId - a String value a String Id value of a previous sibling node, or null if this is the first sibling.
exception:
  PortalException - if an error occurs

getRootId
public String getRootId()(Code)
Returns an id of the root node. a String value

removeLayoutEventListener
public boolean removeLayoutEventListener(LayoutEventListener l)(Code)
Remove a registered layout event listener.
Parameters:
  l - a LayoutEventListener object a boolean success status

writeTo
public void writeTo(ContentHandler ch) throws PortalException(Code)
Writes user layout content (with appropriate markings) into a ContentHandler
Parameters:
  ch - a ContentHandler value
exception:
  PortalException - if an error occurs

writeTo
public void writeTo(String nodeId, ContentHandler ch) throws PortalException(Code)
Writes subtree of a user layout (with appropriate markings) defined by a particular node into a ContentHandler
Parameters:
  nodeId - a String a node determining a user layout subtree.
Parameters:
  ch - a ContentHandler value
exception:
  PortalException - if an error occurs

writeTo
public void writeTo(Document document) throws PortalException(Code)
Writes user layout content (with appropriate markings) into a Document object
Parameters:
  document - a Document value
exception:
  PortalException - if an error occurs

writeTo
public void writeTo(String nodeId, Document document) throws PortalException(Code)
Writes subtree of a user layout (with appropriate markings) defined by a particular node into a Document
Parameters:
  nodeId - a String a node determining a user layout subtree.
Parameters:
  document - a Document object
exception:
  PortalException - if an error occurs

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.