xml.schema/javahelp/org/netbeans/modules/xml/schema/tasks/usingrefactoringforrenamedelete.html
author Milutin Kristofic <mkristofic@netbeans.org>
Tue, 31 Jan 2017 14:20:36 +0100
changeset 1584 ddcac47bfed1
parent 1241 f7c3471c4a3f
permissions -rw-r--r--
Added Missing license terms
samaresh@338
     1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
samaresh@338
     2
<!--
mkristofic@1584
     3
DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
mkristofic@1584
     4
mkristofic@1584
     5
Copyright 2009-2017 Oracle and/or its affiliates. All rights reserved.
mkristofic@1584
     6
mkristofic@1584
     7
Oracle and Java are registered trademarks of Oracle and/or its affiliates.
mkristofic@1584
     8
Other names may be trademarks of their respective owners.
mkristofic@1584
     9
mkristofic@1584
    10
The contents of this file are subject to the terms of either the GNU
mkristofic@1584
    11
General Public License Version 2 only ("GPL") or the Common
mkristofic@1584
    12
Development and Distribution License("CDDL") (collectively, the
mkristofic@1584
    13
"License"). You may not use this file except in compliance with the
mkristofic@1584
    14
License. You can obtain a copy of the License at
mkristofic@1584
    15
http://www.netbeans.org/cddl-gplv2.html
mkristofic@1584
    16
or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
mkristofic@1584
    17
specific language governing permissions and limitations under the
mkristofic@1584
    18
License.  When distributing the software, include this License Header
mkristofic@1584
    19
Notice in each file and include the License file at
mkristofic@1584
    20
nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this
mkristofic@1584
    21
particular file as subject to the "Classpath" exception as provided
mkristofic@1584
    22
by Oracle in the GPL Version 2 section of the License file that
mkristofic@1584
    23
accompanied this code. If applicable, add the following below the
mkristofic@1584
    24
License Header, with the fields enclosed by brackets [] replaced by
mkristofic@1584
    25
your own identifying information:
mkristofic@1584
    26
"Portions Copyrighted [year] [name of copyright owner]"
mkristofic@1584
    27
mkristofic@1584
    28
Contributor(s):
mkristofic@1584
    29
mkristofic@1584
    30
The Original Software is NetBeans. The Initial Developer of the Original
mkristofic@1584
    31
Software is Sun Microsystems, Inc. Portions Copyright 2009-2010 Sun
mkristofic@1584
    32
Microsystems, Inc. All Rights Reserved.
mkristofic@1584
    33
mkristofic@1584
    34
If you wish your version of this file to be governed by only the CDDL
mkristofic@1584
    35
or only the GPL Version 2, indicate your decision by adding
mkristofic@1584
    36
"[Contributor] elects to include this software in this distribution
mkristofic@1584
    37
under the [CDDL or GPL Version 2] license." If you do not indicate a
mkristofic@1584
    38
single choice of license, a recipient has the option to distribute
mkristofic@1584
    39
your version of this file under either the CDDL, the GPL Version 2 or
mkristofic@1584
    40
to extend the choice of license to its licensees as provided above.
mkristofic@1584
    41
However, if you add GPL Version 2 code and therefore, elected the GPL
mkristofic@1584
    42
Version 2 license, then the option applies only if the new code is
mkristofic@1584
    43
made subject to such option by the copyright holder.
samaresh@338
    44
-->
samaresh@338
    45
<html>
samaresh@338
    46
<head>
psmejkal@1107
    47
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
samaresh@338
    48
<link rel="stylesheet" href="nbdocs://org.netbeans.modules.usersguide/org/netbeans/modules/usersguide/ide.css" type="text/css">
samaresh@338
    49
<title>Using Refactoring to Rename or Delete XML Schema Components</title>
samaresh@338
    50
</head>
samaresh@338
    51
<body>
samaresh@338
    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>
samaresh@338
    53
<p><small><a href="#seealso">See Also</a></small></p>
samaresh@338
    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>
samaresh@338
    55
<ul>
samaresh@338
    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>
samaresh@338
    57
<ul>
samaresh@338
    58
<li>The rename action will check for usages of the component in the current project if the component is a global component. </li>
samaresh@338
    59
<li>Non-global components will be renamed without checking for usages and without showing the XML Refactoring window. </li>
samaresh@338
    60
<li>The rename action will check for usages of the component in WSDL and BPEL files.</li>
samaresh@338
    61
</ul></li>
samaresh@338
    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>
samaresh@338
    63
<ul>
samaresh@338
    64
<li>The safely delete action will check for usages of the component in the project, if the component is a global component.</li>
samaresh@338
    65
<li>Non-global components will be deleted without checking for usages and without showing the XML Refactoring window.</li>
samaresh@338
    66
<li>The safely delete action will also check for usages of the component in WSDL and BPEL files.</li>
samaresh@338
    67
<li>If references to the selected component are found, you must remove those references before you can safely delete the component.</li>
samaresh@338
    68
</ul></li>
samaresh@338
    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&nbsp;&gt;<i>action</i> command. Undo is disabled if any member of the refactoring set is modified after the initial refactoring action.</li>
samaresh@338
    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>
samaresh@338
    71
</ul>
samaresh@338
    72
