Top   Module   Use   Manual   Index 
 EXPORTING SERVICES | METHODS' SUMMARY | METHODS' DETAILS 

com :: sun :: star :: container ::

interface XEnumeration

Base Interface
com::sun::star::uno::XInterface

Description
provides functionality to enumerate the contents of a container.

An object that implements the XEnumeration interface generates a series of elements, one at a time. Successive calls to the XEnumeration::nextElement method return successive elements of the series.

For example (Java), to print all elements of a vector aVect :

 for ( XEnumeration xEnum = aVect.elements() ;
 xEnum.hasMoreElements() ; )
 {
 System.out.println( xEnum.nextElement() );
 }

If the object changed, the behavior of the enumeration is not specified. This is not a remote interface.



Known Services which Export this Interface

com::sun::star::table::TableChartsEnumeration represents an enumeration of table charts.
com::sun::star::table::TableColumnsEnumeration represents an enumeration of table columns.
com::sun::star::table::TableRowsEnumeration represents an enumeration of table rows.
com::sun::star::sheet::CellFormatRangesEnumeration enumerates ranges with different formatting.
com::sun::star::sheet::CellAnnotationsEnumeration represents an enumeration of cell annotations in a spreadsheet document.
com::sun::star::sheet::CellsEnumeration represents an enumeration of spreadsheet cells.
com::sun::star::sheet::SheetCellRangesEnumeration represents an enumeration of cell ranges in a spreadsheet document.
com::sun::star::packages::PackageFolderEnumeration This service provides an iterator over the contents of a given instance of a PackageFolder. This provides a "snapshot" of the contents of the PackageFolder at the time of construction. It is the responsibility of the caller to ensure that any given member of the enumeration refers to a valid PackageStream or PackageFolder.
com::sun::star::text::TextPortionEnumeration This interface creates an enumeration of paragraph within a text document. The elements created by this enumeration contains either parts of text with equal properties or text content elements like text fields, reference marks or bookmarks.
com::sun::star::text::ParagraphEnumeration provides access to the paragraphs of an XText interface.
com::sun::star::text::TextFieldEnumeration This interface creates an enumeration of all text fields within a text document.

Methods' Summary

hasMoreElements tests whether this enumeration contains more elements.
nextElement

Methods' Details

hasMoreElements
 
boolean
hasMoreElements();
Description
tests whether this enumeration contains more elements.
nextElement
 
any
nextElement( )
raises ( com::sun::star::container::NoSuchElementException, com::sun::star::lang::WrappedTargetException );

Returns
the next element of this enumeration.
Throws
NoSuchElementException if no more elements exist.
Throws
com::sun::star::lang::WrappedTargetException If the implementation has internal reasons for exceptions, then wrap these in a WrappedTargetException exception.

Top of Page