com.sas.sasserver.tree
Interface RemoteServerNodeInterface

All Known Subinterfaces:

ServerNodeInterface

All Known Implementing Classes:

_rprxJ2ServerNode, _rprxRemoteDesignTimeServerNode, _rprxRemoteServerNodeClient

public interface RemoteServerNodeInterface

RemoteServerNodeInterface defines the SCL level interface of a remote ServerNodeInterface. This interface is used primarily for direct, internal communication with the remote SCL object. ServerNodeDelegate, which acts as the Adapter between the more public ServerNodeInterface and the remote SCL object, is the princical user of this interface. Most users of a remote server node/tree will use the public methods in com.sas.models.TreeInterface, com.sas.models.NodeInterface,

The RemoteServerNodeInterface is designed to provide more and com.sas.models.NodeIconInterface

To do: implement

 void _addNodeChild( ??? child, int index);
 

See Also:

TreeInterface, NodeInterface, NodeIconInterface

Field Summary

static java.lang.String	CHILDREN_KEY Key for the item which contains a possibly empty list of sublists.
static java.lang.String	CLASS_KEY Key for the String item which names the SCL class that should be instantiated should the cached node list not provide enough information.
static java.lang.String	contextClasspath Name of the default SAS/AF class which implements the remote tree.
static java.lang.String	EXPICON_KEY Key for the String item which names the icon to use for the node when the node is expanded or "open".
static java.lang.String	EXPSELICON_KEY Key for the String item which names the icon to use for the node when the node is selected and expanded.
static java.lang.String	EXPTEXT_KEY Key for the String item which names the text to used for the node when expanded in a tree.
static java.lang.String	ICON_KEY Key for the String item which names the icon to use for the node.
static java.lang.String	ID_KEY Key for the numeric item which names the object identifer of a remote SCL node object.
static java.lang.String	LEAF_KEY Key for the numeric item which is non zero if the node represented by this list is a leaf node, and 0 if the node represents a tree.
static java.lang.String	OTHERICONS_KEY Key for the String item which names the icon to use if the expanded, expandedSelected, or selected icons are null.
static java.lang.String	PARENTID_KEY
static java.lang.String	SELICON_KEY Key for the String item which names the icon to use for the node when the node is selected but not expanded.
static java.lang.String	TEXT_KEY Key for the String item which contains the node's text.
static java.lang.String	TYPE_KEY Key for the String item which defines the node type.

Method Summary

int	_countNodeChildren(int max) Count the node's children, but stop if a maximum is reached.
int	_getDefaultIcon() Retrieve this node's default icon, which is used to display the unexpanded node in a tree view.
int	_getExpandedIcon() Retrieve this node's expanded icon, which is used to display the expanded node in a tree view.
int	_getExpandedSelectedIcon() Retrieve this node's icon to be used when displaying the selected expanded node in a tree view.
int	_getNodeChildCount() Returns the number of children.
com.sas.collection.hlist.HListInterface	_getNodeChildren(int nodeIndex, int count) Obtain a list that describes the specified children of the current node.
java.lang.String	_getNodeExpandedText() Retrieve the text to display when this node is expanded.
java.lang.String	_getNodeText() Retrieve the text to display when this node is not expanded.
java.lang.String	_getNodeType() Retrieve this node's type, which is used to determine the node's icon if none is specified explicitly.
int	_getSelectedIcon() Retrieve this node's selected icon, which is used to display the selected unexpanded node in a tree view.
void	_initialize(com.sas.collection.hlist.HListInterface initList, int parentId, int descListId) Initialize the remote object based on the items in the initList.
boolean	_isLeafNode() Tell if the node is a leaf node.
void	_removeNodeChild(int index) Remove a child node.
void	_setDefaultIcon(int icon) Set this node's default icon, which is used to display the unexpanded node in a tree view.
void	_setExpandedIcon(int icon) Set this node's expanded icon, which is used to display the expanded node in a tree view.
void	_setExpandedSelectedIcon(int icon) Set this node's type, which is used when displaying the selected expanded node in a tree view.
void	_setNodeExpandedText(java.lang.String text) Set the text to display when this node is expanded.
void	_setNodeText(java.lang.String text) Set the text to display when this node is not expanded.
void	_setNodeType(java.lang.String type) Set this node's type, which is used to determine the node's icon if none is specified explicitly.
void	_setSelectedIcon(int icon) Set this node's selected icon, which is used to display the selected unexpanded node in a tree view.

