PageRenderTime 13ms CodeModel.GetById 2ms app.highlight 6ms RepoModel.GetById 1ms app.codeStats 0ms

/www/tags/NOV_07_2009/htdocs/api/org/gjt/sp/jedit/Marker.html

#
HTML | 237 lines | 196 code | 31 blank | 10 comment | 0 complexity | a9b393360be17d9d53aacbddbc0c9d49 MD5 | raw file
  1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2<!--NewPage-->
  3<HTML>
  4<HEAD>
  5<!-- Generated by javadoc (build 1.5.0_14) on Tue Jul 22 07:13:46 GMT-08:00 2008 -->
  6<TITLE>
  7Marker (jEdit API)
  8</TITLE>
  9
 10<META NAME="keywords" CONTENT="org.gjt.sp.jedit.Marker class">
 11
 12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
 13
 14
 15<NOSCRIPT>
 16</NOSCRIPT>
 17
 18</HEAD>
 19
 20<BODY BGCOLOR="white" >
 21
 22
 23<!-- ========= START OF TOP NAVBAR ======= -->
 24<A NAME="navbar_top"><!-- --></A>
 25<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
 26<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 27<TR>
 28<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 29<A NAME="navbar_top_firstrow"><!-- --></A>
 30<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 31  <TR ALIGN="center" VALIGN="top">
 32  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 33  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 34  <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 35  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Marker.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
 36  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 37  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 38  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 39  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 40  </TR>
 41</TABLE>
 42</TD>
 43<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 44</EM>
 45</TD>
 46</TR>
 47
 48<TR>
 49<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 50&nbsp;<A HREF="../../../../org/gjt/sp/jedit/Macros.Recorder.html" title="class in org.gjt.sp.jedit"><B>PREV CLASS</B></A>&nbsp;
 51&nbsp;<A HREF="../../../../org/gjt/sp/jedit/MiscUtilities.html" title="class in org.gjt.sp.jedit"><B>NEXT CLASS</B></A></FONT></TD>
 52<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 53  <A HREF="../../../../index.html?org/gjt/sp/jedit/Marker.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 54&nbsp;<A HREF="Marker.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 55&nbsp;
 56<NOSCRIPT>
 57  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
 58</NOSCRIPT>
 59
 60
 61</FONT></TD>
 62</TR>
 63<TR>
 64<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 65  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 66<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 67DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 68</TR>
 69</TABLE>
 70<A NAME="skip-navbar_top"></A>
 71<!-- ========= END OF TOP NAVBAR ========= -->
 72
 73<HR>
 74<!-- ======== START OF CLASS DATA ======== -->
 75<H2>
 76<FONT SIZE="-1">
 77org.gjt.sp.jedit</FONT>
 78<BR>
 79Class Marker</H2>
 80<PRE>
 81java.lang.Object
 82  <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.gjt.sp.jedit.Marker</B>
 83</PRE>
 84<HR>
 85<DL>
 86<DT><PRE>public class <B>Marker</B><DT>extends java.lang.Object</DL>
 87</PRE>
 88
 89<P>
 90Buffers may contain one or more <i>markers</i> which serve
 91 as textual bookmarks.<p>
 92
 93 A <code>Marker</code> has three key attributes: the
 94 <code>Buffer</code> to which it relates, the line number to which
 95 the marker refers, and an optional shortcut character. The shortcut
 96 identifies the the key that can be pressed with the
 97 <b>Markers</b>&gt;<b>Go To Marker</b> command.
 98<P>
 99
100<P>
101<HR>
102
103<P>
104
105<!-- ========== METHOD SUMMARY =========== -->
106
107<A NAME="method_summary"><!-- --></A>
108<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
109<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
110<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
111<B>Method Summary</B></FONT></TH>
112</TR>
113<TR BGCOLOR="white" CLASS="TableRowColor">
114<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
115<CODE>&nbsp;int</CODE></FONT></TD>
116<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Marker.html#getPosition()">getPosition</A></B>()</CODE>
117
118<BR>
119&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the position of this marker.</TD>
120</TR>
121<TR BGCOLOR="white" CLASS="TableRowColor">
122<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
123<CODE>&nbsp;char</CODE></FONT></TD>
124<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Marker.html#getShortcut()">getShortcut</A></B>()</CODE>
125
126<BR>
127&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the marker's shortcut character.</TD>
128</TR>
129</TABLE>
130&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
131<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
132<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
133<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
134</TR>
135<TR BGCOLOR="white" CLASS="TableRowColor">
136<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
137</TR>
138</TABLE>
139&nbsp;
140<P>
141
142<!-- ============ METHOD DETAIL ========== -->
143
144<A NAME="method_detail"><!-- --></A>
145<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
146<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
147<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
148<B>Method Detail</B></FONT></TH>
149</TR>
150</TABLE>
151
152<A NAME="getShortcut()"><!-- --></A><H3>
153getShortcut</H3>
154<PRE>
155public char <B>getShortcut</B>()</PRE>
156<DL>
157<DD>Returns the marker's shortcut character.
158<P>
159<DD><DL>
160<DT><B>Since:</B></DT>
161  <DD>jEdit 3.2pre1</DD>
162</DL>
163</DD>
164</DL>
165<HR>
166
167<A NAME="getPosition()"><!-- --></A><H3>
168getPosition</H3>
169<PRE>
170public int <B>getPosition</B>()</PRE>
171<DL>
172<DD>Returns the position of this marker.
173<P>
174<DD><DL>
175<DT><B>Since:</B></DT>
176  <DD>jEdit 3.2pre1</DD>
177</DL>
178</DD>
179</DL>
180<!-- ========= END OF CLASS DATA ========= -->
181<HR>
182
183
184<!-- ======= START OF BOTTOM NAVBAR ====== -->
185<A NAME="navbar_bottom"><!-- --></A>
186<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
187<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
188<TR>
189<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
190<A NAME="navbar_bottom_firstrow"><!-- --></A>
191<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
192  <TR ALIGN="center" VALIGN="top">
193  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
194  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
195  <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
196  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Marker.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
197  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
198  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
199  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
200  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
201  </TR>
202</TABLE>
203</TD>
204<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
205</EM>
206</TD>
207</TR>
208
209<TR>
210<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
211&nbsp;<A HREF="../../../../org/gjt/sp/jedit/Macros.Recorder.html" title="class in org.gjt.sp.jedit"><B>PREV CLASS</B></A>&nbsp;
212&nbsp;<A HREF="../../../../org/gjt/sp/jedit/MiscUtilities.html" title="class in org.gjt.sp.jedit"><B>NEXT CLASS</B></A></FONT></TD>
213<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
214  <A HREF="../../../../index.html?org/gjt/sp/jedit/Marker.html" target="_top"><B>FRAMES</B></A>  &nbsp;
215&nbsp;<A HREF="Marker.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
216&nbsp;
217<NOSCRIPT>
218  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
219</NOSCRIPT>
220
221
222</FONT></TD>
223</TR>
224<TR>
225<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
226  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
227<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
228DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
229</TR>
230</TABLE>
231<A NAME="skip-navbar_bottom"></A>
232<!-- ======== END OF BOTTOM NAVBAR ======= -->
233
234<HR>
235
236</BODY>
237</HTML>