Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKai Maetzel2004-06-21 15:52:20 +0000
committerKai Maetzel2004-06-21 15:52:20 +0000
commitb12fd50071c766ec391197a0db9243dee403ab10 (patch)
tree384a9e019bd960e9c998f789699946877c7212ce
parent96c90cae5bf9e6f8ed7f858b09c765851686453e (diff)
downloadeclipse.platform.text-b12fd50071c766ec391197a0db9243dee403ab10.tar.gz
eclipse.platform.text-b12fd50071c766ec391197a0db9243dee403ab10.tar.xz
eclipse.platform.text-b12fd50071c766ec391197a0db9243dee403ab10.zip
updated Javadoc
-rw-r--r--org.eclipse.text/src/org/eclipse/jface/text/IDocumentPartitioningListener.java33
-rw-r--r--org.eclipse.text/src/org/eclipse/jface/text/IDocumentPartitioningListenerExtension.java16
-rw-r--r--org.eclipse.text/src/org/eclipse/jface/text/IDocumentPartitioningListenerExtension2.java17
3 files changed, 52 insertions, 14 deletions
diff --git a/org.eclipse.text/src/org/eclipse/jface/text/IDocumentPartitioningListener.java b/org.eclipse.text/src/org/eclipse/jface/text/IDocumentPartitioningListener.java
index 742cd9d62..e7b202db8 100644
--- a/org.eclipse.text/src/org/eclipse/jface/text/IDocumentPartitioningListener.java
+++ b/org.eclipse.text/src/org/eclipse/jface/text/IDocumentPartitioningListener.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
@@ -15,18 +15,39 @@ package org.eclipse.jface.text;
/**
* Interface of objects which are interested in getting informed
* about changes of a document's partitioning. Clients may
- * implement this interface.
+ * implement this interface.<p>
+ *
+ * In order to provided backward compatibility for clients of <code>IDocumentPartitioningListener</code>, extension
+ * interfaces are used to provide a means of evolution. The following extension interfaces
+ * exist:
+ * <ul>
+ * <li> {@link org.eclipse.jface.text.IDocumentPartitioningListenerExtension} since version 2.0 replacing the original
+ * notification mechanism.</li>
+ * <li> {@link org.eclipse.jface.text.IDocumentPartitioningListenerExtension2} since version 3.0 replacing all previous
+ * notification mechanisms. Thus, implementers up-to-date with version 3.0 do not have to implement
+ * {@link org.eclipse.jface.text.IDocumentPartitioningListenerExtension}.</li>
+ * </ul>
*
- * @see IDocument
- * @see IDocumentPartitioner
+ * @see org.eclipse.jface.text.IDocumentPartitioningListenerExtension
+ * @see org.eclipse.jface.text.IDocumentPartitioningListenerExtension2
+ * @see org.eclipse.jface.text.IDocument
+ * @see org.eclipse.jface.text.IDocumentPartitioner
*/
public interface IDocumentPartitioningListener {
/**
* The partitioning of the given document changed.
- *
+ * <p>
+ * In version 2.0 this method has been replaces by
+ * {@link IDocumentPartitioningListenerExtension#documentPartitioningChanged(IDocument, IRegion)}.
+ * <p>
+ * In version 3.0 this method has been replaces by
+ * {@link IDocumentPartitioningListenerExtension2#documentPartitioningChanged(DocumentPartitioningChangedEvent)}<p>
+ *
* @param document the document whose partitioning changed
- *
+ *
+ * @see IDocumentPartitioningListenerExtension#documentPartitioningChanged(IDocument, IRegion)
+ * @see IDocumentPartitioningListenerExtension2#documentPartitioningChanged(DocumentPartitioningChangedEvent)
* @see IDocument#addDocumentPartitioningListener(IDocumentPartitioningListener)
*/
void documentPartitioningChanged(IDocument document);
diff --git a/org.eclipse.text/src/org/eclipse/jface/text/IDocumentPartitioningListenerExtension.java b/org.eclipse.text/src/org/eclipse/jface/text/IDocumentPartitioningListenerExtension.java
index d8413910d..a0b68e9b4 100644
--- a/org.eclipse.text/src/org/eclipse/jface/text/IDocumentPartitioningListenerExtension.java
+++ b/org.eclipse.text/src/org/eclipse/jface/text/IDocumentPartitioningListenerExtension.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
@@ -13,9 +13,11 @@ package org.eclipse.jface.text;
/**
- * Extension interface for <code>IDocumentPartitioningListener</code>. Extends the original
- * partitioning listener concept by telling the listener the minimal region that comprises all
- * partitioning changes.
+ * Extension interface for
+ * {@link org.eclipse.jface.text.IDocumentPartitioningListener}.
+ * <p>
+ * Replaces the original notification mechanism by telling the listener the
+ * minimal region that comprises all partitioning changes.
*
* @see org.eclipse.jface.text.IDocumentPartitionerExtension
* @since 2.0
@@ -24,9 +26,13 @@ public interface IDocumentPartitioningListenerExtension {
/**
* The partitioning of the given document changed in the given region.
- *
+ * <p>
+ * In version 3.0, this method has been replaced with
+ * {@link IDocumentPartitioningListenerExtension2#documentPartitioningChanged(DocumentPartitioningChangedEvent)}.
+ *
* @param document the document whose partitioning changed
* @param region the region in which the partitioning changed
+ * @see IDocumentPartitioningListenerExtension2#documentPartitioningChanged(DocumentPartitioningChangedEvent)
* @see IDocument#addDocumentPartitioningListener(IDocumentPartitioningListener)
*/
void documentPartitioningChanged(IDocument document, IRegion region);
diff --git a/org.eclipse.text/src/org/eclipse/jface/text/IDocumentPartitioningListenerExtension2.java b/org.eclipse.text/src/org/eclipse/jface/text/IDocumentPartitioningListenerExtension2.java
index 21db55acd..b2bd1d5df 100644
--- a/org.eclipse.text/src/org/eclipse/jface/text/IDocumentPartitioningListenerExtension2.java
+++ b/org.eclipse.text/src/org/eclipse/jface/text/IDocumentPartitioningListenerExtension2.java
@@ -1,5 +1,5 @@
/**********************************************************************
-Copyright (c) 2000, 2003 IBM Corp. and others.
+Copyright (c) 2000, 2004 IBM Corporation and others.
All rights reserved. This program and the accompanying materials
are made available under the terms of the Common Public License v1.0
which accompanies this distribution, and is available at
@@ -11,15 +11,26 @@ Contributors:
package org.eclipse.jface.text;
/**
- * Extension interface to <code>DocumentPartitioningListener</code>. Replaces the previous concepts.
+ * Extension interface to
+ * {@link org.eclipse.jface.text.IDocumentPartitioningListener}.
+ * <p>
*
+ * Replaces the previous notification mechanisms by introducing an explicit
+ * document partitioning changed event.
+ *
+ * @see org.eclipse.jface.text.DocumentPartitioningChangedEvent
* @since 3.0
*/
public interface IDocumentPartitioningListenerExtension2 {
/**
* Signals the change of document partitionings.
- *
+ * <p>
+ * This method replaces
+ * {@link IDocumentPartitioningListener#documentPartitioningChanged(IDocument)}
+ * and
+ * {@link IDocumentPartitioningListenerExtension2#documentPartitioningChanged(DocumentPartitioningChangedEvent)}.
+ *
* @param event the event describing the change
* @see IDocument#addDocumentPartitioningListener(IDocumentPartitioningListener)
*/

Back to the top