blob: a866e03eaa4949b09547dbe3a4c043d48357fb14 [file] [log] [blame]
<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<meta name="Author" content="IBM">
<meta name="GENERATOR" content="Mozilla/4.51 [en] (WinNT; I) [Netscape]">
<title>Package-level Javadoc</title>
</head>
<body>
Provides a framework for editing text documents.
<h2>
Package Specification</h2>
<p>The packages defines and implements a viewer for text documents.</p>
<p><tt>ITextViewer</tt> defines the concept of a document based, editiable viewer.
<tt>ITextViewer</tt> offers the following functionality: </p>
<ul>
<li>
present a document</li>
<li>
event consumption (<tt>IEventConsumer</tt>)</li>
<li>
viewport tracking and notification (<tt>IIViewportListener</tt>)</li>
<li>
change notification (<tt>ITextListener</tt>, <tt>ITextInputListener</tt>)</li>
<li>
listeners (combined view/model notification, input document)</li>
<li>
standard text editing functions plus text hover support</li>
<li>
visual region support</li>
</ul>
An ITextViewer supports the following plugins
<ul>
<li>
<tt>IUndoManager</tt> for the undo/redo mechanism</li>
<li>
<tt>IDoubleClickStrategy</tt> for partition type specific behavior on mouse
double click</li>
<li>
<tt>IAutoIndentStrategy</tt>&nbsp; for content type specific behavior on
inserting a line break</li>
<li>
<tt>ITextHover</tt> for content type specific behavior when overing over
text</li>
</ul>
The package provides default implementations for all these interfaces.
</body>
</html>