com.sas.servlet.beans.javascript
Interface TreeControlInterface

All Known Implementing Classes:
TreeControl

public interface TreeControlInterface
extends TransformationInterface

Transformation bean definition for creating a TreeControl implemented using JavaScript. A TreeControl is an tree menu that displays hierarchical information. The TreeControl allows the user to expand and colapse nodes on the tree. The TreeControl can use any model that implements the com.sas.sasserver.jstree.JSTreeNodesInterface.

See Also:
JSTreeNodesInterface, JSTreeInterface

Field Summary
static int IMAGES
           
static int NO_IMAGES
           
 
Method Summary
 int getDisplayStyle()
          Returns the display style for the tree.
 String getFrame()
          Returns the value of the FRAME= argument used on the anchor tags generated.
 String getImagesLocation()
          Returns the location(directory) of the images needed to construct the Tree.
 boolean getUseTextAsLink()
          Returns whether or not the text descriptions in the tree are links or plain text.
 void setDisplayStyle(int style)
          Sets the display style for the tree.
 void setFrame(String frm)
          Sets the value of the FRAME= argument used on the anchor tags generated.
 void setImagesLocation(String imageLocation)
          Sets the location(web server defined directory) of the images needed to construct the Tree.
 void setUseTextAsLink(boolean textAsLink)
          Determines if the text descriptions in the tree are links or plain text.
 
Methods inherited from interface com.sas.servlet.beans.TransformationInterface
getCustomAttributes, getDescription, getName, getParent, getRequest, getResponse, setCustomAttributes, setDescription, setName, setParent, setRequest, setResponse, write, write, write, write
 
Methods inherited from interface com.sas.ComponentInterface
addPropertyChangeListener, addVetoableChangeListener, anyPropertyChangeListeners, dumpComponent, firePropertyChange, firePropertyChange, fireVetoableChange, getComponentDescription, getComponentSupportInfo, initialize, initializeComponent, isDesignTime, removePropertyChangeListener, removeVetoableChangeListener, setComponentDescription, setComponentSupportInfo, setDefaultValues
 
Methods inherited from interface com.sas.ViewInterface
attachModel, detachModel, getModelInterface, getRequiredInterfaces, getViewInterfaceSupportInfo, refresh, removeInterfaceTraps, setModelInterface, setRequiredInterfaces, setViewInterfaceSupportInfo, supportsRequiredInterfaces, trapInterfaceEvents
 
Methods inherited from interface com.sas.ModelInterface
attachView, detachView
 
Methods inherited from interface com.sas.LinkPropertiesInterface
addLink, getLinkInfo, isLinked, queryLinks, queryLinks, removeAllLinks, removeLink, setLinkInfo
 
Methods inherited from interface java.beans.PropertyChangeListener
propertyChange
 
Methods inherited from interface java.io.ObjectInputValidation
validateObject
 

Field Detail

NO_IMAGES

public static final int NO_IMAGES

IMAGES

public static final int IMAGES
Method Detail

getDisplayStyle

public int getDisplayStyle()
Returns the display style for the tree. The two possible values for display style are com.sas.servlet.beans.javascript.TreeControlInterface.NO_IMAGES and com.sas.servlet.beans.javascript.TreeControlInterface.IMAGES.
Returns:
the display style for the tree.
See Also:
setDisplayStyle(int)

setDisplayStyle

public void setDisplayStyle(int style)
Sets the display style for the tree. The two possible values for display style are com.sas.servlet.beans.javascript.TreeControlInterface.NO_IMAGES and com.sas.servlet.beans.javascript.TreeControlInterface.IMAGES.
Parameters:
style - - the new value for the display style
See Also:
getDisplayStyle()

getImagesLocation

public String getImagesLocation()
Returns the location(directory) of the images needed to construct the Tree. The location can be a fully qualified URL or a relative location.
Returns:
the location of the needed images
See Also:
setImagesLocation(java.lang.String)

setImagesLocation

public void setImagesLocation(String imageLocation)
Sets the location(web server defined directory) of the images needed to construct the Tree. The location can be a fully qualified URL or a relative location.
Parameters:
imageLocation - - the location of the needed images
See Also:
getImagesLocation()

getUseTextAsLink

public boolean getUseTextAsLink()
Returns whether or not the text descriptions in the tree are links or plain text.
Returns:
true if text descriptions are displayed as links, false otherwise.
See Also:
setUseTextAsLink(boolean)

setUseTextAsLink

public void setUseTextAsLink(boolean textAsLink)
Determines if the text descriptions in the tree are links or plain text.
Parameters:
textAsLink - - true to use the text descriptions as links, false otherwise.
See Also:
setDisplayStyle(int), getUseTextAsLink()

getFrame

public String getFrame()
Returns the value of the FRAME= argument used on the anchor tags generated. This value determines where/how the links associated with the nodes on the tree are displayed. The default value is _blank which will cause a new browser window to be opened each time a node is clicked on.
Returns:
FRAME= argument of each folders anchor tag.
See Also:
setFrame(java.lang.String)

setFrame

public void setFrame(String frm)
Sets the value of the FRAME= argument used on the anchor tags generated. This value determines where/how the links associated with the nodes on the tree are displayed. The default value is _blank which will cause a new browser window to be opened each time a node is clicked on.
Returns:
FRAME= argument of each folders anchor tag.
See Also:
getFrame()


Version: 1.2.20000317.001 Formatted: 2000/07/06 15:57:33PM