Interface nsITreeViewType

Hierarchy

Properties

rowCount: number

The total number of rows in the tree (including the offscreen rows).

selection: nsITreeSelection

The selection for this view.

Methods

  • 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

  • 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

  • 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

  • Methods used by the drag feedback code to determine if a drag is allowable at the current location. To get the behavior where drops are only allowed on items, such as the mailNews folder pane, always return false when the orientation is not DROP_ON.

    Parameters

    • index: number
    • orientation: number
    • dataTransfer: DataTransfer

    Returns boolean

  • Called on the view when a cell in a non-selectable cycling column (e.g., unread/flag/etc.) is clicked.

    Parameters

    • row: number
    • col: TreeColumn

    Returns void

  • Called on the view when a header is clicked.

    Parameters

    • col: TreeColumn

    Returns void

  • Called when the user drops something on this view. The |orientation| param specifies before/on/after the given |row|.

    Parameters

    • row: number
    • orientation: number
    • dataTransfer: DataTransfer

    Returns void

  • A whitespace delimited list of properties for a given cell. Each property, x, that the view gives back will cause the pseudoclasses ::-moz-tree-cell(x), ::-moz-tree-row(x), ::-moz-tree-twisty(x), ::-moz-tree-image(x), ::-moz-tree-cell-text(x). to be matched on the cell.

    Parameters

    • row: number
    • col: TreeColumn

    Returns string

  • The text for a given cell. If a column consists only of an image, then the empty string is returned.

    Parameters

    • row: number
    • col: TreeColumn

    Returns string

  • The value for a given cell. This method is only called for columns of type other than |text|.

    Parameters

    • row: number
    • col: TreeColumn

    Returns string

  • Called to get properties to paint a column background. For shading the sort column, etc.

    Parameters

    • col: TreeColumn

    Returns string

  • The image path for a given cell. For defining an icon for a cell. If the empty string is returned, the :moz-tree-image pseudoelement will be used.

    Parameters

    • row: number
    • col: TreeColumn

    Returns string

  • The level is an integer value that represents the level of indentation. It is multiplied by the width specified in the :moz-tree-indentation pseudoelement to compute the exact indendation.

    Parameters

    • index: number

    Returns number

  • Methods used by the tree to draw thread lines in the tree. getParentIndex is used to obtain the index of a parent row. If there is no parent row, getParentIndex returns -1.

    Parameters

    • rowIndex: number

    Returns number

  • A whitespace delimited list of properties. For each property X the view gives back will cause the pseudoclasses ::-moz-tree-cell(x), ::-moz-tree-row(x), ::-moz-tree-twisty(x), ::-moz-tree-image(x), ::-moz-tree-cell-text(x). to be matched on the pseudoelement ::moz-tree-row.

    Parameters

    • index: number

    Returns string

  • hasNextSibling is used to determine if the row at rowIndex has a nextSibling that occurs after the index specified by afterIndex. Code that is forced to march down the view looking at levels can optimize the march by starting at afterIndex+1.

    Parameters

    • rowIndex: number
    • afterIndex: number

    Returns boolean

  • Methods that can be used to test whether or not a twisty should be drawn, and if so, whether an open or closed twisty should be used.

    Parameters

    • index: number

    Returns boolean

  • Parameters

    • index: number

    Returns boolean

  • Parameters

    • index: number

    Returns boolean

  • isEditable is called to ask the view if the cell contents are editable. A value of true will result in the tree popping up a text field when the user tries to inline edit the cell.

    Parameters

    • row: number
    • col: TreeColumn

    Returns boolean

  • isSeparator is used to determine if the row at index is a separator. A value of true will result in the tree drawing a horizontal separator. The tree uses the ::moz-tree-separator pseudoclass to draw the separator.

    Parameters

    • index: number

    Returns boolean

  • Specifies if there is currently a sort on any column. Used mostly by dragdrop to affect drop feedback.

    Returns boolean

  • Should be called from a XUL onselect handler whenever the selection changes.

    Returns void

  • setCellText is called when the contents of the cell have been edited by the user.

    Parameters

    • row: number
    • col: TreeColumn
    • value: string

    Returns void

  • setCellValue is called when the value of the cell has been set by the user. This method is only called for columns of type other than |text|.

    Parameters

    • row: number
    • col: TreeColumn
    • value: string

    Returns void

  • Called during initialization to link the view to the front end box object.

    Parameters

    • tree: XULTreeElement

    Returns void

  • Called on the view when an item is opened or closed.

    Parameters

    • index: number

    Returns void

Generated using TypeDoc