xml.schema/javahelp/org/netbeans/modules/xml/schema/tasks/usingrefactoringforrenamedelete.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
3 DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
5 Copyright 2009-2017 Oracle and/or its affiliates. All rights reserved.
7 Oracle and Java are registered trademarks of Oracle and/or its affiliates.
8 Other names may be trademarks of their respective owners.
10 The contents of this file are subject to the terms of either the GNU
11 General Public License Version 2 only ("GPL") or the Common
12 Development and Distribution License("CDDL") (collectively, the
13 "License"). You may not use this file except in compliance with the
14 License. You can obtain a copy of the License at
15 http://www.netbeans.org/cddl-gplv2.html
16 or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
17 specific language governing permissions and limitations under the
18 License. When distributing the software, include this License Header
19 Notice in each file and include the License file at
20 nbbuild/licenses/CDDL-GPL-2-CP. Oracle designates this
21 particular file as subject to the "Classpath" exception as provided
22 by Oracle in the GPL Version 2 section of the License file that
23 accompanied this code. If applicable, add the following below the
24 License Header, with the fields enclosed by brackets [] replaced by
25 your own identifying information:
26 "Portions Copyrighted [year] [name of copyright owner]"
30 The Original Software is NetBeans. The Initial Developer of the Original
31 Software is Sun Microsystems, Inc. Portions Copyright 2009-2010 Sun
32 Microsystems, Inc. All Rights Reserved.
34 If you wish your version of this file to be governed by only the CDDL
35 or only the GPL Version 2, indicate your decision by adding
36 "[Contributor] elects to include this software in this distribution
37 under the [CDDL or GPL Version 2] license." If you do not indicate a
38 single choice of license, a recipient has the option to distribute
39 your version of this file under either the CDDL, the GPL Version 2 or
40 to extend the choice of license to its licensees as provided above.
41 However, if you add GPL Version 2 code and therefore, elected the GPL
42 Version 2 license, then the option applies only if the new code is
43 made subject to such option by the copyright holder.
47 <meta http-equiv="content-type" content="text/html; charset=UTF-8">
48 <link rel="stylesheet" href="nbdocs://org.netbeans.modules.usersguide/org/netbeans/modules/usersguide/ide.css" type="text/css">
49 <title>Using Refactoring to Rename or Delete XML Schema Components</title>
52 <h2><a name="filerename"></a><a name="whereused"></a><a name="safedelete"></a><a name="rename"></a>Using Refactoring to Rename or Delete XML Schema Components</h2>
53 <p><small><a href="#seealso">See Also</a></small></p>
54 <p>You can use refactoring in XML schema tools to rename or safely delete schema components and update all references throughout your project. You can use the following refactoring actions in XML schema files:</p>
56 <li><b>Rename.</b> Enables you to change the name of a schema component and update all the source code in your project to reference the component by its new name.<br>
58 <li>The rename action will check for usages of the component in the current project if the component is a global component. </li>
59 <li>Non-global components will be renamed without checking for usages and without showing the XML Refactoring window. </li>
60 <li>The rename action will check for usages of the component in WSDL and BPEL files.</li>
62 <li><b>Safely Delete.</b> Checks for references to a schema component and then automatically deletes that component if there are no other references to that component.<br>
64 <li>The safely delete action will check for usages of the component in the project, if the component is a global component.</li>
65 <li>Non-global components will be deleted without checking for usages and without showing the XML Refactoring window.</li>
66 <li>The safely delete action will also check for usages of the component in WSDL and BPEL files.</li>
67 <li>If references to the selected component are found, you must remove those references before you can safely delete the component.</li>
69 <li><b>Undo [<i>action</i>].</b> After performing a Rename or Safely Delete refactoring action, you can undo that action. The Undo [<i>action</i>] menu option is only enabled after you completed a Refactor ><i>action</i> command. Undo is disabled if any member of the refactoring set is modified after the initial refactoring action.</li>
70 <li><b>Redo [<i>action</i>].</b> After performing an Undo of a Rename or Safely Delete refactoring action, you can redo that action. The Redo [<i>action</i>] menu option is only enabled after you completed an Undo [<i>action</i>] command.</li>
73 <p><b>To rename an XML schema component:</b></p>
75 <li>Open the XML schema file in the Schema view or the Design view of the XML schema editor.</li>
76 <li>Navigate to and select the XML schema component to rename.</li>
77 <li>Right-click and choose Refactor > Rename from the pop-up menu.<br>
78 The Rename dialog box opens.</li>
79 <li>In the New Name field, type the new name of the XML schema component.</li>
80 <li>To preview all changes in the XML Refactoring window, select the Preview All Changes checkbox.</li>
82 The IDE finds all usages of the XML schema component and shows the results in the XML Refactoring window. The preview shows the components in the project files.
84 <li>If you cleared the Preview All Changes checkbox, the rename action happens without additional confirmation. In this case, this is the last step of the rename action.</li>
87 <li>In the XML Refactoring window, review the refactoring changes.</li>
88 <li>Clear the checkbox of any node where you do not want to change the name of the XML schema component.</li>
89 <li>Click Do Refactoring to apply the selected changes.<br>
90 The IDE executes the rename action, saves all the files affected by the rename action, and closes the XML Refactoring window.</li>
93 <p><b>To safely delete an XML schema component:</b></p>
95 <li>Open the XML schema file in the Schema view or the Design view of the XML schema editor.</li>
96 <li>Navigate to and select the XML schema component to delete.</li>
97 <li>Right-click and choose Refactor > Safely Delete from the pop-up menu.<br>
98 The Safe Delete dialog box opens and shows you the name of the XML schema component you selected for deletion.</li>
99 <li>To preview all changes in the XML Refactoring window, select the Preview All Changes checkbox.</li>
101 The IDE finds usages of the XML schema component. If usages are found, a Safe Delete warning dialog box opens. This warning dialog box may also contain errors.</li>
102 <li>(Optional) In the Safe Delete warning dialog box, click Find Usages to show the XML Usages window which contains usage information for the selected component.<br>
103 You can return to the refactoring action by clicking the Rerun Delete <i>component-name</i> button.</li>
104 <li>In the Safe Delete warning dialog box, click Next.
106 <li>If you cleared the Preview All Changes checkbox, the delete action happens without additional confirmation. In this case, this is the last step of the delete action.</li>
109 <li>In the XML Refactoring window, review the refactoring changes.</li>
110 <li>Clear the checkbox of any node where you do not want to apply the change.</li>
111 <li>Click Do Refactoring to apply the selected changes.<br>
112 The IDE deletes the XML schema component and all references to the component, saves all the files affected by the refactoring action, and closes the XML Refactoring window.</li>
115 <p><b>To undo refactoring changes:</b></p>
117 <li>After completing a Refactor > <i>action</i> command, select any XML schema component node in the Schema view or the Design view of the XML schema editor.</li>
118 <li>Right-click and choose Refactor > Undo [<i>action</i>] from the pop-up menu.<br>
119 The IDE rolls back all the changes in all the files that were affected by the refactoring.</li>
122 <p><b>To redo undone refactoring changes:</b></p>
124 <li>After completing a Refactor > Undo [<i>action</i>] command, select any XML schema component node in the Schema view or the Design view of the XML schema editor.</li>
125 <li>Right-click and choose Refactor > Redo [<i>action</i>] from the pop-up menu.<br>
126 The IDE reverses the changes from the last Refactor > Undo [<i>action</i>] command.</li>
130 <dt><a name="seealso">See Also</a></dt>
131 <dd><a href="../windows/window_xmlrefactoring.html" title="XML Refactoring Window (XML Schema Tools)">XML Refactoring Window (XML Schema Tools)</a></dd>
132 <dd><a href="../about.html" title="About XML Schema Tools">About XML Schema Tools</a></dd>
135 <small><a href="../credits.html">Legal Notices</a></small>
136 <table cellpadding="150" border="0">
137 <tr><td> </td></tr>
138 <tr><td> </td></tr>
139 <tr><td> </td></tr>