/www/tags/NOV_07_2009/htdocs/api/org/gjt/sp/jedit/textarea/TextAreaExtension.html
HTML | 369 lines | 318 code | 39 blank | 12 comment | 0 complexity | 2e949357e801accba7e17535c3aa28ba MD5 | raw file
Possible License(s): BSD-3-Clause, AGPL-1.0, Apache-2.0, LGPL-2.0, LGPL-3.0, GPL-2.0, CC-BY-SA-3.0, LGPL-2.1, GPL-3.0, MPL-2.0-no-copyleft-exception, IPL-1.0
- <!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_14) on Tue Jul 22 07:14:15 GMT-08:00 2008 -->
- <TITLE>
- TextAreaExtension (jEdit API)
- </TITLE>
- <META NAME="keywords" CONTENT="org.gjt.sp.jedit.textarea.TextAreaExtension class">
- <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
- <NOSCRIPT>
- </NOSCRIPT>
- </HEAD>
- <BODY BGCOLOR="white" >
- <!-- ========= 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="#00008B" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/TextAreaExtension.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/gjt/sp/jedit/textarea/TextAreaException.html" title="class in org.gjt.sp.jedit.textarea"><B>PREV CLASS</B></A>
- <A HREF="../../../../../org/gjt/sp/jedit/textarea/TextAreaMouseHandler.html" title="class in org.gjt.sp.jedit.textarea"><B>NEXT CLASS</B></A></FONT></TD>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../../index.html?org/gjt/sp/jedit/textarea/TextAreaExtension.html" target="_top"><B>FRAMES</B></A>
- <A HREF="TextAreaExtension.html" target="_top"><B>NO FRAMES</B></A>
-
- <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.gjt.sp.jedit.textarea</FONT>
- <BR>
- Class TextAreaExtension</H2>
- <PRE>
- java.lang.Object
- <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.gjt.sp.jedit.textarea.TextAreaExtension</B>
- </PRE>
- <DL>
- <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../org/gjt/sp/jedit/textarea/StructureMatcher.Highlight.html" title="class in org.gjt.sp.jedit.textarea">StructureMatcher.Highlight</A></DD>
- </DL>
- <HR>
- <DL>
- <DT><PRE>public abstract class <B>TextAreaExtension</B><DT>extends java.lang.Object</DL>
- </PRE>
- <P>
- Subclasses of this class can perform custom painting and tool tip
- handling in the text area and gutter.
- <P>
- <P>
- <DL>
- <DT><B>Since:</B></DT>
- <DD>jEdit 4.0pre4</DD>
- <DT><B>See Also:</B><DD><A HREF="../../../../../org/gjt/sp/jedit/textarea/TextAreaPainter.html#addExtension(org.gjt.sp.jedit.textarea.TextAreaExtension)"><CODE>TextAreaPainter.addExtension(TextAreaExtension)</CODE></A>,
- <A HREF="../../../../../org/gjt/sp/jedit/textarea/TextAreaPainter.html#removeExtension(org.gjt.sp.jedit.textarea.TextAreaExtension)"><CODE>TextAreaPainter.removeExtension(TextAreaExtension)</CODE></A>,
- <A HREF="../../../../../org/gjt/sp/jedit/textarea/Gutter.html#addExtension(org.gjt.sp.jedit.textarea.TextAreaExtension)"><CODE>Gutter.addExtension(TextAreaExtension)</CODE></A>,
- <A HREF="../../../../../org/gjt/sp/jedit/textarea/Gutter.html#removeExtension(org.gjt.sp.jedit.textarea.TextAreaExtension)"><CODE>Gutter.removeExtension(TextAreaExtension)</CODE></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/gjt/sp/jedit/textarea/TextAreaExtension.html#TextAreaExtension()">TextAreaExtension</A></B>()</CODE>
- <BR>
- </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> java.lang.String</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/textarea/TextAreaExtension.html#getToolTipText(int, int)">getToolTipText</A></B>(int x,
- int y)</CODE>
- <BR>
- Called by the text area when the mouse hovers over the
- location specified in the mouse 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="../../../../../org/gjt/sp/jedit/textarea/TextAreaExtension.html#paintInvalidLine(java.awt.Graphics2D, int, int)">paintInvalidLine</A></B>(java.awt.Graphics2D gfx,
- int screenLine,
- int y)</CODE>
- <BR>
- Called by the text area when the extension is to paint a
- screen line which is not part of the buffer.</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="../../../../../org/gjt/sp/jedit/textarea/TextAreaExtension.html#paintScreenLineRange(java.awt.Graphics2D, int, int, int[], int[], int[], int, int)">paintScreenLineRange</A></B>(java.awt.Graphics2D gfx,
- int firstLine,
- int lastLine,
- int[] physicalLines,
- int[] start,
- int[] end,
- int y,
- int lineHeight)</CODE>
- <BR>
- Paints a range of screen lines.</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="../../../../../org/gjt/sp/jedit/textarea/TextAreaExtension.html#paintValidLine(java.awt.Graphics2D, int, int, int, int, int)">paintValidLine</A></B>(java.awt.Graphics2D gfx,
- int screenLine,
- int physicalLine,
- int start,
- int end,
- int y)</CODE>
- <BR>
- Called by the text area when the extension is to paint a
- screen line which has an associated physical line number in
- the buffer.</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>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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="TextAreaExtension()"><!-- --></A><H3>
- TextAreaExtension</H3>
- <PRE>
- public <B>TextAreaExtension</B>()</PRE>
- <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="paintScreenLineRange(java.awt.Graphics2D, int, int, int[], int[], int[], int, int)"><!-- --></A><H3>
- paintScreenLineRange</H3>
- <PRE>
- public void <B>paintScreenLineRange</B>(java.awt.Graphics2D gfx,
- int firstLine,
- int lastLine,
- int[] physicalLines,
- int[] start,
- int[] end,
- int y,
- int lineHeight)</PRE>
- <DL>
- <DD>Paints a range of screen lines. The default implementation calls
- <A HREF="../../../../../org/gjt/sp/jedit/textarea/TextAreaExtension.html#paintValidLine(java.awt.Graphics2D, int, int, int, int, int)"><CODE>paintValidLine(Graphics2D,int,int,int,int,int)</CODE></A> and
- <A HREF="../../../../../org/gjt/sp/jedit/textarea/TextAreaExtension.html#paintInvalidLine(java.awt.Graphics2D, int, int)"><CODE>paintInvalidLine(Graphics2D,int,int)</CODE></A>.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>gfx</CODE> - A graphics context<DD><CODE>firstLine</CODE> - The first screen line<DD><CODE>lastLine</CODE> - The last screen line<DD><CODE>physicalLines</CODE> - The list of physical line numbers. Entries are
- -1 if the screen line is out of range.<DD><CODE>start</CODE> - An array of screen line start offsets.<DD><CODE>end</CODE> - An array of screen line end offsets<DD><CODE>y</CODE> - The y co-ordinate<DD><CODE>lineHeight</CODE> - The line height<DT><B>Since:</B></DT>
- <DD>jEdit 4.2pre2</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="paintValidLine(java.awt.Graphics2D, int, int, int, int, int)"><!-- --></A><H3>
- paintValidLine</H3>
- <PRE>
- public void <B>paintValidLine</B>(java.awt.Graphics2D gfx,
- int screenLine,
- int physicalLine,
- int start,
- int end,
- int y)</PRE>
- <DL>
- <DD>Called by the text area when the extension is to paint a
- screen line which has an associated physical line number in
- the buffer. Note that since one physical line may consist of
- several screen lines due to soft wrap, the start and end
- offsets of the screen line are passed in as well.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>gfx</CODE> - The graphics context<DD><CODE>screenLine</CODE> - The screen line number<DD><CODE>physicalLine</CODE> - The physical line number<DD><CODE>start</CODE> - The offset where the screen line begins, from
- the start of the buffer<DD><CODE>end</CODE> - The offset where the screen line ends, from the
- start of the buffer<DD><CODE>y</CODE> - The y co-ordinate of the top of the line's
- bounding box<DT><B>Since:</B></DT>
- <DD>jEdit 4.0pre4</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="paintInvalidLine(java.awt.Graphics2D, int, int)"><!-- --></A><H3>
- paintInvalidLine</H3>
- <PRE>
- public void <B>paintInvalidLine</B>(java.awt.Graphics2D gfx,
- int screenLine,
- int y)</PRE>
- <DL>
- <DD>Called by the text area when the extension is to paint a
- screen line which is not part of the buffer. This can happen
- if the buffer is shorter than the height of the text area,
- for example.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>gfx</CODE> - The graphics context<DD><CODE>screenLine</CODE> - The screen line number<DD><CODE>y</CODE> - The y co-ordinate of the top of the line's
- bounding box<DT><B>Since:</B></DT>
- <DD>jEdit 4.0pre4</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="getToolTipText(int, int)"><!-- --></A><H3>
- getToolTipText</H3>
- <PRE>
- public java.lang.String <B>getToolTipText</B>(int x,
- int y)</PRE>
- <DL>
- <DD>Called by the text area when the mouse hovers over the
- location specified in the mouse event.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>x</CODE> - The x co-ordinate<DD><CODE>y</CODE> - The y co-ordinate<DT><B>Since:</B></DT>
- <DD>jEdit 4.0pre4</DD>
- </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="#00008B" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/TextAreaExtension.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/gjt/sp/jedit/textarea/TextAreaException.html" title="class in org.gjt.sp.jedit.textarea"><B>PREV CLASS</B></A>
- <A HREF="../../../../../org/gjt/sp/jedit/textarea/TextAreaMouseHandler.html" title="class in org.gjt.sp.jedit.textarea"><B>NEXT CLASS</B></A></FONT></TD>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../../index.html?org/gjt/sp/jedit/textarea/TextAreaExtension.html" target="_top"><B>FRAMES</B></A>
- <A HREF="TextAreaExtension.html" target="_top"><B>NO FRAMES</B></A>
-
- <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>