ActionsPublisher.java
01 /*
02  *  Copyright (c) 1995-2012, 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 21/11/2002
11  *
12  *  $Id: ActionsPublisher.java 15333 2012-02-07 13:18:33Z ian_roberts $
13  *
14  */
15 
16 package gate.gui;
17 
18 import java.util.List;
19 
20 import javax.swing.Action;
21 
22 /**
23  * This interface is used to mark resources that publish a list of actions
24  * that can be performed on them.
25  * Those actions will automatically be added to the appropriate menus when
26  * needed.
27  */
28 
29 public interface ActionsPublisher {
30   /**
31    * Returns a list of Action objects. This method will be called everytime a
32    * menu for this resource needs to be built, thus allowing for dynamic updates
33    * to the list of actions.
34    * A <tt>null</tt> value in this list will cause a separator to be created.
35    @return {@link List} of {@link javax.swing.Action}s.
36    */
37   public List<Action> getActions();
38 }