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.properties;
043:
044: import java.lang.ref.WeakReference;
045: import java.util.Arrays;
046: import java.util.List;
047: import org.netbeans.modules.vmd.api.model.DesignComponent;
048:
049: /**
050: *
051: * @author Karol Harezlak
052: */
053:
054: /**
055: * This class is a property descriptor. It contains all information about given DesignComponent's PropertyDescriptor
056: * to create property in the Properties Window. It is possible to bind more that one DesignComponent's PropertyDescriptor \
057: * in one DesignPropertyDescryptor. In this case single property in the Properties Window will represent more
058: * that one DesignComponent's PropertyDescriptor.
059: *
060: */
061: public abstract class DesignPropertyDescriptor {
062:
063: /**
064: * Default implementation of DesignPropertyDescriptor. To map one DesignPropertyDescriptor with
065: * more that one DesignComponent's PropertyDescriptors assign more that one PropertyDescriptor name to the
066: * propertyNames parameter. Creates DesignPropertyDescriptor based on given parameters.
067: *
068: *
069: * @param displayName display name of this property created based on this DesignPropertyDescriptor.
070: * This String represent display name of the property shown in the Properties Window.
071: * @param toolTip tool tip shown for this property in the Properties Window.
072: * @param category property's category
073: * @param propertyEditor custom property editor
074: * @param propertyEditorType type of property ediotr (for example Boolena.class, String.class)
075: * @param propertyNames names of the PropertyDescriptors connected with this DesignPropertyDescriptor
076: * @return instance of DesignPropertyDescriptor
077: */
078: public static final DesignPropertyDescriptor create(
079: String displayName, String toolTip, String category,
080: DesignPropertyEditor propertyEditor,
081: Class propertyEditorType, String... propertyNames) {
082: return new DefaultPropertyDescriptor(displayName, toolTip,
083: category, propertyEditor, propertyEditorType,
084: propertyNames);
085: }
086:
087: /**
088: * Returns list of the names of the PropertyDescriptors connected with this DesignPropertyDescriptor.
089: * NOTE: First name of this list is a primary name of the property created based on this DesignPropertyDescriptor.
090: *
091: * @return list of properties names
092: */
093: public abstract List<String> getPropertyNames();
094:
095: /**
096: * Returns display name of this property created based on this DesignPropertyDescriptor.
097: * This String represent display name of the property shown in the Properties Window.
098: * @return display name
099: */
100: public abstract String getPropertyDisplayName();
101:
102: /**
103: * Returns tool tip shown for property created based on this DesignPropertyDescriptor in the Properties Window.
104: * @return tool tip
105: */
106: public abstract String getPropertyToolTip();
107:
108: /**
109: * Returns property's category as a String.
110: * @return category
111: */
112: public abstract String getPropertyCategory();
113:
114: /**
115: * Returns custom property editor for the property .
116: * @return category
117: */
118: public abstract DesignPropertyEditor getPropertyEditor();
119:
120: /**
121: * Returns DesignComponent connected with this DesignPropertyDEscriptor (property).
122: * @return DesignComponent
123: */
124: public abstract DesignComponent getComponent();
125:
126: @Deprecated
127: public abstract Class getPropertyEditorType();
128:
129: /**
130: * This method is executed when PropertiesPresenter which contains this DesignPropertyDesciptor is
131: * attached to the DesignComponet.
132: * @param component DesignComponent connected with this DesignPropertyDEscriptor
133: */
134: public abstract void init(DesignComponent component);
135:
136: private static class DefaultPropertyDescriptor extends
137: DesignPropertyDescriptor {
138:
139: private List<String> propertyNames;
140: private String displayName;
141: private String toolTip;
142: private String category;
143: private DesignPropertyEditor propertyEditor;
144: private WeakReference<DesignComponent> component;
145: private Class propertyEditorType;
146:
147: private DefaultPropertyDescriptor(String displayName,
148: String toolTip, String category,
149: DesignPropertyEditor propertyEditor,
150: Class propertyEditorType, String... propertyNames) {
151: if (category == null) {
152: throw new IllegalArgumentException("Empty category"); // NOI18N
153: }
154: this .propertyNames = Arrays.asList(propertyNames);
155: this .displayName = displayName;
156: this .toolTip = toolTip;
157: this .category = category;
158: this .propertyEditor = propertyEditor;
159: this .propertyEditorType = propertyEditorType;
160: }
161:
162: public List<String> getPropertyNames() {
163: return propertyNames;
164: }
165:
166: public String getPropertyDisplayName() {
167: return displayName;
168: }
169:
170: public String getPropertyToolTip() {
171: return toolTip;
172: }
173:
174: public String getPropertyCategory() {
175: return category;
176: }
177:
178: public DesignPropertyEditor getPropertyEditor() {
179: return propertyEditor;
180: }
181:
182: public DesignComponent getComponent() {
183: if (component == null) {
184: return null;
185: }
186: return component.get();
187: }
188:
189: public Class getPropertyEditorType() {
190: if (propertyEditor != null) {
191: return propertyEditor.getClass();
192: } else {
193: return propertyEditorType;
194: }
195: }
196:
197: public void init(DesignComponent component) {
198: this .component = new WeakReference<DesignComponent>(
199: component);
200: }
201: }
202: }
|