| Method Summary |
|
| public boolean | addLayoutEventListener(LayoutEventListener l)
|
| public IUserLayoutNodeDescription | addNode(IUserLayoutNodeDescription node, String parentId, String nextSiblingId)
Add a new node to a current user layout.
Parameters:
node - an UserLayoutNodeDescription value of a node to be added (Id doesn't have to be set)
Parameters:
parentId - a String id of a folder to which the new node (channel or folder) should be added.
Parameters:
nextSiblingId - a String an id of a sibling node (channel or folder) prior to which the new node should be inserted. |
| public boolean | canAddNode(IUserLayoutNodeDescription node, String parentId, String nextSiblingId)
Test if a particular node can be added at a given location.
Parameters:
node - an UserLayoutNodeDescription value describing the node to be added.
Parameters:
parentId - a String id of a parent to which the node to be added.
Parameters:
nextSiblingId - a String id of a sibling prior to which the node to be inserted. |
| public boolean | canDeleteNode(String nodeId)
Tests if a particular node can be deleted.
Parameters:
nodeId - a String node id. |
| public boolean | canMoveNode(String nodeId, String parentId, String nextSiblingId)
Test if a particular node can be moved to a given location. |
| public boolean | canUpdateNode(IUserLayoutNodeDescription node)
Test if a certain node can be updated.
Parameters:
node - a IUserLayoutNodeDescription node id. |
| public IUserLayoutNodeDescription | createNodeDescription(int nodeType)
|
| public boolean | deleteNode(String nodeId)
Delete a node (folder or a channel) from a user layout. |
| public String | getCacheKey()
Return a cache key, uniqly corresponding to the composition and the structure of the user layout. |
| public Enumeration | getChildIds(String nodeId)
Returns a list of child node Ids for a given node. |
| public int | getDepth(String nodeId)
Returns the depth of a node in the layout tree. |
| public int | getLayoutId()
|
| public String | getNextSiblingId(String nodeId)
Determine an Id of a next sibling node. |
| public IUserLayoutNodeDescription | getNode(String nodeId)
Obtain a description of a node (channel or a folder) in a given user layout.
Parameters:
nodeId - a String channel subscribe id or folder id. |
| public String | getParentId(String nodeId)
Returns an Id of a parent user layout node. |
| public String | getPreviousSiblingId(String nodeId)
Determine an Id of a previous sibling node. |
| public String | getRootFolderId()
Returns an id of the root folder. |
| public String | getSubscribeId(String fname)
Returns a subscription id using the supplied functional name. |
| public IUserLayout | getUserLayout()
Gets a user layout (with appropriate markings). |
| public void | getUserLayout(ContentHandler ch)
|
| public void | getUserLayout(String nodeId, ContentHandler ch)
|
| public Document | getUserLayoutDOM()
|
| public void | loadUserLayout()
|
| public void | markAddTargets(IUserLayoutNodeDescription node)
Ask manager to output markings at the locations where a given node can be added. |
| public void | markMoveTargets(String nodeId)
Ask manager to output markings at the locations where a given node can be moved. |
| public boolean | moveNode(String nodeId, String parentId, String nextSiblingId)
Move a node (channel or folder) from one location to another.
Parameters:
nodeId - a String value of a node Id.
Parameters:
parentId - a String id of a folder to which the node should be moved.
Parameters:
nextSiblingId - a String id of a sibling node (folder or channel) prior to which the node should be placed. |
| public void | processLayoutParameters(IPerson person, UserPreferences userPrefs, HttpServletRequest req)
Allows layout manager specific handling of user request parameter
processing potentially including passing of specific parameters to the
structure and theme transformations via the user preferences object. |
| public boolean | removeLayoutEventListener(LayoutEventListener l)
Remove a registered layout event listener. |
| public void | saveUserLayout()
|
| public void | setLayoutStore(IUserLayoutStore ls)
Set a user layout store implementation. |
| public void | setUserLayout(IUserLayout userLayout)
Sets a user layout (with appropriate markings). |
| public boolean | updateNode(IUserLayoutNodeDescription node)
Update a given node.
Parameters:
node - an UserLayoutNodeDescription value with a valid id. |