PageRenderTime 115ms CodeModel.GetById 79ms app.highlight 27ms RepoModel.GetById 1ms app.codeStats 1ms

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

#
HTML | 338 lines | 285 code | 43 blank | 10 comment | 0 complexity | dec71b32e59c4669a14e8394a04c4a72 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:14:01 GMT-08:00 2008 -->
  6<TITLE>
  7HelpViewerInterface (jEdit API)
  8</TITLE>
  9
 10<META NAME="keywords" CONTENT="org.gjt.sp.jedit.help.HelpViewerInterface interface">
 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/HelpViewerInterface.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/help/HelpViewer.html" title="class in org.gjt.sp.jedit.help"><B>PREV CLASS</B></A>&nbsp;
 51&nbsp;<A HREF="../../../../../org/gjt/sp/jedit/help/HistoryButton.html" title="class in org.gjt.sp.jedit.help"><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/help/HelpViewerInterface.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 54&nbsp;<A HREF="HelpViewerInterface.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.help</FONT>
 78<BR>
 79Interface HelpViewerInterface</H2>
 80<DL>
 81<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../org/gjt/sp/jedit/help/HelpViewer.html" title="class in org.gjt.sp.jedit.help">HelpViewer</A></DD>
 82</DL>
 83<HR>
 84<DL>
 85<DT><PRE>public interface <B>HelpViewerInterface</B></DL>
 86</PRE>
 87
 88<P>
 89Interface supported by all HelpViewer classes.
 90 Currently used by @ref infoviewer.InfoViewerPlugin and @ref HelpViewer
 91<P>
 92
 93<P>
 94<DL>
 95<DT><B>Since:</B></DT>
 96  <DD>Jedit 4.2pre5</DD>
 97</DL>
 98<HR>
 99