Field Detail

contextClasspath

static final java.lang.String contextClasspath

Name of the default SAS/AF class which implements the remote tree.

See Also:

Constant Field Values

CLASS_KEY

static final java.lang.String CLASS_KEY

Key for the String item which names the SCL class that should be instantiated should the cached node list not provide enough information.

Items with names matching ID_KEY and CLASS_KEY are mutually exclusive

See Also:

_getNodeChildren(int, int), _initialize(com.sas.collection.hlist.HListInterface, int, int), Constant Field Values

ID_KEY

static final java.lang.String ID_KEY

Key for the numeric item which names the object identifer of a remote SCL node object. A client proxy SeverNodeInterface for the remote object is created only when necessary (i.e. when the list of data transmitted by _getNodeChildren is insufficient.)

Items with names matching ID_KEY and CLASS_KEY are mutually exclusive

See Also:

_getNodeChildren(int, int), Constant Field Values

TEXT_KEY

static final java.lang.String TEXT_KEY

Key for the String item which contains the node's text. This may be used as the label in a tree view.

See Also:

_getNodeChildren(int, int), Constant Field Values

TYPE_KEY

static final java.lang.String TYPE_KEY

Key for the String item which defines the node type.

See Also:

_getNodeChildren(int, int), TreeView.setIcon(java.lang.String, com.sas.visuals.IconInterface), Constant Field Values

EXPTEXT_KEY

static final java.lang.String EXPTEXT_KEY

Key for the String item which names the text to used for the node when expanded in a tree.

See Also:

_getNodeChildren(int, int), Constant Field Values

ICON_KEY

static final java.lang.String ICON_KEY

Key for the String item which names the icon to use for the node. This is an icon number assigned by the SAS System.

See Also:

_getNodeChildren(int, int), Constant Field Values

EXPICON_KEY

static final java.lang.String EXPICON_KEY

Key for the String item which names the icon to use for the node when the node is expanded or "open". This is an icon number assigned by the SAS System.

See Also:

_getNodeChildren(int, int), Constant Field Values

SELICON_KEY

static final java.lang.String SELICON_KEY

Key for the String item which names the icon to use for the node when the node is selected but not expanded. This is an icon number assigned by the SAS System.

See Also:

_getNodeChildren(int, int), Constant Field Values

EXPSELICON_KEY

static final java.lang.String EXPSELICON_KEY

Key for the String item which names the icon to use for the node when the node is selected and expanded. This is an icon number assigned by the SAS System.

See Also:

_getNodeChildren(int, int), Constant Field Values

OTHERICONS_KEY

static final java.lang.String OTHERICONS_KEY

Key for the String item which names the icon to use if the expanded, expandedSelected, or selected icons are null. This is normally a URL naming an image.

See Also:

_getNodeChildren(int, int), Constant Field Values

LEAF_KEY

static final java.lang.String LEAF_KEY

Key for the numeric item which is non zero if the node represented by this list is a leaf node, and 0 if the node represents a tree.

See Also:

_getNodeChildren(int, int), Constant Field Values

PARENTID_KEY

static final java.lang.String PARENTID_KEY

See Also:

Constant Field Values

CHILDREN_KEY

static final java.lang.String CHILDREN_KEY

Key for the item which contains a possibly empty list of sublists. Each sublist contains items describing a subnode of the current node. Items in that sublist are optional but use the item names stored in the static variables:

See Also:

_getNodeChildren(int, int), CLASS_KEY, ID_KEY, TEXT_KEY, TYPE_KEY, EXPTEXT_KEY, ICON_KEY, EXPICON_KEY, SELICON_KEY, EXPSELICON_KEY, LEAF_KEY, Constant Field Values

Method Detail

_getNodeChildren

com.sas.collection.hlist.HListInterface _getNodeChildren(int nodeIndex,
                                                         int count)

Obtain a list that describes the specified children of the current node. Each child is described by a sublist in this returned list.

Parameters:

nodeIndex - the index of the first subnode to return (the first child is at index 0)

count - how many children to return. The returned array will have length equal to count. If there are not this many chldren starting at nodeIndex, the remaining items are left null.

Returns:

a list of sublists, each of which contains items describing a subnode of the current node. Items in each sublist are optional but use the item names stored in the static variables:

