edu.rice.cs.util.swing
Interface DocumentIterator

All Known Implementing Classes:

AbstractGlobalModel, DefaultGlobalModel, DocumentCacheTest.TestGlobalModel, GlobalModelTestCase.TestGlobalModel

public interface DocumentIterator

Used to get the next or previous open document given the current one.

Method Summary

int	getDocumentCount()
OpenDefinitionsDocument	getNextDocument(OpenDefinitionsDocument doc) Gets the next document.
OpenDefinitionsDocument	getNextDocument(OpenDefinitionsDocument doc, Component frame) Gets the next document.
OpenDefinitionsDocument	getPrevDocument(OpenDefinitionsDocument doc) Gets the previous document.

Method Detail

getNextDocument

OpenDefinitionsDocument getNextDocument(OpenDefinitionsDocument doc)

Gets the next document.

Parameters:

doc - the current document.

Returns:

the next document.

getNextDocument

OpenDefinitionsDocument getNextDocument(OpenDefinitionsDocument doc,
                                        Component frame)

Gets the next document.

Parameters:

doc - the current document.

frame - a frame for use with dialog popups

Returns:

the next document.

getPrevDocument

OpenDefinitionsDocument getPrevDocument(OpenDefinitionsDocument doc)

Gets the previous document.

Parameters:

doc - the current document.

Returns:

the previous document.

getDocumentCount

int getDocumentCount()

Returns:

the number of documents being iterated over