javax.ide.model.text
Class TextDocument

java.lang.Object
  javax.ide.model.Element
      javax.ide.model.Document
          javax.ide.model.text.TextDocument

Direct Known Subclasses:

JavaSource, XMLDocument

public class TextDocument
extends Document

The TextDocument class.

Constructor Summary

TextDocument()

Method Summary

TextModel

getTextModel() Fetches the document contents.

Methods inherited from class javax.ide.model.Document

addDocumentListener, close, equals, getDisplayInfo, getElementImpl, getReader, getTimestamp, getURI, hashCode, isDirty, isNew, isOpen, isReadOnly, markDirty, open, removeDocumentListener, save, setDisplayInfo, setURI

Methods inherited from class javax.ide.model.Element

getIcon, getLabel, getLongLabel, getToolTip

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TextDocument

public TextDocument()

Method Detail

getTextModel

public final TextModel getTextModel()
                             throws java.io.IOException

Fetches the document contents. This calls opens the document and loads its contents. The document instance returned lives while clients refer to it. Once a document instance is not referred by clients it may be garbage collected at any time.

Returns:

the TextModel containing the document text.

Throws:

java.io.IOException - if the document cannot be opened.