001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package org.netbeans.modules.xml.xam.ui.highlight;
043:
044: import java.util.HashSet;
045: import java.util.Set;
046:
047: /**
048: * A collection of Highlight objects, which are shown or hidden as a group.
049: *
050: * @author Nathan Fiedler
051: */
052: public class HighlightGroup {
053: /** Type of highlight group for search results (includes parents). */
054: public static final String SEARCH = "search";
055: /** Set of Highlight instances. */
056: private Set<Highlight> highlights;
057: /** The type of this group. */
058: private String type;
059: /** True if this group is shown, false if hidden. */
060: private boolean showing;
061:
062: /**
063: * Creates a new instance of HighlightGroup.
064: *
065: * @param type highlight group type.
066: */
067: public HighlightGroup(String type) {
068: assert type != null;
069: this .type = type;
070: highlights = new HashSet<Highlight>();
071: }
072:
073: /**
074: * Add the given Highlight to this group.
075: *
076: * @param hl Highlight to be added.
077: */
078: public void addHighlight(Highlight hl) {
079: highlights.add(hl);
080: }
081:
082: /**
083: * Return the group type.
084: *
085: * @return group type.
086: */
087: public String getType() {
088: return type;
089: }
090:
091: /**
092: * Return true if group is showing, false otherwise.
093: *
094: * @return true if group is showing, false otherwise.
095: */
096: public boolean isShowing() {
097: return showing;
098: }
099:
100: /**
101: * Return the set of highlights in this group.
102: *
103: * @return highlight set.
104: */
105: public Set<Highlight> highlights() {
106: return highlights;
107: }
108:
109: /**
110: * Set the showing property for tracking this group's visibility.
111: *
112: * @param showing true if showing, false if hidden.
113: */
114: public void setShowing(boolean showing) {
115: this.showing = showing;
116: }
117: }
|