blob: f6019b10a048df3edd077f08fe17d33e0d6ede7d [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_12) on Fri May 30 11:16:02 CDT 2008 -->
<TITLE>
CodeStyleConfiguration
</TITLE>
<META NAME="keywords" CONTENT="org.eclipse.wst.jsdt.ui.CodeStyleConfiguration class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="CodeStyleConfiguration";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/CodeStyleConfiguration.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../org/eclipse/wst/jsdt/ui/CodeGeneration.html" title="class in org.eclipse.wst.jsdt.ui"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../org/eclipse/wst/jsdt/ui/IContextMenuConstants.html" title="interface in org.eclipse.wst.jsdt.ui"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?org/eclipse/wst/jsdt/ui/CodeStyleConfiguration.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="CodeStyleConfiguration.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.eclipse.wst.jsdt.ui</FONT>
<BR>
Class CodeStyleConfiguration</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.eclipse.wst.jsdt.ui.CodeStyleConfiguration</B>
</PRE>
<HR>
<DL>
<DT><PRE>public class <B>CodeStyleConfiguration</B><DT>extends java.lang.Object</DL>
</PRE>
<P>
Provisional API: This class/interface is part of an interim API that is still under development and expected to
change significantly before reaching stability. It is being made available at this early stage to solicit feedback
from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
(repeatedly) as the API evolves.
<P>
<P>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="../../../../../org/eclipse/wst/jsdt/core/dom/rewrite/ImportRewrite.html" title="class in org.eclipse.wst.jsdt.core.dom.rewrite">ImportRewrite</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/ui/CodeStyleConfiguration.html#createImportRewrite(org.eclipse.wst.jsdt.core.IJavaScriptUnit, boolean)">createImportRewrite</A></B>(<A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptUnit.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptUnit</A>&nbsp;cu,
boolean&nbsp;restoreExistingImports)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a <A HREF="../../../../../org/eclipse/wst/jsdt/core/dom/rewrite/ImportRewrite.html" title="class in org.eclipse.wst.jsdt.core.dom.rewrite"><CODE>ImportRewrite</CODE></A> using <A HREF="../../../../../org/eclipse/wst/jsdt/core/dom/rewrite/ImportRewrite.html#create(org.eclipse.wst.jsdt.core.IJavaScriptUnit, boolean)"><CODE>ImportRewrite.create(IJavaScriptUnit, boolean)</CODE></A> and
configures the rewriter with the settings as specified in the JDT UI preferences.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="../../../../../org/eclipse/wst/jsdt/core/dom/rewrite/ImportRewrite.html" title="class in org.eclipse.wst.jsdt.core.dom.rewrite">ImportRewrite</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/ui/CodeStyleConfiguration.html#createImportRewrite(org.eclipse.wst.jsdt.core.dom.JavaScriptUnit, boolean)">createImportRewrite</A></B>(<A HREF="../../../../../org/eclipse/wst/jsdt/core/dom/JavaScriptUnit.html" title="class in org.eclipse.wst.jsdt.core.dom">JavaScriptUnit</A>&nbsp;astRoot,
boolean&nbsp;restoreExistingImports)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a <A HREF="../../../../../org/eclipse/wst/jsdt/core/dom/rewrite/ImportRewrite.html" title="class in org.eclipse.wst.jsdt.core.dom.rewrite"><CODE>ImportRewrite</CODE></A> using <A HREF="../../../../../org/eclipse/wst/jsdt/core/dom/rewrite/ImportRewrite.html#create(org.eclipse.wst.jsdt.core.dom.JavaScriptUnit, boolean)"><CODE>ImportRewrite.create(JavaScriptUnit, boolean)</CODE></A> and
configures the rewriter with the settings as specified in the JDT UI preferences.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="createImportRewrite(org.eclipse.wst.jsdt.core.IJavaScriptUnit, boolean)"><!-- --></A><H3>
createImportRewrite</H3>
<PRE>
public static <A HREF="../../../../../org/eclipse/wst/jsdt/core/dom/rewrite/ImportRewrite.html" title="class in org.eclipse.wst.jsdt.core.dom.rewrite">ImportRewrite</A> <B>createImportRewrite</B>(<A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptUnit.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptUnit</A>&nbsp;cu,
boolean&nbsp;restoreExistingImports)
throws <A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></PRE>
<DL>
<DD>Returns a <A HREF="../../../../../org/eclipse/wst/jsdt/core/dom/rewrite/ImportRewrite.html" title="class in org.eclipse.wst.jsdt.core.dom.rewrite"><CODE>ImportRewrite</CODE></A> using <A HREF="../../../../../org/eclipse/wst/jsdt/core/dom/rewrite/ImportRewrite.html#create(org.eclipse.wst.jsdt.core.IJavaScriptUnit, boolean)"><CODE>ImportRewrite.create(IJavaScriptUnit, boolean)</CODE></A> and
configures the rewriter with the settings as specified in the JDT UI preferences.
<p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>cu</CODE> - the compilation unit to create the rewriter on<DD><CODE>restoreExistingImports</CODE> - specifies if the existing imports should be kept or removed.
<DT><B>Returns:</B><DD>the new rewriter configured with the settings as specified in the JDT UI preferences.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></CODE> - thrown when the compilation unit could not be accessed.<DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/jsdt/core/dom/rewrite/ImportRewrite.html#create(org.eclipse.wst.jsdt.core.IJavaScriptUnit, boolean)"><CODE>ImportRewrite.create(IJavaScriptUnit, boolean)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="createImportRewrite(org.eclipse.wst.jsdt.core.dom.JavaScriptUnit, boolean)"><!-- --></A><H3>
createImportRewrite</H3>
<PRE>
public static <A HREF="../../../../../org/eclipse/wst/jsdt/core/dom/rewrite/ImportRewrite.html" title="class in org.eclipse.wst.jsdt.core.dom.rewrite">ImportRewrite</A> <B>createImportRewrite</B>(<A HREF="../../../../../org/eclipse/wst/jsdt/core/dom/JavaScriptUnit.html" title="class in org.eclipse.wst.jsdt.core.dom">JavaScriptUnit</A>&nbsp;astRoot,
boolean&nbsp;restoreExistingImports)</PRE>
<DL>
<DD>Returns a <A HREF="../../../../../org/eclipse/wst/jsdt/core/dom/rewrite/ImportRewrite.html" title="class in org.eclipse.wst.jsdt.core.dom.rewrite"><CODE>ImportRewrite</CODE></A> using <A HREF="../../../../../org/eclipse/wst/jsdt/core/dom/rewrite/ImportRewrite.html#create(org.eclipse.wst.jsdt.core.dom.JavaScriptUnit, boolean)"><CODE>ImportRewrite.create(JavaScriptUnit, boolean)</CODE></A> and
configures the rewriter with the settings as specified in the JDT UI preferences.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>astRoot</CODE> - the AST root to create the rewriter on<DD><CODE>restoreExistingImports</CODE> - specifies if the existing imports should be kept or removed.
<DT><B>Returns:</B><DD>the new rewriter configured with the settings as specified in the JDT UI preferences.<DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/jsdt/core/dom/rewrite/ImportRewrite.html#create(org.eclipse.wst.jsdt.core.dom.JavaScriptUnit, boolean)"><CODE>ImportRewrite.create(JavaScriptUnit, boolean)</CODE></A></DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/CodeStyleConfiguration.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../org/eclipse/wst/jsdt/ui/CodeGeneration.html" title="class in org.eclipse.wst.jsdt.ui"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../org/eclipse/wst/jsdt/ui/IContextMenuConstants.html" title="interface in org.eclipse.wst.jsdt.ui"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?org/eclipse/wst/jsdt/ui/CodeStyleConfiguration.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="CodeStyleConfiguration.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>