Back to index

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

import "nsIXFormsRepeatElement.idl";

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

List of all members.

Public Member Functions

void setIndex (inout unsigned long aIndex, in boolean aIsRefresh)
 Set the current index, and return new value.
void deselect ()
 Deselect current index.
void setCurrentRepeat (in nsIXFormsRepeatElement aCurrentRepeat, in unsigned long aIndex)
 Set currently selected repeat and index value (nested repeats)
nsIDOMNode getCurrentRepeatRow ()
 Get currently selected repeat row.
void addIndexUser (in nsIXFormsControl aControl)
 Add user of repeat-index.
void removeIndexUser (in nsIXFormsControl aControl)
 Remove user of repeat-index.
void indexHasChanged ()
 Informs repeat-index users of index change.
unsigned long getStartingIndex ()
 Retrieve the starting index for the repeat, that is the index that the repeat is initialized to.
void handleNodeInsert (in nsIDOMNode node)
 Handle insertion of a node, ie.

Public Attributes

readonly attribute unsigned long index
 The current index.
attribute boolean isParent
 Sets whether the repeat is a parent to nested repeats.
attribute nsIXFormsRepeatElement parent
 Set parent repeat (nested repeats)
attribute unsigned long level
 The tree level of this repeat (nested repeats)

Detailed Description

Definition at line 50 of file nsIXFormsRepeatElement.idl.


Member Function Documentation

Add user of repeat-index.

The control will have Bind() and Refresh() called on it, when the index changes.

Deselect current index.

Get currently selected repeat row.

Returns:
The current repeat row

Retrieve the starting index for the repeat, that is the index that the repeat is initialized to.

It is the "startindex" attribute, corrected to be a valid index value.

Handle insertion of a node, ie.

eventually adjust index. Note that the node might not be influencing the repeat, it is the repeat's responsibility to check that.

Parameters:
nodeThe node that was inserted

Informs repeat-index users of index change.

Remove user of repeat-index.

Set currently selected repeat and index value (nested repeats)

Parameters:
aCurrentRepeatThe current repeat
aIndexThe current index value
void nsIXFormsRepeatElement::setIndex ( inout unsigned long  aIndex,
in boolean  aIsRefresh 
)

Set the current index, and return new value.

Parameters:
aIndexThe index
aIsRefreshIs this part of a refresh event?

Member Data Documentation

The current index.

Definition at line 64 of file nsIXFormsRepeatElement.idl.

Sets whether the repeat is a parent to nested repeats.

Definition at line 74 of file nsIXFormsRepeatElement.idl.

The tree level of this repeat (nested repeats)

Definition at line 84 of file nsIXFormsRepeatElement.idl.

Set parent repeat (nested repeats)

Definition at line 79 of file nsIXFormsRepeatElement.idl.


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