/www/tags/NOV_07_2009/htdocs/api/org/gjt/sp/jedit/msg/DockableWindowUpdate.html
HTML | 393 lines | 334 code | 45 blank | 14 comment | 0 complexity | f31aad56cea7819ae92c7080ae26e585 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:14:03 GMT-08:00 2008 -->
6<TITLE>
7DockableWindowUpdate (jEdit API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.gjt.sp.jedit.msg.DockableWindowUpdate 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> </TD>
33 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
34 <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
35 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DockableWindowUpdate.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
36 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
37 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </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 <A HREF="../../../../../org/gjt/sp/jedit/msg/CaretChanging.html" title="class in org.gjt.sp.jedit.msg"><B>PREV CLASS</B></A>
51 <A HREF="../../../../../org/gjt/sp/jedit/msg/DynamicMenuChanged.html" title="class in org.gjt.sp.jedit.msg"><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/msg/DockableWindowUpdate.html" target="_top"><B>FRAMES</B></A>
54 <A HREF="DockableWindowUpdate.html" target="_top"><B>NO FRAMES</B></A>
55
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: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
66<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
67DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <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.msg</FONT>
78<BR>
79Class DockableWindowUpdate</H2>
80<PRE>
81java.lang.Object
82 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../org/gjt/sp/jedit/EBMessage.html" title="class in org.gjt.sp.jedit">org.gjt.sp.jedit.EBMessage</A>
83 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.gjt.sp.jedit.msg.DockableWindowUpdate</B>
84</PRE>
85<HR>
86<DL>
87<DT><PRE>public class <B>DockableWindowUpdate</B><DT>extends <A HREF="../../../../../org/gjt/sp/jedit/EBMessage.html" title="class in org.gjt.sp.jedit">EBMessage</A></DL>
88</PRE>
89
90<P>
91Message sent when dockable window state changes.
92<P>
93
94<P>
95<DL>
96<DT><B>Since:</B></DT>
97 <DD>jEdit 4.2pre1</DD>
98</DL>
99<HR>
100
101<P>
102<!-- =========== FIELD SUMMARY =========== -->
103
104<A NAME="field_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>Field 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>static java.lang.Object</CODE></FONT></TD>
113<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/msg/DockableWindowUpdate.html#ACTIVATED">ACTIVATED</A></B></CODE>
114
115<BR>
116 Dockable activated.</TD>
117</TR>
118<TR BGCOLOR="white" CLASS="TableRowColor">
119<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
120<CODE>static java.lang.Object</CODE></FONT></TD>
121<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/msg/DockableWindowUpdate.html#DEACTIVATED">DEACTIVATED</A></B></CODE>
122
123<BR>
124 Dockable deactivated.</TD>
125</TR>
126<TR BGCOLOR="white" CLASS="TableRowColor">
127<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
128<CODE>static java.lang.Object</CODE></FONT></TD>
129<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/msg/DockableWindowUpdate.html#PROPERTIES_CHANGED">PROPERTIES_CHANGED</A></B></CODE>
130
131<BR>
132 Properties changed.</TD>
133</TR>
134</TABLE>
135
136<!-- ======== CONSTRUCTOR SUMMARY ======== -->
137
138<A NAME="constructor_summary"><!-- --></A>
139<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
140<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
141<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
142<B>Constructor Summary</B></FONT></TH>
143</TR>
144<TR BGCOLOR="white" CLASS="TableRowColor">
145<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/msg/DockableWindowUpdate.html#DockableWindowUpdate(org.gjt.sp.jedit.gui.DockableWindowManager, java.lang.Object, java.lang.String)">DockableWindowUpdate</A></B>(<A HREF="../../../../../org/gjt/sp/jedit/gui/DockableWindowManager.html" title="class in org.gjt.sp.jedit.gui">DockableWindowManager</A> wm,
146 java.lang.Object what,
147 java.lang.String dockable)</CODE>
148
149<BR>
150 Creates a new dockable window update message.</TD>
151</TR>
152</TABLE>
153
154<!-- ========== METHOD SUMMARY =========== -->
155
156<A NAME="method_summary"><!-- --></A>
157<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
158<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
159<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
160<B>Method Summary</B></FONT></TH>
161</TR>
162<TR BGCOLOR="white" CLASS="TableRowColor">
163<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
164<CODE> java.lang.String</CODE></FONT></TD>
165<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/msg/DockableWindowUpdate.html#getDockable()">getDockable</A></B>()</CODE>
166
167<BR>
168 Returns the dockable in question, or null if the message type is
169 <code>PROPERTIES_CHANGED</code>.</TD>
170</TR>
171<TR BGCOLOR="white" CLASS="TableRowColor">
172<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
173<CODE> java.lang.Object</CODE></FONT></TD>
174<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/msg/DockableWindowUpdate.html#getWhat()">getWhat</A></B>()</CODE>
175
176<BR>
177 Returns what caused this dockable update.</TD>
178</TR>
179<TR BGCOLOR="white" CLASS="TableRowColor">
180<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
181<CODE> java.lang.String</CODE></FONT></TD>
182<TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/msg/DockableWindowUpdate.html#paramString()">paramString</A></B>()</CODE>
183
184<BR>
185 Returns a string representation of this message's parameters.</TD>
186</TR>
187</TABLE>
188 <A NAME="methods_inherited_from_class_org.gjt.sp.jedit.EBMessage"><!-- --></A>
189<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
190<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
191<TH ALIGN="left"><B>Methods inherited from class org.gjt.sp.jedit.<A HREF="../../../../../org/gjt/sp/jedit/EBMessage.html" title="class in org.gjt.sp.jedit">EBMessage</A></B></TH>
192</TR>
193<TR BGCOLOR="white" CLASS="TableRowColor">
194<TD><CODE><A HREF="../../../../../org/gjt/sp/jedit/EBMessage.html#getSource()">getSource</A>, <A HREF="../../../../../org/gjt/sp/jedit/EBMessage.html#toString()">toString</A></CODE></TD>
195</TR>
196</TABLE>
197 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
198<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
199<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
200<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
201</TR>
202<TR BGCOLOR="white" CLASS="TableRowColor">
203<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
204</TR>
205</TABLE>
206
207<P>
208
209<!-- ============ FIELD DETAIL =========== -->
210
211<A NAME="field_detail"><!-- --></A>
212<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
213<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
214<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
215<B>Field Detail</B></FONT></TH>
216</TR>
217</TABLE>
218
219<A NAME="PROPERTIES_CHANGED"><!-- --></A><H3>
220PROPERTIES_CHANGED</H3>
221<PRE>
222public static final java.lang.Object <B>PROPERTIES_CHANGED</B></PRE>
223<DL>
224<DD>Properties changed. Fired instead of global
225 <code>PropertiesChanged</code> for improved performance.
226<P>
227<DL>
228<DT><B>Since:</B></DT>
229 <DD>jEdit 4.2pre1</DD>
230</DL>
231</DL>
232<HR>
233
234<A NAME="ACTIVATED"><!-- --></A><H3>
235ACTIVATED</H3>
236<PRE>
237public static final java.lang.Object <B>ACTIVATED</B></PRE>
238<DL>
239<DD>Dockable activated. This is sent when the dockable is made visible.
240<P>
241<DL>
242<DT><B>Since:</B></DT>
243 <DD>jEdit 4.2pre1</DD>
244</DL>
245</DL>
246<HR>
247
248<A NAME="DEACTIVATED"><!-- --></A><H3>
249DEACTIVATED</H3>
250<PRE>
251public static final java.lang.Object <B>DEACTIVATED</B></PRE>
252<DL>
253<DD>Dockable deactivated. This is sent when the dockable is hidden.
254<P>
255<DL>
256<DT><B>Since:</B></DT>
257 <DD>jEdit 4.2pre1</DD>
258</DL>
259</DL>
260
261<!-- ========= CONSTRUCTOR DETAIL ======== -->
262
263<A NAME="constructor_detail"><!-- --></A>
264<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
265<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
266<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
267<B>Constructor Detail</B></FONT></TH>
268</TR>
269</TABLE>
270
271<A NAME="DockableWindowUpdate(org.gjt.sp.jedit.gui.DockableWindowManager, java.lang.Object, java.lang.String)"><!-- --></A><H3>
272DockableWindowUpdate</H3>
273<PRE>
274public <B>DockableWindowUpdate</B>(<A HREF="../../../../../org/gjt/sp/jedit/gui/DockableWindowManager.html" title="class in org.gjt.sp.jedit.gui">DockableWindowManager</A> wm,
275 java.lang.Object what,
276 java.lang.String dockable)</PRE>
277<DL>
278<DD>Creates a new dockable window update message.
279<P>
280<DL>
281<DT><B>Parameters:</B><DD><CODE>wm</CODE> - The dockable window manager<DD><CODE>what</CODE> - What happened<DD><CODE>dockable</CODE> - The dockable window in question</DL>
282</DL>
283
284<!-- ============ METHOD DETAIL ========== -->
285
286<A NAME="method_detail"><!-- --></A>
287<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
288<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
289<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
290<B>Method Detail</B></FONT></TH>
291</TR>
292</TABLE>
293
294<A NAME="getWhat()"><!-- --></A><H3>
295getWhat</H3>
296<PRE>
297public java.lang.Object <B>getWhat</B>()</PRE>
298<DL>
299<DD>Returns what caused this dockable update.
300<P>
301<DD><DL>
302</DL>
303</DD>
304</DL>
305<HR>
306
307<A NAME="getDockable()"><!-- --></A><H3>
308getDockable</H3>
309<PRE>
310public java.lang.String <B>getDockable</B>()</PRE>
311<DL>
312<DD>Returns the dockable in question, or null if the message type is
313 <code>PROPERTIES_CHANGED</code>.
314<P>
315<DD><DL>
316</DL>
317</DD>
318</DL>
319<HR>
320
321<A NAME="paramString()"><!-- --></A><H3>
322paramString</H3>
323<PRE>
324public java.lang.String <B>paramString</B>()</PRE>
325<DL>
326<DD><B>Description copied from class: <CODE><A HREF="../../../../../org/gjt/sp/jedit/EBMessage.html#paramString()">EBMessage</A></CODE></B></DD>
327<DD>Returns a string representation of this message's parameters.
328<P>
329<DD><DL>
330<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/gjt/sp/jedit/EBMessage.html#paramString()">paramString</A></CODE> in class <CODE><A HREF="../../../../../org/gjt/sp/jedit/EBMessage.html" title="class in org.gjt.sp.jedit">EBMessage</A></CODE></DL>
331</DD>
332<DD><DL>
333</DL>
334</DD>
335</DL>
336<!-- ========= END OF CLASS DATA ========= -->
337<HR>
338
339
340<!-- ======= START OF BOTTOM NAVBAR ====== -->
341<A NAME="navbar_bottom"><!-- --></A>
342<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
343<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
344<TR>
345<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
346<A NAME="navbar_bottom_firstrow"><!-- --></A>
347<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
348 <TR ALIGN="center" VALIGN="top">
349 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
350 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
351 <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
352 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DockableWindowUpdate.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
353 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
354 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
355 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
356 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
357 </TR>
358</TABLE>
359</TD>
360<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
361</EM>
362</TD>
363</TR>
364
365<TR>
366<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
367 <A HREF="../../../../../org/gjt/sp/jedit/msg/CaretChanging.html" title="class in org.gjt.sp.jedit.msg"><B>PREV CLASS</B></A>
368 <A HREF="../../../../../org/gjt/sp/jedit/msg/DynamicMenuChanged.html" title="class in org.gjt.sp.jedit.msg"><B>NEXT CLASS</B></A></FONT></TD>
369<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
370 <A HREF="../../../../../index.html?org/gjt/sp/jedit/msg/DockableWindowUpdate.html" target="_top"><B>FRAMES</B></A>
371 <A HREF="DockableWindowUpdate.html" target="_top"><B>NO FRAMES</B></A>
372
373<NOSCRIPT>
374 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
375</NOSCRIPT>
376
377
378</FONT></TD>
379</TR>
380<TR>
381<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
382 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
383<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
384DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
385</TR>
386</TABLE>
387<A NAME="skip-navbar_bottom"></A>
388<!-- ======== END OF BOTTOM NAVBAR ======= -->
389
390<HR>
391
392</BODY>
393</HTML>