API Docs for: 3.17.2
Show:

Tree.Openable Class

Defined in: tree/js/extensions/tree-openable.js:11
Module: tree-openable
Parent Module: tree

Extension for Tree that adds the concept of open/closed state for nodes.

Constructor

Tree.Openable

()

Defined in tree/js/extensions/tree-openable.js:11

Methods

_defCloseFn

(
  • e
)
protected

Defined in tree/js/extensions/tree-openable.js:127

Default handler for the close event.

Parameters:

_defOpenFn

(
  • e
)
protected

Defined in tree/js/extensions/tree-openable.js:138

Default handler for the open event.

Parameters:

closeNode

(
  • node
  • [options]
)
chainable

Defined in tree/js/extensions/tree-openable.js:49

Closes the specified node if it isn't already closed.

Parameters:

  • node Tree.Node

    Node to close.

  • [options] Object optional

    Options.

    • [silent=false] Boolean optional

      If true, the close event will be suppressed.

    • [src] String optional

      Source of the change, to be passed along to the event facade of the resulting event. This can be used to distinguish between changes triggered by a user and changes triggered programmatically, for example.

openNode

(
  • node
  • [options]
)
chainable

Defined in tree/js/extensions/tree-openable.js:77

Opens the specified node if it isn't already open.

Parameters:

  • node Tree.Node

    Node to open.

  • [options] Object optional

    Options.

    • [silent=false] Boolean optional

      If true, the open event will be suppressed.

    • [src] String optional

      Source of the change, to be passed along to the event facade of the resulting event. This can be used to distinguish between changes triggered by a user and changes triggered programmatically, for example.

toggleOpenNode

(
  • node
  • [options]
)
chainable

Defined in tree/js/extensions/tree-openable.js:105

Toggles the open/closed state of the specified node, closing it if it's currently open or opening it if it's currently closed.

Parameters:

  • node Tree.Node

    Node to toggle.

  • [options] Object optional

    Options.

    • [silent=false] Boolean optional

      If true, events will be suppressed.

    • [src] String optional

      Source of the change, to be passed along to the event facade of the resulting event. This can be used to distinguish between changes triggered by a user and changes triggered programmatically, for example.

Events

close

Defined in tree/js/extensions/tree-openable.js:19

Fired when a node is closed.

Event Payload:

open

Defined in tree/js/extensions/tree-openable.js:29

Fired when a node is opened.

Event Payload: