Package com.smartgwt.client.widgets.tree

Class NodeLocator

java.lang.Object

com.smartgwt.client.core.BaseClass

com.smartgwt.client.widgets.tree.NodeLocator

All Implemented Interfaces:

HasHandlers

public class NodeLocator
extends BaseClass

An object containing sufficient context to unambiguously identify a single node in the tree. For normal trees, the node itself - or its ID - is sufficient for this purpose, but for multi-link trees, we also need to know the node's parent, and its position within that parent. For cases where we need to propagate change back up the node's parent chain, in order to maintain a given parent node's openList, the node, parent and position are not enough context; for those cases, we need either the node's position in the tree's openList, or a full path to the node. NodeLocator objects contain this extra context, and can be passed to APIs such as Tree.openFolder(), which would ordinarily accept a parameter of type TreeNode.

Field Summary

Fields inherited from class com.smartgwt.client.core.BaseClass

config, configOnly, factoryCreated, factoryProperties, id, scClassName

Constructor Summary

Constructors

Constructor	Description
NodeLocator()
NodeLocator(JavaScriptObject jsObj)

Method Summary

Modifier and Type	Method	Description
JavaScriptObject	create()
JavaScriptObject	getJsObj()
JavaScriptObject	getOrCreateJsObj()
static NodeLocator	getOrCreateRef(JavaScriptObject jsObj)
boolean	isCreated()
void	setJavaScriptObject(JavaScriptObject jsObj)

Methods inherited from class com.smartgwt.client.core.BaseClass

addDynamicProperty, addDynamicProperty, addDynamicProperty, addDynamicProperty, applyFactoryProperties, asSGWTComponent, clearDynamicProperty, createJsObj, destroy, doAddHandler, doInit, error, error, errorIfNotCreated, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsString, getAttributeAsStringArray, getClassName, getConfig, getHandlerCount, getID, getRef, getRuleScope, getScClassName, getTestInstance, hasAutoAssignedID, hasDynamicProperty, internalSetID, internalSetID, isConfigOnly, isFactoryCreated, onBind, onInit, registerID, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setFactoryCreated, setID, setProperty, setProperty, setProperty, setProperty, setRuleScope, setScClassName

Methods inherited from class java.lang.Object

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

Constructor Details

NodeLocator

public NodeLocator()

NodeLocator

public NodeLocator(JavaScriptObject jsObj)

Method Details

getOrCreateRef

public static NodeLocator getOrCreateRef(JavaScriptObject jsObj)

setJavaScriptObject

public void setJavaScriptObject(JavaScriptObject jsObj)

Overrides:

setJavaScriptObject in class BaseClass

create

public JavaScriptObject create()

Specified by:

create in class BaseClass

isCreated

public boolean isCreated()

Overrides:

isCreated in class BaseClass

getJsObj

public JavaScriptObject getJsObj()

Overrides:

getJsObj in class BaseClass

getOrCreateJsObj

public JavaScriptObject getOrCreateJsObj()

Overrides:

getOrCreateJsObj in class BaseClass