WARNING: Most of this content (with the exception of the Mozilla 1.9 XPCOM reference) is very old, and can be expected to be out of date and possibly obsolete. For better XUL documentation, please visit the XUL hub at the Mozilla Developer Center.

nsIRDFContainer

IID:D4214E90-FB94-11D2-BDD8-00104BDE6048
Inherits From:nsISupports

An object of this interface should be created in the following way:

RDFContainerUtils.MakeSeq(resource)

This interface is implemented by the following components:


Properties

readonly nsIRDFDataSource DataSource

readonly nsIRDFResource Resource


Methods

void AppendElement ( nsIRDFNode element ) PRInt32 GetCount ( ) nsISimpleEnumerator GetElements ( ) PRInt32 IndexOf ( nsIRDFNode element ) void Init ( nsIRDFDataSource dataSource , nsIRDFResource container ) void InsertElementAt ( nsIRDFNode element , PRInt32 index , PRBool renumber ) void RemoveElement ( nsIRDFNode element , PRBool renumber ) nsIRDFNode RemoveElementAt ( PRInt32 index , PRBool renumber )

void AppendElement ( nsIRDFNode element )

Append an element to the container, assigning it the next available ordinal.

Arguments:
element

PRInt32 GetCount ( )

Return the number of elements in the container. Note that this may not always be accurate due to aggregation.


nsISimpleEnumerator GetElements ( )

Return an enumerator that can be used to enumerate the contents of the container in ascending order.


PRInt32 IndexOf ( nsIRDFNode element )

Determine the index of an element in the container.

Arguments:
element
Returns:
The index of the specified element in the container. If the element is not contained in the container, this function returns '-1'.

void Init ( nsIRDFDataSource dataSource , nsIRDFResource container )

Initialize the container wrapper to the specified resource using the specified datasource for context.

Arguments:
dataSource
container

void InsertElementAt ( nsIRDFNode element , PRInt32 index , PRBool renumber )

Insert element at the specified index. If renumber is 'true', then the underlying RDF graph will be 're-numbered' to accomodate the new element.

Arguments:
element
index
renumber

void RemoveElement ( nsIRDFNode element , PRBool renumber )

Remove the first occurence of the specified element from the container. If renumber is 'true', then the underlying RDF graph will be 're-numbered' to account for the removal.

Arguments:
element
renumber

nsIRDFNode RemoveElementAt ( PRInt32 index , PRBool renumber )

Remove the element at the specified index. If renumber is 'true', then the underlying RDF graph will be 're-numbered' to account for the removal.

Arguments:
index
renumber
Returns:
the element that was removed.

References

This interface is returned from the following methods:

nsIRDFContainerUtils.MakeAlt, nsIRDFContainerUtils.MakeBag, nsIRDFContainerUtils.MakeSeq

Reference documentation is generated from Mozilla's source.

Copyright © 1999-2006 XULPlanet.com