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