Name

opttree

Synopsis

LZX: opttree
JavaScript: opttree
Type: Class
Access: public
Topic: Incubator.Opttree
Declared in: lps/components/incubator/opttree/opttree.lzx

Description

A keyboard navigable (with arrow keys) tree control that supports selection and dynamic data loading. This tree must be backed by an XML DOM datastructure and presented within a clipping region. The datapath for an opttree must resolve to a single LzDataElement which is the undisplayed root of the tree.

Superclass Chain

node (LzNode) » view (LzView) » opttree

Known Subclasses

Details

Properties (11)

depthattr
<attribute name="depthattr" type="string" value="__OPTTREE_META_depth" />
public var depthattr : String;
(Protected) The attribute name to use in the data to mark a a node's depth in the tree hierarchy
depthattrpath
<attribute name="depthattrpath" type="string" value="@__OPTTREE_META_depth" />
public var depthattrpath : String;
(Protected) An xpath that selects the depthattr attribute from a node. This should match depthattr but prepend the '@' symbol. This cannot be when=always or when=once because it is used as a reference in a $path expression n baseopttreenode
dragee
<attribute name="dragee" value="null" />
public var dragee;
dragged
<attribute name="dragged" value="null" />
public var dragged;
highlighted
<attribute name="highlighted" value="null" />
public var highlighted;
The keyboard nav highlighted baseopttreenode or null. This attribute is read-only.
nodeclass
<attribute name="nodeclass" type="string" />
public var nodeclass : String;
The name of the class to use to represent nodes in the tree.
nodecollection
<attribute name="nodecollection" value="${ opttreecontroller.nodelist }" />
public var nodecollection;
nodelist
<attribute name="nodelist" value="nodecollection" />
public var nodelist;
nodepath
<attribute name="nodepath" type="string" value="*" />
public var nodepath : String;
The xpath expression to use to retrieve nodes out of the datapath.
openattr
<attribute name="openattr" type="string" value="__OPTTREE_META_open" />
public var openattr : String;
(Protected) The attribute name to use in the data to mark a a node as open.
openattrpath
<attribute name="openattrpath" type="string" value="@__OPTTREE_META_open" />
public var openattrpath : String;
(Protected) An xpath that selects the openattr attribute from a node. This should match openattr but prepend the '@' symbol. This cannot be when=always or when=once because it is used as a reference in a $path expression in baseopttreenode

Methods (7)

beginDrag()
<method name="beginDrag" args="who, ix, iy" />
public function beginDrag(who, ix, iy);
endDrag()
<method name="endDrag" args="who" />
public function endDrag(who);
recursiveOpen()
<method name="recursiveOpen" args="p, val" />
public function recursiveOpen(p, val);
select()
<method name="select" args="el" />
public function select(el);
Make the element be open. Open elements display their children; not open elements do not.
setAllOpen()
<method name="setAllOpen" args="val" />
public function setAllOpen(val);
setOpen()
<method name="setOpen" args="p, val" />
public function setOpen(p : LzDataElement, val : boolean);
Set the tree node that represents the given LzDataElement to be open. Open elements display their children; not open elements do not.
updateHierarchy()
<method name="updateHierarchy" args="p" />
public function updateHierarchy(p);

LZX Synopsis

<class name="opttree" extends=" LzView ">
  <attribute name=" depthattr " type="string" value="__OPTTREE_META_depth" />
  <attribute name=" depthattrpath " type="string" value="@__OPTTREE_META_depth" />
  <attribute name=" dragee " value="null" />
  <attribute name=" dragged " value="null" />
  <attribute name=" highlighted " value="null" />
  <attribute name=" nodeclass " type="string" />
  <attribute name=" nodecollection " value="${ opttreecontroller.nodelist }" />
  <attribute name=" nodelist " value="nodecollection" />
  <attribute name=" nodepath " type="string" value="*" />
  <attribute name=" openattr " type="string" value="__OPTTREE_META_open" />
  <attribute name=" openattrpath " type="string" value="@__OPTTREE_META_open" />
  <method name=" beginDrag " args="who, ix, iy" />
  <method name=" endDrag " args="who" />
  <method name=" recursiveOpen " args="p, val" />
  <method name=" select " args="el" />
  <method name=" setAllOpen " args="val" />
  <method name=" setOpen " args="p, val" />
  <method name=" updateHierarchy " args="p" />
</class>

JavaScript Synopsis

public opttree extends  LzView  {
  public var depthattr  : String;
  public var depthattrpath  : String;
  public var dragee ;
  public var dragged ;
  public var highlighted ;
  public var nodeclass  : String;
  public var nodecollection ;
  public var nodelist ;
  public var nodepath  : String;
  public var openattr  : String;
  public var openattrpath  : String;
  prototype public function beginDrag (who, ix, iy);
  prototype public function endDrag (who);
  prototype public function recursiveOpen (p, val);
  prototype public function select (el);
  prototype public function setAllOpen (val);
  prototype public function setOpen (p : LzDataElement, val : boolean);
  prototype public function updateHierarchy (p);
}