| <!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:46 CDT 2008 --> |
| <TITLE> |
| BufferChangedEvent |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.eclipse.wst.jsdt.core.BufferChangedEvent class"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="BufferChangedEvent"; |
| } |
| </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> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/BufferChangedEvent.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/BindingKey.html" title="class in org.eclipse.wst.jsdt.core"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/CompletionContext.html" title="class 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/BufferChangedEvent.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="BufferChangedEvent.html" target="_top"><B>NO FRAMES</B></A> |
| <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: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <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> |
| Class BufferChangedEvent</H2> |
| <PRE> |
| java.lang.Object |
| <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">java.util.EventObject |
| <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.eclipse.wst.jsdt.core.BufferChangedEvent</B> |
| </PRE> |
| <DL> |
| <DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public class <B>BufferChangedEvent</B><DT>extends java.util.EventObject</DL> |
| </PRE> |
| |
| <P> |
| A buffer changed event describes how a buffer has changed. These events are |
| used in <code>IBufferChangedListener</code> notifications. |
| <p> |
| For text insertions, <code>getOffset</code> is the offset |
| of the first inserted character, <code>getText</code> is the |
| inserted text, and <code>getLength</code> is 0. |
| </p> |
| <p> |
| For text removals, <code>getOffset</code> is the offset |
| of the first removed character, <code>getText</code> is <code>null</code>, |
| and <code>getLength</code> is the length of the text that was removed. |
| </p> |
| <p> |
| For replacements (including <code>IBuffer.setContents</code>), |
| <code>getOffset</code> is the offset |
| of the first replaced character, <code>getText</code> is the replacement |
| text, and <code>getLength</code> is the length of the original text |
| that was replaced. |
| </p> |
| <p> |
| When a buffer is closed, <code>getOffset</code> is 0, <code>getLength</code> |
| is 0, and <code>getText</code> is <code>null</code>. |
| </p> |
| <p> |
| This class is not intended to be instantiated or subclassed by clients. |
| Instances of this class are automatically created by the JavaScript model. |
| </p> |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/jsdt/core/IBuffer.html" title="interface in org.eclipse.wst.jsdt.core"><CODE>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.</CODE></A>, |
| <A HREF="../../../../../serialized-form.html#org.eclipse.wst.jsdt.core.BufferChangedEvent">Serialized Form</A></DL> |
| <HR> |
| |
| <P> |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| <A NAME="constructor_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>Constructor Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/BufferChangedEvent.html#BufferChangedEvent(org.eclipse.wst.jsdt.core.IBuffer, int, int, java.lang.String)">BufferChangedEvent</A></B>(<A HREF="../../../../../org/eclipse/wst/jsdt/core/IBuffer.html" title="interface in org.eclipse.wst.jsdt.core">IBuffer</A> buffer, |
| int offset, |
| int length, |
| java.lang.String text)</CODE> |
| |
| <BR> |
| Creates a new buffer changed event indicating that the given buffer has changed.</TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== 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> <A HREF="../../../../../org/eclipse/wst/jsdt/core/IBuffer.html" title="interface in org.eclipse.wst.jsdt.core">IBuffer</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/BufferChangedEvent.html#getBuffer()">getBuffer</A></B>()</CODE> |
| |
| <BR> |
| Returns the buffer which has changed.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/BufferChangedEvent.html#getLength()">getLength</A></B>()</CODE> |
| |
| <BR> |
| Returns the length of text removed or replaced in the buffer, or |
| 0 if text has been inserted into the buffer.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/BufferChangedEvent.html#getOffset()">getOffset</A></B>()</CODE> |
| |
| <BR> |
| Returns the index of the first character inserted, removed, or replaced |
| in the buffer.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/BufferChangedEvent.html#getText()">getText</A></B>()</CODE> |
| |
| <BR> |
| Returns the text that was inserted, the replacement text, |
| or <code>null</code> if text has been removed.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.util.EventObject"><!-- --></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.util.EventObject</B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE>getSource, toString</CODE></TD> |
| </TR> |
| </TABLE> |
| <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, wait, wait, wait</CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| <A NAME="constructor_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>Constructor Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="BufferChangedEvent(org.eclipse.wst.jsdt.core.IBuffer, int, int, java.lang.String)"><!-- --></A><H3> |
| BufferChangedEvent</H3> |
| <PRE> |
| public <B>BufferChangedEvent</B>(<A HREF="../../../../../org/eclipse/wst/jsdt/core/IBuffer.html" title="interface in org.eclipse.wst.jsdt.core">IBuffer</A> buffer, |
| int offset, |
| int length, |
| java.lang.String text)</PRE> |
| <DL> |
| <DD>Creates a new buffer changed event indicating that the given buffer has changed. |
| <P> |
| <DL> |
| <DT><B>Parameters:</B><DD><CODE>buffer</CODE> - the given buffer<DD><CODE>offset</CODE> - the given offset<DD><CODE>length</CODE> - the given length<DD><CODE>text</CODE> - the given text</DL> |
| </DL> |
| |
| <!-- ============ 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="getBuffer()"><!-- --></A><H3> |
| getBuffer</H3> |
| <PRE> |
| public <A HREF="../../../../../org/eclipse/wst/jsdt/core/IBuffer.html" title="interface in org.eclipse.wst.jsdt.core">IBuffer</A> <B>getBuffer</B>()</PRE> |
| <DL> |
| <DD>Returns the buffer which has changed. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the buffer affected by the change</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getLength()"><!-- --></A><H3> |
| getLength</H3> |
| <PRE> |
| public int <B>getLength</B>()</PRE> |
| <DL> |
| <DD>Returns the length of text removed or replaced in the buffer, or |
| 0 if text has been inserted into the buffer. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the length of the original text fragment modified by the |
| buffer change (<code> 0 </code> in case of insertion).</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getOffset()"><!-- --></A><H3> |
| getOffset</H3> |
| <PRE> |
| public int <B>getOffset</B>()</PRE> |
| <DL> |
| <DD>Returns the index of the first character inserted, removed, or replaced |
| in the buffer. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the source offset of the textual manipulation in the buffer</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getText()"><!-- --></A><H3> |
| getText</H3> |
| <PRE> |
| public java.lang.String <B>getText</B>()</PRE> |
| <DL> |
| <DD>Returns the text that was inserted, the replacement text, |
| or <code>null</code> if text has been removed. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the text corresponding to the buffer change (<code> null </code> |
| in case of deletion).</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> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/BufferChangedEvent.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/BindingKey.html" title="class in org.eclipse.wst.jsdt.core"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/CompletionContext.html" title="class 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/BufferChangedEvent.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="BufferChangedEvent.html" target="_top"><B>NO FRAMES</B></A> |
| <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: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| |
| </BODY> |
| </HTML> |
