KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > ui > texteditor > ITextEditorExtension3


1 /*******************************************************************************
2  * Copyright (c) 2000, 2006 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.ui.texteditor;
13
14 /**
15  * Extension interface for {@link org.eclipse.ui.texteditor.ITextEditor}. Adds
16  * the following functions:
17  * <ul>
18  * <li>insert mode management</li>
19  * </ul>
20  *
21  * @since 3.0
22  */
23 public interface ITextEditorExtension3 {
24
25     /**
26      * Constitutes entities to enumerate the editor insert modes.
27      */
28     public static class InsertMode {
29         private InsertMode() {
30         }
31     }
32
33     /**
34      * Represents the non-smart insert mode.
35      */
36     final static InsertMode INSERT= new InsertMode();
37     /**
38      * Represents the smart insert mode.
39      */
40     final static InsertMode SMART_INSERT= new InsertMode();
41
42
43     /**
44      * Returns the current input mode of this editor.
45      *
46      * @return the current input mode of this editor
47      */
48     InsertMode getInsertMode();
49
50     /**
51      * Sets the insert mode of this editor.
52      *
53      * @param mode the new insert mode
54      * @exception IllegalArgumentException if <code>mode</code> is not a legal insert mode for this editor
55      */
56     void setInsertMode(InsertMode mode);
57
58     /**
59      * Sets the display of quick diff information.
60      *
61      * @param show <code>true</code> if quick diff information should be shown, <code>false</code> otherwise
62      */
63     void showChangeInformation(boolean show);
64
65     /**
66      * Returns the quick diff display state.
67      *
68      * @return <code>true</code> if quick diff info is displayed, <code>false</code> otherwise
69      */
70     boolean isChangeInformationShowing();
71 }
72
Popular Tags