01 /*
02 * Copyright (c) 1995-2010, The University of Sheffield. See the file
03 * COPYRIGHT.txt in the software or at http://gate.ac.uk/gate/COPYRIGHT.txt
04 *
05 * This file is part of GATE (see http://gate.ac.uk/), and is free
06 * software, licenced under the GNU Library General Public License,
07 * Version 2, June 1991 (in the distribution as file licence.html,
08 * and also available at http://gate.ac.uk/gate/licence.html).
09 *
10 * Valentin Tablan, Sep 11, 2007
11 *
12 * $Id: OwnedAnnotationEditor.java 13726 2011-04-20 16:31:46Z ian_roberts $
13 */
14 package gate.gui.annedit;
15
16 import gate.*;
17 import gate.creole.AnnotationVisualResource;
18
19 /**
20 * Interface for all annotation editor components
21 */
22 public interface OwnedAnnotationEditor extends AnnotationVisualResource{
23
24 /**
25 * Finds the best location for the editor dialog for a given span of text
26 */
27 public void placeDialog(int start, int end);
28
29 /**
30 * Sets the owner (i.e. controller) for this editor.
31 * @param owner
32 */
33 public void setOwner(AnnotationEditorOwner owner);
34
35 /**
36 * @return owner The owner (i.e. controller) for this editor.
37 */
38 public AnnotationEditorOwner getOwner();
39
40 /**
41 * @param pinned true if the window should not move
42 * when an annotation is selected.
43 */
44 public void setPinnedMode(boolean pinned);
45
46 /**
47 * Enable or disable the editing GUI components.
48 * @param isEditingEnabled true to enable the editing,
49 * false to disable it
50 */
51 public void setEditingEnabled(boolean isEditingEnabled);
52 }
|