samaresh@338
    73
<p><b>To rename an XML schema component:</b></p>
samaresh@338
    74
<ol>
samaresh@338
    75
<li>Open the XML schema file in the Schema view or the Design view of the XML schema editor.</li>
samaresh@338
    76
<li>Navigate to and select the XML schema component to rename.</li>
samaresh@338
    77
<li>Right-click and choose Refactor&nbsp;&gt;&nbsp;Rename from the pop-up menu.<br>
samaresh@338
    78
The Rename dialog box opens.</li>
samaresh@338
    79
<li>In the New Name field, type the new name of the XML schema component.</li>
samaresh@338
    80
<li>To preview all changes in the XML Refactoring window, select the Preview All Changes checkbox.</li>
samaresh@338
    81
<li>Click Next.<br>
samaresh@338
    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.
samaresh@338
    83
<ul class="note">
samaresh@338
    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>
samaresh@338
    85
</ul>
samaresh@338
    86
</li>
samaresh@338
    87
<li>In the XML Refactoring window, review the refactoring changes.</li>
samaresh@338
    88
<li>Clear the checkbox of any node where you do not want to change the name of the XML schema component.</li>
samaresh@338
    89
<li>Click Do Refactoring to apply the selected changes.<br>
samaresh@338
    90
The IDE executes the rename action, saves all the files affected by the rename action, and closes the XML Refactoring window.</li>
samaresh@338
    91
</ol>
samaresh@338
    92
samaresh@338
    93
<p><b>To safely delete an XML schema component:</b></p>
samaresh@338
    94
<ol>
samaresh@338
    95
<li>Open the XML schema file in the Schema view or the Design view of the XML schema editor.</li>
samaresh@338
    96
<li>Navigate to and select the XML schema component to delete.</li>
samaresh@338
    97
<li>Right-click and choose Refactor&nbsp;&gt;&nbsp;Safely Delete from the pop-up menu.<br>
samaresh@338
    98
The Safe Delete dialog box opens and shows you the name of the XML schema component you selected for deletion.</li>
samaresh@338
    99
<li>To preview all changes in the XML Refactoring window, select the Preview All Changes checkbox.</li>
samaresh@338
   100
<li>Click Next.<br>
samaresh@338
   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>
samaresh@338
   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>
samaresh@338
   103
You can return to the refactoring action by clicking the Rerun Delete <i>component-name</i> button.</li>
samaresh@338
   104
<li>In the Safe Delete warning dialog box, click Next.
samaresh@338
   105
<ul class="note">
samaresh@338
   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>
samaresh@338
   107
</ul>
samaresh@338
   108
</li>
samaresh@338
   109
<li>In the XML Refactoring window, review the refactoring changes.</li>
samaresh@338
   110
<li>Clear the checkbox of any node where you do not want to apply the change.</li>
samaresh@338
   111
<li>Click Do Refactoring to apply the selected changes.<br>
samaresh@338
   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>
samaresh@338
   113
</ol>
samaresh@338
   114
samaresh@338
   115
<p><b>To undo refactoring changes:</b></p>
samaresh@338
   116
<ol>
samaresh@338
   117
<li>After completing a Refactor&nbsp;&gt;&nbsp;<i>action</i> command, select any XML schema component node in the Schema view or the Design view of the XML schema editor.</li>
samaresh@338
   118
<li>Right-click and choose Refactor&nbsp;&gt;&nbsp;Undo [<i>action</i>] from the pop-up menu.<br>
samaresh@338
   119
The IDE rolls back all the changes in all the files that were affected by the refactoring.</li>
samaresh@338
   120
</ol>
samaresh@338
   121
samaresh@338
   122
<p><b>To redo undone refactoring changes:</b></p>
samaresh@338
   123
<ol>
samaresh@338
   124
<li>After completing a Refactor&nbsp;&gt;&nbsp;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>
samaresh@338
   125
<li>Right-click and choose Refactor&nbsp;&gt;&nbsp;Redo [<i>action</i>] from the pop-up menu.<br>
samaresh@338
   126
The IDE reverses the changes from the last Refactor&nbsp;&gt;&nbsp;Undo [<i>action</i>] command.</li>
samaresh@338
   127
</ol>
samaresh@338
   128
samaresh@338
   129
<dl>
samaresh@338
   130
<dt><a name="seealso">See Also</a></dt>
samaresh@338
   131
<dd><a href="../windows/window_xmlrefactoring.html" title="XML Refactoring Window (XML Schema Tools)">XML Refactoring Window (XML Schema Tools)</a></dd>
samaresh@338
   132
<dd><a href="../about.html" title="About XML Schema Tools">About XML Schema Tools</a></dd>
samaresh@338
   133
</dl>
samaresh@338
   134
<hr>
samaresh@338
   135
<small><a href="../credits.html">Legal Notices</a></small>
samaresh@338
   136
<table cellpadding="150" border="0"> 
samaresh@338
   137
<tr><td>&nbsp;</td></tr> 
samaresh@338
   138
<tr><td>&nbsp;</td></tr> 
samaresh@338
   139
<tr><td>&nbsp;</td></tr> 
samaresh@338
   140
</table> 
samaresh@338
   141
</body>
samaresh@338
   142
</html>