See Also:

CLASS_KEY, ID_KEY, TEXT_KEY, TYPE_KEY, EXPTEXT_KEY, ICON_KEY, EXPICON_KEY, SELICON_KEY, EXPSELICON_KEY, LEAF_KEY

_initialize

void _initialize(com.sas.collection.hlist.HListInterface initList,
                 int parentId,
                 int descListId)

Initialize the remote object based on the items in the initList. This method is called after creating a remote instance of a subnode based on the CLASS_KEY of the subnode.

Parameters:

initList - a list of node properties.

parentId - the object id of the parent node

descListId - the list id of the original list used to create the node. The new node should replace this obsolete list on the parent with the new initList and new node object id.

_getNodeExpandedText

java.lang.String _getNodeExpandedText()

Retrieve the text to display when this node is expanded.

Returns:

the expanded text

See Also:

NodeInterface.getNodeExpandedText()

_setNodeExpandedText

void _setNodeExpandedText(java.lang.String text)

Set the text to display when this node is expanded.

Parameters:

text - the expanded text

_getNodeText

java.lang.String _getNodeText()

Retrieve the text to display when this node is not expanded.

Returns:

the unexpanded text

See Also:

NodeInterface.getNodeExpandedText()

_setNodeText

void _setNodeText(java.lang.String text)

Set the text to display when this node is not expanded.

Parameters:

text - the unexpanded text

_getNodeType

java.lang.String _getNodeType()

Retrieve this node's type, which is used to determine the node's icon if none is specified explicitly.

Returns:

this node type

See Also:

NodeInterface.getNodeType()

_setNodeType

void _setNodeType(java.lang.String type)

Set this node's type, which is used to determine the node's icon if none is specified explicitly.

Parameters:

type - this node type

See Also:

NodeInterface.getNodeType()

_getDefaultIcon

int _getDefaultIcon()

Retrieve this node's default icon, which is used to display the unexpanded node in a tree view.

Returns:

this node type

See Also:

NodeIconInterface.getDefaultIcon()

_setDefaultIcon

void _setDefaultIcon(int icon)

Set this node's default icon, which is used to display the unexpanded node in a tree view.

Parameters:

icon - this node type

_getExpandedIcon

int _getExpandedIcon()

Retrieve this node's expanded icon, which is used to display the expanded node in a tree view.

Returns:

this node type

See Also:

NodeIconInterface.getDefaultIcon()

_setExpandedIcon

void _setExpandedIcon(int icon)

Set this node's expanded icon, which is used to display the expanded node in a tree view.

Parameters:

icon - this node type

See Also:

NodeIconInterface.getExpandedIcon()

_getSelectedIcon

int _getSelectedIcon()

Retrieve this node's selected icon, which is used to display the selected unexpanded node in a tree view.

Returns:

this node type

See Also:

NodeIconInterface.getDefaultIcon()

_setSelectedIcon

void _setSelectedIcon(int icon)

Set this node's selected icon, which is used to display the selected unexpanded node in a tree view.

Parameters:

icon - this node type

See Also:

NodeIconInterface.getSelectedIcon()

_getExpandedSelectedIcon

int _getExpandedSelectedIcon()

Retrieve this node's icon to be used when displaying the selected expanded node in a tree view.

Returns:

this node type

See Also:

NodeIconInterface.getExpandedSelectedIcon()

_setExpandedSelectedIcon

void _setExpandedSelectedIcon(int icon)

Set this node's type, which is used when displaying the selected expanded node in a tree view.

Parameters:

icon - this node type

_isLeafNode

boolean _isLeafNode()

Tell if the node is a leaf node.

Returns:

true if the node is a leaf, false if it has zero or more children.

See Also:

SimpleNodeInterface.isLeafNode()

_countNodeChildren

int _countNodeChildren(int max)

Count the node's children, but stop if a maximum is reached.

Returns:

the number of children. This may be max even if there are more than max children but it is expensive to count them all.

See Also:

SimpleNodeInterface.countNodeChildren(int)

_getNodeChildCount

int _getNodeChildCount()

Returns the number of children. If the number of children is unknown, -1 is returned.

See Also:

_countNodeChildren(int)

_removeNodeChild

void _removeNodeChild(int index)

Remove a child node.

Parameters:

the - index of the child node to remove.