JClass DesktopViews 6.3.0 API
Documentation

com.klg.jclass.datasource.beans
Class JCTreeData

java.lang.Object
  |
  +--com.klg.jclass.datasource.TreeData
        |
        +--com.klg.jclass.datasource.beans.JCTreeData
All Implemented Interfaces:
DataModel, Serializable
Direct Known Subclasses:
IdeJCTreeData

public class JCTreeData
extends TreeData
implements Serializable

This Bean creates a hierarchical structure of data. It supports different data source objects.

See Also:
NodeProperties, Serialized Form

Field Summary
protected  Applet applet
          The parent applet.
protected  com.klg.jclass.datasource.beans.MetaDataCreator metaDataCreator
           
protected  String name
          Name of the Bean.
 
Fields inherited from class com.klg.jclass.datasource.TreeData
currentBookmark, currentDataTable, data_tree, eventsEnabled, listeners, meta_tree, modelName, nameCounter
 
Constructor Summary
JCTreeData()
           
JCTreeData(Applet applet, String name)
          Creates a JCTreeData which reads parameters from the applet's HTML file.
JCTreeData(int type)
           
 
Method Summary
 void addDataModelListener(com.klg.jclass.datasource.DataModelListener listener)
          implements DataModel method addDataModelListener.
protected  void createMetaData()
          Creates meta data for the tree data Bean.
 String getAbout()
          Gets the about property.
 AppletContext getAppletContext()
          Gets the Bean's applet's context.
static AppletContext getAppletContext(Applet applet)
          Gets the Bean's applet's context.
 String getName()
          Gets the name of the Bean, as set in the constructor or by setName.
protected  void getParameters()
          Reads the parameter values from the HTML page using the tree data Bean's applet.
 void getParameters(Applet applet)
          Reads the parameter values from the HTML page using the specified applet.
 void getParameters(Applet applet, String file)
          Reads the parameter values from the file.
 com.klg.jclass.datasource.beans.TreeProperties getTreeProperties()
          Gets TreeProperties property.
 String getVersion()
          Gets the value of the Version property.
 void setAbout(String s)
          about property is read-only.
 void setModelName(String s)
          Sets the model name of the tree data Bean.
 void setName(String name)
          Sets the name of the Bean.
 void setTreeProperties(String resource_name, ClassLoader cl)
          Sets the tree data Bean component using a serialization file.
 void setTreeProperties(com.klg.jclass.datasource.beans.TreeProperties comp)
          Sets TreeProperties property.
 void setVersion(String s)
          Version property is read-only.
 
Methods inherited from class com.klg.jclass.datasource.TreeData
cancelAll, clearCurrentPath, clearDataTableTreeInternalData, clearDataTableTreeUserData, enableDataModelEvents, fireDataModelEvent, fireDataModelEvent, fireDataModelEventInternal, getCurrentDataItem, getCurrentDataTable, getCurrentGlobalBookmark, getCurrentGlobalTable, getDataTableTree, getEventsEnabled, getListeners, getMetaData, getMetaDataTree, getModelName, isModified, moveToRow, moveToRow, removeDataModelListener, requeryAll, sendDataModelEvent, updateAll
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

applet

protected transient Applet applet
The parent applet.


name

protected String name
Name of the Bean.


metaDataCreator

protected com.klg.jclass.datasource.beans.MetaDataCreator metaDataCreator
Constructor Detail

JCTreeData

public JCTreeData()

JCTreeData

public JCTreeData(int type)

JCTreeData

public JCTreeData(Applet applet,
                  String name)
Creates a JCTreeData which reads parameters from the applet's HTML file.

Parameters:
applet - the applet whose PARAM tags are to be read
name - if this is not null, only parameters preceded by this name are read
See Also:
Applet.getParameter(java.lang.String)
Method Detail

getName

public String getName()
Gets the name of the Bean, as set in the constructor or by setName. If no name has been set, a 0-length String will be returned.

Returns:
See Also:
setName(java.lang.String)

setName

public void setName(String name)
Sets the name of the Bean.

Parameters:
name - Bean name

getParameters

public void getParameters(Applet applet)
Reads the parameter values from the HTML page using the specified applet. The values will override those previously set.

Parameters:
applet -
See Also:
Applet.getParameter(java.lang.String)

getParameters

public void getParameters(Applet applet,
                          String file)
Reads the parameter values from the file. The values will override those previously set.

Parameters:
applet - if not null and in a browser, its documentBase() is used to construct a complete filename if necessary
file - if an http protocol is not specified (if a ":" is not present), the current working directory is used

getAppletContext

public AppletContext getAppletContext()
Gets the Bean's applet's context. The applet context lets an applet control the applet's environment, which is usually the browser or the applet viewer.

Returns:
null if the component is not in an applet or the applet is not in a browser
See Also:
Applet.getAppletContext()

getAppletContext

public static AppletContext getAppletContext(Applet applet)
Gets the Bean's applet's context. The applet context lets an applet control the applet's environment, which is usually the browser or the applet viewer.

Parameters:
applet -
Returns:
null if the component is not in an applet or the applet is not in a browser.
See Also:
Applet.getAppletContext()

getAbout

public String getAbout()
Gets the about property. The about property displays contact information for Quest Software.

Returns:
the about propety

setAbout

public void setAbout(String s)
about property is read-only.

Parameters:
s -

getVersion

public String getVersion()
Gets the value of the Version property. The Version property specifies the JClass version number.

Returns:

setVersion

public void setVersion(String s)
Version property is read-only.

Parameters:
s -

setModelName

public void setModelName(String s)
Sets the model name of the tree data Bean.

Specified by:
setModelName in interface DataModel
Overrides:
setModelName in class TreeData
Parameters:
s -

setTreeProperties

public void setTreeProperties(com.klg.jclass.datasource.beans.TreeProperties comp)
                       throws DataModelException
Sets TreeProperties property.

Parameters:
comp -
Throws:
DataModelException - If fails to create a meta data.

getTreeProperties

public com.klg.jclass.datasource.beans.TreeProperties getTreeProperties()
Gets TreeProperties property.

Returns:
See Also:
setTreeProperties(com.klg.jclass.datasource.beans.TreeProperties)

setTreeProperties

public void setTreeProperties(String resource_name,
                              ClassLoader cl)
                       throws DataModelException
Sets the tree data Bean component using a serialization file.

Parameters:
resource_name - resource name relative to a class loader to the tree data Bean component
cl - class loader used to get the resource
Throws:
DataModelException - If fails to create a meta data.

addDataModelListener

public void addDataModelListener(com.klg.jclass.datasource.DataModelListener listener)
implements DataModel method addDataModelListener.

Specified by:
addDataModelListener in interface DataModel
Overrides:
addDataModelListener in class TreeData
Parameters:
listener -
See Also:
DataModelListener

createMetaData

protected void createMetaData()
                       throws DataModelException
Creates meta data for the tree data Bean.

Throws:
DataModelException - If fails to create a meta data.

getParameters

protected void getParameters()
Reads the parameter values from the HTML page using the tree data Bean's applet. The values will override those previously set. Subclasses may override this method to set their own values; in this case, the method should first call super.getParameters().


Copyright © 2004 Quest Software Inc..
All rights reserved.