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.vmd.api.inspector;
043:
044: import java.awt.Image;
045: import java.awt.datatransfer.Transferable;
046: import javax.swing.Action;
047: import org.netbeans.modules.vmd.api.model.TypeID;
048: import org.netbeans.modules.vmd.api.model.common.AcceptSuggestion;
049:
050: /**
051: * @author Karol Harezlak
052: */
053:
054: /**
055: * This class suits as a descriptor for the Mobility Visual Designer Navigator node.
056: */
057: public abstract class InspectorFolder implements
058: InspectorPositionController {
059:
060: /**
061: * Returns TypeID of the component connected with this folder descriptor.
062: * @return components TypeID
063: */
064: public abstract TypeID getTypeID();
065:
066: /**
067: * Returns ComponentsID of the component connected with this folder descriptor.
068: * @return Long components ID
069: */
070: public abstract Long getComponentID();
071:
072: /**
073: * Returns image icon which represents folder in the Visual Designer Navigator.
074: * @return folder's image icon
075: */
076: public abstract Image getIcon();
077:
078: /**
079: * Returns display name of the folder.
080: * @return folder's display name
081: */
082: public abstract String getDisplayName();
083:
084: /**
085: * Returns HTML display name of the folder.
086: * @return folder's HTML display name
087: */
088: public abstract String getHtmlDisplayName();
089:
090: /**
091: * Returns name of the folder.
092: * @return folder's name
093: */
094: public abstract String getName();
095:
096: /**
097: * Returns array of actions available for this folder.
098: * @return array of folder's actions
099: */
100: public abstract Action[] getActions();
101:
102: /**
103: * Indicates if folder can be rename.
104: * @return returns boolean value. Boolean.TRUE folder can be rename. Boolean.FALSE folder can't be rename.
105: */
106: public abstract boolean canRename();
107:
108: /**
109: * Returns array of InspectorOrderingControllers.
110: * @return returns array of the InspectorOrderingControllers
111: */
112: public abstract InspectorOrderingController[] getOrderingControllers();
113:
114: /**
115: * Creates object with implemented interface AcceptSuggestion.Created object
116: * can have any type of functionality that helps with folder dragging and dropping.
117: * AcceptSuggestion interface is just a empty interface used as a marker.
118: * @return default implementation returns null
119: */
120: public AcceptSuggestion createSuggestion(Transferable transferable) {
121: return null;
122: }
123:
124: }
|