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

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

Deprecated. All IChannel implementations should be migrated to portlets

@Deprecated
public class Config
extends Object

Represents configuration of the JSP Tree control.

Author:

Mark Boyd

Constructor Summary

Config()
Deprecated. Returns an instance of Config with suitable defaults for rendering a very limited view of the tree hierarchy.

Method Summary

void	addSurrogate(ISurrogate surrogate) Deprecated. Adds a surrogate suitable for handling translation of tree semantics to calls to a domain object of specific types.
IDomainActionSet	getActionSet() Deprecated. Returns the plugged-in implementation of IDomainActionSet.
String[]	getDomainActions() Deprecated. Returns the set of supported domain action identifiers.
Map	getImages() Deprecated.
boolean	getIncludeUnresolveables() Deprecated.
String	getLabelRenderer() Deprecated. Returns the web application context relative path to a JSP for rendering node and action labels for the tree.
boolean	getLazilyLoad() Deprecated.
String	getRenderer() Deprecated. Returns the web application context relative path to the tree renderer JSP that knows how to render a tree using the classes in this package.
boolean	getShowBranches() Deprecated.
Map	getTreeUrlResolvers() Deprecated.
boolean	getViewContainment() Deprecated.
void	setActionSet(IDomainActionSet actionSet) Deprecated.
void	setImages(Map types) Deprecated.
void	setIncludeUnresolveables(boolean includeUnresolveables) Deprecated.
void	setLabelRenderer(String labelRenderer) Deprecated. Sets the required, web application context relative path to a JSP for rendering action, node, and aspect labels.
void	setLazilyLoad(boolean b) Deprecated.
void	setShowBranches(boolean showBranches) Deprecated.
void	setTreeUrlResolver(ITreeActionUrlResolver resolver) Deprecated.
void	setViewContainment(boolean b) Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

Config

public Config()

Deprecated.

Returns an instance of Config with suitable defaults for rendering a very limited view of the tree hierarchy. Most default settings will be overridden for all implementations. By default there are no supported domain actions. The default surrogate uses hash codes for identifiers and returns the value of toString() for labels. Default label rendering treats the value returned from getlabelData and any registered implementations of ISurrogate or IDomainActionSet as a String and embeds that value as-is in the generated tree. The default image set will most likely not be accessible since its image paths are relative to these classes and do not take into consideration the web application architecture in which the tree is being rendered. By default branches are shown from parents to children, unresolveable domain objects are not show in the tree, containment is not portrayed, and domain objects are resolved through lazy loading.

Method Detail

getRenderer

public String getRenderer()

Deprecated.

Returns the web application context relative path to the tree renderer JSP that knows how to render a tree using the classes in this package.

Returns:

getDomainActions

public String[] getDomainActions()

Deprecated.

Returns the set of supported domain action identifiers.

Returns:

Returns the actions.

setLabelRenderer

public void setLabelRenderer(String labelRenderer)

Deprecated.

Sets the required, web application context relative path to a JSP for rendering action, node, and aspect labels. To this JSP will be passed the TreeModel, the current TreeNode, the type of label being rendered, and for actions the current action. These are accessible in the called JSP via:

   TreeModel = ${requestScope.model}
   Current TreeNode = ${requestScope.model.node}
   Label Type = ${requestScope.model.labelType} = ['action'|'node'|'aspect']
   Current Action = ${requestScope.model.action}
 

Parameters:

labelRenderer -

getLabelRenderer

public String getLabelRenderer()

Deprecated.

Returns the web application context relative path to a JSP for rendering node and action labels for the tree. Called by the tree renderer JSP to include the contents of the rendered label.

Returns:

addSurrogate

public void addSurrogate(ISurrogate surrogate)

Deprecated.

Adds a surrogate suitable for handling translation of tree semantics to calls to a domain object of specific types.

Parameters:

surrogate -

getImages

public Map getImages()

Deprecated.

setImages

public void setImages(Map types)

Deprecated.

getViewContainment

public boolean getViewContainment()

Deprecated.

setViewContainment

public void setViewContainment(boolean b)

Deprecated.

getShowBranches

public boolean getShowBranches()

Deprecated.

Returns:

Returns the showBranches.

setShowBranches

public void setShowBranches(boolean showBranches)

Deprecated.

Parameters:

showBranches - The showBranches to set.

getActionSet

public IDomainActionSet getActionSet()

Deprecated.

Returns the plugged-in implementation of IDomainActionSet.

Returns:

setActionSet

public void setActionSet(IDomainActionSet actionSet)

Deprecated.

getTreeUrlResolvers

public Map getTreeUrlResolvers()

Deprecated.

setTreeUrlResolver

public void setTreeUrlResolver(ITreeActionUrlResolver resolver)

Deprecated.

setIncludeUnresolveables

public void setIncludeUnresolveables(boolean includeUnresolveables)

Deprecated.

getIncludeUnresolveables

public boolean getIncludeUnresolveables()

Deprecated.

getLazilyLoad

public boolean getLazilyLoad()

Deprecated.

setLazilyLoad

public void setLazilyLoad(boolean b)

Deprecated.