KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > modules > xml > xam > ui > highlight > Highlight


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 org.netbeans.modules.xml.xam.Component;
23
24 /**
25  * Represents a highlighted component.
26  *
27  * @author Nathan Fiedler
28  */
29 public abstract class Highlight {
30     /** The type for a search result highlight. */
31     public static final String JavaDoc SEARCH_RESULT = "searchResult";
32     /** The type for the parent of a search result highlight. */
33     public static final String JavaDoc SEARCH_RESULT_PARENT = "searchResultParent";
34     /** The type for a find usages result highlight. */
35     public static final String JavaDoc FIND_USAGES_RESULT_PARENT = "find-usages-result-parent";
36     /** The type for the parent of a find usages result highlight. */
37     public static final String JavaDoc FIND_USAGES_RESULT = "find-usages-result";
38     /** The highlighted component. */
39     private Component component;
40     /** Type of highlight. */
41     private String JavaDoc type;
42
43     /**
44      * Creates a new instance of Highlight.
45      *
46      * @param component highlighted component.
47      * @param type highlight type.
48      */
49     public Highlight(Component component, String JavaDoc type) {
50         assert component != null;
51         assert type != null;
52         this.component = component;
53         this.type = type;
54     }
55
56     public boolean equals(Object JavaDoc obj) {
57         if (obj instanceof Highlight) {
58             Highlight oh = (Highlight) obj;
59             // We assert that these fields are non-null.
60 return type.equals(oh.type) && component.equals(oh.component);
61         }
62         return false;
63     }
64
65     /**
66      * Return the component that is highlighted.
67      *
68      * @return highlighted component.
69      */
70     public Component getComponent() {
71         return component;
72     }
73
74     /**
75      * Return the type of this highlight.
76      *
77      * @return type of highlight.
78      */
79     public String JavaDoc getType() {
80         return type;
81     }
82
83     public int hashCode() {
84         return type.hashCode() + component.hashCode();
85     }
86 }
87
Popular Tags