|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jasig.portal.layout.SimpleLayout
The simple user layout implementation. This layout is based on a Document.
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 |
public SimpleLayout(java.lang.String layoutId, org.w3c.dom.Document layout)
Method Detail |
public void writeTo(org.xml.sax.ContentHandler ch) throws PortalException
IUserLayout
ContentHandler
writeTo
in interface IUserLayout
ch
- a ContentHandler
value
PortalException
- if an error occurspublic void writeTo(java.lang.String nodeId, org.xml.sax.ContentHandler ch) throws PortalException
IUserLayout
ContentHandler
writeTo
in interface IUserLayout
nodeId
- a String
a node determining a user layout subtree.ch
- a ContentHandler
value
PortalException
- if an error occurspublic void writeTo(org.w3c.dom.Document document) throws PortalException
IUserLayout
Document
object
writeTo
in interface IUserLayout
document
- a Document
value
PortalException
- if an error occurspublic void writeTo(java.lang.String nodeId, org.w3c.dom.Document document) throws PortalException
IUserLayout
Document
writeTo
in interface IUserLayout
nodeId
- a String
a node determining a user layout subtree.document
- a Document
object
PortalException
- if an error occurspublic IUserLayoutNodeDescription getNodeDescription(java.lang.String nodeId) throws PortalException
IUserLayout
getNodeDescription
in interface IUserLayout
nodeId
- a String
channel subscribe id or folder id.
UserLayoutNodeDescription
value
PortalException
- if an error occurspublic java.lang.String getParentId(java.lang.String nodeId) throws PortalException
IUserLayout
getParentId
in interface IUserLayout
nodeId
- a String
value
String
value
PortalException
- if an error occurspublic java.util.Enumeration getChildIds(java.lang.String nodeId) throws PortalException
IUserLayout
getChildIds
in interface IUserLayout
nodeId
- a String
value
Enumeration
of String
child node Ids.
PortalException
- if an error occurspublic java.lang.String getNextSiblingId(java.lang.String nodeId) throws PortalException
IUserLayout
getNextSiblingId
in interface IUserLayout
nodeId
- a String
value
String
Id value of a next sibling node, or null
if this is the last sibling.
PortalException
- if an error occurspublic java.lang.String getPreviousSiblingId(java.lang.String nodeId) throws PortalException
IUserLayout
getPreviousSiblingId
in interface IUserLayout
nodeId
- a String
value
String
Id value of a previous sibling node, or null
if this is the first sibling.
PortalException
- if an error occurspublic java.lang.String getCacheKey() throws PortalException
IUserLayout
getCacheKey
in interface IUserLayout
String
value
PortalException
- if an error occurspublic boolean addLayoutEventListener(LayoutEventListener l)
IUserLayout
addLayoutEventListener
in interface IUserLayout
l
- a LayoutEventListener
object
boolean
success statuspublic boolean removeLayoutEventListener(LayoutEventListener l)
IUserLayout
removeLayoutEventListener
in interface IUserLayout
l
- a LayoutEventListener
object
boolean
success statuspublic java.lang.String getId()
IUserLayout
getId
in interface IUserLayout
String
layout Id value;public java.lang.String getNodeId(java.lang.String fname) throws PortalException
IUserLayout
getNodeId
in interface IUserLayout
fname
- the functional name to lookup
String
subscription id
PortalException
- if an error occurspublic java.util.Enumeration getNodeIds() throws PortalException
IUserLayout
getNodeIds
in interface IUserLayout
Enumeration
of node Ids
PortalException
- if an error occurspublic java.lang.String getRootId()
IUserLayout
getRootId
in interface IUserLayout
String
value
|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |