|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IAggregatedLayout
An aggregated-layout specific extension of the user layout interface Prior to uPortal 2.5, this class existed in the package org.jasig.portal.layout. It was moved to its present package to reflect that it is part of Aggregated Layouts.
Field Summary | |
---|---|
static java.lang.String |
ADD_TARGET
|
static java.lang.String |
CHANNEL
|
static java.lang.String |
FOLDER
|
static java.lang.String |
FRAGMENT
|
static java.lang.String |
LAYOUT
|
static java.lang.String |
MOVE_TARGET
|
static java.lang.String |
PARAMETER
|
static java.lang.String |
RESTRICTION
|
Fields inherited from interface org.jasig.portal.layout.IUserLayout |
---|
ROOT_NODE_NAME |
Method Summary | |
---|---|
int |
getDepth(java.lang.String nodeId)
Gets the tree depth for a given node |
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. |
ALFolder |
getLayoutFolder(java.lang.String folderId)
Returns the folder by a given folder ID. |
ALNode |
getLayoutNode(java.lang.String nodeId)
Returns the node by a given node ID. |
Methods inherited from interface org.jasig.portal.layout.IUserLayout |
---|
addLayoutEventListener, getCacheKey, getChildIds, getId, getNextSiblingId, getNodeDescription, getNodeId, getNodeIds, getParentId, getPreviousSiblingId, getRootId, removeLayoutEventListener, writeTo, writeTo, writeTo, writeTo |
Field Detail |
---|
static final java.lang.String LAYOUT
static final java.lang.String FRAGMENT
static final java.lang.String FOLDER
static final java.lang.String CHANNEL
static final java.lang.String PARAMETER
static final java.lang.String RESTRICTION
static final java.lang.String ADD_TARGET
static final java.lang.String MOVE_TARGET
Method Detail |
---|
java.util.Set getFragmentIds() throws PortalException
Set
of String
fragment Ids.
PortalException
- if an error occursjava.lang.String getFragmentId(java.lang.String nodeId) throws PortalException
nodeId
- a String
value
String
fragment Id
PortalException
- if an error occursjava.lang.String getFragmentRootId(java.lang.String fragmentId) throws PortalException
fragmentId
- a String
value
String
fragment root Id
PortalException
- if an error occursALNode getLayoutNode(java.lang.String nodeId)
nodeId
- a String
value
ALNode
instanceALFolder getLayoutFolder(java.lang.String folderId)
folderId
- a String
value
ALFolder
instanceint getDepth(java.lang.String nodeId) throws PortalException
nodeId
- a String
node ID
PortalException
- if an error occurs
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |