|
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.AggregatedLayout
The aggregated user layout implementation.
Field Summary |
Fields inherited from interface org.jasig.portal.layout.IAggregatedLayout |
ADD_TARGET, CHANNEL, FOLDER, FRAGMENT, LAYOUT, MOVE_TARGET, PARAMETER, RESTRICTION |
Constructor Summary | |
AggregatedLayout(java.lang.String layoutId)
|
|
AggregatedLayout(java.lang.String layoutId,
IAggregatedUserLayoutManager layoutManager)
|
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. |
ALNode |
getFirstSiblingNode(java.lang.String nodeId)
|
java.lang.String |
getFragmentId(java.lang.String nodeId)
Returns an fragment Id for a given node. |
java.util.Set |
getFragmentIds()
Returns a list of fragment Ids existing in the layout. |
java.lang.String |
getFragmentRootId(java.lang.String fragmentId)
Returns an fragment root Id for a given fragment. |
java.lang.String |
getId()
Returns a layout Id associated with this manager/ |
ALNode |
getLastSiblingNode(java.lang.String nodeId)
|
java.util.Hashtable |
getLayoutData()
|
ALFolder |
getLayoutFolder(java.lang.String folderId)
|
ALNode |
getLayoutNode(java.lang.String nodeId)
|
java.lang.String |
getNextSiblingId(java.lang.String nodeId)
Determine an Id of a next sibling node. |
ALNode |
getNode(java.lang.String nodeId)
Returns a node specified by a node ID. |
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 |
setLayoutData(java.util.Hashtable layout)
|
void |
setLayoutManager(IAggregatedUserLayoutManager layoutManager)
|
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 contentHandler)
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 AggregatedLayout(java.lang.String layoutId, IAggregatedUserLayoutManager layoutManager) throws PortalException
public AggregatedLayout(java.lang.String layoutId) throws PortalException
Method Detail |
public void setLayoutManager(IAggregatedUserLayoutManager layoutManager)
public void setLayoutData(java.util.Hashtable layout) throws PortalException
PortalException
public java.util.Hashtable getLayoutData() throws PortalException
PortalException
public ALNode getLayoutNode(java.lang.String nodeId)
public ALFolder getLayoutFolder(java.lang.String folderId)
public ALNode getLastSiblingNode(java.lang.String nodeId)
public ALNode getFirstSiblingNode(java.lang.String nodeId)
public java.util.Set getFragmentIds() throws PortalException
getFragmentIds
in interface IAggregatedLayout
Set
of String
fragment Ids.
PortalException
- if an error occurspublic java.lang.String getFragmentId(java.lang.String nodeId) throws PortalException
getFragmentId
in interface IAggregatedLayout
nodeId
- a String
value
String
fragment Id
PortalException
- if an error occurspublic java.lang.String getFragmentRootId(java.lang.String fragmentId) throws PortalException
getFragmentRootId
in interface IAggregatedLayout
fragmentId
- a String
value
String
fragment root Id
PortalException
- if an error occurspublic void writeTo(org.xml.sax.ContentHandler ch) throws PortalException
ContentHandler
writeTo
in interface IUserLayout
ch
- a ContentHandler
value
PortalException
- if an error occurspublic void writeTo(java.lang.String nodeId, org.xml.sax.ContentHandler contentHandler) throws PortalException
ContentHandler
writeTo
in interface IUserLayout
nodeId
- a String
a node determining a user layout subtree.contentHandler
- a ContentHandler
value
PortalException
- if an error occurspublic void writeTo(org.w3c.dom.Document document) throws PortalException
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
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
getNodeDescription
in interface IUserLayout
nodeId
- a String
channel subscribe id or folder id.
UserLayoutNodeDescription
value
PortalException
- if an error occurspublic ALNode getNode(java.lang.String nodeId) throws PortalException
nodeId
- a String
value
ALNode
object
PortalException
- if an error occurspublic java.lang.String getParentId(java.lang.String nodeId) throws PortalException
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
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
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
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
getCacheKey
in interface IUserLayout
String
value
PortalException
- if an error occurspublic boolean addLayoutEventListener(LayoutEventListener l)
addLayoutEventListener
in interface IUserLayout
l
- a LayoutEventListener
object
boolean
success statuspublic boolean removeLayoutEventListener(LayoutEventListener l)
removeLayoutEventListener
in interface IUserLayout
l
- a LayoutEventListener
object
boolean
success statuspublic java.lang.String getId()
getId
in interface IUserLayout
String
layout Id value;public java.lang.String getNodeId(java.lang.String fname) throws PortalException
getNodeId
in interface IUserLayout
fname
- the functional name to lookup
String
subscription id
PortalException
- if an error occurspublic java.util.Enumeration getNodeIds() throws PortalException
getNodeIds
in interface IUserLayout
Enumeration
of node Ids
PortalException
- if an error occurspublic java.lang.String getRootId()
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 |