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.category;
043:
044: import java.awt.Component;
045: import java.beans.PropertyChangeListener;
046: import javax.swing.JToolBar;
047: import org.openide.util.Lookup;
048:
049: /**
050: * A CategoryPane manages a set of Category instances, displaying one
051: * category at any given time, and providing a means of selecting the
052: * category to be shown.
053: *
054: * @author Nathan Fiedler
055: */
056: public interface CategoryPane {
057: /** Property name for the selected Category. */
058: public static final String PROP_CATEGORY = "category";
059:
060: /**
061: * Adds the Category to this pane. All of the available categories
062: * must be added before the populateToolbar() method is invoked.
063: *
064: * @param category Category to be added.
065: */
066: void addCategory(Category category);
067:
068: /**
069: * Add a PropertyChangeListener to the listener list.
070: *
071: * @param listener property change listener to add.
072: */
073: void addPropertyChangeListener(PropertyChangeListener listener);
074:
075: /**
076: * Add a PropertyChangeListener for a specific property.
077: *
078: * @param name name of property to listen to.
079: * @param listener property change listener to add.
080: */
081: void addPropertyChangeListener(String name,
082: PropertyChangeListener listener);
083:
084: /**
085: * Returns the currently selected Category.
086: *
087: * @return currently seleced Category, or null if none.
088: */
089: Category getCategory();
090:
091: /**
092: * Returns the user interface component for this category pane.
093: *
094: * @return the user interface component.
095: */
096: Component getComponent();
097:
098: /**
099: * Returns the search component for this category pane. This component
100: * should be made visible when the Find action is invoked, by calling
101: * <code>setVisible(true)</code>.
102: *
103: * @return search component.
104: */
105: SearchComponent getSearchComponent();
106:
107: /**
108: * Add components to the given toolbar to permit selecting the current
109: * category. Note that all categories should have already been added
110: * to this pane via the add(Category) method.
111: *
112: * @param toolbar toolbar component to be populated.
113: */
114: void populateToolbar(JToolBar toolbar);
115:
116: /**
117: * Remove a PropertyChangeListener from the listener list.
118: *
119: * @param listener property change listener to remove.
120: */
121: void removePropertyChangeListener(PropertyChangeListener listener);
122:
123: /**
124: * Remove a PropertyChangeListener for a specific property.
125: *
126: * @param name name of property to listen to.
127: * @param listener property change listener to remove.
128: */
129: void removePropertyChangeListener(String name,
130: PropertyChangeListener listener);
131:
132: /**
133: * Change the selected Category to the one given. Notifies property change
134: * listeners of the change in selection (property name "category").
135: *
136: * @param category Category to be selected (may not be null).
137: */
138: void setCategory(Category category);
139: }
|