view release on metacpan or  search on metacpan

doc/html/TreeNavigator.html  view on Meta::CPAN

<p>Returns the last subnode within that node's content.  If no argument
is given, returns the last node of the tree.</p>
</li>
<li><a name="item__code_lastVisibleSubNode_node___code_"></a><b><code>lastVisibleSubNode(node)</code></b>
<p>Returns the last visible subnode (recursively) of the argument
node. If no argument is given, returns the last visible subnode of the
tree.</p>
</li>
<li><a name="item__code_label_node___code_"></a><b><code>label(node)</code></b>
<p>Returns the label of that node, i.e. the first HTML child element
having class <code>TN_label</code>.</p>
</li>
<li><a name="item__code_content_node___code_"></a><b><code>content(node)</code></b>
<p>Returns the content of that node, i.e. the last HTML child element
having class <code>TN_content</code>.</p>
</li>
<li><a name="item__code_nextDisplayedNode_node___code_"></a><b><code>nextDisplayedNode(node)</code></b>
<p>Returns the next tree node in page display order (i.e. next visible
node down the page).</p>
</li>
<li><a name="item__code_previousDisplayedNode_node___code_"></a><b><code>previousDisplayedNode(node)</code></b>
<p>Returns the previous tree node in page display order (i.e. previous
visible node up the page).</p>
</li>
<li><a name="item__code_enclosingNode_elem___code_"></a><b><code>enclosingNode(elem)</code></b>
<p>Returns the first tree node that contains the given element
(which might be for example a form input).</p>
</li>
</ul>

    </div>
  </div>

    </div>
  </div>
  <div class="TN_node" id="Event_handling">
    <h3 class="TN_label">Event handling</h3>
    <div class="TN_content">
      <p>Manipulations to the tree generate <i>events</i>
for which clients can register some <i>handlers</i>,
exactly like ordinary HTML events.</p>
  <div class="TN_node" id="Event_list">
    <h4 class="TN_label">Event list</h4>
    <div class="TN_content">
        <div class="TN_node" id="Select_Deselect">
    <h5 class="TN_label"><code>Select</code> / <code>Deselect</code></h5>
    <div class="TN_content">
      <p>triggered when a node is marked / unmarked as the
currently selected node. Both events are not
triggered immediately, but only after 
<code>selectDelay</code> milliseconds have elapsed :
this is an optimization to avoid too many calls
while the user is navigating quickly through the
nodes; in other words, intermediate nodes
crossed while navigating the tree will not
receive any trigger.</p>
<p>If label selection is associated with 
focus (i.e. if <code>tabIndex</code> was not set
to -1), then selection/deselection events
are also triggered when the user switches
to another desktop window.</p>

    </div>
  </div>
  <div class="TN_node" id="Open_Close">
    <h5 class="TN_label"><code>Open</code> / <code>Close</code></h5>
    <div class="TN_content">
      <p>triggered when a node is opened or
closed</p>

    </div>
  </div>
  <div class="TN_node" id="BeforeLoadContent_AfterLoadContent">
    <h5 class="TN_label"><code>BeforeLoadContent</code> / <code>AfterLoadContent</code></h5>
    <div class="TN_content">
      <p>triggered before/after a node's content
is loaded from an URL (throug opening the node,
or hitting the <code>Ctrl-R</code> key) -- see
the section below about dynamic tree
updates).</p>

    </div>
  </div>
  <div class="TN_node" id="inspect">
    <h5 class="TN_label"><code>inspect</code></h5>
    <div class="TN_content">
      <p>triggered when a user calls the
<i>inspector</i> for a node (either by
hitting the RETURN key or by
double-clicking the node's label)</p>

    </div>
  </div>

    </div>
  </div>
  <div class="TN_node" id="Event_structure_passed_to_handlers">
    <h4 class="TN_label">Event structure passed to handlers</h4>
    <div class="TN_content">
      <p>Handlers can access an <code>event</code> structure,
similar to what is passed to ordinary HTML events;
the entries are:</p>
<ul>
<li><a name="item__code_type__code_"></a><b><code>type</code></b>
<p>the name of the triggered event
(i.e. <code>Select</code>, <code>Deselect</code>, <code>Open</code>, etc.)</p>
</li>
<li><a name="item__code_target__code_"></a><b><code>target</code></b>
<p>the node element on which the event was
triggered</p>
</li>
<li><a name="item__code_srcElement__code_"></a><b><code>srcElement</code></b>
<p>synonym for <code>target</code></p>
</li>
<li><a name="item__code_treeNavigator__code_"></a><b><code>treeNavigator</code></b>
<p>the tree navigator object controlling the
target node</p>
</li>
</ul>

    </div>