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-2006 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.palette;
043:
044: import javax.swing.Action;
045: import org.netbeans.spi.palette.PaletteController;
046: import org.openide.util.*;
047:
048: /**
049: * An interface for palette contents.
050: *
051: * @author S. Aubrecht
052: */
053: public interface Model {
054:
055: /**
056: * Interested parties should listent to changes of this property to be
057: * notified when the selected item has changed.
058: */
059: public static final String PROP_SELECTED_ITEM = "selectedItem";
060:
061: String getName();
062:
063: /**
064: * @return Palette categories.
065: */
066: Category[] getCategories();
067:
068: /**
069: * @return Actions for palette's popup menu.
070: */
071: Action[] getActions();
072:
073: void addModelListener(ModelListener listener);
074:
075: void removeModelListener(ModelListener listener);
076:
077: /**
078: * @return The item currently selected in the palette or null if no item is selected.
079: */
080: Item getSelectedItem();
081:
082: /**
083: * @return The category that owns the currently selected item.
084: */
085: Category getSelectedCategory();
086:
087: /**
088: * Select new item and category.
089: *
090: * @param category New category to be selected or null.
091: * @param item New item to be selected or null.
092: */
093: void setSelectedItem(Lookup category, Lookup item);
094:
095: /**
096: * Ensure no item is selected.
097: */
098: void clearSelection();
099:
100: void refresh();
101:
102: void showCustomizer(PaletteController controller, Settings settings);
103:
104: Lookup getRoot();
105:
106: boolean moveCategory(Category source, Category target,
107: boolean moveBefore);
108:
109: boolean canReorderCategories();
110: }
|