<!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) on Wed Nov 22 10:48:23 MSK 2006 --> <TITLE> BaseEditor </TITLE> <META NAME="keywords" CONTENT="net.sf.colorer.editor.BaseEditor interface"> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> <SCRIPT type="text/javascript"> function windowTitle() { parent.document.title="BaseEditor"; } </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="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-all.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"> PREV CLASS <A HREF="../../../../net/sf/colorer/editor/EditorListener.html" title="interface in net.sf.colorer.editor"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html?net/sf/colorer/editor/BaseEditor.html" target="_top"><B>FRAMES</B></A> <A HREF="BaseEditor.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 | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | CONSTR | <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"> net.sf.colorer.editor</FONT> <BR> Interface BaseEditor</H2> <DL> <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../net/sf/colorer/impl/BaseEditorNative.html" title="class in net.sf.colorer.impl">BaseEditorNative</A></DD> </DL> <HR> <DL> <DT><PRE>public interface <B>BaseEditor</B></DL> </PRE> <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> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/colorer/editor/BaseEditor.html#addEditorListener(net.sf.colorer.editor.EditorListener)">addEditorListener</A></B>(<A HREF="../../../../net/sf/colorer/editor/EditorListener.html" title="interface in net.sf.colorer.editor">EditorListener</A> el)</CODE> <BR> Adds specified EditorListener object into parse process.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/colorer/editor/BaseEditor.html#addRegionHandler(net.sf.colorer.RegionHandler, net.sf.colorer.Region)">addRegionHandler</A></B>(<A HREF="../../../../net/sf/colorer/RegionHandler.html" title="interface in net.sf.colorer">RegionHandler</A> rh, <A HREF="../../../../net/sf/colorer/Region.html" title="class in net.sf.colorer">Region</A> filter)</CODE> <BR> Adds specified RegionHandler object into the parse process.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../net/sf/colorer/FileType.html" title="class in net.sf.colorer">FileType</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/colorer/editor/BaseEditor.html#chooseFileType(java.lang.String)">chooseFileType</A></B>(java.lang.String fname)</CODE> <BR> Chooses filetype according to the filename and first line of text</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/colorer/editor/BaseEditor.html#dispose()">dispose</A></B>()</CODE> <BR> Dispose this Editor's resources</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../net/sf/colorer/handlers/RegionDefine.html" title="class in net.sf.colorer.handlers">RegionDefine</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/colorer/editor/BaseEditor.html#getBackground()">getBackground</A></B>()</CODE> <BR> Current Background Region (def:Text)</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../net/sf/colorer/FileType.html" title="class in net.sf.colorer">FileType</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/colorer/editor/BaseEditor.html#getFileType()">getFileType</A></B>()</CODE> <BR> Returns Currently selected file type</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../net/sf/colorer/handlers/RegionDefine.html" title="class in net.sf.colorer.handlers">RegionDefine</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/colorer/editor/BaseEditor.html#getHorzCross()">getHorzCross</A></B>()</CODE> <BR> Current Horizontal Rule (def:HorzCross)</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../net/sf/colorer/handlers/LineRegion.html" title="class in net.sf.colorer.handlers">LineRegion</A>[]</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/colorer/editor/BaseEditor.html#getLineRegions(int)">getLineRegions</A></B>(int lno)</CODE> <BR> Return parsed and colored LineRegions of requested line.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../net/sf/colorer/editor/PairMatch.html" title="class in net.sf.colorer.editor">PairMatch</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/colorer/editor/BaseEditor.html#getPairMatch(int, int)">getPairMatch</A></B>(int lineNo, int pos)</CODE> <BR> Searches and creates pair match object.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../net/sf/colorer/handlers/RegionDefine.html" title="class in net.sf.colorer.handlers">RegionDefine</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/colorer/editor/BaseEditor.html#getVertCross()">getVertCross</A></B>()</CODE> <BR> Current Vertical Rule (def:VertCross)</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/colorer/editor/BaseEditor.html#idleJob(int)">idleJob</A></B>(int time)</CODE> <BR> Tries to do some parsing job while user is doing nothing.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/colorer/editor/BaseEditor.html#lineCountEvent(int)">lineCountEvent</A></B>(int newLineCount)</CODE> <BR> Informs about total lines count change.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/colorer/editor/BaseEditor.html#modifyEvent(int)">modifyEvent</A></B>(int topLine)</CODE> <BR> Informs BaseEditor object about text modification event.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/colorer/editor/BaseEditor.html#modifyLineEvent(int)">modifyLineEvent</A></B>(int line)</CODE> <BR> Informs about single line modification event.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/colorer/editor/BaseEditor.html#removeEditorListener(net.sf.colorer.editor.EditorListener)">removeEditorListener</A></B>(<A HREF="../../../../net/sf/colorer/editor/EditorListener.html" title="interface in net.sf.colorer.editor">EditorListener</A> el)</CODE> <BR> Removes previously added EditorListener object.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/colorer/editor/BaseEditor.html#removeRegionHandler(net.sf.colorer.RegionHandler)">removeRegionHandler</A></B>(<A HREF="../../../../net/sf/colorer/RegionHandler.html" title="interface in net.sf.colorer">RegionHandler</A> rh)</CODE> <BR> Removes previously added region handler.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/colorer/editor/BaseEditor.html#searchGlobalPair(net.sf.colorer.editor.PairMatch)">searchGlobalPair</A></B>(<A HREF="../../../../net/sf/colorer/editor/PairMatch.html" title="class in net.sf.colorer.editor">PairMatch</A> pm)</CODE> <BR> Searches pair match in all available text, possibly, making additional processing.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/colorer/editor/BaseEditor.html#searchLocalPair(net.sf.colorer.editor.PairMatch)">searchLocalPair</A></B>(<A HREF="../../../../net/sf/colorer/editor/PairMatch.html" title="class in net.sf.colorer.editor">PairMatch</A> pm)</CODE> <BR> Searches pair match in currently visible text.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/colorer/editor/BaseEditor.html#setBackParse(int)">setBackParse</A></B>(int backParse)</CODE> <BR> Specifies number of lines, for which parser would be able to run continual processing without highlight invalidation.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/colorer/editor/BaseEditor.html#setFileType(net.sf.colorer.FileType)">setFileType</A></B>(<A HREF="../../../../net/sf/colorer/FileType.html" title="class in net.sf.colorer">FileType</A> typeName)</CODE> <BR> Changes used file type</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/colorer/editor/BaseEditor.html#setRegionCompact(boolean)">setRegionCompact</A></B>(boolean compact)</CODE> <BR> LineRegionsSupport object preferences.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/colorer/editor/BaseEditor.html#setRegionMapper(net.sf.colorer.handlers.RegionMapper)">setRegionMapper</A></B>(<A HREF="../../../../net/sf/colorer/handlers/RegionMapper.html" title="class in net.sf.colorer.handlers">RegionMapper</A> regionMapper)</CODE> <BR> Installs specified external RegionMapper.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/colorer/editor/BaseEditor.html#setRegionMapper(java.lang.String, java.lang.String)">setRegionMapper</A></B>(java.lang.String hrdClass, java.lang.String hrdName)</CODE> <BR> Installs specified internal RegionMapper.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/colorer/editor/BaseEditor.html#validate(int)">validate</A></B>(int lno)</CODE> <BR> Validates current state of the editor and runs parser, if needed.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/colorer/editor/BaseEditor.html#visibleTextEvent(int, int)">visibleTextEvent</A></B>(int wStart, int wSize)</CODE> <BR> Informs about changes in visible range of text lines.</TD> </TR> </TABLE> <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="dispose()"><!-- --></A><H3> dispose</H3> <PRE> void <B>dispose</B>()</PRE> <DL> <DD>Dispose this Editor's resources <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="setRegionCompact(boolean)"><!-- --></A><H3> setRegionCompact</H3> <PRE> void <B>setRegionCompact</B>(boolean compact)</PRE> <DL> <DD>LineRegionsSupport object preferences. Installs specified RegionStore (basically HRDRegionStore), which maps HRC Regions into color data, sets default size (in lines) of Regions structure cache. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>compact</CODE> - Creates LineRegionsSupport (false) or LineRegionsCompactSupport (true) object to store lists of RegionDefine's</DL> </DD> </DL> <HR> <A NAME="setFileType(net.sf.colorer.FileType)"><!-- --></A><H3> setFileType</H3> <PRE> void <B>setFileType</B>(<A HREF="../../../../net/sf/colorer/FileType.html" title="class in net.sf.colorer">FileType</A> typeName)</PRE> <DL> <DD>Changes used file type <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="chooseFileType(java.lang.String)"><!-- --></A><H3> chooseFileType</H3> <PRE> <A HREF="../../../../net/sf/colorer/FileType.html" title="class in net.sf.colorer">FileType</A> <B>chooseFileType</B>(java.lang.String fname)</PRE> <DL> <DD>Chooses filetype according to the filename and first line of text <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="getFileType()"><!-- --></A><H3> getFileType</H3> <PRE> <A HREF="../../../../net/sf/colorer/FileType.html" title="class in net.sf.colorer">FileType</A> <B>getFileType</B>()</PRE> <DL> <DD>Returns Currently selected file type <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="setBackParse(int)"><!-- --></A><H3> setBackParse</H3> <PRE> void <B>setBackParse</B>(int backParse)</PRE> <DL> <DD>Specifies number of lines, for which parser would be able to run continual processing without highlight invalidation. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>backParse</CODE> - Number of lines. If <= 0, dropped into default value.</DL> </DD> </DL> <HR> <A NAME="setRegionMapper(net.sf.colorer.handlers.RegionMapper)"><!-- --></A><H3> setRegionMapper</H3> <PRE> void <B>setRegionMapper</B>(<A HREF="../../../../net/sf/colorer/handlers/RegionMapper.html" title="class in net.sf.colorer.handlers">RegionMapper</A> regionMapper)</PRE> <DL> <DD>Installs specified external RegionMapper. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="setRegionMapper(java.lang.String, java.lang.String)"><!-- --></A><H3> setRegionMapper</H3> <PRE> void <B>setRegionMapper</B>(java.lang.String hrdClass, java.lang.String hrdName)</PRE> <DL> <DD>Installs specified internal RegionMapper. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="addRegionHandler(net.sf.colorer.RegionHandler, net.sf.colorer.Region)"><!-- --></A><H3> addRegionHandler</H3> <PRE> void <B>addRegionHandler</B>(<A HREF="../../../../net/sf/colorer/RegionHandler.html" title="interface in net.sf.colorer">RegionHandler</A> rh, <A HREF="../../../../net/sf/colorer/Region.html" title="class in net.sf.colorer">Region</A> filter)</PRE> <DL> <DD>Adds specified RegionHandler object into the parse process. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>filter</CODE> - If not null, handler would be activated only if passed regions have specified <code>filter</code> parent. This allows to optimize performance and disable unnecesary JNI context switches.</DL> </DD> </DL> <HR> <A NAME="removeRegionHandler(net.sf.colorer.RegionHandler)"><!-- --></A><H3> removeRegionHandler</H3> <PRE> void <B>removeRegionHandler</B>(<A HREF="../../../../net/sf/colorer/RegionHandler.html" title="interface in net.sf.colorer">RegionHandler</A> rh)</PRE> <DL> <DD>Removes previously added region handler. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="addEditorListener(net.sf.colorer.editor.EditorListener)"><!-- --></A><H3> addEditorListener</H3> <PRE> void <B>addEditorListener</B>(<A HREF="../../../../net/sf/colorer/editor/EditorListener.html" title="interface in net.sf.colorer.editor">EditorListener</A> el)</PRE> <DL> <DD>Adds specified EditorListener object into parse process. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="removeEditorListener(net.sf.colorer.editor.EditorListener)"><!-- --></A><H3> removeEditorListener</H3> <PRE> void <B>removeEditorListener</B>(<A HREF="../../../../net/sf/colorer/editor/EditorListener.html" title="interface in net.sf.colorer.editor">EditorListener</A> el)</PRE> <DL> <DD>Removes previously added EditorListener object. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="getBackground()"><!-- --></A><H3> getBackground</H3> <PRE> <A HREF="../../../../net/sf/colorer/handlers/RegionDefine.html" title="class in net.sf.colorer.handlers">RegionDefine</A> <B>getBackground</B>()</PRE> <DL> <DD>Current Background Region (def:Text) <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="getVertCross()"><!-- --></A><H3> getVertCross</H3> <PRE> <A HREF="../../../../net/sf/colorer/handlers/RegionDefine.html" title="class in net.sf.colorer.handlers">RegionDefine</A> <B>getVertCross</B>()</PRE> <DL> <DD>Current Vertical Rule (def:VertCross) <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="getHorzCross()"><!-- --></A><H3> getHorzCross</H3> <PRE> <A HREF="../../../../net/sf/colorer/handlers/RegionDefine.html" title="class in net.sf.colorer.handlers">RegionDefine</A> <B>getHorzCross</B>()</PRE> <DL> <DD>Current Horizontal Rule (def:HorzCross) <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="getPairMatch(int, int)"><!-- --></A><H3> getPairMatch</H3> <PRE> <A HREF="../../../../net/sf/colorer/editor/PairMatch.html" title="class in net.sf.colorer.editor">PairMatch</A> <B>getPairMatch</B>(int lineNo, int pos)</PRE> <DL> <DD>Searches and creates pair match object. Returned object can be used later in the pair search methods. This object is valid only until reparse of it's line occured. After that event information about line region's references in it becomes invalid and, if used, can produce faults. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>lineNo</CODE> - Line number, where to search paired region.<DD><CODE>pos</CODE> - Position in line, where paired region to be searched. Paired Region is found, if it includes specified position or ends directly at one char before line position.</DL> </DD> </DL> <HR> <A NAME="searchLocalPair(net.sf.colorer.editor.PairMatch)"><!-- --></A><H3> searchLocalPair</H3> <PRE> void <B>searchLocalPair</B>(<A HREF="../../../../net/sf/colorer/editor/PairMatch.html" title="class in net.sf.colorer.editor">PairMatch</A> pm)</PRE> <DL> <DD>Searches pair match in currently visible text. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>pm</CODE> - Unmatched pair match</DL> </DD> </DL> <HR> <A NAME="searchGlobalPair(net.sf.colorer.editor.PairMatch)"><!-- --></A><H3> searchGlobalPair</H3> <PRE> void <B>searchGlobalPair</B>(<A HREF="../../../../net/sf/colorer/editor/PairMatch.html" title="class in net.sf.colorer.editor">PairMatch</A> pm)</PRE> <DL> <DD>Searches pair match in all available text, possibly, making additional processing. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>pm</CODE> - Unmatched pair match</DL> </DD> </DL> <HR> <A NAME="getLineRegions(int)"><!-- --></A><H3> getLineRegions</H3> <PRE> <A HREF="../../../../net/sf/colorer/handlers/LineRegion.html" title="class in net.sf.colorer.handlers">LineRegion</A>[] <B>getLineRegions</B>(int lno)</PRE> <DL> <DD>Return parsed and colored LineRegions of requested line. This method validates current cache state and, if needed, calls Colorer parser to validate modified block of text. Size of reparsed text is choosed according to information about visible text range and modification events. <P> <DD><DL> <DT><B>To do:</B></DT> <DD>If number of lines, to be reparsed is more, than backParse parameter, then method will return null, until validate() method is called.</DD> </DL> </DD> </DL> <HR> <A NAME="validate(int)"><!-- --></A><H3> validate</H3> <PRE> void <B>validate</B>(int lno)</PRE> <DL> <DD>Validates current state of the editor and runs parser, if needed. This method can be called periodically in background thread to make possible background parsing process. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>lno</CODE> - Line number, for which validation is requested. If this number is in the current visible window range, the part of text is validated, which is required for visual repaint. If this number is equals to -1, all the text is validated. If this number is not in visible range, optimal partial validation is used</DL> </DD> </DL> <HR> <A NAME="idleJob(int)"><!-- --></A><H3> idleJob</H3> <PRE> void <B>idleJob</B>(int time)</PRE> <DL> <DD>Tries to do some parsing job while user is doing nothing. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>time</CODE> - integer between 0 and 100, shows an abount of time, available for this job.</DL> </DD> </DL> <HR> <A NAME="modifyEvent(int)"><!-- --></A><H3> modifyEvent</H3> <PRE> void <B>modifyEvent</B>(int topLine)</PRE> <DL> <DD>Informs BaseEditor object about text modification event. All the text becomes invalid after the specified line. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>topLine</CODE> - Topmost modified line of text.</DL> </DD> </DL> <HR> <A NAME="modifyLineEvent(int)"><!-- --></A><H3> modifyLineEvent</H3> <PRE> void <B>modifyLineEvent</B>(int line)</PRE> <DL> <DD>Informs about single line modification event. Generally, this type of event can be processed much faster because of pre-checking line's changed structure and cancelling further parsing in case of unmodified text structure. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>line</CODE> - Modified line of text.<DT><B>To do:</B></DT> <DD>Not used yet! This must include special 'try' parse method.</DD> </DL> </DD> </DL> <HR> <A NAME="visibleTextEvent(int, int)"><!-- --></A><H3> visibleTextEvent</H3> <PRE> void <B>visibleTextEvent</B>(int wStart, int wSize)</PRE> <DL> <DD>Informs about changes in visible range of text lines. This information is used to make assumptions about text structure and to make faster parsing. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>wStart</CODE> - Topmost visible line of text.<DD><CODE>wSize</CODE> - Number of currently visible text lines. This number must includes all partially visible lines.</DL> </DD> </DL> <HR> <A NAME="lineCountEvent(int)"><!-- --></A><H3> lineCountEvent</H3> <PRE> void <B>lineCountEvent</B>(int newLineCount)</PRE> <DL> <DD>Informs about total lines count change. This must include initial lines number setting. <P> <DD><DL> </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="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-all.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"> PREV CLASS <A HREF="../../../../net/sf/colorer/editor/EditorListener.html" title="interface in net.sf.colorer.editor"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html?net/sf/colorer/editor/BaseEditor.html" target="_top"><B>FRAMES</B></A> <A HREF="BaseEditor.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 | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_bottom"></A> <!-- ======== END OF BOTTOM NAVBAR ======= --> <HR> <i>Copyright © 2003 Cail Lomecb. All Rights Reserved.</i> </BODY> </HTML>