net.ontopia.topicmaps.nav2.servlets
Class TreeWidget

java.lang.Object
  net.ontopia.topicmaps.nav2.servlets.TreeWidget

Deprecated. Use the version in nav2.utils. This version will be removed soon.

public class TreeWidget
extends java.lang.Object

EXPERIMENTAL: This class is highly experimental. We recommend that you not use this class. If you do, expect it to break in the next version.

Since:

2.0

Field Summary

protected static int	CLOSE Deprecated.
protected static int	CLOSE_ALL Deprecated.
protected static int	EXPAND_ALL Deprecated.
protected java.lang.String	imageurl Deprecated.
protected java.lang.String	nodepage Deprecated.
protected static int	OPEN Deprecated.
protected java.util.Set	openNodes Deprecated.
protected QueryProcessorIF	processor Deprecated.
protected java.lang.String	staticurl Deprecated.
protected static int	WINDOW_SIZE Deprecated.
protected int	windowSize Deprecated.

Constructor Summary

TreeWidget(TopicMapIF topicmap, java.lang.String query, java.lang.String topquery, java.lang.String ownpage, java.lang.String nodepage)
Deprecated. Sets up the widget ready for use.

Method Summary

protected void	endRender(java.io.Writer out) Deprecated.
protected java.lang.String	getId(TopicIF topic) Deprecated.
protected TopicIF	getTopic(java.lang.String id) Deprecated.
protected java.lang.String	list(java.util.Set nodes) Deprecated.
void	loadRules(java.io.Reader rulereader) Deprecated. EXPERIMENTAL: We really don't recommend that you use this method.
protected void	renderBackButton(java.io.Writer out, int topline) Deprecated. EXPERIMENTAL: Renders the back button at the top/bottom of the form.
protected void	renderCloseAllButton(java.io.Writer out, int topline) Deprecated. EXPERIMENTAL: Renders the close all button at the top/bottom of the form.
protected void	renderExpandAllButton(java.io.Writer out, int topline) Deprecated. EXPERIMENTAL: Renders the expand all button at the top/bottom of the form.
protected void	renderForwardButton(java.io.Writer out, int topline) Deprecated. EXPERIMENTAL: Renders the close all button at the top/bottom of the form.
protected void	renderNode(TopicTreeNode node, java.io.Writer out) Deprecated. EXPERIMENTAL: This method renders the tree node, including its link, but not the button in front of the node.
protected void	renderNodeButton(int topline, int level, int action, java.lang.String id, java.io.Writer out) Deprecated. EXPERIMENTAL: Renders the +/- button in front of the node.
void	run(javax.servlet.jsp.PageContext ctxt, java.io.Writer writer) Deprecated. EXPERIMENTAL: Runs the widget, producing the output.
void	setAddAnchor(boolean addAnchor) Deprecated. EXPERIMENTAL: FIXME.
void	setImageUrl(java.lang.String imageurl) Deprecated. EXPERIMENTAL: The URL at which the graphics used by the widget are found.
void	setNodeFrame(java.lang.String nodeFrame) Deprecated. EXPERIMENTAL: The name of the HTML frame in which to open links to nodes.
void	setWidgetName(java.lang.String name) Deprecated. EXPERIMENTAL: The name of the session key in which the set of open nodes is stored.
void	setWindowSize(int windowSize) Deprecated. EXPERIMENTAL: FIXME
protected void	startRender(java.io.Writer out) Deprecated.
java.lang.String	toString(TopicIF topic) Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

OPEN

protected static final int OPEN

Deprecated.

See Also:

Constant Field Values

CLOSE

protected static final int CLOSE

Deprecated.

See Also:

Constant Field Values

EXPAND_ALL

protected static final int EXPAND_ALL

Deprecated.

See Also:

Constant Field Values

CLOSE_ALL

protected static final int CLOSE_ALL

Deprecated.

See Also:

Constant Field Values

WINDOW_SIZE

protected static final int WINDOW_SIZE

Deprecated.

See Also:

Constant Field Values

processor

protected QueryProcessorIF processor

Deprecated.

nodepage

protected java.lang.String nodepage

Deprecated.

staticurl

protected java.lang.String staticurl

Deprecated.

openNodes

protected java.util.Set openNodes

Deprecated.

imageurl

protected java.lang.String imageurl

Deprecated.

windowSize

protected int windowSize

Deprecated.

Constructor Detail

TreeWidget

public TreeWidget(TopicMapIF topicmap,
                  java.lang.String query,
                  java.lang.String topquery,
                  java.lang.String ownpage,
                  java.lang.String nodepage)
           throws InvalidQueryException

Deprecated.

Sets up the widget ready for use.

Parameters:

topicmap - The topic map being displayed.

query - A tolog query that given a node generates its children. Use the %parent% parameter to reference the parent node in the query. Make sure the query produces a 1-column result.

topquery - A tolog query that generates the list of top nodes. Make sure the query produces a 1-column result.

ownpage - The URI of the page the widget is on. The widget will append request parameters in the form "a=b&c=d&e=f..."

nodepage - The URI of of the page that shows the nodes.

Throws:

InvalidQueryException

Method Detail

setWidgetName

public void setWidgetName(java.lang.String name)

Deprecated.

EXPERIMENTAL: The name of the session key in which the set of open nodes is stored.

Since:

2.0.4

setImageUrl

public void setImageUrl(java.lang.String imageurl)

Deprecated.

EXPERIMENTAL: The URL at which the graphics used by the widget are found.

Since:

2.0.4

setAddAnchor

public void setAddAnchor(boolean addAnchor)

Deprecated.

EXPERIMENTAL: FIXME.

Since:

2.0.4

setWindowSize

public void setWindowSize(int windowSize)

Deprecated.

EXPERIMENTAL: FIXME

Since:

2.0.4

setNodeFrame

public void setNodeFrame(java.lang.String nodeFrame)

Deprecated.

EXPERIMENTAL: The name of the HTML frame in which to open links to nodes.

Since:

2.0.3

loadRules

public void loadRules(java.io.Reader rulereader)
               throws java.io.IOException,
                      InvalidQueryException

Deprecated.

EXPERIMENTAL: We really don't recommend that you use this method.

Throws:

java.io.IOException

InvalidQueryException

run

public void run(javax.servlet.jsp.PageContext ctxt,
                java.io.Writer writer)
         throws java.io.IOException,
                InvalidQueryException,
                NavigatorRuntimeException

Deprecated.

EXPERIMENTAL: Runs the widget, producing the output.

Throws:

java.io.IOException

InvalidQueryException

NavigatorRuntimeException

getTopic

protected TopicIF getTopic(java.lang.String id)

Deprecated.

getId

protected java.lang.String getId(TopicIF topic)

Deprecated.

list

protected java.lang.String list(java.util.Set nodes)

Deprecated.

toString

public java.lang.String toString(TopicIF topic)

Deprecated.

renderNode

protected void renderNode(TopicTreeNode node,
                          java.io.Writer out)
                   throws java.io.IOException

Deprecated.

EXPERIMENTAL: This method renders the tree node, including its link, but not the button in front of the node. Intended to be overridden by applications wanting to control rendering of nodes in detail.

Throws:

java.io.IOException

renderNodeButton

protected void renderNodeButton(int topline,
                                int level,
                                int action,
                                java.lang.String id,
                                java.io.Writer out)
                         throws java.io.IOException

Deprecated.

EXPERIMENTAL: Renders the +/- button in front of the node.

Throws:

java.io.IOException

renderBackButton

protected void renderBackButton(java.io.Writer out,
                                int topline)
                         throws java.io.IOException

Deprecated.

EXPERIMENTAL: Renders the back button at the top/bottom of the form.

Throws:

java.io.IOException

renderExpandAllButton

protected void renderExpandAllButton(java.io.Writer out,
                                     int topline)
                              throws java.io.IOException

Deprecated.

EXPERIMENTAL: Renders the expand all button at the top/bottom of the form.

Throws:

java.io.IOException

renderCloseAllButton

protected void renderCloseAllButton(java.io.Writer out,
                                    int topline)
                             throws java.io.IOException

Deprecated.

EXPERIMENTAL: Renders the close all button at the top/bottom of the form.

Throws:

java.io.IOException

renderForwardButton

protected void renderForwardButton(java.io.Writer out,
                                   int topline)
                            throws java.io.IOException

Deprecated.

EXPERIMENTAL: Renders the close all button at the top/bottom of the form.

Throws:

java.io.IOException

startRender

protected void startRender(java.io.Writer out)
                    throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

endRender

protected void endRender(java.io.Writer out)
                  throws java.io.IOException

Deprecated.

Throws:

java.io.IOException