01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common
08: * Development and Distribution License("CDDL") (collectively, the
09: * "License"). You may not use this file except in compliance with the
10: * License. You can obtain a copy of the License at
11: * http://www.netbeans.org/cddl-gplv2.html
12: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
13: * specific language governing permissions and limitations under the
14: * License. When distributing the software, include this License Header
15: * Notice in each file and include the License file at
16: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
17: * particular file as subject to the "Classpath" exception as provided
18: * by Sun in the GPL Version 2 section of the License file that
19: * accompanied this code. If applicable, add the following below the
20: * License Header, with the fields enclosed by brackets [] replaced by
21: * your own identifying information:
22: * "Portions Copyrighted [year] [name of copyright owner]"
23: *
24: * Contributor(s):
25: *
26: * The Original Software is NetBeans. The Initial Developer of the Original
27: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
28: * Microsystems, Inc. All Rights Reserved.
29: *
30: * If you wish your version of this file to be governed by only the CDDL
31: * or only the GPL Version 2, indicate your decision by adding
32: * "[Contributor] elects to include this software in this distribution
33: * under the [CDDL or GPL Version 2] license." If you do not indicate a
34: * single choice of license, a recipient has the option to distribute
35: * your version of this file under either the CDDL, the GPL Version 2 or
36: * to extend the choice of license to its licensees as provided above.
37: * However, if you add GPL Version 2 code and therefore, elected the GPL
38: * Version 2 license, then the option applies only if the new code is
39: * made subject to such option by the copyright holder.
40: */
41:
42: package org.netbeans.modules.vmd.api.inspector;
43:
44: import java.util.Collection;
45: import java.util.List;
46: import org.netbeans.modules.vmd.api.model.DesignComponent;
47: import org.netbeans.modules.vmd.api.model.DesignDocument;
48: import org.netbeans.modules.vmd.api.model.TypeID;
49:
50: /**
51: *
52: * @author Karol Harezlak
53: */
54:
55: /**
56: * This class controls order of the InspectorFolder in the branch of the Mobility
57: * Visual Designer Navigator tree.
58: */
59: public interface InspectorOrderingController {
60: /**
61: * Checks if given TypeId is supported by this ordering controller.
62: * @param document current DesignDocument
63: * @param typeID typeID to check
64: * @return Boolen.TRUE when TypyID is supported, Boolean.FALSE when TypeID is
65: * not supported
66: */
67: boolean isTypeIDSupported(DesignDocument document, TypeID typeID);
68:
69: /**
70: * Orders and returns List of InspectorFolder for given component and collection of folders.
71: * @param component DesignComponent
72: * @return folders to order
73: */
74: List<InspectorFolder> getOrdered(DesignComponent component,
75: Collection<InspectorFolder> folders);
76:
77: /**
78: * Returns order Integer number for list of folders sorted by method getOrdered.
79: * Higher Integer number means that sorted list of folders has higher priority when
80: * it's necessary to order not only folders but also lists (List<InspectorFolder>) of sorted folders
81: * in the same tree branch. For example if in the same tree branch there is two or more InspectorOrderingController
82: * then ordered lists need to be ordered by Integer number returns by this method.
83: *
84: * @return Integer number, when null then sorted list has lowest possible priority
85: */
86: Integer getOrder();
87:
88: }
|