com.plumtree.remote.sci
Class SciTreeElement

java.lang.Object
  com.plumtree.remote.sci.SciTreeElement

All Implemented Interfaces:

ISciElement

public class SciTreeElement

extends java.lang.Object

implements ISciElement

Represents an element that displays a tree view of directories (for example, a file system or database).

Constructor Summary

SciTreeElement(ITreeIterator treeIterator, java.lang.String formName, java.lang.String formValue, java.lang.String repostLocation, java.lang.String repostRoot, java.lang.String rootDisplayName, boolean chooseRoot, java.lang.String rootImage, java.lang.String emptyMessage, java.lang.String noSelectionMessage, int columns)
Valued Constructor

Method Summary

org.w3c.dom.Node	getRootNode() Gets the root Node to add to the page.
java.lang.String	toString() Writes the element to a string for debugging.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SciTreeElement

public SciTreeElement(ITreeIterator treeIterator,
                      java.lang.String formName,
                      java.lang.String formValue,
                      java.lang.String repostLocation,
                      java.lang.String repostRoot,
                      java.lang.String rootDisplayName,
                      boolean chooseRoot,
                      java.lang.String rootImage,
                      java.lang.String emptyMessage,
                      java.lang.String noSelectionMessage,
                      int columns)

Valued Constructor

Parameters:

treeIterator - iterator for particular directory

formName - name of the field; should be uppercase as the portal will uppercase all names in the NamedValue[] returned by IAdminEditor.finalize().

formValue - the default field value

repostLocation - the location to repost to (for example, a subfolder)

repostRoot - the programmatic name of the root location

rootDisplayName - the display name of the root location

chooseRoot - whether or not the root is selectable

rootImage - the image to display for for the root

emptyMessage - the JavaScript message to display if there are no Nodes in this 'folder'

noSelectionMessage - the JavaScript message to display if nothing is selected

columns - the number of columns to display

Method Detail

getRootNode

public org.w3c.dom.Node getRootNode()

Gets the root Node to add to the page.

Specified by:

getRootNode in interface ISciElement

Returns:

root Node

toString

public java.lang.String toString()

Writes the element to a string for debugging.

Returns:

string