|
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.TransientUserLayoutManagerWrapper
Wraps IUserLayoutManager
interface to provide ability to
incorporate channels into a user layout that are not part of
their layout structure (persistent).
The channels are incorporated upon request (functional name)
and remain part of the layout structure only as long as they
are the target channel.
Field Summary | |
static java.lang.String |
SUBSCRIBE_PREFIX
|
static java.lang.String |
TRANSIENT_FOLDER_ID
|
Constructor Summary | |
TransientUserLayoutManagerWrapper(IUserLayoutManager manager)
|
Method Summary | |
boolean |
addLayoutEventListener(LayoutEventListener l)
Register a layout event listener |
IUserLayoutNodeDescription |
addNode(IUserLayoutNodeDescription node,
java.lang.String parentId,
java.lang.String nextSiblingId)
Add a new node to a current user layout. |
boolean |
canAddNode(IUserLayoutNodeDescription node,
java.lang.String parentId,
java.lang.String nextSiblingId)
Test if a particular node can be added at a given location. |
boolean |
canDeleteNode(java.lang.String nodeId)
Tests if a particular node can be deleted. |
boolean |
canMoveNode(java.lang.String nodeId,
java.lang.String parentId,
java.lang.String nextSiblingId)
Test if a particular node can be moved to a given location. |
boolean |
canUpdateNode(IUserLayoutNodeDescription node)
Test if a certain node can be updated. |
IUserLayoutNodeDescription |
createNodeDescription(int nodeType)
A factory method to create an empty IUserLayoutNodeDescription instance |
boolean |
deleteNode(java.lang.String nodeId)
Delete a node (folder or a channel) from a user layout. |
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. |
int |
getDepth(java.lang.String nodeId)
Returns the depth of a node in the layout tree. |
java.lang.String |
getFname(java.lang.String subId)
Given a subscribe Id, return its functional name. |
java.lang.String |
getFocusedId()
Get the current focused layout subscribe id. |
int |
getLayoutId()
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 |
getNode(java.lang.String nodeId)
Obtain a description of a node (channel or a folder) in a given user layout. |
IUserLayoutManager |
getOriginalLayoutManager()
|
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 |
getRootFolderId()
Returns an id of the root folder. |
java.lang.String |
getSubscribeId(java.lang.String fname)
Given an functional name, return its subscribe id. |
IUserLayout |
getUserLayout()
Gets a user layout (with appropriate markings). |
void |
getUserLayout(org.xml.sax.ContentHandler ch)
Output user layout (with appropriate markings) into a ContentHandler |
void |
getUserLayout(java.lang.String nodeId,
org.xml.sax.ContentHandler ch)
Output subtree of a user layout (with appropriate markings) defined by a particular node into a ContentHandler |
org.w3c.dom.Document |
getUserLayoutDOM()
|
void |
loadUserLayout()
Signal manager to load a user layout from a database |
void |
markAddTargets(IUserLayoutNodeDescription node)
Ask manager to output markings at the locations where a given node can be added. |
void |
markMoveTargets(java.lang.String nodeId)
Ask manager to output markings at the locations where a given node can be moved. |
boolean |
moveNode(java.lang.String nodeId,
java.lang.String parentId,
java.lang.String nextSiblingId)
Move a node (channel or folder) from one location to another. |
boolean |
removeLayoutEventListener(LayoutEventListener l)
Remove a registered layout event listener. |
void |
saveUserLayout()
Signal manager to persist user layout to a database |
void |
setFocusedId(java.lang.String subscribeId)
Set the current focused layout subscribe id. |
void |
setLayoutStore(IUserLayoutStore ls)
Set a user layout store implementation. |
void |
setOriginalLayoutManager(IUserLayoutManager man)
|
void |
setUserLayout(IUserLayout userLayout)
Sets a user layout (with appropriate markings). |
boolean |
updateNode(IUserLayoutNodeDescription node)
Update a given node. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String TRANSIENT_FOLDER_ID
public static final java.lang.String SUBSCRIBE_PREFIX
Constructor Detail |
public TransientUserLayoutManagerWrapper(IUserLayoutManager manager) throws PortalException
Method Detail |
public IUserLayoutManager getOriginalLayoutManager() throws PortalException
PortalException
public void setOriginalLayoutManager(IUserLayoutManager man) throws PortalException
PortalException
public IUserLayout getUserLayout() throws PortalException
IUserLayoutManager
getUserLayout
in interface IUserLayoutManager
PortalException
- if an error occurspublic void setUserLayout(IUserLayout userLayout) throws PortalException
IUserLayoutManager
setUserLayout
in interface IUserLayoutManager
userLayout
- the user layout
PortalException
- if an error occurspublic void getUserLayout(org.xml.sax.ContentHandler ch) throws PortalException
IUserLayoutManager
ContentHandler
getUserLayout
in interface IUserLayoutManager
ch
- a ContentHandler
value
PortalException
- if an error occurspublic void getUserLayout(java.lang.String nodeId, org.xml.sax.ContentHandler ch) throws PortalException
IUserLayoutManager
ContentHandler
getUserLayout
in interface IUserLayoutManager
nodeId
- a String
a node determining a user layout subtree.ch
- a ContentHandler
value
PortalException
- if an error occurspublic void setLayoutStore(IUserLayoutStore ls)
IUserLayoutManager
setLayoutStore
in interface IUserLayoutManager
ls
- an IUserLayoutStore
valuepublic org.w3c.dom.Document getUserLayoutDOM() throws PortalException
getUserLayoutDOM
in interface IUserLayoutManager
PortalException
public void loadUserLayout() throws PortalException
IUserLayoutManager
loadUserLayout
in interface IUserLayoutManager
PortalException
- if an error occurspublic void saveUserLayout() throws PortalException
IUserLayoutManager
saveUserLayout
in interface IUserLayoutManager
PortalException
- if an error occurspublic IUserLayoutNodeDescription getNode(java.lang.String nodeId) throws PortalException
IUserLayoutManager
getNode
in interface IUserLayoutManager
nodeId
- a String
channel subscribe id or folder id.
UserLayoutNodeDescription
value
PortalException
- if an error occurspublic IUserLayoutNodeDescription addNode(IUserLayoutNodeDescription node, java.lang.String parentId, java.lang.String nextSiblingId) throws PortalException
IUserLayoutManager
addNode
in interface IUserLayoutManager
node
- an UserLayoutNodeDescription
value of a node to be added (Id doesn't have to be set)parentId
- a String
id of a folder to which the new node (channel or folder) should be added.nextSiblingId
- a String
an id of a sibling node (channel or folder) prior to which the new node should be inserted.
UserLayoutNodeDescription
value with a newly determined Id.
PortalException
- if an error occurspublic boolean moveNode(java.lang.String nodeId, java.lang.String parentId, java.lang.String nextSiblingId) throws PortalException
IUserLayoutManager
moveNode
in interface IUserLayoutManager
nodeId
- a String
value of a node Id.parentId
- a String
id of a folder to which the node should be moved.nextSiblingId
- a String
id of a sibling node (folder or channel) prior to which the node should be placed. (null
to append at the end)
boolean
value noting if the operation was successful
PortalException
- if an error occurspublic boolean deleteNode(java.lang.String nodeId) throws PortalException
IUserLayoutManager
deleteNode
in interface IUserLayoutManager
nodeId
- a String
id (channel subscribe id or folder id)
boolean
value noting if the operation was successful
PortalException
- if an error occurspublic boolean updateNode(IUserLayoutNodeDescription node) throws PortalException
IUserLayoutManager
updateNode
in interface IUserLayoutManager
node
- an UserLayoutNodeDescription
value with a valid id.
boolean
value noting if the operation was successful
PortalException
- if an error occurspublic boolean canAddNode(IUserLayoutNodeDescription node, java.lang.String parentId, java.lang.String nextSiblingId) throws PortalException
IUserLayoutManager
canAddNode
in interface IUserLayoutManager
node
- an UserLayoutNodeDescription
value describing the node to be added.parentId
- a String
id of a parent to which the node to be added.nextSiblingId
- a String
id of a sibling prior to which the node to be inserted. (null
to append at the end)
boolean
value
PortalException
- if an error occurspublic boolean canMoveNode(java.lang.String nodeId, java.lang.String parentId, java.lang.String nextSiblingId) throws PortalException
IUserLayoutManager
canMoveNode
in interface IUserLayoutManager
nodeId
- a String
id of a node to be moved.parentId
- a String
id of a parent to which the node to be moved.nextSiblingId
- a String
id of a sibling prior to which the node is to be inserted (null
to append at the end)
boolean
value
PortalException
- if an error occurspublic boolean canDeleteNode(java.lang.String nodeId) throws PortalException
IUserLayoutManager
canDeleteNode
in interface IUserLayoutManager
nodeId
- a String
node id.
boolean
value
PortalException
- if an error occurspublic boolean canUpdateNode(IUserLayoutNodeDescription node) throws PortalException
IUserLayoutManager
canUpdateNode
in interface IUserLayoutManager
node
- a IUserLayoutNodeDescription
node id.
boolean
value
PortalException
- if an error occurspublic void markAddTargets(IUserLayoutNodeDescription node) throws PortalException
IUserLayoutManager
getUserLayout
method is called.
markAddTargets
in interface IUserLayoutManager
node
- an UserLayoutNodeDescription
value or null
to stop outputting add markings.
PortalException
- if an error occurspublic void markMoveTargets(java.lang.String nodeId) throws PortalException
IUserLayoutManager
getUserLayout
method is called.
markMoveTargets
in interface IUserLayoutManager
nodeId
- a String
value or null
to stop outputting move markings.
PortalException
- if an error occurspublic java.lang.String getParentId(java.lang.String nodeId) throws PortalException
IUserLayoutManager
getParentId
in interface IUserLayoutManager
nodeId
- a String
value
String
value
PortalException
- if an error occurspublic java.util.Enumeration getChildIds(java.lang.String nodeId) throws PortalException
IUserLayoutManager
getChildIds
in interface IUserLayoutManager
nodeId
- a String
value
List
of String
child node Ids.
PortalException
- if an error occurspublic java.lang.String getNextSiblingId(java.lang.String nodeId) throws PortalException
IUserLayoutManager
getNextSiblingId
in interface IUserLayoutManager
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
IUserLayoutManager
getPreviousSiblingId
in interface IUserLayoutManager
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
IUserLayoutManager
getCacheKey
in interface IUserLayoutManager
String
value
PortalException
- if an error occurspublic int getLayoutId()
IUserLayoutManager
getLayoutId
in interface IUserLayoutManager
int
layout Id value;public java.lang.String getRootFolderId()
IUserLayoutManager
getRootFolderId
in interface IUserLayoutManager
String
valuepublic int getDepth(java.lang.String nodeId) throws PortalException
getDepth
in interface IUserLayoutManager
nodeId
- a String
value
PortalException
- if an error occurspublic IUserLayoutNodeDescription createNodeDescription(int nodeType) throws PortalException
IUserLayoutManager
IUserLayoutNodeDescription
instance
createNodeDescription
in interface IUserLayoutManager
nodeType
- a node type constant from IUserLayoutNodeDescription
interface
IUserLayoutNodeDescription
instance
PortalException
- if the error occurs.public boolean addLayoutEventListener(LayoutEventListener l)
IUserLayoutManager
addLayoutEventListener
in interface IUserLayoutManager
l
- a LayoutEventListener
object
boolean
success statuspublic boolean removeLayoutEventListener(LayoutEventListener l)
IUserLayoutManager
removeLayoutEventListener
in interface IUserLayoutManager
l
- a LayoutEventListener
object
boolean
success statuspublic java.lang.String getFname(java.lang.String subId)
subId
- the subscribe id to lookup
public java.lang.String getSubscribeId(java.lang.String fname) throws PortalException
getSubscribeId
in interface IUserLayoutManager
fname
- the functional name to lookup
PortalException
public java.lang.String getFocusedId()
public void setFocusedId(java.lang.String subscribeId)
subscribeId
- Id to be set as focused.
|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |