uPortal 2.4.1
API Documentation

org.jasig.portal.layout
Class SimpleLayout

java.lang.Object
  extended byorg.jasig.portal.layout.SimpleLayout
All Implemented Interfaces:
IUserLayout

public class SimpleLayout
extends java.lang.Object
implements IUserLayout

The simple user layout implementation. This layout is based on a Document.

Version:
$Revision: 1.2 $
Author:
Ken Weiner, kweiner@unicon.net

Constructor Summary
SimpleLayout(java.lang.String layoutId, org.w3c.dom.Document layout)
           
 
Method Summary
 boolean addLayoutEventListener(LayoutEventListener l)
          Register a layout event listener
 java.lang.String getCacheKey()
          Return a cache key, uniqly corresponding to the composition and the structure of the user layout.
 java.util.Enumeration getChildIds(java.lang.String nodeId)
          Returns a list of child node Ids for a given node.
 java.lang.String getId()
          Returns a layout Id associated with this manager/
 java.lang.String getNextSiblingId(java.lang.String nodeId)
          Determine an Id of a next sibling node.
 IUserLayoutNodeDescription getNodeDescription(java.lang.String nodeId)
          Obtain a description of a node (channel or a folder) in a given user layout.
 java.lang.String getNodeId(java.lang.String fname)
          Returns a node id associated with the supplied functional name.
 java.util.Enumeration getNodeIds()
          Returns a list of node Ids in the layout.
 java.lang.String getParentId(java.lang.String nodeId)
          Returns an Id of a parent user layout node.
 java.lang.String getPreviousSiblingId(java.lang.String nodeId)
          Determine an Id of a previous sibling node.
 java.lang.String getRootId()
          Returns an id of the root node.
 boolean removeLayoutEventListener(LayoutEventListener l)
          Remove a registered layout event listener.
 void writeTo(org.xml.sax.ContentHandler ch)
          Writes user layout content (with appropriate markings) into a ContentHandler
 void writeTo(org.w3c.dom.Document document)
          Writes user layout content (with appropriate markings) into a Document object
 void writeTo(java.lang.String nodeId, org.xml.sax.ContentHandler ch)
          Writes subtree of a user layout (with appropriate markings) defined by a particular node into a ContentHandler
 void writeTo(java.lang.String nodeId, org.w3c.dom.Document document)
          Writes subtree of a user layout (with appropriate markings) defined by a particular node into a Document
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SimpleLayout

public SimpleLayout(java.lang.String layoutId,
                    org.w3c.dom.Document layout)
Method Detail

writeTo

public void writeTo(org.xml.sax.ContentHandler ch)
             throws PortalException
Description copied from interface: IUserLayout
Writes user layout content (with appropriate markings) into a ContentHandler

Specified by:
writeTo in interface IUserLayout
Parameters:
ch - a ContentHandler value
Throws:
PortalException - if an error occurs

writeTo

public void writeTo(java.lang.String nodeId,
                    org.xml.sax.ContentHandler ch)
             throws PortalException
Description copied from interface: IUserLayout
Writes subtree of a user layout (with appropriate markings) defined by a particular node into a ContentHandler

Specified by:
writeTo in interface IUserLayout
Parameters:
nodeId - a String a node determining a user layout subtree.
ch - a ContentHandler value
Throws:
PortalException - if an error occurs

writeTo

public void writeTo(org.w3c.dom.Document document)
             throws PortalException
Description copied from interface: IUserLayout
Writes user layout content (with appropriate markings) into a Document object

Specified by:
writeTo in interface IUserLayout
Parameters:
document - a Document value
Throws:
PortalException - if an error occurs

writeTo

public void writeTo(java.lang.String nodeId,
                    org.w3c.dom.Document document)
             throws PortalException
Description copied from interface: IUserLayout
Writes subtree of a user layout (with appropriate markings) defined by a particular node into a Document

Specified by:
writeTo in interface IUserLayout
Parameters:
nodeId - a String a node determining a user layout subtree.
document - a Document object
Throws:
PortalException - if an error occurs

