edu.rice.cs.drjava.model
Interface SingleDisplayModel

All Superinterfaces:

GlobalModel, ILoadDocuments

All Known Implementing Classes:

AbstractGlobalModel, DefaultGlobalModel, DocumentCacheTest.TestGlobalModel, GlobalModelTestCase.TestGlobalModel

public interface SingleDisplayModel
extends GlobalModel

A GlobalModel that enforces invariants associated with having one active document at a time. Invariants:

1. GlobalModel.getOpenDefinitionsDocuments() will always return an array of at least size 1.
2. (follows from previous) If there is ever no document in the model, a new one will be created.
3. There is always exactly one active document, which can be get/set via getActiveDocument() and setActiveDocument(edu.rice.cs.drjava.model.OpenDefinitionsDocument).

Other functions added by this class:

1. When calling ILoadDocuments.openFile(edu.rice.cs.util.FileOpenSelector), if there is currently only one open document, and it is untitled and unchanged, it will be closed after the new document is opened. This means that, in one atomic transaction, the model goes from having one totally empty document open to having one document (the requested one) open.

Version:

$Id: SingleDisplayModel.java 5175 2010-01-20 08:46:32Z mgricken $

Method Summary

boolean	closeAllFilesOnQuit()
boolean	closeFiles(java.util.List<OpenDefinitionsDocument> docList) Shared code between close project and close All files which only sets the new active document after all documents to be closed have been closed.
void	dispose()
void	disposeExternalResources() Disposes of external resources, e.g.
void	ensureJVMStarterFinished() Ensures that the _jvmStarter thread has executed.
OpenDefinitionsDocument	getActiveDocument()
java.awt.Container	getDocCollectionWidget()
java.io.File[]	getExclFiles() Return an array of the files excluded from the current project
void	refreshActiveDocument() Invokes the activeDocumentChanged method in the global listener on the argument _activeDocument.
void	setActiveDocument(OpenDefinitionsDocument doc) Sets the currently active document by updating the selection model.
void	setActiveFirstDocument()
void	setActiveNextDocument() Sets the active document to be the next one in the list.
void	setActivePreviousDocument() Sets the active document to be the previous one in the list.
void	setExcludedFiles(java.io.File[] fs) Sets the array of files excluded from the current project

Methods inherited from interface edu.rice.cs.drjava.model.GlobalModel

addAuxiliaryFile, addListener, addToBrowserHistory, cleanBuildDirectory, clearHistory, closeAllFiles, closeFile, closeFileWithoutPrompt, closeProject, configNewProject, createFindResultsManager, createNewProject, findFileInPaths, fixPathForNavigator, forceQuit, getAutoRefreshStatus, getAuxiliaryBinTitle, getAuxiliaryDocuments, getBookmarkManager, getBreakpointManager, getBrowserHistoryManager, getBuildDirectory, getClassFiles, getClassPath, getCompilerModel, getConsoleDocument, getCreateJarFile, getCreateJarFlags, getCustomManifest, getDebugger, getDebugPort, getDocumentCount, getDocumentForFile, getDocumentIterator, getDocumentNavigator, getEditorKit, getExternalBinTitle, getExtraClassPath, getHistoryAsString, getHistoryAsStringWithSemicolons, getInteractionsClassPath, getInteractionsDocument, getInteractionsModel, getJavadocModel, getJUnitModel, getLLOpenDefinitionsDocuments, getMainClass, getMainClassContainingFile, getMasterWorkingDirectory, getNonProjectDocuments, getNotifier, getNumCompErrors, getODDForDocument, getOpenDefinitionsDocuments, getOutOfSyncDocuments, getOutOfSyncDocuments, getPageFormat, getPreferencesStoredInProject, getProjectDocuments, getProjectFile, getProjectFiles, getProjectRoot, getSourceBinTitle, getSourceFile, getSourceRootSet, getSwingConsoleDocument, getSwingInteractionsDocument, getWorkingDirectory, hasModifiedDocuments, hasModifiedDocuments, hasOutOfSyncDocuments, hasOutOfSyncDocuments, hasUntitledDocuments, inProject, inProjectPath, interpretCurrentInteraction, isProjectActive, isProjectChanged, loadHistory, loadHistoryAsScript, newFile, newFile, newTestCase, openFolder, openProject, printDebugMessage, quit, reloadProject, removeAuxiliaryFile, removeFindResultsManager, removeListener, resetConsole, resetInteractions, resetInteractions, saveAllFiles, saveConsoleCopy, saveHistory, saveHistory, saveProject, setAutoRefreshStatus, setBuildDirectory, setCreateJarFile, setCreateJarFlags, setCustomManifest, setDocumentNavigator, setExtraClassPath, setMainClass, setNumCompErrors, setPageFormat, setPreferencesStoredInProject, setProjectChanged, setProjectFile, setProjectRoot, setWorkingDirectory, systemErrPrint, systemInEcho, systemOutPrint

Methods inherited from interface edu.rice.cs.drjava.model.ILoadDocuments

openFile, openFiles

Method Detail

getActiveDocument

OpenDefinitionsDocument getActiveDocument()

Returns:

the currently active document.

setActiveDocument

void setActiveDocument(OpenDefinitionsDocument doc)

Sets the currently active document by updating the selection model.

Parameters:

doc - Document to set as active

refreshActiveDocument

void refreshActiveDocument()

Invokes the activeDocumentChanged method in the global listener on the argument _activeDocument.

Specified by:

refreshActiveDocument in interface GlobalModel

getDocCollectionWidget

java.awt.Container getDocCollectionWidget()

Returns:

the IDocumentNavigator container expressed as an AWT component.

setActiveNextDocument

void setActiveNextDocument()

Sets the active document to be the next one in the list.

setActivePreviousDocument

void setActivePreviousDocument()

Sets the active document to be the previous one in the list.

closeFiles

boolean closeFiles(java.util.List<OpenDefinitionsDocument> docList)

Shared code between close project and close All files which only sets the new active document after all documents to be closed have been closed.

Specified by:

closeFiles in interface GlobalModel

Parameters:

docList - the list of files to close

Returns:

whether all files were closed

setActiveFirstDocument

void setActiveFirstDocument()

dispose

void dispose()

disposeExternalResources

void disposeExternalResources()

Disposes of external resources, e.g. other VMs.

closeAllFilesOnQuit

boolean closeAllFilesOnQuit()

getExclFiles

java.io.File[] getExclFiles()

Return an array of the files excluded from the current project

setExcludedFiles

void setExcludedFiles(java.io.File[] fs)

Sets the array of files excluded from the current project

ensureJVMStarterFinished

void ensureJVMStarterFinished()

Ensures that the _jvmStarter thread has executed. Never called in practice outside of GlobalModelTestCase.setUp().