VisualResource.java
01 /*
02  *  VisualResource.java
03  *
04  *  Copyright (c) 1995-2012, The University of Sheffield. See the file
05  *  COPYRIGHT.txt in the software or at http://gate.ac.uk/gate/COPYRIGHT.txt
06  *
07  *  This file is part of GATE (see http://gate.ac.uk/), and is free
08  *  software, licenced under the GNU Library General Public License,
09  *  Version 2, June1991.
10  *
11  *  A copy of this licence is included in the distribution in the file
12  *  licence.html, and is also available at http://gate.ac.uk/gate/licence.html.
13  *
14  *  Hamish Cunningham, 16/Oct/2000
15  *
16  *  $Id: VisualResource.java 15832 2012-05-23 10:06:06Z valyt $
17  */
18 
19 package gate;
20 
21 import gate.gui.Handle;
22 
23 /** Models all sorts of visual resources.
24   */
25 public interface VisualResource extends Resource{
26   /**
27    * Called by the GUI when this viewer/editor has to initialise itself for a
28    * specific object.
29    @param target the object (be it a {@link gate.Resource},
30    {@link gate.DataStore} or whatever) this viewer has to display
31    
32    @throws IllegalArgumentException if the view is incapable of displaying 
33    * the supplied target resource, for whatever reason.   
34    */
35   public void setTarget(Object targetthrows IllegalArgumentException;
36 
37 
38   /**
39    * Used by the main GUI to tell this VR what handle created it. The VRs can
40    * use this information e.g. to add items to the popup for the resource.
41    */
42   public void setHandle(Handle handle);
43 
44 // interface VisualResource