Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDani Megert2008-09-23 15:07:05 +0000
committerDani Megert2008-09-23 15:07:05 +0000
commit13c59e1485e3a20244e6f73089d4abbfb7ce8c70 (patch)
treee879a52b12e464954a330956e4e280a2026d9e0b /org.eclipse.text/src/org/eclipse/jface
parent103b3aa124e3548560471e6ef925b04f8410c056 (diff)
downloadeclipse.platform.text-13c59e1485e3a20244e6f73089d4abbfb7ce8c70.tar.gz
eclipse.platform.text-13c59e1485e3a20244e6f73089d4abbfb7ce8c70.tar.xz
eclipse.platform.text-13c59e1485e3a20244e6f73089d4abbfb7ce8c70.zip
Added package documentation for org.eclipse.jface.text from the org.eclipse.jface.text plug-in
Diffstat (limited to 'org.eclipse.text/src/org/eclipse/jface')
-rw-r--r--org.eclipse.text/src/org/eclipse/jface/text/package.html51
1 files changed, 51 insertions, 0 deletions
diff --git a/org.eclipse.text/src/org/eclipse/jface/text/package.html b/org.eclipse.text/src/org/eclipse/jface/text/package.html
index 1e96df031..04bb34ada 100644
--- a/org.eclipse.text/src/org/eclipse/jface/text/package.html
+++ b/org.eclipse.text/src/org/eclipse/jface/text/package.html
@@ -26,4 +26,55 @@
with a line tracker understanding the three standard line delimiters ("\r",
"\n", "\r\n") and a line tracker which can be freely configured
to consider any given set of strings as valid line delimiters. </p>
+
+
+<!-- ===================================================================================================== -->
+<!-- Below is the package documentation for org.eclipse.jface.text from the org.eclipse.jface.text plug-in -->
+<!-- ===================================================================================================== -->
+
+<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 <code>ITextViewer</code> supports the following plug-ins
+<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>
+
</body></html> \ No newline at end of file

Back to the top