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.util.ArrayList;
045: import java.util.Collection;
046: import java.util.Collections;
047: import java.util.List;
048:
049: import org.netbeans.modules.vmd.api.model.DesignComponent;
050: import org.netbeans.modules.vmd.api.model.DesignEvent;
051: import org.netbeans.modules.vmd.api.model.DesignEventFilter;
052: import org.netbeans.modules.vmd.api.model.Presenter;
053: import org.netbeans.modules.vmd.api.model.PresenterEvent;
054:
055: /**
056: *
057: * @author Karol Harezlak
058: * @author Anton Chechel
059: */
060:
061: /**
062: * This implemementation of PropertiesPresenter enables forwarding of particular
063: * DesignPropertyDEscriptors from one DesignComponent to another. For example using this class
064: * it is possible to attache DesignPropertyDescriptors from one DesignComponent to another so user
065: * sees it in the Properties Window as single component's properties collection even though they dont belong
066: * to the same DesignComponent.
067: */
068: public class PropertiesPresenterForwarder extends PropertiesPresenter {
069:
070: private String propertyName;
071: private String[] propertyNames;
072:
073: /**
074: * Creates PropertiesPresenterForwarder based on the name of
075: * the PropertyDescriptor attached to the DesignComponent which owns this presenter
076: * forwarder. In this case all DesignPropertyDescriptors are forwarded to this presenter and they are
077: * taken from the DesignComponent which is referenced through the DesignComponent property (PropertyValue).
078: * @param propertyName property name of the DesignComponent PropertyDescriptor
079: * @return PropertiesPresenter with forwarded DesignPropertyDescriptors
080: */
081: public static Presenter createByReference(String propertyName) {
082: return new PropertiesPresenterForwarder(propertyName);
083: }
084:
085: /**
086: * Creates PropertiesPresenterForwarder based on the name of
087: * the PropertyDescriptor attached to the DesignComponent which owns this presenter
088: * forwarder and the list of the properties names of the DesignComponent properties to forward. In this case chosen
089: * DesignPropertyDescriptors are forwarded to this presenter and they are
090: * taken from the DesignComponent which is referenced through the DesignComponent property (PropertyValue).
091: * @param propertyName property name of the DesignComponent PropertyDescriptor with the DesignComponet references
092: * @param propertyNames properties names of chosen propertires to forward
093: * @return PropertiesPresenter with forwarded DesignPropertyDescriptors
094: */
095: public static Presenter createByNames(String propertyName,
096: String... propertyNames) {
097: return new PropertiesPresenterForwarder(propertyName,
098: propertyNames);
099: }
100:
101: private PropertiesPresenterForwarder(String propertyName,
102: String... propertyNames) {
103: this .propertyName = propertyName;
104: this .propertyNames = propertyNames;
105: }
106:
107: @Override
108: public List<DesignPropertyDescriptor> getDesignPropertyDescriptors() {
109: DesignComponent component = getComponent().readProperty(
110: propertyName).getComponent();
111:
112: if (component == null)
113: return Collections.<DesignPropertyDescriptor> emptyList();
114:
115: List<DesignPropertyDescriptor> descriptors = new ArrayList<DesignPropertyDescriptor>();
116: Collection<? extends PropertiesPresenter> propertiesPresenters = component
117: .getPresenters(PropertiesPresenter.class);
118: if (propertiesPresenters == null)
119: return Collections.<DesignPropertyDescriptor> emptyList();
120:
121: for (PropertiesPresenter presenter : propertiesPresenters) {
122: descriptors.addAll(filterDescriptors(presenter
123: .getDesignPropertyDescriptors()));
124: }
125:
126: return descriptors;
127: }
128:
129: @Override
130: public List<String> getPropertiesCategories() {
131: DesignComponent component = getComponent().readProperty(
132: propertyName).getComponent();
133:
134: if (component == null)
135: return Collections.<String> emptyList();
136:
137: List<String> categories = new ArrayList<String>();
138: for (PropertiesPresenter presenter : component
139: .getPresenters(PropertiesPresenter.class)) {
140: categories.addAll(presenter.getPropertiesCategories());
141: }
142:
143: return categories;
144: }
145:
146: private List<DesignPropertyDescriptor> filterDescriptors(
147: List<DesignPropertyDescriptor> descriptors) {
148: if (propertyNames == null || propertyNames.length == 0) {
149: return descriptors;
150: }
151: List<DesignPropertyDescriptor> list = new ArrayList<DesignPropertyDescriptor>(
152: descriptors.size());
153: for (DesignPropertyDescriptor designPropertyDescriptor : descriptors) {
154: for (String name : propertyNames) {
155: if (designPropertyDescriptor.getPropertyNames()
156: .contains(name)) {
157: list.add(designPropertyDescriptor);
158: }
159: }
160: }
161: return list;
162: }
163:
164: @Override
165: protected void notifyDetached(DesignComponent component) {
166: }
167:
168: @Override
169: protected DesignEventFilter getEventFilter() {
170: return null;
171: }
172:
173: @Override
174: protected void designChanged(DesignEvent event) {
175: }
176:
177: @Override
178: protected void presenterChanged(PresenterEvent event) {
179: }
180:
181: @Override
182: protected void notifyAttached(DesignComponent component) {
183: }
184:
185: }
|