100<P>
101
102<!-- ========== METHOD SUMMARY =========== -->
103
104<A NAME="method_summary"><!-- --></A>
105<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
106<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
107<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
108<B>Method Summary</B></FONT></TH>
109</TR>
110<TR BGCOLOR="white" CLASS="TableRowColor">
111<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
112<CODE>&nbsp;void</CODE></FONT></TD>
113<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/help/HelpViewerInterface.html#addPropertyChangeListener(java.beans.PropertyChangeListener)">addPropertyChangeListener</A></B>(java.beans.PropertyChangeListener&nbsp;l)</CODE>
114
115<BR>
116&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
117</TR>
118<TR BGCOLOR="white" CLASS="TableRowColor">
119<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
120<CODE>&nbsp;void</CODE></FONT></TD>
121<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/help/HelpViewerInterface.html#dispose()">dispose</A></B>()</CODE>
122
123<BR>
124&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called when the helpviewer is closed</TD>
125</TR>
126<TR BGCOLOR="white" CLASS="TableRowColor">
127<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
128<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
129<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/help/HelpViewerInterface.html#getBaseURL()">getBaseURL</A></B>()</CODE>
130
131<BR>
132&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
133</TR>
134<TR BGCOLOR="white" CLASS="TableRowColor">
135<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
136<CODE>&nbsp;java.awt.Component</CODE></FONT></TD>
137<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/help/HelpViewerInterface.html#getComponent()">getComponent</A></B>()</CODE>
138
139<BR>
140&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
141</TR>
142<TR BGCOLOR="white" CLASS="TableRowColor">
143<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
144<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
145<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/help/HelpViewerInterface.html#getShortURL()">getShortURL</A></B>()</CODE>
146
147<BR>
148&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
149</TR>
150<TR BGCOLOR="white" CLASS="TableRowColor">
151<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
152<CODE>&nbsp;void</CODE></FONT></TD>
153<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/help/HelpViewerInterface.html#gotoURL(java.lang.String, boolean, int)">gotoURL</A></B>(java.lang.String&nbsp;url,
154        boolean&nbsp;addToHistory,
155        int&nbsp;scrollPos)</CODE>
156
157<BR>
158&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
159</TR>
160<TR BGCOLOR="white" CLASS="TableRowColor">
161<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
162<CODE>&nbsp;void</CODE></FONT></TD>
163<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/help/HelpViewerInterface.html#queueTOCReload()">queueTOCReload</A></B>()</CODE>
164
165<BR>
166&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
167</TR>
168<TR BGCOLOR="white" CLASS="TableRowColor">
169<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
170<CODE>&nbsp;void</CODE></FONT></TD>
171<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/help/HelpViewerInterface.html#setTitle(java.lang.String)">setTitle</A></B>(java.lang.String&nbsp;newTitle)</CODE>
172
173<BR>
174&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
175</TR>
176</TABLE>
177&nbsp;
178<P>
179
180<!-- ============ METHOD DETAIL ========== -->
181
182<A NAME="method_detail"><!-- --></A>
183<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
184<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
185<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
186<B>Method Detail</B></FONT></TH>
187</TR>
188</TABLE>
189
190<A NAME="gotoURL(java.lang.String, boolean, int)"><!-- --></A><H3>
191gotoURL</H3>
192<PRE>
193void <B>gotoURL</B>(java.lang.String&nbsp;url,
194             boolean&nbsp;addToHistory,
195             int&nbsp;scrollPos)</PRE>
196<DL>
197<DD><DL>
198<DT><B>Parameters:</B><DD><CODE>url</CODE> - <DD><CODE>addToHistory</CODE> - <DD><CODE>scrollPos</CODE> - desired vertical scrollbar position after we go there</DL>
199</DD>
200</DL>
201<HR>
202
203<A NAME="getBaseURL()"><!-- --></A><H3>
204getBaseURL</H3>
205<PRE>
206java.lang.String <B>getBaseURL</B>()</PRE>
207<DL>
208<DD><DL>
209</DL>
210</DD>
211</DL>
212<HR>
213
214<A NAME="addPropertyChangeListener(java.beans.PropertyChangeListener)"><!-- --></A><H3>
215addPropertyChangeListener</H3>
216<PRE>
217void <B>addPropertyChangeListener</B>(java.beans.PropertyChangeListener&nbsp;l)</PRE>
218<DL>
219<DD><DL>
220</DL>
221</DD>
222</DL>
223<HR>
224
225<A NAME="dispose()"><!-- --></A><H3>
226dispose</H3>
227<PRE>
228void <B>dispose</B>()</PRE>
229<DL>
230<DD>Called when the helpviewer is closed
231<P>
232<DD><DL>
233</DL>
234</DD>
235</DL>
236<HR>
237
238<A NAME="getComponent()"><!-- --></A><H3>
239getComponent</H3>
240<PRE>
241java.awt.Component <B>getComponent</B>()</PRE>
242<DL>
243<DD><DL>
244
245<DT><B>Returns:</B><DD>the root pane of this help viewer</DL>
246</DD>
247</DL>
248<HR>
249
250<A NAME="getShortURL()"><!-- --></A><H3>
251getShortURL</H3>
252<PRE>
253java.lang.String <B>getShortURL</B>()</PRE>
254<DL>
255<DD><DL>
256</DL>
257</DD>
258</DL>
259<HR>
260
261<A NAME="queueTOCReload()"><!-- --></A><H3>
262queueTOCReload</H3>
263<PRE>
264void <B>queueTOCReload</B>()</PRE>
265<DL>
266<DD><DL>
267</DL>
268</DD>
269</DL>
270<HR>
271
272<A NAME="setTitle(java.lang.String)"><!-- --></A><H3>
273setTitle</H3>
274<PRE>
275void <B>setTitle</B>(java.lang.String&nbsp;newTitle)</PRE>
276<DL>
277<DD><DL>
278</DL>
279</DD>
280</DL>
281<!-- ========= END OF CLASS DATA ========= -->
282<HR>
283
284
285<!-- ======= START OF BOTTOM NAVBAR ====== -->
286<A NAME="navbar_bottom"><!-- --></A>
287<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
288<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
289<TR>
290<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
291<A NAME="navbar_bottom_firstrow"><!-- --></A>
292<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
293  <TR ALIGN="center" VALIGN="top">
294  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
295  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
296  <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
297  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/HelpViewerInterface.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
298  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
299  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
300  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
301  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
302  </TR>
303</TABLE>
304</TD>
305<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
306</EM>
307</TD>
308</TR>
309
310<TR>
311<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
312&nbsp;<A HREF="../../../../../org/gjt/sp/jedit/help/HelpViewer.html" title="class in org.gjt.sp.jedit.help"><B>PREV CLASS</B></A>&nbsp;
313&nbsp;<A HREF="../../../../../org/gjt/sp/jedit/help/HistoryButton.html" title="class in org.gjt.sp.jedit.help"><B>NEXT CLASS</B></A></FONT></TD>
314<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
315  <A HREF="../../../../../index.html?org/gjt/sp/jedit/help/HelpViewerInterface.html" target="_top"><B>FRAMES</B></A>  &nbsp;
316&nbsp;<A HREF="HelpViewerInterface.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
317&nbsp;
318<NOSCRIPT>
319  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
320</NOSCRIPT>
321
322
323</FONT></TD>
324</TR>
325<TR>
326<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
327  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
328<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
329DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
330</TR>
331</TABLE>
332<A NAME="skip-navbar_bottom"></A>
333<!-- ======== END OF BOTTOM NAVBAR ======= -->
334
335<HR>
336
337</BODY>
338</HTML>