Context Navigation

← Previous Revision
Latest Revision
Next Revision →
Blame
Revision Log

source: other-projects/trunk/gs3-webservices-democlient/docs/GS3DemoClient/org/greenstone/gs3client/QueryFormControl.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: 26.9 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>
7	QueryFormControl
8	</TITLE>
9
10	<META NAME="keywords" CONTENT="org.greenstone.gs3client.QueryFormControl class">
11
12	<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
13
14	<SCRIPT type="text/javascript">
15	function windowTitle()
16	{
17	parent.document.title="QueryFormControl";
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> </TD>
38	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
39	<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
40	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
41	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
42	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
43	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </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	<A HREF="../../../org/greenstone/gs3client/QueryForm.html" title="class in org.greenstone.gs3client"><B>PREV CLASS</B></A>
55	<A HREF="../../../org/greenstone/gs3client/SearchResultsDisplay.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/QueryFormControl.html" target="_top"><B>FRAMES</B></A>
58	<A HREF="QueryFormControl.html" target="_top"><B>NO FRAMES</B></A>
59	<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: <A HREF="#nested_classes_inherited_from_class_org.greenstone.gs3client.data.QueryFormData">NESTED</A> \| <A HREF="#field_summary">FIELD</A> \| <A HREF="#constructor_summary">CONSTR</A> \| <A HREF="#method_summary">METHOD</A></FONT></TD>
76	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
77	DETAIL: <A HREF="#field_detail">FIELD</A> \| <A HREF="#constructor_detail">CONSTR</A> \| <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">
87	org.greenstone.gs3client</FONT>
88	<BR>
89	Class QueryFormControl</H2>
90	<PRE>
91	java.lang.Object
92	<IMG SRC="../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../org/greenstone/gs3client/data/QueryFormData.html" title="class in org.greenstone.gs3client.data">org.greenstone.gs3client.data.QueryFormData</A>
93	<IMG SRC="../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../org/greenstone/gs3client/data/QueryFormData.QueryFormParam.html" title="class in org.greenstone.gs3client.data">org.greenstone.gs3client.data.QueryFormData.QueryFormParam</A>
94	<IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>org.greenstone.gs3client.QueryFormControl</B>
95	</PRE>
96	<HR>
97	<DL>
98	<DT><PRE> class <B>QueryFormControl</B><DT>extends <A HREF="../../../org/greenstone/gs3client/data/QueryFormData.QueryFormParam.html" title="class in org.greenstone.gs3client.data">QueryFormData.QueryFormParam</A></DL>
99	</PRE>
100
101	<P>
102	Represents a control in a query form. This wrapper class is a subclass of
103	QueryFormParam that presents its QueryFormParam details as an appropriate
104	GUI item with label (based on the QueryFormParam's type) for display
105	in its own JPanel.
106	This wrapper class is a widget that knows to display this QueryFormParam --
107	and any child <param>s or <option>s -- in its own JPanel.
108	<P>
109
110	<P>
111	<DL>
112	<DT><B>Author:</B></DT>
113	<DD>ak19</DD>
114	</DL>
115	<HR>
116
117	<P>
118	<!-- ======== NESTED CLASS SUMMARY ======== -->
119
120	<A NAME="nested_class_summary"><!-- --></A>
121	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
122	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
123	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
124	<B>Nested Class Summary</B></FONT></TH>
125	</TR>
126	</TABLE>
127	<A NAME="nested_classes_inherited_from_class_org.greenstone.gs3client.data.QueryFormData"><!-- --></A>
128	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
129	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
130	<TH ALIGN="left"><B>Nested classes/interfaces inherited from class org.greenstone.gs3client.data.<A HREF="../../../org/greenstone/gs3client/data/QueryFormData.html" title="class in org.greenstone.gs3client.data">QueryFormData</A></B></TH>
131	</TR>
132	<TR BGCOLOR="white" CLASS="TableRowColor">
133	<TD><CODE><A HREF="../../../org/greenstone/gs3client/data/QueryFormData.QueryFormParam.html" title="class in org.greenstone.gs3client.data">QueryFormData.QueryFormParam</A></CODE></TD>
134	</TR>
135	</TABLE>
136
137	<!-- =========== FIELD SUMMARY =========== -->
138
139	<A NAME="field_summary"><!-- --></A>
140	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
141	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
142	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
143	<B>Field Summary</B></FONT></TH>
144	</TR>
145	<TR BGCOLOR="white" CLASS="TableRowColor">
146	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
147	<CODE>protected  javax.swing.JComponent</CODE></FONT></TD>
148	<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/QueryFormControl.html#ref">ref</A></B></CODE>
149
150	<BR>
151	the widget that's a visual representation of this QueryFormParam</TD>
152	</TR>
153	<TR BGCOLOR="white" CLASS="TableRowColor">
154	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
155	<CODE>(package private)  int</CODE></FONT></TD>
156	<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/QueryFormControl.html#width">width</A></B></CODE>
157
158	<BR>
159	</TD>
160	</TR>
161	</TABLE>
162	<A NAME="fields_inherited_from_class_org.greenstone.gs3client.data.QueryFormData.QueryFormParam"><!-- --></A>
163	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
164	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
165	<TH ALIGN="left"><B>Fields inherited from class org.greenstone.gs3client.data.<A HREF="../../../org/greenstone/gs3client/data/QueryFormData.QueryFormParam.html" title="class in org.greenstone.gs3client.data">QueryFormData.QueryFormParam</A></B></TH>
166	</TR>
167	<TR BGCOLOR="white" CLASS="TableRowColor">
168	<TD><CODE><A HREF="../../../org/greenstone/gs3client/data/QueryFormData.QueryFormParam.html#def">def</A>, <A HREF="../../../org/greenstone/gs3client/data/QueryFormData.QueryFormParam.html#ignore">ignore</A>, <A HREF="../../../org/greenstone/gs3client/data/QueryFormData.QueryFormParam.html#occurs">occurs</A>, <A HREF="../../../org/greenstone/gs3client/data/QueryFormData.QueryFormParam.html#subElements">subElements</A>, <A HREF="../../../org/greenstone/gs3client/data/QueryFormData.QueryFormParam.html#type">type</A></CODE></TD>
169	</TR>
170	</TABLE>
171	<A NAME="fields_inherited_from_class_org.greenstone.gs3client.data.QueryFormData"><!-- --></A>
172	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
173	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
174	<TH ALIGN="left"><B>Fields inherited from class org.greenstone.gs3client.data.<A HREF="../../../org/greenstone/gs3client/data/QueryFormData.html" title="class in org.greenstone.gs3client.data">QueryFormData</A></B></TH>
175	</TR>
176	<TR BGCOLOR="white" CLASS="TableRowColor">
177	<TD><CODE><A HREF="../../../org/greenstone/gs3client/data/QueryFormData.html#displayItem">displayItem</A>, <A HREF="../../../org/greenstone/gs3client/data/QueryFormData.html#name">name</A>, <A HREF="../../../org/greenstone/gs3client/data/QueryFormData.html#OCCURS_ATT">OCCURS_ATT</A></CODE></TD>
178	</TR>
179	</TABLE>
180
181	<!-- ======== CONSTRUCTOR SUMMARY ======== -->
182
183	<A NAME="constructor_summary"><!-- --></A>
184	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
185	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
186	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
187	<B>Constructor Summary</B></FONT></TH>
188	</TR>
189	<TR BGCOLOR="white" CLASS="TableRowColor">
190	<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/QueryFormControl.html#QueryFormControl(org.w3c.dom.Element)">QueryFormControl</A></B>(org.w3c.dom.Element param)</CODE>
191
192	<BR>
193	Constructor that creates a QueryFormControl for a <param> element</TD>
194	</TR>
195	<TR BGCOLOR="white" CLASS="TableRowColor">
196	<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/QueryFormControl.html#QueryFormControl(org.w3c.dom.Element, javax.swing.JPanel)">QueryFormControl</A></B>(org.w3c.dom.Element param,
197	javax.swing.JPanel parentPanel)</CODE>
198
199	<BR>
200	Constructor that creates a QueryFormControl for a <param> element
201	inside a panel.</TD>
202	</TR>
203	</TABLE>
204
205	<!-- ========== METHOD SUMMARY =========== -->
206
207	<A NAME="method_summary"><!-- --></A>
208	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
209	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
210	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
211	<B>Method Summary</B></FONT></TH>
212	</TR>
213	<TR BGCOLOR="white" CLASS="TableRowColor">
214	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
215	<CODE>protected  void</CODE></FONT></TD>
216	<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/QueryFormControl.html#addGridBagComponent(javax.swing.JPanel, javax.swing.JComponent, java.awt.GridBagLayout, java.awt.GridBagConstraints, int, int, int, int)">addGridBagComponent</A></B>(javax.swing.JPanel panel,
217	javax.swing.JComponent comp,
218	java.awt.GridBagLayout gbLayout,
219	java.awt.GridBagConstraints gbConstraints,
220	int col,
221	int row,
222	int w,
223	int h)</CODE>
224
225	<BR>
226	The multi-panel is laid out with a GridBagLayout in order to make
227	the layout more attractive (so that the form controls don't have as
228	odd sizes as before when GraphPaperLayout was used).</TD>
229	</TR>
230	<TR BGCOLOR="white" CLASS="TableRowColor">
231	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
232	<CODE> void</CODE></FONT></TD>
233	<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/QueryFormControl.html#createBooleanField()">createBooleanField</A></B>()</CODE>
234
235	<BR>
236	Creates check box controls for the <param> elements whose
237	types are GSXML.PARAM_TYPE_BOOLEAN.</TD>
238	</TR>
239	<TR BGCOLOR="white" CLASS="TableRowColor">
240	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
241	<CODE> void</CODE></FONT></TD>
242	<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/QueryFormControl.html#createEnumListing(org.w3c.dom.Element)">createEnumListing</A></B>(org.w3c.dom.Element param)</CODE>
243
244	<BR>
245	Creates combo boxes/drop-downs for the <param> elements
246	whose types are GSXML.PARAM_TYPE_ENUM_SINGLE and listboxes for those
247	whose types are GSXML.PARAM_TYPE_ENUM_MULTI.</TD>
248	</TR>
249	<TR BGCOLOR="white" CLASS="TableRowColor">
250	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
251	<CODE> void</CODE></FONT></TD>
252	<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/QueryFormControl.html#createMultiPanel(org.w3c.dom.Element, javax.swing.JPanel)">createMultiPanel</A></B>(org.w3c.dom.Element param,
253	javax.swing.JPanel parentPanel)</CODE>
254
255	<BR>
256	A multi-panel is created for a set of controls that occur more than
257	once.</TD>
258	</TR>
259	<TR BGCOLOR="white" CLASS="TableRowColor">
260	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
261	<CODE> void</CODE></FONT></TD>
262	<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/QueryFormControl.html#createTextField()">createTextField</A></B>()</CODE>
263
264	<BR>
265	Creates text fields for the <param> elements whose types are
266	GSXML.PARAM_TYPE_STRING or GSXML.PARAM_TYPE_INTEGER).</TD>
267	</TR>
268	<TR BGCOLOR="white" CLASS="TableRowColor">
269	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
270	<CODE> void</CODE></FONT></TD>
271	<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/QueryFormControl.html#createWidget(org.w3c.dom.Element)">createWidget</A></B>(org.w3c.dom.Element param)</CODE>
272
273	<BR>
274	Creates the appropriate form control for the <param> element,
275	based on its type.</TD>
276	</TR>
277	<TR BGCOLOR="white" CLASS="TableRowColor">
278	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
279	<CODE> void</CODE></FONT></TD>
280	<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/QueryFormControl.html#setSelectedValue(java.util.HashMap)">setSelectedValue</A></B>(java.util.HashMap nameValsMap)</CODE>
281
282	<BR>
283	If called after the form containing these param controls has been
284	displayed and the user has entered/selected values (i.e.</TD>
285	</TR>
286	</TABLE>
287	<A NAME="methods_inherited_from_class_org.greenstone.gs3client.data.QueryFormData.QueryFormParam"><!-- --></A>
288	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
289	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
290	<TH ALIGN="left"><B>Methods inherited from class org.greenstone.gs3client.data.<A HREF="../../../org/greenstone/gs3client/data/QueryFormData.QueryFormParam.html" title="class in org.greenstone.gs3client.data">QueryFormData.QueryFormParam</A></B></TH>
291	</TR>
292	<TR BGCOLOR="white" CLASS="TableRowColor">
293	<TD><CODE><A HREF="../../../org/greenstone/gs3client/data/QueryFormData.QueryFormParam.html#getSubElements()">getSubElements</A>, <A HREF="../../../org/greenstone/gs3client/data/QueryFormData.QueryFormParam.html#show()">show</A></CODE></TD>
294	</TR>
295	</TABLE>
296	<A NAME="methods_inherited_from_class_org.greenstone.gs3client.data.QueryFormData"><!-- --></A>
297	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
298	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
299	<TH ALIGN="left"><B>Methods inherited from class org.greenstone.gs3client.data.<A HREF="../../../org/greenstone/gs3client/data/QueryFormData.html" title="class in org.greenstone.gs3client.data">QueryFormData</A></B></TH>
300	</TR>
301	<TR BGCOLOR="white" CLASS="TableRowColor">
302	<TD><CODE><A HREF="../../../org/greenstone/gs3client/data/QueryFormData.html#extractDisplayItem(org.w3c.dom.Element)">extractDisplayItem</A>, <A HREF="../../../org/greenstone/gs3client/data/QueryFormData.html#toString()">toString</A></CODE></TD>
303	</TR>
304	</TABLE>
305	<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
306	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
307	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
308	<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
309	</TR>
310	<TR BGCOLOR="white" CLASS="TableRowColor">
311	<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
312	</TR>
313	</TABLE>
314
315	<P>
316
317	<!-- ============ FIELD DETAIL =========== -->
318
319	<A NAME="field_detail"><!-- --></A>
320	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
321	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
322	<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
323	<B>Field Detail</B></FONT></TH>
324	</TR>
325	</TABLE>
326
327	<A NAME="ref"><!-- --></A><H3>
328	ref</H3>
329	<PRE>
330	protected javax.swing.JComponent <B>ref</B></PRE>
331	<DL>
332	<DD>the widget that's a visual representation of this QueryFormParam
333	<P>
334	<DL>
335	</DL>
336	</DL>
337	<HR>
338
339	<A NAME="width"><!-- --></A><H3>
340	width</H3>
341	<PRE>
342	int <B>width</B></PRE>
343	<DL>
344	<DL>
345	</DL>
346	</DL>
347
348	<!-- ========= CONSTRUCTOR DETAIL ======== -->
349
350	<A NAME="constructor_detail"><!-- --></A>
351	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
352	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
353	<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
354	<B>Constructor Detail</B></FONT></TH>
355	</TR>
356	</TABLE>
357
358	<A NAME="QueryFormControl(org.w3c.dom.Element)"><!-- --></A><H3>
359	QueryFormControl</H3>
360	<PRE>
361	public <B>QueryFormControl</B>(org.w3c.dom.Element param)</PRE>
362	<DL>
363	<DD>Constructor that creates a QueryFormControl for a <param> element
364	<P>
365	<DL>
366	<DT><B>Parameters:</B><DD><CODE>param</CODE> - - a <param> element in a Query Service's describe
367	response XML message</DL>
368	</DL>
369	<HR>
370
371	<A NAME="QueryFormControl(org.w3c.dom.Element, javax.swing.JPanel)"><!-- --></A><H3>
372	QueryFormControl</H3>
373	<PRE>
374	public <B>QueryFormControl</B>(org.w3c.dom.Element param,
375	javax.swing.JPanel parentPanel)</PRE>
376	<DL>
377	<DD>Constructor that creates a QueryFormControl for a <param> element
378	inside a panel.
379	<P>
380	<DL>
381	<DT><B>Parameters:</B><DD><CODE>param</CODE> - - a <param> element in a Query Service's describe
382	response XML message<DD><CODE>parentPanel</CODE> - - the panel inside which this QueryFormControl is to
383	display itself.</DL>
384	</DL>
385
386	<!-- ============ METHOD DETAIL ========== -->
387
388	<A NAME="method_detail"><!-- --></A>
389	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
390	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
391	<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
392	<B>Method Detail</B></FONT></TH>
393	</TR>
394	</TABLE>
395
396	<A NAME="createWidget(org.w3c.dom.Element)"><!-- --></A><H3>
397	createWidget</H3>
398	<PRE>
399	public void <B>createWidget</B>(org.w3c.dom.Element param)</PRE>
400	<DL>
401	<DD>Creates the appropriate form control for the <param> element,
402	based on its type.
403	<P>
404	<DD><DL>
405	<DT><B>Parameters:</B><DD><CODE>param</CODE> - - a <param> element in a Query Service's describe
406	response XML message</DL>
407	</DD>
408	</DL>
409	<HR>
410
411	<A NAME="createBooleanField()"><!-- --></A><H3>
412	createBooleanField</H3>
413	<PRE>
414	public void <B>createBooleanField</B>()</PRE>
415	<DL>
416	<DD>Creates check box controls for the <param> elements whose
417	types are GSXML.PARAM_TYPE_BOOLEAN.
418	<P>
419	<DD><DL>
420	</DL>
421	</DD>
422	</DL>
423	<HR>
424
425	<A NAME="createTextField()"><!-- --></A><H3>
426	createTextField</H3>
427	<PRE>
428	public void <B>createTextField</B>()</PRE>
429	<DL>
430	<DD>Creates text fields for the <param> elements whose types are
431	GSXML.PARAM_TYPE_STRING or GSXML.PARAM_TYPE_INTEGER).
432	<P>
433	<DD><DL>
434	</DL>
435	</DD>
436	</DL>
437	<HR>
438
439	<A NAME="createEnumListing(org.w3c.dom.Element)"><!-- --></A><H3>
440	createEnumListing</H3>
441	<PRE>
442	public void <B>createEnumListing</B>(org.w3c.dom.Element param)</PRE>
443	<DL>
444	<DD>Creates combo boxes/drop-downs for the <param> elements
445	whose types are GSXML.PARAM_TYPE_ENUM_SINGLE and listboxes for those
446	whose types are GSXML.PARAM_TYPE_ENUM_MULTI.
447	<P>
448	<DD><DL>
449	<DT><B>Parameters:</B><DD><CODE>param</CODE> - - a <param> element in a Query Service's describe
450	response XML message</DL>
451	</DD>
452	</DL>
453	<HR>
454
455	<A NAME="createMultiPanel(org.w3c.dom.Element, javax.swing.JPanel)"><!-- --></A><H3>
456	createMultiPanel</H3>
457	<PRE>
458	public void <B>createMultiPanel</B>(org.w3c.dom.Element param,
459	javax.swing.JPanel parentPanel)</PRE>
460	<DL>
461	<DD>A multi-panel is created for a set of controls that occur more than
462	once.
463	Processes <param type="multi"> in a Query Service's describe
464	response XML. (I.e. the type is GSXML.PARAM_TYPE_MULTI)
465	Complicated case: can have 'occurs' field set. And this <param>
466	element can have multiple <param>s itself, each with the 'ignore'
467	possibly set and each with its own <option> elements.
468	<P>
469	<DD><DL>
470	<DT><B>Parameters:</B><DD><CODE>param</CODE> - - a <param> element in a Query Service's describe
471	response XML message<DD><CODE>parentPanel</CODE> - - the panel inside which the multipanel is to display
472	itself.</DL>
473	</DD>
474	</DL>
475	<HR>
476
477	<A NAME="addGridBagComponent(javax.swing.JPanel, javax.swing.JComponent, java.awt.GridBagLayout, java.awt.GridBagConstraints, int, int, int, int)"><!-- --></A><H3>
478	addGridBagComponent</H3>
479	<PRE>
480	protected void <B>addGridBagComponent</B>(javax.swing.JPanel panel,
481	javax.swing.JComponent comp,
482	java.awt.GridBagLayout gbLayout,
483	java.awt.GridBagConstraints gbConstraints,
484	int col,
485	int row,
486	int w,
487	int h)</PRE>
488	<DL>
489	<DD>The multi-panel is laid out with a GridBagLayout in order to make
490	the layout more attractive (so that the form controls don't have as
491	odd sizes as before when GraphPaperLayout was used).
492	This method sets the constraints for the given control and then adds
493	it to the given JPanel.
494	This method is called to add a control (or heading label) to the
495	multi-panel using GridBagLayout.
496	<P>
497	<DD><DL>
498	<DT><B>Parameters:</B><DD><CODE>panel</CODE> - is the panel to add the control (or heading label) to.<DD><CODE>comp</CODE> - is the Query Form control or heading JLabel to be laid out.<DD><CODE>gbLayout</CODE> - is the GridBagLayout object used to lay out the panel.<DD><CODE>gbConstraints</CODE> - is the GridBagConstraints object for the panel's
499	GridBagLayout.<DD><CODE>col</CODE> - is the column value of the top-left of the control (for
500	setting the GridBagLayout's gridx value).<DD><CODE>row</CODE> - is the row value of the top-left of the control (for
501	setting the GridBagLayout's gridy value).<DD><CODE>w</CODE> - is the number of columns spanned by the control (for setting
502	the GridBagLayout's gridwidth value).<DD><CODE>h</CODE> - is the number of rows spanned by the control (for setting
503	the GridBagLayout's gridheight value).</DL>
504	</DD>
505	</DL>
506	<HR>
507
508	<A NAME="setSelectedValue(java.util.HashMap)"><!-- --></A><H3>
509	setSelectedValue</H3>
510	<PRE>
511	public void <B>setSelectedValue</B>(java.util.HashMap nameValsMap)</PRE>
512	<DL>
513	<DD>If called after the form containing these param controls has been
514	displayed and the user has entered/selected values (i.e. after the search
515	button to execute a query has been pressed), then this method puts
516	the controls' associated QueryFormParam names and the user-
517	entered/-selected values into the HashMap nameValsmap (= the argument).
518	Note that for the GSXML.PARAM_TYPE_MULTI case - where each related set
519	of controls may occur several times (depending on member variable
520	'occurs') - the value entered/selected for each control that has the
521	same name (= key into the HashMap) is added into the HashMap as
522	a comma-separated list associated with its name-key.
523	This method requires that argument nameValsmap is a non-null HashMap.
524	<P>
525	<DD><DL>
526	<DT><B>Parameters:</B><DD><CODE>nameValsMap</CODE> - - a non-null HashMap. At the end of this method,
527	the nameValsMap HashMap will contain mappings from query parameter field
528	names to their user-entered values (for the field's associated
529	form controls).</DL>
530	</DD>
531	</DL>
532	<!-- ========= END OF CLASS DATA ========= -->
533	<HR>
534
535
536	<!-- ======= START OF BOTTOM NAVBAR ====== -->
537	<A NAME="navbar_bottom"><!-- --></A>
538	<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
539	<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
540	<TR>
541	<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
542	<A NAME="navbar_bottom_firstrow"><!-- --></A>
543	<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
544	<TR ALIGN="center" VALIGN="top">
545	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
546	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
547	<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
548	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
549	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
550	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
551	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
552	</TR>
553	</TABLE>
554	</TD>
555	<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
556	</EM>
557	</TD>
558	</TR>
559
560	<TR>
561	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
562	<A HREF="../../../org/greenstone/gs3client/QueryForm.html" title="class in org.greenstone.gs3client"><B>PREV CLASS</B></A>
563	<A HREF="../../../org/greenstone/gs3client/SearchResultsDisplay.html" title="class in org.greenstone.gs3client"><B>NEXT CLASS</B></A></FONT></TD>
564	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
565	<A HREF="../../../index.html?org/greenstone/gs3client/QueryFormControl.html" target="_top"><B>FRAMES</B></A>
566	<A HREF="QueryFormControl.html" target="_top"><B>NO FRAMES</B></A>
567	<SCRIPT type="text/javascript">
568	<!--
569	if(window==top) {
570	document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
571	}
572	//-->
573	</SCRIPT>
574	<NOSCRIPT>
575	<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
576	</NOSCRIPT>
577
578
579	</FONT></TD>
580	</TR>
581	<TR>
582	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
583	SUMMARY: <A HREF="#nested_classes_inherited_from_class_org.greenstone.gs3client.data.QueryFormData">NESTED</A> \| <A HREF="#field_summary">FIELD</A> \| <A HREF="#constructor_summary">CONSTR</A> \| <A HREF="#method_summary">METHOD</A></FONT></TD>
584	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
585	DETAIL: <A HREF="#field_detail">FIELD</A> \| <A HREF="#constructor_detail">CONSTR</A> \| <A HREF="#method_detail">METHOD</A></FONT></TD>
586	</TR>
587	</TABLE>
588	<A NAME="skip-navbar_bottom"></A>
589	<!-- ======== END OF BOTTOM NAVBAR ======= -->
590
591	<HR>
592
593	</BODY>
594	</HTML>

Note: See TracBrowser for help on using the repository browser.

Download in other formats: