nsITreeView Interface Reference

import "nsITreeView.idl";

Inheritance diagram for nsITreeView:

Inheritance graph
[legend]
Collaboration diagram for nsITreeView:

Collaboration graph
[legend]

List of all members.

Public Member Functions

void getRowProperties (in long index, in nsISupportsArray properties)
 An atomized list of properties for a given row.
void getCellProperties (in long row, in nsITreeColumn col, in nsISupportsArray properties)
 An atomized list of properties for a given cell.
void getColumnProperties (in nsITreeColumn col, in nsISupportsArray properties)
 Called to get properties to paint a column background.
boolean isContainer (in long index)
 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.
boolean isContainerOpen (in long index)
boolean isContainerEmpty (in long index)
boolean isSeparator (in long index)
 isSeparator is used to determine if the row at index is a separator.
boolean isSorted ()
 Specifies if there is currently a sort on any column.
boolean canDrop (in long index, in long orientation)
 Methods used by the drag feedback code to determine if a drag is allowable at the current location.
void drop (in long row, in long orientation)
 Called when the user drops something on this view.
long getParentIndex (in long rowIndex)
 Methods used by the tree to draw thread lines in the tree.
boolean hasNextSibling (in long rowIndex, in long afterIndex)
 hasNextSibling is used to determine if the row at rowIndex has a nextSibling that occurs *after* the index specified by afterIndex.
long getLevel (in long index)
 The level is an integer value that represents the level of indentation.
AString getImageSrc (in long row, in nsITreeColumn col)
 The image path for a given cell.
long getProgressMode (in long row, in nsITreeColumn col)
AString getCellValue (in long row, in nsITreeColumn col)
 The value for a given cell.
AString getCellText (in long row, in nsITreeColumn col)
 The text for a given cell.
void setTree (in nsITreeBoxObject tree)
 Called during initialization to link the view to the front end box object.
void toggleOpenState (in long index)
 Called on the view when an item is opened or closed.
void cycleHeader (in nsITreeColumn col)
 Called on the view when a header is clicked.
void selectionChanged ()
 Should be called from a XUL onselect handler whenever the selection changes.
void cycleCell (in long row, in nsITreeColumn col)
 Called on the view when a cell in a non-selectable cycling column (e.g., unread/flag/etc.
boolean isEditable (in long row, in nsITreeColumn col)
 isEditable is called to ask the view if the cell contents are editable.
boolean isSelectable (in long row, in nsITreeColumn col)
 isSelectable is called to ask the view if the cell is selectable.
void setCellValue (in long row, in nsITreeColumn col, in AString value)
 setCellValue is called when the value of the cell has been set by the user.
void setCellText (in long row, in nsITreeColumn col, in AString value)
 setCellText is called when the contents of the cell have been edited by the user.
void performAction (in wstring action)
 A command API that can be used to invoke commands on the selection.
void performActionOnRow (in wstring action, in long row)
 A command API that can be used to invoke commands on a specific row.
void performActionOnCell (in wstring action, in long row, in nsITreeColumn col)
 A command API that can be used to invoke commands on a specific cell.

Public Attributes

readonly attribute long rowCount
 The total number of rows in the tree (including the offscreen rows).
attribute nsITreeSelection selection
 The selection for this view.
const short DROP_BEFORE = -1
const short DROP_ON = 0
const short DROP_AFTER = 1
const short PROGRESS_NORMAL = 1
 The progress mode for a given cell.
const short PROGRESS_UNDETERMINED = 2
const short PROGRESS_NONE = 3


Member Function Documentation

void nsITreeView::getRowProperties ( in long  index,
in nsISupportsArray  properties 
)

Each property, x, that the view gives back will cause the pseudoclass :moz-tree-row-x to be matched on the pseudoelement moz-tree-row.

void nsITreeView::getCellProperties ( in long  row,
in nsITreeColumn  col,
in nsISupportsArray  properties 
)

Each property, x, that the view gives back will cause the pseudoclass :moz-tree-cell-x to be matched on the moz-tree-cell pseudoelement.

void nsITreeView::getColumnProperties ( in nsITreeColumn  col,
in nsISupportsArray  properties 
)

For shading the sort column, etc.

boolean nsITreeView::isContainer ( in long  index  ) 

boolean nsITreeView::isContainerOpen ( in long  index  ) 

boolean nsITreeView::isContainerEmpty ( in long  index  ) 

boolean nsITreeView::isSeparator ( in long  index  ) 

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.

boolean nsITreeView::isSorted (  ) 

Used mostly by dragdrop to affect drop feedback.

boolean nsITreeView::canDrop ( in long  index,
in long  orientation 
)

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.

void nsITreeView::drop ( in long  row,
in long  orientation 
)

The |orientation| param specifies before/on/after the given |row|.

long nsITreeView::getParentIndex ( in long  rowIndex  ) 

getParentIndex is used to obtain the index of a parent row. If there is no parent row, getParentIndex returns -1.

boolean nsITreeView::hasNextSibling ( in long  rowIndex,
in long  afterIndex 
)

Code that is forced to march down the view looking at levels can optimize the march by starting at afterIndex+1.

long nsITreeView::getLevel ( in long  index  ) 

It is multiplied by the width specified in the :moz-tree-indentation pseudoelement to compute the exact indendation.

AString nsITreeView::getImageSrc ( in long  row,
in nsITreeColumn  col 
)

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

long nsITreeView::getProgressMode ( in long  row,
in nsITreeColumn  col 
)

AString nsITreeView::getCellValue ( in long  row,
in nsITreeColumn  col 
)

This method is only called for columns of type other than |text|.

AString nsITreeView::getCellText ( in long  row,
in nsITreeColumn  col 
)

If a column consists only of an image, then the empty string is returned.

void nsITreeView::setTree ( in nsITreeBoxObject  tree  ) 

void nsITreeView::toggleOpenState ( in long  index  ) 

void nsITreeView::cycleHeader ( in nsITreeColumn  col  ) 

void nsITreeView::selectionChanged (  ) 

void nsITreeView::cycleCell ( in long  row,
in nsITreeColumn  col 
)

) is clicked.

boolean nsITreeView::isEditable ( in long  row,
in nsITreeColumn  col 
)

A value of true will result in the tree popping up a text field when the user tries to inline edit the cell.

boolean nsITreeView::isSelectable ( in long  row,
in nsITreeColumn  col 
)

This method is only called if the selection style is |cell| or |text|. XXXvarga shouldn't this be called isCellSelectable?

void nsITreeView::setCellValue ( in long  row,
in nsITreeColumn  col,
in AString  value 
)

This method is only called for columns of type other than |text|.

void nsITreeView::setCellText ( in long  row,
in nsITreeColumn  col,
in AString  value 
)

void nsITreeView::performAction ( in wstring  action  ) 

The tree will automatically invoke this method when certain keys are pressed. For example, when the DEL key is pressed, performAction will be called with the "delete" string.

void nsITreeView::performActionOnRow ( in wstring  action,
in long  row 
)

void nsITreeView::performActionOnCell ( in wstring  action,
in long  row,
in nsITreeColumn  col 
)


Member Data Documentation

This method is only called for columns of type |progressmeter|.


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

Generated Mozilla by doxygen 1.5.6