AlloyUI - API Docs

  • API Docs for Version: 3.1.0-deprecated.60

    • Show:

    Tree.Selectable Class

    Defined in: yui3/src/tree/js/extensions/tree-selectable.js:13
    Module: tree-selectable
    Parent Module: tree

    Extension for Tree that adds the concept of selection state for nodes.

    Constructor

    Methods

    getSelectedNodes

    () Tree.Node.Selectable[]

    Defined in yui3/src/tree/js/extensions/tree-selectable.js:75

    Returns an array of nodes that are currently selected.

    Returns:

    Tree.Node.Selectable[]:

    Array of selected nodes.

    selectNode

    (
    • node
    • [options]
    )
    chainable

    Defined in yui3/src/tree/js/extensions/tree-selectable.js:85

    Selects the specified node.

    Parameters:

    • node Tree.Node.Selectable

      Node to select.

    • [options] Object optional

      Options.

      • [silent=false] Boolean optional

        If true, the select 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.

    unselect

    (
    • [options]
    )
    chainable

    Defined in yui3/src/tree/js/extensions/tree-selectable.js:117

    Unselects all selected nodes.

    Parameters:

    • [options] Object optional

      Options.

      • [silent=false] Boolean optional

        If true, the unselect 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.

    unselectNode

    (
    • node
    • [options]
    )
    chainable

    Defined in yui3/src/tree/js/extensions/tree-selectable.js:140

    Unselects the specified node.

    Parameters:

    • node Tree.Node.Selectable

      Node to unselect.

    • [options] Object optional

      Options.

      • [silent=false] Boolean optional

        If true, the unselect 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.

    Properties

    _selectedMap

    Object protected

    Defined in yui3/src/tree/js/extensions/tree-selectable.js:44

    Mapping of node ids to node instances for nodes in this tree that are currently selected.

    Attributes

    multiSelect

    Boolean

    Defined in yui3/src/tree/js/extensions/tree-selectable.js:207

    Whether or not to allow multiple nodes to be selected at once.

    Default: false

    Events

    select

    Defined in yui3/src/tree/js/extensions/tree-selectable.js:21

    Fired when a node is selected.

    Event Payload:

    unselect

    Defined in yui3/src/tree/js/extensions/tree-selectable.js:30

    Fired when a node is unselected.

    Event Payload: