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-2007 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: package org.netbeans.modules.compapp.casaeditor.nodes;
042:
043: import java.awt.Image;
044: import java.awt.Point;
045: import java.io.IOException;
046: import java.lang.ref.WeakReference;
047: import java.util.ArrayList;
048: import java.util.HashMap;
049: import java.util.List;
050: import java.util.Map;
051: import javax.swing.Action;
052: import org.netbeans.api.visual.widget.Widget;
053: import org.netbeans.modules.compapp.casaeditor.CasaDataObject;
054: import org.netbeans.modules.compapp.casaeditor.model.casa.CasaComponent;
055: import org.netbeans.modules.compapp.casaeditor.model.casa.CasaWrapperModel;
056: import org.netbeans.modules.compapp.casaeditor.nodes.actions.NodeDeleteAction;
057: import org.netbeans.modules.compapp.casaeditor.properties.PropertyUtils;
058: import org.openide.ErrorManager;
059: import org.openide.cookies.SaveCookie;
060: import org.openide.loaders.DataObject;
061: import org.openide.nodes.AbstractNode;
062: import org.openide.nodes.Children;
063: import org.openide.nodes.Sheet;
064: import org.openide.util.NbBundle;
065: import org.openide.util.lookup.AbstractLookup;
066: import org.openide.util.lookup.InstanceContent;
067:
068: /**
069: * This class represents the base class for Casa related nodes.
070: *
071: * @author Josh Sandusky
072: */
073: public abstract class CasaNode extends AbstractNode {
074: // special flag to mark a property that is always writable
075: protected static final String ALWAYS_WRITABLE_PROPERTY = "[WRITABLE]"; // NOI18N
076:
077: private WeakReference mDataReference;
078: private static Map<Object, Image> mImageMap = new HashMap<Object, Image>();
079:
080: public CasaNode() {
081: super (Children.LEAF);
082: }
083:
084: public CasaNode(Object data, Children children,
085: CasaNodeFactory factory) {
086: this (data, children, factory.createInstanceContent());
087: }
088:
089: private CasaNode(Object data, Children children,
090: InstanceContent content) {
091: super (children, new AbstractLookup(content));
092: mDataReference = new WeakReference<Object>(data);
093: content.add(new SaveCookieDelegate());
094: }
095:
096: /**
097: * Looks for the Properties Set by the Group enum.
098: */
099: protected Sheet.Set getPropertySet(Sheet sheet,
100: PropertyUtils.PropertiesGroups group) {
101: return getPropertySet(sheet, group.getDisplayName());
102: }
103:
104: protected Sheet.Set getPropertySet(Sheet sheet, String displayName) {
105: Sheet.Set propSet = sheet.get(displayName);
106: if (propSet == null) {
107: propSet = new Sheet.Set();
108: propSet.setName(displayName);
109: sheet.put(propSet);
110: }
111: return propSet;
112: }
113:
114: public Object getData() {
115: if (mDataReference != null) {
116: Object ref = mDataReference.get();
117: if (ref instanceof CasaComponent) {
118: if (!((CasaComponent) ref).isInDocumentModel()) {
119: return null;
120: }
121: }
122: return ref;
123: }
124: return null;
125: }
126:
127: public CasaDataObject getDataObject() {
128: return getLookup().lookup(CasaDataObject.class);
129: }
130:
131: public CasaWrapperModel getModel() {
132: return getLookup().lookup(CasaWrapperModel.class);
133: }
134:
135: public boolean isEditable(String propertyType) {
136: return false;
137: }
138:
139: public boolean isDeletable() {
140: return false;
141: }
142:
143: protected void addCustomActions(List<Action> actions) {
144: // Subclasses can override this to provide custom actions.
145: }
146:
147: public final Action[] getActions(boolean context) {
148: List<Action> actions = new ArrayList<Action>();
149:
150: addCustomActions(actions);
151: if (actions.size() > 0) {
152: actions.add(null);
153: }
154:
155: if (isDeletable()) {
156: actions.add(new NodeDeleteAction(this ));
157: actions.add(null);
158: }
159:
160: Action[] parentActions = super .getActions(context);
161: for (Action parentAction : parentActions) {
162: actions.add(parentAction);
163: }
164:
165: return (Action[]) actions.toArray(new Action[actions.size()]);
166: }
167:
168: /**
169: * If this action is invoked from the graph, this method will be called to determine
170: * if the graph location in context is valid for the given action.
171: */
172: public boolean isValidSceneActionForLocation(Action action,
173: Widget widget, Point sceneLocation) {
174: return true;
175: }
176:
177: protected String getBadName() {
178: return NbBundle.getMessage(PropertyUtils.class,
179: "PROP_ERROR_VALUE"); // NOI18N
180: }
181:
182: protected final Sheet createSheet() {
183: Sheet sheet = super .createSheet();
184: try {
185: setupPropertySheet(sheet);
186: } catch (Throwable t) {
187: // The user should be informed of any failure
188: // during intialization of properties.
189: ErrorManager.getDefault().notify(t);
190: }
191: return sheet;
192: }
193:
194: /**
195: * Refreshes the property sheet.
196: */
197: public void refresh() {
198: setSheet(createSheet());
199: }
200:
201: protected void setupPropertySheet(Sheet sheet) {
202: // Subclasses can intialize the sheet if desired.
203: }
204:
205: class SaveCookieDelegate implements SaveCookie {
206: public void save() throws IOException {
207: DataObject dobj = getDataObject();
208: // May be null if component was removed from the model.
209: if (dobj != null) {
210: SaveCookie cookie = (SaveCookie) dobj
211: .getCookie(SaveCookie.class);
212: if (cookie != null) {
213: cookie.save();
214: }
215: }
216: }
217: }
218: }
|