gate.VisualResource Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gate-core Show documentation

GATE - general achitecture for text engineering - is open source software capable of solving almost any text processing problem. This artifact enables you to embed the core GATE Embedded with its essential dependencies. You will able to use the GATE Embedded API and load and store GATE XML documents. This artifact is the perfect dependency for CREOLE plugins or for applications that need to customize the GATE dependencies due to confict with their own dependencies or for lower footprint.

The newest version!

/*
 *  VisualResource.java
 *
 *  Copyright (c) 1995-2012, The University of Sheffield. See the file
 *  COPYRIGHT.txt in the software or at http://gate.ac.uk/gate/COPYRIGHT.txt
 *
 *  This file is part of GATE (see http://gate.ac.uk/), and is free
 *  software, licenced under the GNU Library General Public License,
 *  Version 2, June1991.
 *
 *  A copy of this licence is included in the distribution in the file
 *  licence.html, and is also available at http://gate.ac.uk/gate/licence.html.
 *
 *  Hamish Cunningham, 16/Oct/2000
 *
 *  $Id: VisualResource.java 15832 2012-05-23 10:06:06Z valyt $
 */

package gate;

import gate.gui.Handle;

/** Models all sorts of visual resources.
  */
public interface VisualResource extends Resource{
  /**
   * Called by the GUI when this viewer/editor has to initialise itself for a
   * specific object.
   * @param target the object (be it a {@link gate.Resource},
   * {@link gate.DataStore} or whatever) this viewer has to display
   * 
   * @throws IllegalArgumentException if the view is incapable of displaying 
   * the supplied target resource, for whatever reason.   
   */
  public void setTarget(Object target) throws IllegalArgumentException;


  /**
   * Used by the main GUI to tell this VR what handle created it. The VRs can
   * use this information e.g. to add items to the popup for the resource.
   */
  public void setHandle(Handle handle);

  /**
   * Used by the main GUI to tell this VR that the object it's displaying has
   * been reinitialised and so the VR may need to update it's display. The
   * default implementation does nothing which replicates the behaviour from
   * before the method was added.
   */
  default void targetReinitialised() {
    // do nothing
  }

} // interface VisualResource