1258 lines
31 KiB
HTML
1258 lines
31 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
|
<!--NewPage-->
|
|
<HTML>
|
|
<HEAD>
|
|
<TITLE>
|
|
jala.Form.Component.Input
|
|
</TITLE>
|
|
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
|
</HEAD>
|
|
<SCRIPT>
|
|
function asd()
|
|
{
|
|
parent.document.title="jala.Form.Component.Input";
|
|
}
|
|
</SCRIPT>
|
|
<BODY BGCOLOR="white" onload="asd();">
|
|
|
|
<!-- ========== START OF NAVBAR ========== -->
|
|
<A NAME="navbar_bottom"><!-- --></A>
|
|
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
|
|
<TR>
|
|
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|
<A NAME="navbar_bottom_firstrow"><!-- --></A>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
|
|
<TR ALIGN="center" VALIGN="top">
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-summary-Form.js.html"><FONT CLASS="NavBarFont1"><B>File</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
<!--TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"--> <!--A HREF="deprecated-list.html"--><!--FONT CLASS="NavBarFont1">Deprecated</FONT--><!--/A--><!-- </TD-->
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-all.html"--><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
</TR>
|
|
</TABLE>
|
|
</TD>
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
<B>Jala 1.3</B>
|
|
</EM>
|
|
</TD
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="jala.Form.Component.Image.html"><B>PREV CLASS</B></A><!--
|
|
NEXT CLASS
|
|
-->
|
|
<A HREF="jala.Form.Component.Password.html"><B>NEXT CLASS</B></A></FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="index.html" TARGET="_top"><B>FRAMES</B></A>
|
|
<A HREF="jala.Form.Component.Input.html" TARGET="_top"><B>NO FRAMES</B></A>
|
|
|
|
<SCRIPT>
|
|
<!--
|
|
if(window==top) {
|
|
document.writeln('<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
|
|
}
|
|
//-->
|
|
</SCRIPT>
|
|
<NOSCRIPT>
|
|
<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
|
|
</NOSCRIPT>
|
|
</FONT></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
SUMMARY: <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
<!-- =========== END OF NAVBAR =========== -->
|
|
<HR>
|
|
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<H2>Class jala.Form.Component.Input</H2>
|
|
<PRE>Object
|
|
|
|
|
+--<b>jala.Form.Component.Input</b>
|
|
</PRE>
|
|
|
|
<DL>
|
|
<DT>
|
|
<B>Direct Known Subclasses:</B>
|
|
<DD>
|
|
<a href="jala.Form.Component.Hidden.html">jala.Form.Component.Hidden</a>, <a href="jala.Form.Component.Checkbox.html">jala.Form.Component.Checkbox</a>, <a href="jala.Form.Component.File.html">jala.Form.Component.File</a>, <a href="jala.Form.Component.Password.html">jala.Form.Component.Password</a>, <a href="jala.Form.Component.Button.html">jala.Form.Component.Button</a>, <a href="jala.Form.Component.Select.html">jala.Form.Component.Select</a>, <a href="jala.Form.Component.Textarea.html">jala.Form.Component.Textarea</a>, <a href="jala.Form.Component.Date.html">jala.Form.Component.Date</a>
|
|
</DD>
|
|
</DL>
|
|
|
|
|
|
<HR>
|
|
<DL>
|
|
<!-- Class definition -->
|
|
<DT>class
|
|
<B>jala.Form.Component.Input</B>
|
|
|
|
|
|
</DL>
|
|
|
|
<P>
|
|
<BR/>Instances of this class represent a single form input field.
|
|
<BR/><I>Defined in <a href='overview-summary-Form.js.html'>Form.js</a></I><BR/><BR/>
|
|
</P>
|
|
|
|
<HR>
|
|
|
|
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
|
|
|
<!-- ======== END NESTED CLASS SUMMARY ======== -->
|
|
|
|
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
|
|
|
|
|
|
|
|
<!-- =========== END FIELD SUMMARY =========== -->
|
|
|
|
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
|
|
<A NAME="constructor_summary"><!-- --></A>
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TD COLSPAN=2><FONT SIZE="+2">
|
|
<B>Constructor Summary</B></FONT></TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="jala.Form.Component.Input.html#jala.Form.Component.Input()">jala.Form.Component.Input</A>
|
|
</B>
|
|
(<String> name)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Creates a new input component instance.
|
|
</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<!-- ======== END CONSTRUCTOR SUMMARY ======== -->
|
|
|
|
|
|
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
|
|
<A NAME="method_summary"><!-- --></A>
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TD COLSPAN=2><FONT SIZE="+2">
|
|
<B>Method Summary</B></FONT></TD>
|
|
</TR>
|
|
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> String</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#checkLength">checkLength</A></B>(<Object> reqData)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Checks user input for maximum length, minimum length and require
|
|
if the corresponding options have been set using the require method.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> String</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#checkRequirements">checkRequirements</A></B>(<Object> reqData)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Checks user input against options set using the require method.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#class_macro">class_macro</A></B>()
|
|
</CODE>
|
|
<BR>
|
|
|
|
Renders this component's class name.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#controls_macro">controls_macro</A></B>()
|
|
</CODE>
|
|
<BR>
|
|
|
|
Renders the control(s) of this component
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#error_macro">error_macro</A></B>()
|
|
</CODE>
|
|
<BR>
|
|
|
|
Renders this component's error message (if set) directly to response
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> Object</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#getControlAttributes">getControlAttributes</A></B>()
|
|
</CODE>
|
|
<BR>
|
|
|
|
Creates a new attribute object for this element.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> String|Number|Date</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#getValue">getValue</A></B>()
|
|
</CODE>
|
|
<BR>
|
|
|
|
Retrieves the property which is edited by this component.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#help_macro">help_macro</A></B>()
|
|
</CODE>
|
|
<BR>
|
|
|
|
Renders this component's help text, if set.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#id_macro">id_macro</A></B>()
|
|
</CODE>
|
|
<BR>
|
|
|
|
Renders this component's id
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#label_macro">label_macro</A></B>()
|
|
</CODE>
|
|
<BR>
|
|
|
|
Renders this component's label.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#name_macro">name_macro</A></B>()
|
|
</CODE>
|
|
<BR>
|
|
|
|
Renders this component's name
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> Object</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#parseValue">parseValue</A></B>(<Object> reqData)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Parses the string input from the form and creates the datatype that
|
|
is edited with this component.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#render">render</A></B>()
|
|
</CODE>
|
|
<BR>
|
|
|
|
Renders this component including label, error and help messages directly
|
|
to response.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#render_macro">render_macro</A></B>()
|
|
</CODE>
|
|
<BR>
|
|
|
|
Renders this component including label, error and help messages
|
|
directly to response
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#renderControls">renderControls</A></B>(<Object> attr, <Object> value, <Object> reqData)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Renders the html form elements to the response.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> String</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#renderError">renderError</A></B>()
|
|
</CODE>
|
|
<BR>
|
|
|
|
If the error tracker holds an error message for this component,
|
|
it is wrapped in a div-tag and returned as a string.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> String</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#renderHelp">renderHelp</A></B>()
|
|
</CODE>
|
|
<BR>
|
|
|
|
If this component contains a help message, it is wrapped in
|
|
a div-tag and returned as a string.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> String</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#renderLabel">renderLabel</A></B>()
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns the rendered label of this component
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#save">save</A></B>(<<a href="jala.Form.Tracker.html">jala.Form.Tracker</a>> tracker, <Object> destObj)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Saves the parsed value using setValue.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> Object</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#setValue">setValue</A></B>(<Object> destObj, <Object> value)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Sets a property of the object passed as argument to the given value.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#type_macro">type_macro</A></B>()
|
|
</CODE>
|
|
<BR>
|
|
|
|
Renders this component's type
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#validate">validate</A></B>(<<a href="jala.Form.Tracker.html">jala.Form.Tracker</a>> tracker)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Validates the input provided to this component.
|
|
</TD>
|
|
</TR>
|
|
|
|
|
|
</TABLE>
|
|
|
|
|
|
|
|
<P>
|
|
<!-- ========== END METHOD SUMMARY =========== -->
|
|
|
|
|
|
<!-- ============ FIELD DETAIL START =========== -->
|
|
|
|
|
|
<!-- ============ FIELD DETAIL END =========== -->
|
|
|
|
<!-- ========= CONSTRUCTOR DETAIL START ======== -->
|
|
|
|
<A NAME="constructor_detail"><!-- --></A>
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TD COLSPAN=1>
|
|
<FONT SIZE="+2"><B>Constructor Detail</B></FONT>
|
|
</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<A NAME="jala.Form.Component.Input()"><!-- --></A><H3>
|
|
jala.Form.Component.Input</H3>
|
|
<PRE><B>jala.Form.Component.Input</B>(<String> name)</PRE>
|
|
|
|
|
|
<UL>
|
|
Creates a new input component instance.
|
|
</UL>
|
|
|
|
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>name</CODE> - Name of the component, used as name of the html control.
|
|
</UL>
|
|
|
|
|
|
</UL>
|
|
|
|
|
|
<!-- Constructor return value(s) -->
|
|
|
|
<!-- End constructor return value(s) -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES -->
|
|
|
|
<HR/>
|
|
<!-- END ADDITIONAL ATTRIBUTES -->
|
|
|
|
<!-- ========= CONSTRUCTOR DETAIL END ======== -->
|
|
|
|
|
|
<!-- ============ METHOD DETAIL START ========== -->
|
|
|
|
<A NAME="method_detail"><!-- --></A>
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TD COLSPAN=1><FONT SIZE="+2">
|
|
<B>Method Detail</B></FONT>
|
|
</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<!-- One single method detail entry -->
|
|
|
|
<A NAME="checkLength"><!-- --></A>
|
|
<H3>checkLength</H3>
|
|
<PRE>String <B>checkLength</B>(<Object> reqData)</PRE>
|
|
|
|
<UL>Checks user input for maximum length, minimum length and require
|
|
if the corresponding options have been set using the require method.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>reqData</CODE> - request data
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
String containing error message or null if everything is ok.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<UL>
|
|
<B>See:</B><UL>- <a href="#require">require</a></UL>
|
|
</UL>
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="checkRequirements"><!-- --></A>
|
|
<H3>checkRequirements</H3>
|
|
<PRE>String <B>checkRequirements</B>(<Object> reqData)</PRE>
|
|
|
|
<UL>Checks user input against options set using the require method.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>reqData</CODE> - request data
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
String containing error message or null if everything is ok.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<UL>
|
|
<B>See:</B><UL>- <a href="#checkLength">checkLength()</a><BR/>- <a href="#require">require</a></UL>
|
|
</UL>
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="class_macro"><!-- --></A>
|
|
<H3>class_macro</H3>
|
|
<PRE>void <B>class_macro</B>()</PRE>
|
|
|
|
<UL>Renders this component's class name.
|
|
Note that this is just the class name that has been explicitly
|
|
assigned using setClassName.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<UL>
|
|
<B>See:</B><UL>- <a href="#setClassName">setClassName</a></UL>
|
|
</UL>
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="controls_macro"><!-- --></A>
|
|
<H3>controls_macro</H3>
|
|
<PRE>void <B>controls_macro</B>()</PRE>
|
|
|
|
<UL>Renders the control(s) of this component</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="error_macro"><!-- --></A>
|
|
<H3>error_macro</H3>
|
|
<PRE>void <B>error_macro</B>()</PRE>
|
|
|
|
<UL>Renders this component's error message (if set) directly to response</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="getControlAttributes"><!-- --></A>
|
|
<H3>getControlAttributes</H3>
|
|
<PRE>Object <B>getControlAttributes</B>()</PRE>
|
|
|
|
<UL>Creates a new attribute object for this element.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
Object with properties id, name, class
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="getValue"><!-- --></A>
|
|
<H3>getValue</H3>
|
|
<PRE>String|Number|Date <B>getValue</B>()</PRE>
|
|
|
|
<UL>Retrieves the property which is edited by this component.
|
|
<ul>
|
|
<li>If no getter is given, the method returns the primitive property
|
|
of the data object with the same name as the component.</li>
|
|
<li>If a getter function is defined, it is executed with the scope
|
|
of the data object and the return value is used as default value.
|
|
The name of the component is passed to the getter function
|
|
as an argument.</li>
|
|
</ul></UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
The value of the property
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="help_macro"><!-- --></A>
|
|
<H3>help_macro</H3>
|
|
<PRE>void <B>help_macro</B>()</PRE>
|
|
|
|
<UL>Renders this component's help text, if set.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="id_macro"><!-- --></A>
|
|
<H3>id_macro</H3>
|
|
<PRE>void <B>id_macro</B>()</PRE>
|
|
|
|
<UL>Renders this component's id</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<UL>
|
|
<B>See:</B><UL>- <a href="jala.Form.html#createDomId">jala.Form.createDomId()</a></UL>
|
|
</UL>
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="label_macro"><!-- --></A>
|
|
<H3>label_macro</H3>
|
|
<PRE>void <B>label_macro</B>()</PRE>
|
|
|
|
<UL>Renders this component's label.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="name_macro"><!-- --></A>
|
|
<H3>name_macro</H3>
|
|
<PRE>void <B>name_macro</B>()</PRE>
|
|
|
|
<UL>Renders this component's name</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="parseValue"><!-- --></A>
|
|
<H3>parseValue</H3>
|
|
<PRE>Object <B>parseValue</B>(<Object> reqData)</PRE>
|
|
|
|
<UL>Parses the string input from the form and creates the datatype that
|
|
is edited with this component. For the input component this method
|
|
is not of much use, but subclasses that edit other datatypes may use
|
|
it. For example, a date editor should convert the user input from string
|
|
to a date object.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>reqData</CODE> - request data
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
parsed value
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="render"><!-- --></A>
|
|
<H3>render</H3>
|
|
<PRE>void <B>render</B>()</PRE>
|
|
|
|
<UL>Renders this component including label, error and help messages directly
|
|
to response.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="render_macro"><!-- --></A>
|
|
<H3>render_macro</H3>
|
|
<PRE>void <B>render_macro</B>()</PRE>
|
|
|
|
<UL>Renders this component including label, error and help messages
|
|
directly to response</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="renderControls"><!-- --></A>
|
|
<H3>renderControls</H3>
|
|
<PRE>void <B>renderControls</B>(<Object> attr, <Object> value, <Object> reqData)</PRE>
|
|
|
|
<UL>Renders the html form elements to the response.
|
|
This method shall be overridden by subclasses of input component.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>attr</CODE> - Basic attributes for the html form elements.
|
|
</UL>
|
|
|
|
<UL><CODE>value</CODE> - Value to be used for rendering this element.
|
|
</UL>
|
|
|
|
<UL><CODE>reqData</CODE> - Request data for the whole form. This argument is passed only if the form is re-rendered after an error occured.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="renderError"><!-- --></A>
|
|
<H3>renderError</H3>
|
|
<PRE>String <B>renderError</B>()</PRE>
|
|
|
|
<UL>If the error tracker holds an error message for this component,
|
|
it is wrapped in a div-tag and returned as a string.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
Rendered string
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="renderHelp"><!-- --></A>
|
|
<H3>renderHelp</H3>
|
|
<PRE>String <B>renderHelp</B>()</PRE>
|
|
|
|
<UL>If this component contains a help message, it is wrapped in
|
|
a div-tag and returned as a string.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
The rendered help message
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="renderLabel"><!-- --></A>
|
|
<H3>renderLabel</H3>
|
|
<PRE>String <B>renderLabel</B>()</PRE>
|
|
|
|
<UL>Returns the rendered label of this component</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
The rendered label of this component
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="save"><!-- --></A>
|
|
<H3>save</H3>
|
|
<PRE>void <B>save</B>(<<a href="jala.Form.Tracker.html">jala.Form.Tracker</a>> tracker, <Object> destObj)</PRE>
|
|
|
|
<UL>Saves the parsed value using setValue.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>tracker</CODE> - Tracker object collecting request data, error messages and parsed values.
|
|
</UL>
|
|
|
|
<UL><CODE>destObj</CODE> - (optional) object whose values will be changed.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<UL>
|
|
<B>See:</B><UL>- <a href="#setValue">setValue()</a></UL>
|
|
</UL>
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="setValue"><!-- --></A>
|
|
<H3>setValue</H3>
|
|
<PRE>Object <B>setValue</B>(<Object> destObj, <Object> value)</PRE>
|
|
|
|
<UL>Sets a property of the object passed as argument to the given value.
|
|
<li>If no setter is set at the component, the primitive property
|
|
of the data object is changed.</li>
|
|
<li>If a setter function is defined it is executed with the data object
|
|
as scope and with the name and new value provided as arguments</li>
|
|
<li>If the setter is explicitly set to null, no changes are made at all.</li></UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>destObj</CODE> - (optional) object whose values will be changed.
|
|
</UL>
|
|
|
|
<UL><CODE>value</CODE> - The value to set the property to
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
True in case the update was successful, false otherwise.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<UL>
|
|
<B>See:</B><UL>- <a href="jala.Form.html#setter">jala.Form.setter</a></UL>
|
|
</UL>
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="type_macro"><!-- --></A>
|
|
<H3>type_macro</H3>
|
|
<PRE>void <B>type_macro</B>()</PRE>
|
|
|
|
<UL>Renders this component's type</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="validate"><!-- --></A>
|
|
<H3>validate</H3>
|
|
<PRE>void <B>validate</B>(<<a href="jala.Form.Tracker.html">jala.Form.Tracker</a>> tracker)</PRE>
|
|
|
|
<UL>Validates the input provided to this component. First,
|
|
checkRequirements is called. If no error occurs, the input
|
|
is parsed using parseValue and passed on to the validator
|
|
function.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>tracker</CODE> - Tracker object collecting request data, error messages and parsed values.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<UL>
|
|
<B>See:</B><UL>- <a href="#checkRequirements">checkRequirements()</a><BR/>- <a href="#parseValue">parseValue()</a></UL>
|
|
</UL>
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
|
|
|
|
<!-- ============ METHOD DETAIL END ========== -->
|
|
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
|
|
<!-- ========== START OF NAVBAR ========== -->
|
|
<A NAME="navbar_bottom"><!-- --></A>
|
|
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
|
|
<TR>
|
|
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|
<A NAME="navbar_bottom_firstrow"><!-- --></A>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
|
|
<TR ALIGN="center" VALIGN="top">
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-summary-Form.js.html"><FONT CLASS="NavBarFont1"><B>File</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><b>Tree</b></FONT></A> </TD>
|
|
<!--TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"--> <!--A HREF="deprecated-list.html"--><!--FONT CLASS="NavBarFont1">Deprecated</FONT--><!--/A--><!-- </TD-->
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
</TR>
|
|
</TABLE>
|
|
</TD>
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
<B>Jala 1.3</B>
|
|
</EM>
|
|
</TD
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="jala.Form.Component.Image.html"><B>PREV CLASS</B></A><!--
|
|
NEXT CLASS
|
|
-->
|
|
<A HREF="jala.Form.Component.Password.html"><B>NEXT CLASS</B></A></FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="index.html" TARGET="_top"><B>FRAMES</B></A>
|
|
<A HREF="jala.Form.Component.Input.html" TARGET="_top"><B>NO FRAMES</B></A>
|
|
|
|
<SCRIPT>
|
|
<!--
|
|
if(window==top) {
|
|
document.writeln('<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
|
|
}
|
|
//-->
|
|
</SCRIPT>
|
|
<NOSCRIPT>
|
|
<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
|
|
</NOSCRIPT>
|
|
</FONT></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
SUMMARY: <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<!-- =========== END OF NAVBAR =========== -->
|
|
|
|
<HR>
|
|
<FONT SIZE="-1">
|
|
|
|
</FONT>
|
|
<div class="jsdoc_ctime">Documentation generated by <a href="http://jsdoc.sourceforge.net/" target="_parent">JSDoc</a> on Tue Jan 8 15:45:31 2008</div>
|
|
</BODY>
|
|
</HTML>
|