org.jasig.portal.channels.jsp.tree
Class Model

java.lang.Object
  org.jasig.portal.channels.jsp.tree.Model

Deprecated. All IChannel implementations should be migrated to portlets

@Deprecated
public class Model
extends Object

Author:

Mark Boyd TODO To change the template for this generated type comment go to Window - Preferences - Java - Code Style - Code Templates

Constructor Summary

Model(Config cfg)
Deprecated.

Method Summary

int	getActionLabelType() Deprecated.
int	getAspectLabelType() Deprecated.
Config	getConfig() Deprecated.
String	getDomainAction() Deprecated. Returns the current domain action being rendered by the tree.
List	getIndentImages() Deprecated.
Object	getLabelData() Deprecated. Returns the object acquired from implementations of one of two plugged-in interfaces depending on the label type being rendered.
int	getLabelType() Deprecated. Returns the current label type rendering being requested of the label renderer by the tree renderer.
Node	getNode() Deprecated. Returns the currently rendering node.
Node	getNodeForId(String id) Deprecated. returns the node with the specified id in the root node.
static Node	getNodeForId(String id, Node nodeToSearch) Deprecated. returns the node with the specified id in the specified node.
int	getNodeLabelType() Deprecated.
String	getPopIndent() Deprecated.
Node	getRoot() Deprecated. Returns the root node of the tree.
boolean	getStartRendering() Deprecated. The first time called this method marks this model as being in the midst of rendering and returns true.
Map	getTreeUrls() Deprecated. Used in the tree rendering JSP to translate supported JSP Map semantics to dynamic lookup of an expansion and collapse URLs for a passed in node id.
void	setDomainAction(String action) Deprecated. Sets the current domain action being rendered by the tree.
void	setExpandedForId(String id, boolean expanded) Deprecated. sets whether or not the specified node is expanded.
void	setIsRendering(boolean b) Deprecated. Marks this model as not being in the midst of rendering.
void	setLabelType(int labelType) Deprecated. Sets the current label type being requested of the label renderer by the tree renderer.
void	setNode(Node node) Deprecated. Sets the currently rendering node.
void	setPushIndent(String indentType) Deprecated.
void	setRootDomainObject(Object root) Deprecated. Sets the root object to be translated into the root node of the tree.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Model

public Model(Config cfg)

Deprecated.

Method Detail

getNodeForId

public Node getNodeForId(String id)

Deprecated.

returns the node with the specified id in the root node. if the id passed in to this method is the root node's id than the root node is returned.

Parameters:

id - the id to search for.

Returns:

the node with the specified id.

getNodeForId

public static Node getNodeForId(String id,
                                Node nodeToSearch)

Deprecated.

returns the node with the specified id in the specified node. if the node does not have children and the node's id is not the specified id than null is returned. if the specified id is not found in this node's hierarchy than null is returned. otherwise, the node with the specified id is returned. if more than one node in this hierarchy is found, it uses the first one it encounters.

Parameters:

id - the id to search for.

nodeToSearch - the node to search for id in.

Returns:

the node with the specified id, or null if none is found.

setExpandedForId

public void setExpandedForId(String id,
                             boolean expanded)

Deprecated.

sets whether or not the specified node is expanded.

Parameters:

id - the id of the container

expanded - whether or not it is expanded.

Throws:

IllegalArgumentException - if the node specified by id is not a container or if there is no node with the specified id.

NullPointerException - if id is null.

setRootDomainObject

public void setRootDomainObject(Object root)

Deprecated.

Sets the root object to be translated into the root node of the tree.

Parameters:

root - The root to set.

getConfig

public Config getConfig()

Deprecated.

getIndentImages

public List getIndentImages()

Deprecated.

setPushIndent

public void setPushIndent(String indentType)

Deprecated.

getPopIndent

public String getPopIndent()

Deprecated.

getLabelData

public Object getLabelData()

Deprecated.

Returns the object acquired from implementations of one of two plugged-in interfaces depending on the label type being rendered. If label type is the same as the value returned by getNodeLabelType() or getAspectLabelType() then the returned object is acquired from the instance of ISurrogate that resolved the Node represented by getNode(). If the label type is the same as the value returned by getActionLabelType() then the returned object is acquired from the instance of IDomainActionSet.

Returns:

getTreeUrls

public Map getTreeUrls()

Deprecated.

Used in the tree rendering JSP to translate supported JSP Map semantics to dynamic lookup of an expansion and collapse URLs for a passed in node id. The following pattern in the JSP will cause this method to be called to obtain the Map represented by "treeUrls".

getStartRendering

public boolean getStartRendering()

Deprecated.

The first time called this method marks this model as being in the midst of rendering and returns true. Thereafter, it returns false until stopRendering has been called. This method is called by the JSP to learn if rendering started as a result of making this call. The method name was chosen for the resulting access in the JSP and is misleading when viewed here in the code.

Returns:

Returns true if the JSP is rendering the model.

setIsRendering

public void setIsRendering(boolean b)

Deprecated.

Marks this model as not being in the midst of rendering. This method is called by the JSP to indicate that rendering has completed The method name was chosen for the resulting access in the JSP and is misleading when viewed here in the code since it does have side affects from being called.

getRoot

public Node getRoot()

Deprecated.

Returns the root node of the tree.

Returns:

Returns the root.

getNode

public Node getNode()

Deprecated.

Returns the currently rendering node. Called by the JSP renderer.

Returns:

Returns the node.

setNode

public void setNode(Node node)

Deprecated.

Sets the currently rendering node. Called by the JSP renderer.

Parameters:

node - The node to set.

getDomainAction

public String getDomainAction()

Deprecated.

Returns the current domain action being rendered by the tree. This is called by the required label renderer JSP identified via getLabelRenderer().

Returns:

setDomainAction

public void setDomainAction(String action)

Deprecated.

Sets the current domain action being rendered by the tree. This is called by tree renderer to pass to the label renderer the action whose label is to be rendered. The required label renderer JSP is identified via getLabelRenderer().

getLabelType

public int getLabelType()

Deprecated.

Returns the current label type rendering being requested of the label renderer by the tree renderer. This is called by the required label renderer JSP identified via getLabelRenderer().

Returns:

getActionLabelType

public int getActionLabelType()

Deprecated.

getNodeLabelType

public int getNodeLabelType()

Deprecated.

getAspectLabelType

public int getAspectLabelType()

Deprecated.

setLabelType

public void setLabelType(int labelType)

Deprecated.

Sets the current label type being requested of the label renderer by the tree renderer. This is called by tree renderer to pass to the label renderer the label type to be rendered. The required label renderer JSP is identified via getLabelRenderer().