blob: a74657f8101ae6c3ff48e5cf1ce23eb12a2f1679 [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:15:47 CDT 2008 -->
<TITLE>
ICorrectionRequestor
</TITLE>
<META NAME="keywords" CONTENT="org.eclipse.wst.jsdt.core.ICorrectionRequestor interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="ICorrectionRequestor";
}
</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/ICorrectionRequestor.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/core/ICompletionRequestor.html" title="interface in org.eclipse.wst.jsdt.core"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../org/eclipse/wst/jsdt/core/IElementChangedListener.html" title="interface in org.eclipse.wst.jsdt.core"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?org/eclipse/wst/jsdt/core/ICorrectionRequestor.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="ICorrectionRequestor.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.core</FONT>
<BR>
Interface ICorrectionRequestor</H2>
<HR>
<DL>
<DT><PRE>public interface <B>ICorrectionRequestor</B></DL>
</PRE>
<P>
A callback interface for receiving javaScript problem correction.
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>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/ICorrectionRequestor.html#acceptClass(char[], char[], char[], int, int, int)">acceptClass</A></B>(char[]&nbsp;packageName,
char[]&nbsp;className,
char[]&nbsp;correctionName,
int&nbsp;modifiers,
int&nbsp;correctionStart,
int&nbsp;correctionEnd)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/ICorrectionRequestor.html#acceptField(char[], char[], char[], char[], char[], char[], int, int, int)">acceptField</A></B>(char[]&nbsp;declaringTypePackageName,
char[]&nbsp;declaringTypeName,
char[]&nbsp;name,
char[]&nbsp;typePackageName,
char[]&nbsp;typeName,
char[]&nbsp;correctionName,
int&nbsp;modifiers,
int&nbsp;correctionStart,
int&nbsp;correctionEnd)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Notification of a field/var correction.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/ICorrectionRequestor.html#acceptInterface(char[], char[], char[], int, int, int)">acceptInterface</A></B>(char[]&nbsp;packageName,
char[]&nbsp;interfaceName,
char[]&nbsp;correctionName,
int&nbsp;modifiers,
int&nbsp;correctionStart,
int&nbsp;correctionEnd)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Notification of an interface correction.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/ICorrectionRequestor.html#acceptLocalVariable(char[], char[], char[], int, int, int)">acceptLocalVariable</A></B>(char[]&nbsp;name,
char[]&nbsp;typePackageName,
char[]&nbsp;typeName,
int&nbsp;modifiers,
int&nbsp;correctionStart,
int&nbsp;correctionEnd)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Notification of a local variable correction.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/ICorrectionRequestor.html#acceptMethod(char[], char[], char[], char[][], char[][], char[][], char[], char[], char[], int, int, int)">acceptMethod</A></B>(char[]&nbsp;declaringTypePackageName,
char[]&nbsp;declaringTypeName,
char[]&nbsp;selector,
char[][]&nbsp;parameterPackageNames,
char[][]&nbsp;parameterTypeNames,
char[][]&nbsp;parameterNames,
char[]&nbsp;returnTypePackageName,
char[]&nbsp;returnTypeName,
char[]&nbsp;correctionName,
int&nbsp;modifiers,
int&nbsp;correctionStart,
int&nbsp;correctionEnd)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Notification of a method correction.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/ICorrectionRequestor.html#acceptPackage(char[], char[], int, int)">acceptPackage</A></B>(char[]&nbsp;packageName,
char[]&nbsp;correctionName,
int&nbsp;correctionStart,
int&nbsp;correctionEnd)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Notification of a package correction.</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="acceptClass(char[], char[], char[], int, int, int)"><!-- --></A><H3>
acceptClass</H3>
<PRE>
void <B>acceptClass</B>(char[]&nbsp;packageName,
char[]&nbsp;className,
char[]&nbsp;correctionName,
int&nbsp;modifiers,
int&nbsp;correctionStart,
int&nbsp;correctionEnd)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="acceptField(char[], char[], char[], char[], char[], char[], int, int, int)"><!-- --></A><H3>
acceptField</H3>
<PRE>
void <B>acceptField</B>(char[]&nbsp;declaringTypePackageName,
char[]&nbsp;declaringTypeName,
char[]&nbsp;name,
char[]&nbsp;typePackageName,
char[]&nbsp;typeName,
char[]&nbsp;correctionName,
int&nbsp;modifiers,
int&nbsp;correctionStart,
int&nbsp;correctionEnd)</PRE>
<DL>
<DD>Notification of a field/var correction.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>declaringTypePackageName</CODE> - Name of the package in which the type that contains this field is declared.<DD><CODE>declaringTypeName</CODE> - Name of the type declaring this field.<DD><CODE>name</CODE> - Name of the field.<DD><CODE>typePackageName</CODE> - Name of the package in which the type of this field is declared.<DD><CODE>typeName</CODE> - Name of the type of this field.<DD><CODE>correctionName</CODE> - The correction for the field.<DD><CODE>modifiers</CODE> - The modifiers of this field.<DD><CODE>correctionStart</CODE> - The start position of insertion of the correction of this field.<DD><CODE>correctionEnd</CODE> - The end position of insertion of the correction of this field.</DL>
</DD>
</DL>
<HR>
<A NAME="acceptInterface(char[], char[], char[], int, int, int)"><!-- --></A><H3>
acceptInterface</H3>
<PRE>
void <B>acceptInterface</B>(char[]&nbsp;packageName,
char[]&nbsp;interfaceName,
char[]&nbsp;correctionName,
int&nbsp;modifiers,
int&nbsp;correctionStart,
int&nbsp;correctionEnd)</PRE>
<DL>
<DD>Notification of an interface correction.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>packageName</CODE> - Declaring package name of the interface.<DD><CODE>interfaceName</CODE> - Name of the interface.<DD><CODE>correctionName</CODE> - The correction for the interface.
Can include ';' for imported interfaces.<DD><CODE>modifiers</CODE> - The modifiers of the interface.<DD><CODE>correctionStart</CODE> - The start position of insertion of the correction of the interface.<DD><CODE>correctionEnd</CODE> - The end position of insertion of the correction of the interface.
NOTE - All package and type names are presented in their readable form:
Package names are in the form "a.b.c".
Nested type names are in the qualified form "A.M".
The default package is represented by an empty array.
<b>This Method only applies to ECMAScript 4 which is not yet supported</b></DL>
</DD>
</DL>
<HR>
<A NAME="acceptLocalVariable(char[], char[], char[], int, int, int)"><!-- --></A><H3>
acceptLocalVariable</H3>
<PRE>
void <B>acceptLocalVariable</B>(char[]&nbsp;name,
char[]&nbsp;typePackageName,
char[]&nbsp;typeName,
int&nbsp;modifiers,
int&nbsp;correctionStart,
int&nbsp;correctionEnd)</PRE>
<DL>
<DD>Notification of a local variable correction.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - Name of the local variable.<DD><CODE>typePackageName</CODE> - Name of the package in which the type of this local variable is declared.<DD><CODE>typeName</CODE> - Name of the type of this local variable.<DD><CODE>modifiers</CODE> - The modifiers of this local variable.<DD><CODE>correctionStart</CODE> - The start position of insertion of the correction of this local variable.<DD><CODE>correctionEnd</CODE> - The end position of insertion of the correction of this local variable.</DL>
</DD>
</DL>
<HR>
<A NAME="acceptMethod(char[], char[], char[], char[][], char[][], char[][], char[], char[], char[], int, int, int)"><!-- --></A><H3>
acceptMethod</H3>
<PRE>
void <B>acceptMethod</B>(char[]&nbsp;declaringTypePackageName,
char[]&nbsp;declaringTypeName,
char[]&nbsp;selector,
char[][]&nbsp;parameterPackageNames,
char[][]&nbsp;parameterTypeNames,
char[][]&nbsp;parameterNames,
char[]&nbsp;returnTypePackageName,
char[]&nbsp;returnTypeName,
char[]&nbsp;correctionName,
int&nbsp;modifiers,
int&nbsp;correctionStart,
int&nbsp;correctionEnd)</PRE>
<DL>
<DD>Notification of a method correction.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>declaringTypePackageName</CODE> - Name of the package in which the type that contains this method is declared.<DD><CODE>declaringTypeName</CODE> - Name of the type declaring this method.<DD><CODE>selector</CODE> - Name of the method.<DD><CODE>parameterPackageNames</CODE> - Names of the packages in which the parameter types are declared.
Should contain as many elements as parameterTypeNames.<DD><CODE>parameterTypeNames</CODE> - Names of the parameter types.
Should contain as many elements as parameterPackageNames.<DD><CODE>parameterNames</CODE> - Names of the parameters.
Should contain as many elements as parameterPackageNames.<DD><CODE>returnTypePackageName</CODE> - Name of the package in which the return type is declared.<DD><CODE>returnTypeName</CODE> - Name of the return type of this method, should be <code>null</code> for a constructor.<DD><CODE>correctionName</CODE> - The correction for the method.
Can include zero, one or two brackets. If the closing bracket is included, then the cursor should be placed before it.<DD><CODE>modifiers</CODE> - The modifiers of this method.<DD><CODE>correctionStart</CODE> - The start position of insertion of the correction of this method.<DD><CODE>correctionEnd</CODE> - The end position of insertion of the correction of this method.
NOTE: parameter names can be retrieved from the source model after the user selects a specific method.</DL>
</DD>
</DL>
<HR>
<A NAME="acceptPackage(char[], char[], int, int)"><!-- --></A><H3>
acceptPackage</H3>
<PRE>
void <B>acceptPackage</B>(char[]&nbsp;packageName,
char[]&nbsp;correctionName,
int&nbsp;correctionStart,
int&nbsp;correctionEnd)</PRE>
<DL>
<DD>Notification of a package correction.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>packageName</CODE> - The package name.<DD><CODE>correctionName</CODE> - The correction for the package.
Can include '.*;' for imports.<DD><CODE>correctionStart</CODE> - The start position of insertion of the correction of this package.<DD><CODE>correctionEnd</CODE> - The end position of insertion of the correction of this package.
<b>This Method only applies to ECMAScript 4 which is not yet supported</b></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/ICorrectionRequestor.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/core/ICompletionRequestor.html" title="interface in org.eclipse.wst.jsdt.core"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../org/eclipse/wst/jsdt/core/IElementChangedListener.html" title="interface in org.eclipse.wst.jsdt.core"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?org/eclipse/wst/jsdt/core/ICorrectionRequestor.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="ICorrectionRequestor.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>