Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsITreeBoxObject Interface Reference

import "nsITreeBoxObject.idl";

Inheritance diagram for nsITreeBoxObject:
Inheritance graph
[legend]
Collaboration diagram for nsITreeBoxObject:
Collaboration graph
[legend]

List of all members.

Public Member Functions

long getFirstVisibleRow ()
 Get the index of the first visible row.
long getLastVisibleRow ()
 Get the index of the last visible row.
long getPageLength ()
 Gets the number of possible visible rows.
void ensureRowIsVisible (in long index)
 Ensures that a row at a given index is visible.
void scrollToRow (in long index)
 Scrolls such that the row at index is at the top of the visible view.
void scrollByLines (in long numLines)
 Scroll the tree up or down by numLines lines.
void scrollByPages (in long numPages)
 Scroll the tree up or down by numPages pages.
void invalidate ()
 Invalidation methods for fine-grained painting control.
void invalidateColumn (in nsITreeColumn col)
void invalidateRow (in long index)
void invalidateCell (in long row, in nsITreeColumn col)
void invalidateRange (in long startIndex, in long endIndex)
long getRowAt (in long x, in long y)
 A hit test that can tell you what row the mouse is over.
void getCellAt (in long x, in long y, out long row, out nsITreeColumn col, out ACString childElt)
 A hit test that can tell you what cell the mouse is over.
void getCoordsForCellItem (in long row, in nsITreeColumn col, in ACString element, out long x, out long y, out long width, out long height)
 Find the coordinates of an element within a specific cell.
boolean isCellCropped (in long row, in nsITreeColumn col)
 Determine if the text of a cell is being cropped or not.
void rowCountChanged (in long index, in long count)
 The view is responsible for calling these notification methods when rows are added or removed.
void beginUpdateBatch ()
 Notify the tree that the view is about to perform a batch update, that is, add, remove or invalidate several rows at once.
void endUpdateBatch ()
 Notify the tree that the view has completed a batch update.
void clearStyleAndImageCaches ()
 Called on a theme switch to flush out the tree's style and image caches.

Public Attributes

readonly attribute nsITreeColumns columns
 Obtain the columns.
attribute nsITreeView view
 The view that backs the tree and that supplies it with its data.
attribute boolean focused
 Whether or not we are currently focused.
readonly attribute nsIDOMElement treeBody
 Obtain the treebody content node.
readonly attribute long rowHeight
 Obtain the height of a row.

Detailed Description

Definition at line 50 of file nsITreeBoxObject.idl.


Member Function Documentation

Notify the tree that the view is about to perform a batch update, that is, add, remove or invalidate several rows at once.

This must be followed by calling endUpdateBatch(), otherwise the tree will get out of sync.

Called on a theme switch to flush out the tree's style and image caches.

Notify the tree that the view has completed a batch update.

Ensures that a row at a given index is visible.

void nsITreeBoxObject::getCellAt ( in long  x,
in long  y,
out long  row,
out nsITreeColumn  col,
out ACString  childElt 
)

A hit test that can tell you what cell the mouse is over.

Row is the row index hit, returns -1 for invalid mouse coordinates. ColID is the column hit. ChildElt is the pseudoelement hit: this can have values of "cell", "twisty", "image", and "text".

The coordinate system is the client coordinate system for the document this boxObject lives in, and the units are CSS pixels.

void nsITreeBoxObject::getCoordsForCellItem ( in long  row,
in nsITreeColumn  col,
in ACString  element,
out long  x,
out long  y,
out long  width,
out long  height 
)

Find the coordinates of an element within a specific cell.

Get the index of the first visible row.

Get the index of the last visible row.

Gets the number of possible visible rows.

A hit test that can tell you what row the mouse is over.

returns -1 for invalid mouse coordinates.

The coordinate system is the client coordinate system for the document this boxObject lives in, and the units are CSS pixels.

Invalidation methods for fine-grained painting control.

void nsITreeBoxObject::invalidateRange ( in long  startIndex,
in long  endIndex 
)

Determine if the text of a cell is being cropped or not.

The view is responsible for calling these notification methods when rows are added or removed.

Index is the position at which the new rows were added or at which rows were removed. For non-contiguous additions/removals, this method should be called multiple times.

Scroll the tree up or down by numLines lines.

Positive values move down in the tree. Prevents scrolling off the end of the tree.

Scroll the tree up or down by numPages pages.

A page is considered to be the amount displayed by the tree. Positive values move down in the tree. Prevents scrolling off the end of the tree.

Scrolls such that the row at index is at the top of the visible view.


Member Data Documentation

Obtain the columns.

Definition at line 55 of file nsITreeBoxObject.idl.

Whether or not we are currently focused.

Definition at line 67 of file nsITreeBoxObject.idl.

Obtain the height of a row.

Definition at line 77 of file nsITreeBoxObject.idl.

Obtain the treebody content node.

Definition at line 72 of file nsITreeBoxObject.idl.

The view that backs the tree and that supplies it with its data.

It is dynamically settable, either using a view attribute on the tree tag or by setting this attribute to a new value.

Definition at line 62 of file nsITreeBoxObject.idl.


The documentation for this interface was generated from the following file: