NodeActionsProviderFilter


1   /*
2    * The contents of this file are subject to the terms of the Common Development
3    * and Distribution License (the License). You may not use this file except in
4    * compliance with the License.
5    *
6    * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7    * or http://www.netbeans.org/cddl.txt.
8    *
9    * When distributing Covered Code, include this CDDL Header Notice in each file
10   * and include the License file at http://www.netbeans.org/cddl.txt.
11   * If applicable, add the following below the CDDL Header, with the fields
12   * enclosed by brackets [] replaced by your own identifying information:
13   * "Portions Copyrighted [year] [name of copyright owner]"
14   *
15   * The Original Software is NetBeans. The Initial Developer of the Original
16   * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17   * Microsystems, Inc. All Rights Reserved.
18   */
19  
20  package org.netbeans.spi.viewmodel;
21  
22  import javax.swing.Action  ;
23  
24  
25  /**
26   * Filters actions provided by some original {@link NodeActionsProvider}.
27   * It can be used to add some new actions to nodes pop-up menu, remove
28   * some actions or redefine behaviour of some actions.
29   *
30   * @author   Jan Jancura
31   */
32  public interface NodeActionsProviderFilter extends Model {
33  
34  
35      /**
36       * Performs default action for given node. You should not throw
37       * UnknownTypeException directly from this method!
38       *
39       * @throws  UnknownTypeException this exception can be thrown from 
40       *          <code>original.performDefaultAction (...)</code> method call only!
41       */
42      public abstract void performDefaultAction (
43          NodeActionsProvider original,
44          Object   node
45      ) throws UnknownTypeException;
46      
47      /**
48       * Returns set of actions for given node. You should not throw UnknownTypeException
49       * directly from this method!
50       *
51       * @throws  UnknownTypeException this exception can be thrown from 
52       *          <code>original.getActions (...)</code> method call only!
53       * @return  set of actions for given node
54       */
55      public abstract Action  [] getActions (
56           NodeActionsProvider original,
57           Object   node
58      ) throws UnknownTypeException;
59  
60      /** 
61       * Registers given listener.
62       * 
63       * @param l the listener to add
64       */
65  //    public abstract void addModelListener (ModelListener l);
66  
67      /** 
68       * Unregisters given listener.
69       *
70       * @param l the listener to remove
71       */
72  //    public abstract void removeModelListener (ModelListener l);
73  }
74
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags