TreeBoxObject
This object is available to unprivileged JavaScript. It implements the following interfaces:
Properties
readonly TreeColumns columns
Obtain the columns.
boolean focused
Whether or not we are currently focused.
readonly PRInt32 rowHeight
Obtain the height of a row.
readonly Element treeBody
Obtain the treebody content node
TreeView view
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.
Methods
void beginUpdateBatch ( )
void clearStyleAndImageCaches ( )
void endUpdateBatch ( )
void ensureRowIsVisible ( PRInt32 index )
void getCellAt ( PRInt32 x , PRInt32 y , out PRInt32 row , out TreeColumn col , out ACString childElt )
void getCoordsForCellItem ( PRInt32 row , TreeColumn col , ACString element , out PRInt32 x , out PRInt32 y , out PRInt32 width , out PRInt32 height )
PRInt32 getFirstVisibleRow ( )
PRInt32 getLastVisibleRow ( )
PRInt32 getPageLength ( )
PRInt32 getRowAt ( PRInt32 x , PRInt32 y )
void invalidate ( )
void invalidateCell ( PRInt32 row , TreeColumn col )
void invalidateColumn ( TreeColumn col )
void invalidateRange ( PRInt32 startIndex , PRInt32 endIndex )
void invalidateRow ( PRInt32 index )
boolean isCellCropped ( PRInt32 row , TreeColumn col )
void rowCountChanged ( PRInt32 index , PRInt32 count )
void scrollByLines ( PRInt32 numLines )
void scrollByPages ( PRInt32 numPages )
void scrollToRow ( PRInt32 index )
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.
void clearStyleAndImageCaches ( )
Called on a theme switch to flush out the tree's style and image caches.
void ensureRowIsVisible ( PRInt32 index )
Ensures that a row at a given index is visible.
- Arguments:
- index
void getCellAt ( PRInt32 x , PRInt32 y , out PRInt32 row , out TreeColumn 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.
- Arguments:
- x
- y
- row
- col
- childElt
void getCoordsForCellItem ( PRInt32 row , TreeColumn col , ACString element , out PRInt32 x , out PRInt32 y , out PRInt32 width , out PRInt32 height )
Find the coordinates of an element within a specific cell.
- Arguments:
- row
- col
- element
- x
- y
- width
- height
PRInt32 getRowAt ( PRInt32 x , PRInt32 y )
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.
- Arguments:
- x
- y
void invalidateCell ( PRInt32 row , TreeColumn col )
- Arguments:
- row
- col
void invalidateColumn ( TreeColumn col )
- Arguments:
- col
boolean isCellCropped ( PRInt32 row , TreeColumn col )
Determine if the text of a cell is being cropped or not.
- Arguments:
- row
- col
void rowCountChanged ( PRInt32 index , PRInt32 count )
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.
- Arguments:
- index
- count
void scrollByLines ( PRInt32 numLines )
Scroll the tree up or down by numLines lines. Positive values move down in the tree. Prevents scrolling off the end of the tree.
- Arguments:
- numLines
void scrollByPages ( PRInt32 numPages )
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.
- Arguments:
- numPages
void scrollToRow ( PRInt32 index )
Scrolls such that the row at index is at the top of the visible view.
- Arguments:
- index
Reference documentation is generated from Mozilla's source.

Nikitas Liogkas