KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > jface > text > source > ISourceViewerExtension


1 /*******************************************************************************
2  * Copyright (c) 2000, 2005 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/
11
12 package org.eclipse.jface.text.source;
13
14 /**
15  * Extension interface {@link org.eclipse.jface.text.source.ISourceViewer}.
16  * <p>
17  * Extends the source viewer with the concept of an annotation overview. The
18  * annotation overview differs from the annotation presentation in that it is
19  * independent from the viewer's view port, i.e. the annotations of the whole
20  * document are visible. There are no assumptions about the area in which the
21  * annotation overview is shown.
22  * <p>
23  * As the visibility of annotation overview can dynamically be changed, it is
24  * assumed that the presentation area can dynamically be hidden if it is
25  * different from the text widget.
26  *
27  * @see org.eclipse.jface.text.source.ISourceViewer
28  * @since 2.1
29  */
30 public interface ISourceViewerExtension {
31
32     /**
33      * Shows/hides an overview representation of the annotations of the whole document of this viewer.
34      *
35      * @param show <code>true</code> if annotation overview should be visible, <code>false</code> otherwise
36      */
37     void showAnnotationsOverview(boolean show);
38 }
39
Popular Tags