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:
042: /*
043: * AdvancedSchemaComponentNewType.java
044: *
045: * Created on January 19, 2006, 1:31 PM
046: *
047: * To change this template, choose Tools | Template Manager
048: * and open the template in the editor.
049: */
050:
051: package org.netbeans.modules.xml.schema.ui.nodes.categorized.newtype;
052:
053: // java imports
054: import java.awt.Dialog;
055: import org.netbeans.modules.xml.schema.model.Import;
056: import org.netbeans.modules.xml.schema.model.Include;
057: import org.netbeans.modules.xml.schema.model.Redefine;
058: import org.netbeans.modules.xml.schema.model.Schema;
059:
060: //netbeans imports
061: import org.openide.DialogDisplayer;
062: import org.openide.NotifyDescriptor;
063: import org.openide.util.NbBundle;
064: import org.openide.util.datatransfer.NewType;
065:
066: //local imports
067: import org.netbeans.modules.xml.schema.model.SchemaModel;
068: import org.netbeans.modules.xml.schema.model.SchemaComponent;
069: import org.netbeans.modules.xml.schema.model.SchemaComponentReference;
070: import org.netbeans.modules.xml.schema.ui.basic.UIUtilities;
071: import org.netbeans.modules.xml.schema.ui.nodes.categorized.customizer.ImportCreator;
072: import org.netbeans.modules.xml.schema.ui.nodes.categorized.customizer.IncludeCreator;
073: import org.netbeans.modules.xml.schema.ui.nodes.categorized.customizer.RedefineCreator;
074: import org.netbeans.modules.xml.xam.ui.cookies.ViewComponentCookie;
075: import org.netbeans.modules.xml.xam.ui.customizer.Customizer;
076: import org.openide.DialogDescriptor;
077: import org.openide.filesystems.FileObject;
078: import org.openide.loaders.DataObject;
079: import org.openide.loaders.DataObjectNotFoundException;
080:
081: /**
082: *
083: * @author Ajit Bhate (ajit.bhate@Sun.Com)
084: */
085: public class AdvancedSchemaComponentNewType extends NewType {
086:
087: private SchemaComponentReference<? extends SchemaComponent> reference;
088: private Class<? extends SchemaComponent> childType;
089: private AdvancedSchemaComponentCreator creator;
090: private SchemaComponent component;
091: private SchemaComponent container;
092:
093: /**
094: * Creates a new instance of AdvancedSchemaComponentNewType
095: */
096: public AdvancedSchemaComponentNewType(
097: SchemaComponentReference<? extends SchemaComponent> reference,
098: Class<? extends SchemaComponent> childType) {
099: super ();
100: this .reference = reference;
101: this .childType = childType;
102: this .creator = new AdvancedSchemaComponentCreator();
103: }
104:
105: public String getName() {
106: return NbBundle.getMessage(
107: AdvancedSchemaComponentNewType.class, "LBL_NewType_"
108: .concat(getChildType().getSimpleName()));
109: }
110:
111: public void create() {
112: if (!canCreate()) {
113: showIncompleteDefinitionMessage();
114: return;
115: }
116: SchemaModel model = getSchemaComponent().getModel();
117: assert model != null;
118: boolean showComponent = false;
119: try {
120: if (customize()) {
121: model.startTransaction();
122: addComponent(container);
123: showComponent = true;
124: }
125: } finally {
126: if (model.isIntransaction()) {
127: model.endTransaction();
128: }
129: }
130:
131: // Select in view, only if component was successfully created.
132: if (showComponent) {
133: try {
134: FileObject fobj = (FileObject) model.getModelSource()
135: .getLookup().lookup(FileObject.class);
136: if (fobj != null) {
137: DataObject dobj = DataObject.find(fobj);
138: if (dobj != null) {
139: ViewComponentCookie svc = (ViewComponentCookie) dobj
140: .getCookie(ViewComponentCookie.class);
141: if (svc != null) {
142: svc.view(
143: ViewComponentCookie.View.STRUCTURE,
144: getComponent());
145: }
146: }
147: }
148: } catch (DataObjectNotFoundException donfe) {
149: }
150: }
151: }
152:
153: public boolean canCreate() {
154: if (getComponent() == null) {
155: setComponent(createComponent());
156: setContainer(findContainer());
157: }
158: return getContainer() != null;
159: }
160:
161: /**
162: * The container of the new type.
163: * In most cases it will be getSchemaComponent(), but need to ensure correct type.
164: * It uses AdvancedSchemaComponentCreator to find appropriate container.
165: */
166: protected SchemaComponent findContainer() {
167: return getCreator().findContainer(getSchemaComponent(),
168: getComponent());
169: }
170:
171: /**
172: * This api adds required new type to the container.
173: * This is called from create.
174: * The create method ensures a transaction and does error reporting.
175: */
176: protected void addComponent(SchemaComponent container) {
177: getCreator().add(container, getComponent());
178: }
179:
180: /**
181: * This api creates required new type.
182: * uses SchemaComponentCreator to add
183: */
184: protected SchemaComponent createComponent() {
185: return SchemaComponentCreator.createComponent(
186: getSchemaComponent().getModel().getFactory(),
187: getChildType());
188: }
189:
190: protected SchemaComponent getSchemaComponent() {
191: return getReference().get();
192: }
193:
194: protected SchemaComponentReference<? extends SchemaComponent> getReference() {
195: return reference;
196: }
197:
198: protected Class<? extends SchemaComponent> getChildType() {
199: return childType;
200: }
201:
202: protected AdvancedSchemaComponentCreator getCreator() {
203: return creator;
204: }
205:
206: /**
207: * getter for newly created component
208: */
209: protected SchemaComponent getComponent() {
210: return component;
211: }
212:
213: /**
214: * setter for newly created component
215: */
216: protected void setComponent(SchemaComponent component) {
217: this .component = component;
218: }
219:
220: /**
221: * getter for container
222: */
223: protected SchemaComponent getContainer() {
224: return container;
225: }
226:
227: /**
228: * setter for container
229: */
230: protected void setContainer(SchemaComponent container) {
231: this .container = container;
232: }
233:
234: /**
235: * This apis check if newtype needs a customizer and returns true,
236: * if customizer is not needed or if user OKs customization, false otherwise.
237: */
238: protected boolean customize() {
239: // XXX: This bit is an ugly hack, need a better way to create a
240: // different customizer depending on whether the component
241: // is new versus existing.
242: SchemaComponent comp = getComponent();
243: Customizer customizer;
244: boolean created = true;
245: if (comp instanceof Import) {
246: SchemaModel model = getSchemaComponent().getModel();
247: Schema schema = model.getSchema();
248: customizer = new ImportCreator(schema);
249: } else if (comp instanceof Include) {
250: SchemaModel model = getSchemaComponent().getModel();
251: Schema schema = model.getSchema();
252: customizer = new IncludeCreator(schema);
253: } else if (comp instanceof Redefine) {
254: SchemaModel model = getSchemaComponent().getModel();
255: Schema schema = model.getSchema();
256: customizer = new RedefineCreator(schema);
257: } else {
258: customizer = getCreator().createCustomizer(comp,
259: getContainer());
260: created = false;
261: }
262: if (customizer == null || customizer.getComponent() == null)
263: return true;
264: DialogDescriptor descriptor = UIUtilities.getCustomizerDialog(
265: customizer, getName(), true);
266: Dialog dlg = DialogDisplayer.getDefault().createDialog(
267: descriptor);
268: dlg.setTitle(NbBundle.getMessage(
269: AdvancedSchemaComponentNewType.class, "LBL_Customizer_"
270: .concat(getChildType().getSimpleName())));
271: dlg.getAccessibleContext().setAccessibleDescription(
272: dlg.getTitle());
273: dlg.setVisible(true);
274: // For the created case, return false so that the component will not
275: // be created again, and then not have any customization performed
276: // on it; the creators have already created the component(s).
277: return !created
278: && descriptor.getValue() == DialogDescriptor.OK_OPTION;
279: }
280:
281: /**
282: * This will show a message to user if this newtype can't be created
283: *
284: */
285: private void showIncompleteDefinitionMessage() {
286: String message = NbBundle.getMessage(
287: AdvancedSchemaComponentNewType.class,
288: "MSG_NewType_IncompleteDefinition", getName()
289: .toLowerCase());
290: NotifyDescriptor.Message descriptor = new NotifyDescriptor.Message(
291: message);
292: DialogDisplayer.getDefault().notify(descriptor);
293: }
294: }
|