Highlighted


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-2007 Sun
17   * Microsystems, Inc. All Rights Reserved.
18   */
19  
20  package org.netbeans.modules.xml.xam.ui.highlight;
21  
22  import java.util.EventListener  ;
23  import java.util.Set  ;
24  import org.netbeans.modules.xml.xam.Component;
25  
26  /**
27   * A Highlighted object has the ability to highlight its visual
28   * representation based on a particular Highlight object.
29   *
30   * @author Nathan Fiedler
31   */
32  public interface Highlighted extends EventListener   {
33  
34      /**
35       * Get the set of components this listener is interested in.
36       *
37       * @return  set of component references (empty if none).
38       */
39      Set  <Component> getComponents();
40  
41      /**
42       * The highlight has been added to the highlight manager. The listener
43       * should make the highlight visible in some way.
44       *
45       * @param  hl  Highlight to be shown.
46       */
47      void highlightAdded(Highlight hl);
48  
49      /**
50       * The highlight has been removed from the highlight manager. The listener
51       * should hide the highlight from the user.
52       *
53       * @param  hl  Highlight to be hidden.
54       */
55      void highlightRemoved(Highlight hl);
56  }
57
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags