The nsITreeColumns interface represents the tree columns.

layout/xul/base/src/tree/public/nsITreeColumns.idlScriptable
Please add a summary to this article.
  Last changed in Gecko 1.9 (Firefox 3)

Inherits from: nsISupports

Method overview

nsITreeColumn getColumnAt(in long index);
nsITreeColumn getColumnFor(in nsIDOMElement element);
nsITreeColumn getFirstColumn();
nsITreeColumn getKeyColumn();
nsITreeColumn getLastColumn();
nsITreeColumn getNamedColumn(in AString id);
nsITreeColumn getPrimaryColumn();
nsITreeColumn getSortedColumn();
void invalidateColumns();
void restoreNaturalOrder();

Attributes

Attribute Type Description
count long The number of columns. Read only.
length long An alias for count (for the benefit of scripts which treat this as an array). Read only.
tree nsITreeBoxObject The tree widget for these columns. Read only.

Methods

getColumnAt()

Get the column for a given index.

nsITreeColumn getColumnAt(
  in long index
);
Parameters
index
Index of the column
Return value

A nsITreeColumn for this index.

getColumnFor()

Get the column for a given element.

nsITreeColumn getColumnFor(
  in nsIDOMElement element
);
Parameters
element
A DOM element
Return value

A nsITreeColumn for this element.

getFirstColumn()

Get the first column.

nsITreeColumn getFirstColumn();
Parameters

None.

Return value

The first nsITreeColumn.

getKeyColumn()

Get the key column.

nsITreeColumn getKeyColumn();
Parameters

None.

Return value

The key nsITreeColumn.

getLastColumn()

Get the last column.

nsITreeColumn getLastColumn();
Parameters

None.

Return value

The last nsITreeColumn.

getNamedColumn()

Get a column for a given name.

nsITreeColumn getNamedColumn(
  in AString id
);
Parameters
id
A column id
Return value

The nsITreeColumn for this id.

getPrimaryColumn()

Get the primary column.

nsITreeColumn getPrimaryColumn();
Parameters

None.

Return value

The primary nsITreeColumn.

getSortedColumn()

nsITreeColumn getSortedColumn();
Parameters

None.

Return value

A nsITreeColumn.

invalidateColumns()

This method is called whenever a treecol is added or removed and the column cache needs to be rebuilt.

void invalidateColumns();
Parameters

None.

restoreNaturalOrder()

Restore the original order of the columns before the user moved them.

void restoreNaturalOrder();
Parameters

None.

See also