source: other-projects/trunk/gs3-webservices-democlient/docs/GS3DemoClient/org/greenstone/gs3client/QueryForm.html@ 15222

Last change on this file since 15222 was 15222, checked in by ak19, 16 years ago

Greenstone3 web services demo-clientadded to GS3's other-projects
File size: 32.3 KB
Line 
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_10) on Sun Apr 27 20:47:18 NZST 2008 -->
6<TITLE>
7QueryForm
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.greenstone.gs3client.QueryForm class">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17 parent.document.title="QueryForm";
18}
19</SCRIPT>
20<NOSCRIPT>
21</NOSCRIPT>
22
23</HEAD>
24
25<BODY BGCOLOR="white" onload="windowTitle();">
26
27
28<!-- ========= START OF TOP NAVBAR ======= -->
29<A NAME="navbar_top"><!-- --></A>
30<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
31<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
32<TR>
33<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
34<A NAME="navbar_top_firstrow"><!-- --></A>
35<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
36 <TR ALIGN="center" VALIGN="top">
37 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
39 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
44 </TR>
45</TABLE>
46</TD>
47<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
48</EM>
49</TD>
50</TR>
51
52<TR>
53<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
54&nbsp;<A HREF="../../../org/greenstone/gs3client/GS3JavaClient.PasswordAuthenticator.html" title="class in org.greenstone.gs3client"><B>PREV CLASS</B></A>&nbsp;
55&nbsp;<A HREF="../../../org/greenstone/gs3client/QueryFormControl.html" title="class in org.greenstone.gs3client"><B>NEXT CLASS</B></A></FONT></TD>
56<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
57 <A HREF="../../../index.html?org/greenstone/gs3client/QueryForm.html" target="_top"><B>FRAMES</B></A> &nbsp;
58&nbsp;<A HREF="QueryForm.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
59&nbsp;<SCRIPT type="text/javascript">
60 <!--
61 if(window==top) {
62 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
63 }
64 //-->
65</SCRIPT>
66<NOSCRIPT>
67 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
68</NOSCRIPT>
69
70
71</FONT></TD>
72</TR>
73<TR>
74<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
75 SUMMARY:&nbsp;<A HREF="#nested_classes_inherited_from_class_javax.swing.JPanel">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
76<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
77DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
78</TR>
79</TABLE>
80<A NAME="skip-navbar_top"></A>
81<!-- ========= END OF TOP NAVBAR ========= -->
82
83<HR>
84<!-- ======== START OF CLASS DATA ======== -->
85<H2>
86<FONT SIZE="-1">
87org.greenstone.gs3client</FONT>
88<BR>
89Class QueryForm</H2>
90<PRE>
91java.lang.Object
92 <IMG SRC="../../../resources/inherit.gif" ALT="extended by ">java.awt.Component
93 <IMG SRC="../../../resources/inherit.gif" ALT="extended by ">java.awt.Container
94 <IMG SRC="../../../resources/inherit.gif" ALT="extended by ">javax.swing.JComponent
95 <IMG SRC="../../../resources/inherit.gif" ALT="extended by ">javax.swing.JPanel
96 <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>org.greenstone.gs3client.QueryForm</B>
97</PRE>
98<DL>
99<DT><B>All Implemented Interfaces:</B> <DD>java.awt.event.ActionListener, java.awt.event.KeyListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, <A HREF="../../../org/greenstone/gs3client/ColourCombo.ColourChangeable.html" title="interface in org.greenstone.gs3client">ColourCombo.ColourChangeable</A></DD>
100</DL>
101<HR>
102<DL>
103<DT><PRE>public class <B>QueryForm</B><DT>extends javax.swing.JPanel<DT>implements java.awt.event.ActionListener, java.awt.event.KeyListener, <A HREF="../../../org/greenstone/gs3client/ColourCombo.ColourChangeable.html" title="interface in org.greenstone.gs3client">ColourCombo.ColourChangeable</A></DL>
104</PRE>
105
106<P>
107Panel that represents a Query Form based on GS3 describe response XML
108 messages sent by a Query Service. An inner panel will contain all the
109 actual form controls. The form can be reset to empty which will clear
110 its contents. Its contents can be reset to display controls appropriate
111 to new Query Service describe response XML messages.
112<P>
113
114<P>
115<DL>
116<DT><B>Author:</B></DT>
117 <DD>ak19</DD>
118<DT><B>See Also:</B><DD><A HREF="../../../serialized-form.html#org.greenstone.gs3client.QueryForm">Serialized Form</A></DL>
119<HR>
120
121<P>
122<!-- ======== NESTED CLASS SUMMARY ======== -->
123
124<A NAME="nested_class_summary"><!-- --></A>
125<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
126<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
127<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
128<B>Nested Class Summary</B></FONT></TH>
129</TR>
130</TABLE>
131&nbsp;<A NAME="nested_classes_inherited_from_class_javax.swing.JPanel"><!-- --></A>
132<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
133<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
134<TH ALIGN="left"><B>Nested classes/interfaces inherited from class javax.swing.JPanel</B></TH>
135</TR>
136<TR BGCOLOR="white" CLASS="TableRowColor">
137<TD><CODE>javax.swing.JPanel.AccessibleJPanel</CODE></TD>
138</TR>
139</TABLE>
140&nbsp;
141<A NAME="nested_classes_inherited_from_class_javax.swing.JComponent"><!-- --></A>
142<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
143<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
144<TH ALIGN="left"><B>Nested classes/interfaces inherited from class javax.swing.JComponent</B></TH>
145</TR>
146<TR BGCOLOR="white" CLASS="TableRowColor">
147<TD><CODE>javax.swing.JComponent.AccessibleJComponent</CODE></TD>
148</TR>
149</TABLE>
150&nbsp;
151<A NAME="nested_classes_inherited_from_class_java.awt.Container"><!-- --></A>
152<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
153<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
154<TH ALIGN="left"><B>Nested classes/interfaces inherited from class java.awt.Container</B></TH>
155</TR>
156<TR BGCOLOR="white" CLASS="TableRowColor">
157<TD><CODE>java.awt.Container.AccessibleAWTContainer</CODE></TD>
158</TR>
159</TABLE>
160&nbsp;
161<A NAME="nested_classes_inherited_from_class_java.awt.Component"><!-- --></A>
162<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
163<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
164<TH ALIGN="left"><B>Nested classes/interfaces inherited from class java.awt.Component</B></TH>
165</TR>
166<TR BGCOLOR="white" CLASS="TableRowColor">
167<TD><CODE>java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy</CODE></TD>
168</TR>
169</TABLE>
170&nbsp;
171<!-- =========== FIELD SUMMARY =========== -->
172
173<A NAME="field_summary"><!-- --></A>
174<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
175<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
176<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
177<B>Field Summary</B></FONT></TH>
178</TR>
179<TR BGCOLOR="white" CLASS="TableRowColor">
180<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
181<CODE>protected &nbsp;<A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html" title="class in org.greenstone.gs3client">GS3JavaClient</A></CODE></FONT></TD>
182<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/QueryForm.html#client">client</A></B></CODE>
183
184<BR>
185&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Handle to the running instance of the GS3JavaClient in order to have
186 access to its methods</TD>
187</TR>
188<TR BGCOLOR="white" CLASS="TableRowColor">
189<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
190<CODE>protected &nbsp;javax.swing.JPanel</CODE></FONT></TD>
191<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/QueryForm.html#paramsPanel">paramsPanel</A></B></CODE>
192
193<BR>
194&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Panel to contain all the form controls specific to the chosen Query
195 Service.</TD>
196</TR>
197<TR BGCOLOR="white" CLASS="TableRowColor">
198<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
199<CODE>protected &nbsp;<A HREF="../../../org/greenstone/gs3client/data/QueryFormData.html" title="class in org.greenstone.gs3client.data">QueryFormData</A>[]</CODE></FONT></TD>
200<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/QueryForm.html#paramTags">paramTags</A></B></CODE>
201
202<BR>
203&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Query parameters specified by the query services</TD>
204</TR>
205<TR BGCOLOR="white" CLASS="TableRowColor">
206<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
207<CODE>protected &nbsp;javax.swing.JButton</CODE></FONT></TD>
208<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/QueryForm.html#searchButton">searchButton</A></B></CODE>
209
210<BR>
211&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Search button that will cause the search to be executed when pressed</TD>
212</TR>
213</TABLE>
214&nbsp;<A NAME="fields_inherited_from_class_javax.swing.JComponent"><!-- --></A>
215<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
216<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
217<TH ALIGN="left"><B>Fields inherited from class javax.swing.JComponent</B></TH>
218</TR>
219<TR BGCOLOR="white" CLASS="TableRowColor">
220<TD><CODE>accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW</CODE></TD>
221</TR>
222</TABLE>
223&nbsp;<A NAME="fields_inherited_from_class_java.awt.Component"><!-- --></A>
224<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
225<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
226<TH ALIGN="left"><B>Fields inherited from class java.awt.Component</B></TH>
227</TR>
228<TR BGCOLOR="white" CLASS="TableRowColor">
229<TD><CODE>BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT</CODE></TD>
230</TR>
231</TABLE>
232&nbsp;<A NAME="fields_inherited_from_class_java.awt.image.ImageObserver"><!-- --></A>
233<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
234<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
235<TH ALIGN="left"><B>Fields inherited from interface java.awt.image.ImageObserver</B></TH>
236</TR>
237<TR BGCOLOR="white" CLASS="TableRowColor">
238<TD><CODE>ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH</CODE></TD>
239</TR>
240</TABLE>
241&nbsp;
242<!-- ======== CONSTRUCTOR SUMMARY ======== -->
243
244<A NAME="constructor_summary"><!-- --></A>
245<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
246<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
247<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
248<B>Constructor Summary</B></FONT></TH>
249</TR>
250<TR BGCOLOR="white" CLASS="TableRowColor">
251<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/QueryForm.html#QueryForm(org.greenstone.gs3client.GS3JavaClient)">QueryForm</A></B>(<A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html" title="class in org.greenstone.gs3client">GS3JavaClient</A>&nbsp;client)</CODE>
252
253<BR>
254&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor that instantiates this Form's internal GUI items.</TD>
255</TR>
256</TABLE>
257&nbsp;
258<!-- ========== METHOD SUMMARY =========== -->
259
260<A NAME="method_summary"><!-- --></A>
261<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
262<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
263<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
264<B>Method Summary</B></FONT></TH>
265</TR>
266<TR BGCOLOR="white" CLASS="TableRowColor">
267<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
268<CODE>&nbsp;void</CODE></FONT></TD>
269<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/QueryForm.html#actionPerformed(java.awt.event.ActionEvent)">actionPerformed</A></B>(java.awt.event.ActionEvent&nbsp;e)</CODE>
270
271<BR>
272&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called when this QueryForm's search button is pressed: the data
273 entered/controls settings specified by the user are passed to the
274 digital library's Query Service in order to perform the search.</TD>
275</TR>
276<TR BGCOLOR="white" CLASS="TableRowColor">
277<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
278<CODE>&nbsp;void</CODE></FONT></TD>
279<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/QueryForm.html#changeUIColour()">changeUIColour</A></B>()</CODE>
280
281<BR>
282&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Changes the colour of the query form and its controls to the
283 current colours set in class ColourCombo.</TD>
284</TR>
285<TR BGCOLOR="white" CLASS="TableRowColor">
286<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
287<CODE>&nbsp;void</CODE></FONT></TD>
288<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/QueryForm.html#clear()">clear</A></B>()</CODE>
289
290<BR>
291&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Call this method to empty all the form controls.</TD>
292</TR>
293<TR BGCOLOR="white" CLASS="TableRowColor">
294<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
295<CODE>&nbsp;void</CODE></FONT></TD>
296<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/QueryForm.html#formFromQueryServiceDescribe(org.w3c.dom.Element)">formFromQueryServiceDescribe</A></B>(org.w3c.dom.Element&nbsp;el)</CODE>
297
298<BR>
299&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets up the the query form for display (queryPanel) given the XML of
300 the response-message returned by a "describe" request sent to a
301 Query Service.</TD>
302</TR>
303<TR BGCOLOR="white" CLASS="TableRowColor">
304<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
305<CODE>&nbsp;void</CODE></FONT></TD>
306<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/QueryForm.html#keyPressed(java.awt.event.KeyEvent)">keyPressed</A></B>(java.awt.event.KeyEvent&nbsp;e)</CODE>
307
308<BR>
309&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Defined by KeyListener interface.</TD>
310</TR>
311<TR BGCOLOR="white" CLASS="TableRowColor">
312<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
313<CODE>&nbsp;void</CODE></FONT></TD>
314<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/QueryForm.html#keyReleased(java.awt.event.KeyEvent)">keyReleased</A></B>(java.awt.event.KeyEvent&nbsp;e)</CODE>
315
316<BR>
317&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called when the searchButton was in focus and a key was pressed.</TD>
318</TR>
319<TR BGCOLOR="white" CLASS="TableRowColor">
320<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
321<CODE>&nbsp;void</CODE></FONT></TD>
322<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/QueryForm.html#keyTyped(java.awt.event.KeyEvent)">keyTyped</A></B>(java.awt.event.KeyEvent&nbsp;e)</CODE>
323
324<BR>
325&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Defined by KeyListener interface.</TD>
326</TR>
327<TR BGCOLOR="white" CLASS="TableRowColor">
328<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
329<CODE>protected &nbsp;void</CODE></FONT></TD>
330<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/QueryForm.html#searchButtonPressed()">searchButtonPressed</A></B>()</CODE>
331
332<BR>
333&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called when the searchButton was clicked or when it was in focus
334 and the enter key was pressed.</TD>
335</TR>
336</TABLE>
337&nbsp;<A NAME="methods_inherited_from_class_javax.swing.JPanel"><!-- --></A>
338<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
339<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
340<TH ALIGN="left"><B>Methods inherited from class javax.swing.JPanel</B></TH>
341</TR>
342<TR BGCOLOR="white" CLASS="TableRowColor">
343<TD><CODE>getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI</CODE></TD>
344</TR>
345</TABLE>
346&nbsp;<A NAME="methods_inherited_from_class_javax.swing.JComponent"><!-- --></A>
347<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
348<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
349<TH ALIGN="left"><B>Methods inherited from class javax.swing.JComponent</B></TH>
350</TR>
351<TR BGCOLOR="white" CLASS="TableRowColor">
352<TD><CODE>addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update</CODE></TD>
353</TR>
354</TABLE>
355&nbsp;<A NAME="methods_inherited_from_class_java.awt.Container"><!-- --></A>
356<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
357<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
358<TH ALIGN="left"><B>Methods inherited from class java.awt.Container</B></TH>
359</TR>
360<TR BGCOLOR="white" CLASS="TableRowColor">
361<TD><CODE>add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree</CODE></TD>
362</TR>
363</TABLE>
364&nbsp;<A NAME="methods_inherited_from_class_java.awt.Component"><!-- --></A>
365<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
366<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
367<TH ALIGN="left"><B>Methods inherited from class java.awt.Component</B></TH>
368</TR>
369<TR BGCOLOR="white" CLASS="TableRowColor">
370<TD><CODE>action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle</CODE></TD>
371</TR>
372</TABLE>
373&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
374<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
375<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
376<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
377</TR>
378<TR BGCOLOR="white" CLASS="TableRowColor">
379<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
380</TR>
381</TABLE>
382&nbsp;
383<P>
384
385<!-- ============ FIELD DETAIL =========== -->
386
387<A NAME="field_detail"><!-- --></A>
388<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
389<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
390<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
391<B>Field Detail</B></FONT></TH>
392</TR>
393</TABLE>
394
395<A NAME="client"><!-- --></A><H3>
396client</H3>
397<PRE>
398protected <A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html" title="class in org.greenstone.gs3client">GS3JavaClient</A> <B>client</B></PRE>
399<DL>
400<DD>Handle to the running instance of the GS3JavaClient in order to have
401 access to its methods
402<P>
403<DL>
404</DL>
405</DL>
406<HR>
407
408<A NAME="paramsPanel"><!-- --></A><H3>
409paramsPanel</H3>
410<PRE>
411protected javax.swing.JPanel <B>paramsPanel</B></PRE>
412<DL>
413<DD>Panel to contain all the form controls specific to the chosen Query
414 Service.
415<P>
416<DL>
417</DL>
418</DL>
419<HR>
420
421<A NAME="searchButton"><!-- --></A><H3>
422searchButton</H3>
423<PRE>
424protected javax.swing.JButton <B>searchButton</B></PRE>
425<DL>
426<DD>Search button that will cause the search to be executed when pressed
427<P>
428<DL>
429</DL>
430</DL>
431<HR>
432
433<A NAME="paramTags"><!-- --></A><H3>
434paramTags</H3>
435<PRE>
436protected <A HREF="../../../org/greenstone/gs3client/data/QueryFormData.html" title="class in org.greenstone.gs3client.data">QueryFormData</A>[] <B>paramTags</B></PRE>
437<DL>
438<DD>Query parameters specified by the query services
439<P>
440<DL>
441</DL>
442</DL>
443
444<!-- ========= CONSTRUCTOR DETAIL ======== -->
445
446<A NAME="constructor_detail"><!-- --></A>
447<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
448<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
449<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
450<B>Constructor Detail</B></FONT></TH>
451</TR>
452</TABLE>
453
454<A NAME="QueryForm(org.greenstone.gs3client.GS3JavaClient)"><!-- --></A><H3>
455QueryForm</H3>
456<PRE>
457public <B>QueryForm</B>(<A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html" title="class in org.greenstone.gs3client">GS3JavaClient</A>&nbsp;client)</PRE>
458<DL>
459<DD>Constructor that instantiates this Form's internal GUI items.
460<P>
461<DL>
462<DT><B>Parameters:</B><DD><CODE>client</CODE> - - handle to the running instance of the GS3JavaClient</DL>
463</DL>
464
465<!-- ============ METHOD DETAIL ========== -->
466
467<A NAME="method_detail"><!-- --></A>
468<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
469<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
470<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
471<B>Method Detail</B></FONT></TH>
472</TR>
473</TABLE>
474
475<A NAME="clear()"><!-- --></A><H3>
476clear</H3>
477<PRE>
478public void <B>clear</B>()</PRE>
479<DL>
480<DD>Call this method to empty all the form controls. This Query Form
481 component can then be reused.
482<P>
483<DD><DL>
484</DL>
485</DD>
486<DD><DL>
487</DL>
488</DD>
489</DL>
490<HR>
491
492<A NAME="changeUIColour()"><!-- --></A><H3>
493changeUIColour</H3>
494<PRE>
495public void <B>changeUIColour</B>()</PRE>
496<DL>
497<DD>Changes the colour of the query form and its controls to the
498 current colours set in class ColourCombo. Specified by
499 the ColourCombo.ColourChangeable interface.
500<P>
501<DD><DL>
502<DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/greenstone/gs3client/ColourCombo.ColourChangeable.html#changeUIColour()">changeUIColour</A></CODE> in interface <CODE><A HREF="../../../org/greenstone/gs3client/ColourCombo.ColourChangeable.html" title="interface in org.greenstone.gs3client">ColourCombo.ColourChangeable</A></CODE></DL>
503</DD>
504<DD><DL>
505</DL>
506</DD>
507</DL>
508<HR>
509
510<A NAME="actionPerformed(java.awt.event.ActionEvent)"><!-- --></A><H3>
511actionPerformed</H3>
512<PRE>
513public void <B>actionPerformed</B>(java.awt.event.ActionEvent&nbsp;e)</PRE>
514<DL>
515<DD>Called when this QueryForm's search button is pressed: the data
516 entered/controls settings specified by the user are passed to the
517 digital library's Query Service in order to perform the search.
518<P>
519<DD><DL>
520<DT><B>Specified by:</B><DD><CODE>actionPerformed</CODE> in interface <CODE>java.awt.event.ActionListener</CODE></DL>
521</DD>
522<DD><DL>
523</DL>
524</DD>
525</DL>
526<HR>
527
528<A NAME="keyPressed(java.awt.event.KeyEvent)"><!-- --></A><H3>
529keyPressed</H3>
530<PRE>
531public void <B>keyPressed</B>(java.awt.event.KeyEvent&nbsp;e)</PRE>
532<DL>
533<DD>Defined by KeyListener interface. Does nothing.
534<P>
535<DD><DL>
536<DT><B>Specified by:</B><DD><CODE>keyPressed</CODE> in interface <CODE>java.awt.event.KeyListener</CODE></DL>
537</DD>
538<DD><DL>
539</DL>
540</DD>
541</DL>
542<HR>
543
544<A NAME="keyTyped(java.awt.event.KeyEvent)"><!-- --></A><H3>
545keyTyped</H3>
546<PRE>
547public void <B>keyTyped</B>(java.awt.event.KeyEvent&nbsp;e)</PRE>
548<DL>
549<DD>Defined by KeyListener interface. Does nothing.
550<P>
551<DD><DL>
552<DT><B>Specified by:</B><DD><CODE>keyTyped</CODE> in interface <CODE>java.awt.event.KeyListener</CODE></DL>
553</DD>
554<DD><DL>
555</DL>
556</DD>
557</DL>
558<HR>
559
560<A NAME="keyReleased(java.awt.event.KeyEvent)"><!-- --></A><H3>
561keyReleased</H3>
562<PRE>
563public void <B>keyReleased</B>(java.awt.event.KeyEvent&nbsp;e)</PRE>
564<DL>
565<DD>Called when the searchButton was in focus and a key was pressed. If
566 this key was the Enter button, then the search is performed: the data
567 entered/controls settings specified by the user are passed to the
568 digital library's Query Service in order to perform the search.
569<P>
570<DD><DL>
571<DT><B>Specified by:</B><DD><CODE>keyReleased</CODE> in interface <CODE>java.awt.event.KeyListener</CODE></DL>
572</DD>
573<DD><DL>
574</DL>
575</DD>
576</DL>
577<HR>
578
579<A NAME="searchButtonPressed()"><!-- --></A><H3>
580searchButtonPressed</H3>
581<PRE>
582protected void <B>searchButtonPressed</B>()</PRE>
583<DL>
584<DD>Called when the searchButton was clicked or when it was in focus
585 and the enter key was pressed. The search is performed by passing the
586 data entered/controls settings specified by the user to the digital
587 library's Query Service in order to perform the search.
588<P>
589<DD><DL>
590</DL>
591</DD>
592<DD><DL>
593</DL>
594</DD>
595</DL>
596<HR>
597
598<A NAME="formFromQueryServiceDescribe(org.w3c.dom.Element)"><!-- --></A><H3>
599formFromQueryServiceDescribe</H3>
600<PRE>
601public void <B>formFromQueryServiceDescribe</B>(org.w3c.dom.Element&nbsp;el)</PRE>
602<DL>
603<DD>Sets up the the query form for display (queryPanel) given the XML of
604 the response-message returned by a "describe" request sent to a
605 Query Service. That is, generates the query form as specified
606 by the given response XML for a Query describe.
607<P>
608<DD><DL>
609</DL>
610</DD>
611<DD><DL>
612<DT><B>Parameters:</B><DD><CODE>el</CODE> - - a serviceResponseXML for a describe request that specifies
613 how the paramsPanel should look.</DL>
614</DD>
615</DL>
616<!-- ========= END OF CLASS DATA ========= -->
617<HR>
618
619
620<!-- ======= START OF BOTTOM NAVBAR ====== -->
621<A NAME="navbar_bottom"><!-- --></A>
622<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
623<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
624<TR>
625<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
626<A NAME="navbar_bottom_firstrow"><!-- --></A>
627<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
628 <TR ALIGN="center" VALIGN="top">
629 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
630 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
631 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
632 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
633 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
634 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
635 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
636 </TR>
637</TABLE>
638</TD>
639<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
640</EM>
641</TD>
642</TR>
643
644<TR>
645<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
646&nbsp;<A HREF="../../../org/greenstone/gs3client/GS3JavaClient.PasswordAuthenticator.html" title="class in org.greenstone.gs3client"><B>PREV CLASS</B></A>&nbsp;
647&nbsp;<A HREF="../../../org/greenstone/gs3client/QueryFormControl.html" title="class in org.greenstone.gs3client"><B>NEXT CLASS</B></A></FONT></TD>
648<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
649 <A HREF="../../../index.html?org/greenstone/gs3client/QueryForm.html" target="_top"><B>FRAMES</B></A> &nbsp;
650&nbsp;<A HREF="QueryForm.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
651&nbsp;<SCRIPT type="text/javascript">
652 <!--
653 if(window==top) {
654 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
655 }
656 //-->
657</SCRIPT>
658<NOSCRIPT>
659 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
660</NOSCRIPT>
661
662
663</FONT></TD>
664</TR>
665<TR>
666<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
667 SUMMARY:&nbsp;<A HREF="#nested_classes_inherited_from_class_javax.swing.JPanel">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
668<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
669DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
670</TR>
671</TABLE>
672<A NAME="skip-navbar_bottom"></A>
673<!-- ======== END OF BOTTOM NAVBAR ======= -->
674
675<HR>
676
677</BODY>
678</HTML>
Note: See TracBrowser for help on using the repository browser.