getNodeDescription

public IUserLayoutNodeDescription getNodeDescription(java.lang.String nodeId)
                                              throws PortalException
Description copied from interface: IUserLayout
Obtain a description of a node (channel or a folder) in a given user layout.

Specified by:
getNodeDescription in interface IUserLayout
Parameters:
nodeId - a String channel subscribe id or folder id.
Returns:
an UserLayoutNodeDescription value
Throws:
PortalException - if an error occurs

getParentId

public java.lang.String getParentId(java.lang.String nodeId)
                             throws PortalException
Description copied from interface: IUserLayout
Returns an Id of a parent user layout node. The user layout root node always has ID="root"

Specified by:
getParentId in interface IUserLayout
Parameters:
nodeId - a String value
Returns:
a String value
Throws:
PortalException - if an error occurs

getChildIds

public java.util.Enumeration getChildIds(java.lang.String nodeId)
                                  throws PortalException
Description copied from interface: IUserLayout
Returns a list of child node Ids for a given node.

Specified by:
getChildIds in interface IUserLayout
Parameters:
nodeId - a String value
Returns:
a Enumeration of String child node Ids.
Throws:
PortalException - if an error occurs

getNextSiblingId

public java.lang.String getNextSiblingId(java.lang.String nodeId)
                                  throws PortalException
Description copied from interface: IUserLayout
Determine an Id of a next sibling node.

Specified by:
getNextSiblingId in interface IUserLayout
Parameters:
nodeId - a String value
Returns:
a String Id value of a next sibling node, or null if this is the last sibling.
Throws:
PortalException - if an error occurs

getPreviousSiblingId

public java.lang.String getPreviousSiblingId(java.lang.String nodeId)
                                      throws PortalException
Description copied from interface: IUserLayout
Determine an Id of a previous sibling node.

Specified by:
getPreviousSiblingId in interface IUserLayout
Parameters:
nodeId - a String value
Returns:
a String Id value of a previous sibling node, or null if this is the first sibling.
Throws:
PortalException - if an error occurs

getCacheKey

public java.lang.String getCacheKey()
                             throws PortalException
Description copied from interface: IUserLayout
Return a cache key, uniqly corresponding to the composition and the structure of the user layout.

Specified by:
getCacheKey in interface IUserLayout
Returns:
a String value
Throws:
PortalException - if an error occurs

addLayoutEventListener

public boolean addLayoutEventListener(LayoutEventListener l)
Description copied from interface: IUserLayout
Register a layout event listener

Specified by:
addLayoutEventListener in interface IUserLayout
Parameters:
l - a LayoutEventListener object
Returns:
a boolean success status

removeLayoutEventListener

public boolean removeLayoutEventListener(LayoutEventListener l)
Description copied from interface: IUserLayout
Remove a registered layout event listener.

Specified by:
removeLayoutEventListener in interface IUserLayout
Parameters:
l - a LayoutEventListener object
Returns:
a boolean success status

getId

public java.lang.String getId()
Description copied from interface: IUserLayout
Returns a layout Id associated with this manager/

Specified by:
getId in interface IUserLayout
Returns:
an String layout Id value;

getNodeId

public java.lang.String getNodeId(java.lang.String fname)
                           throws PortalException
Description copied from interface: IUserLayout
Returns a node id associated with the supplied functional name.

Specified by:
getNodeId in interface IUserLayout
Parameters:
fname - the functional name to lookup
Returns:
a String subscription id
Throws:
PortalException - if an error occurs

getNodeIds

public java.util.Enumeration getNodeIds()
                                 throws PortalException
Description copied from interface: IUserLayout
Returns a list of node Ids in the layout.

Specified by:
getNodeIds in interface IUserLayout
Returns:
a Enumeration of node Ids
Throws:
PortalException - if an error occurs

getRootId

public java.lang.String getRootId()
Description copied from interface: IUserLayout
Returns an id of the root node.

Specified by:
getRootId in interface IUserLayout
Returns:
a String value

uPortal 2.4.1
API Documentation