Interface nsITreeSelectionType

Hierarchy

Properties

count currentIndex selectEventsSuppressed shiftSelectPivot single tree

Methods

AddRef QueryInterface Release adjustSelection clearRange clearSelection getRangeAt getRangeCount invalidateSelection isSelected rangedSelect select selectAll timedSelect toggleSelect

Properties

Readonly count

count: number

The number of rows currently selected in this tree.

currentIndex

currentIndex: number

The current item (the one that gets a focus rect in addition to being selected).

selectEventsSuppressed

selectEventsSuppressed: boolean

This attribute is a boolean indicating whether or not the "select" event should fire when the selection is changed using one of our methods. A view can use this to temporarily suppress the selection while manipulating all of the indices, e.g., on a sort. Note: setting this attribute to false will fire a select event.

Readonly shiftSelectPivot

shiftSelectPivot: number

The selection "pivot". This is the first item the user selected as part of a ranged select.

Readonly single

single: boolean

This attribute is a boolean indicating single selection.

tree

tree: XULTreeElement

The tree widget for this selection.

Methods

AddRef

  • Increases the reference count for this interface. The associated instance will not be deleted unless the reference count is returned to zero.

    Returns

    The resulting reference count.

    Returns number

QueryInterface

  • Parameters

    • aIID: object
    • Optional aInstancePtr: object

    Returns any

  • A run time mechanism for interface discovery.

    Returns

    NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.

    aInstancePtr must not be null.

    Parameters

    • aIID: object

      [in] A requested interface IID

    • aInstancePtr: object

      [out] A pointer to an interface pointer to receive the result.

    Returns void

Release

  • Decreases the reference count for this interface. Generally, if the reference count returns to zero, the associated instance is deleted.

    Returns

    The resulting reference count.

    Returns number

adjustSelection

  • Called when the row count changes to adjust selection indices.

    Parameters

    • index: number
    • count: number

    Returns void

clearRange

  • Clears the range.

    Parameters

    • startIndex: number
    • endIndex: number

    Returns void

clearSelection

  • Clears the selection.

    Returns void

getRangeAt

  • Parameters

    • i: number
    • min: number
    • max: number

    Returns void

getRangeCount

  • Iterate the selection using these methods.

    Returns number

invalidateSelection

  • Can be used to invalidate the selection.

    Returns void

isSelected

  • Indicates whether or not the row at the specified index is part of the selection.

    Parameters

    • index: number

    Returns boolean

rangedSelect

  • Select the range specified by the indices. If augment is true, then we add the range to the selection without clearing out anything else. If augment is false, everything is cleared except for the specified range.

    Parameters

    • startIndex: number
    • endIndex: number
    • augment: boolean

    Returns void

select

  • Deselect all rows and select the row at the specified index.

    Parameters

    • index: number

    Returns void

selectAll

  • Selects all rows.

    Returns void

timedSelect

  • Perform a timed select.

    Parameters

    • index: number
    • delay: number

    Returns void

toggleSelect

  • Toggle the selection state of the row at the specified index.

    Parameters

    • index: number

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc