Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKai Maetzel2004-06-23 20:01:37 +0000
committerKai Maetzel2004-06-23 20:01:37 +0000
commit4025624a1378f92c24533b9507752cf6a110e3df (patch)
treef35c5073cec00783ab6741ac46959bf975d955ee /org.eclipse.jface.text/src/org/eclipse/jface/text/ITextViewerExtension4.java
parentd6e189e884be8b74de32491a4638780c2b44e73f (diff)
downloadeclipse.platform.text-4025624a1378f92c24533b9507752cf6a110e3df.tar.gz
eclipse.platform.text-4025624a1378f92c24533b9507752cf6a110e3df.tar.xz
eclipse.platform.text-4025624a1378f92c24533b9507752cf6a110e3df.zip
updated Javadoc
Diffstat (limited to 'org.eclipse.jface.text/src/org/eclipse/jface/text/ITextViewerExtension4.java')
-rw-r--r--org.eclipse.jface.text/src/org/eclipse/jface/text/ITextViewerExtension4.java22
1 files changed, 14 insertions, 8 deletions
diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/ITextViewerExtension4.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/ITextViewerExtension4.java
index bc9ee288498..87b68617861 100644
--- a/org.eclipse.jface.text/src/org/eclipse/jface/text/ITextViewerExtension4.java
+++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/ITextViewerExtension4.java
@@ -12,21 +12,27 @@ package org.eclipse.jface.text;
/**
- * Extension interface for <code>ITextViewer</code>. Adds the following functionality:
- * <ul>
- * <li>focus handling for widget token keepers</li>
- * <li>introduces text presentation listener</li>
- * </ul>
+ * Extension interface for {@link org.eclipse.jface.text.ITextViewer}.
+ * Introduces the concept of text presentation listeners and improves focus
+ * handling among widget token keepers.
+ * <p>
+ * A {@link org.eclipse.jface.text.ITextPresentationListener}is a listener that
+ * is informed by the viewer that a text presentation is about to be applied.
+ * During this callback the listener is allowed to modify the presentation. Text
+ * presentation listeners are thus a mean to participate in the process of text
+ * presentation creation.
*
* @since 3.0
*/
public interface ITextViewerExtension4 {
/**
- * Instructs the receiver to request the <code>IWidgetTokenKeeper</code>
- * currently holding the widget token to take the keyboard focus.
+ * Instructs the receiver to request the {@link IWidgetTokenKeeper}
+ * currently holding the widget token to take the keyboard focus.
*
- * @return <code>true</code> if there was any <code>IWidgetTokenKeeper</code> that was asked to take the focus, <code>false</code> otherwise
+ * @return <code>true</code> if there was any
+ * <code>IWidgetTokenKeeper</code> that was asked to take the
+ * focus, <code>false</code> otherwise
*/
boolean moveFocusToWidgetToken();

Back to the top