chg: replaced ant with gradle
This commit is contained in:
parent
cee0be52e0
commit
5cbeb9f01d
609 changed files with 87626 additions and 638 deletions
692
modules/jala/docs/Global.html
Normal file
692
modules/jala/docs/Global.html
Normal file
|
|
@ -0,0 +1,692 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
Global
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title="Global";
|
||||
}
|
||||
</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"> <FONT CLASS="NavBarFont1">File</FONT> </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">
|
||||
<B>PREV CLASS</B><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="helma.Http.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="Global.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 Global</H2>
|
||||
<PRE>Object
|
||||
|
|
||||
+--<b>Global</b>
|
||||
</PRE>
|
||||
|
||||
|
||||
<HR>
|
||||
<DL>
|
||||
<!-- Class definition -->
|
||||
<DT>class
|
||||
<B>Global</B>
|
||||
|
||||
|
||||
</DL>
|
||||
|
||||
<HR>
|
||||
|
||||
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
||||
|
||||
<!-- ======== END NESTED CLASS SUMMARY ======== -->
|
||||
|
||||
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- =========== END FIELD SUMMARY =========== -->
|
||||
|
||||
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
|
||||
<!-- ======== 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><static> Boolean</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#!s!isArray">isArray</A></B>(<Object> val)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns true if the value passed as argument is an array.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE><static> Boolean</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#!s!isBoolean">isBoolean</A></B>(<Object> val)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns true if the value passed as argument is either a boolean
|
||||
literal or an instance of Boolean.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE><static> Boolean</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#!s!isDate">isDate</A></B>(<Object> val)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns true if the value passed as argument is either a Javascript date
|
||||
or an instance of java.util.Date.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE><static> Boolean</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#!s!isFunction">isFunction</A></B>(<Object> val)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns true if the value passed as argument is a function.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE><static> Boolean</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#!s!isNull">isNull</A></B>(<Object> val)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns true if the value passed as argument is null.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE><static> Boolean</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#!s!isNumber">isNumber</A></B>(<Object> val)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns true if the value passed as argument is either a number,
|
||||
an instance of Number or of java.lang.Number.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE><static> Boolean</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#!s!isObject">isObject</A></B>(<Object> val)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns true if the value passed as argument is either a Javascript
|
||||
object or an instance of java.lang.Object.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE><static> Boolean</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#!s!isString">isString</A></B>(<Object> val)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns true if the value passed as argument is either a string literal,
|
||||
an instance of String or of java.lang.String.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE><static> Boolean</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#!s!isUndefined">isUndefined</A></B>(<Object> val)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns true if the value passed as argument is undefined.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
|
||||
</TABLE>
|
||||
|
||||
|
||||
|
||||
<P>
|
||||
<!-- ========== END METHOD SUMMARY =========== -->
|
||||
|
||||
|
||||
<!-- ============ FIELD DETAIL START =========== -->
|
||||
|
||||
|
||||
<!-- ============ FIELD DETAIL END =========== -->
|
||||
|
||||
<!-- ========= CONSTRUCTOR DETAIL START ======== -->
|
||||
|
||||
|
||||
<!-- 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="!s!isArray"><!-- --></A>
|
||||
<H3>isArray</H3>
|
||||
<PRE><static> Boolean <B>isArray</B>(<Object> val)</PRE>
|
||||
|
||||
<UL>Returns true if the value passed as argument is an array.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>val</CODE> - The value to test
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
True if the value is an array, false otherwise
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="!s!isBoolean"><!-- --></A>
|
||||
<H3>isBoolean</H3>
|
||||
<PRE><static> Boolean <B>isBoolean</B>(<Object> val)</PRE>
|
||||
|
||||
<UL>Returns true if the value passed as argument is either a boolean
|
||||
literal or an instance of Boolean.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>val</CODE> - The value to test
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
True if the value is a boolean, false otherwise
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="!s!isDate"><!-- --></A>
|
||||
<H3>isDate</H3>
|
||||
<PRE><static> Boolean <B>isDate</B>(<Object> val)</PRE>
|
||||
|
||||
<UL>Returns true if the value passed as argument is either a Javascript date
|
||||
or an instance of java.util.Date.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>val</CODE> - The value to test
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
True if the value is a date, false otherwise
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="!s!isFunction"><!-- --></A>
|
||||
<H3>isFunction</H3>
|
||||
<PRE><static> Boolean <B>isFunction</B>(<Object> val)</PRE>
|
||||
|
||||
<UL>Returns true if the value passed as argument is a function.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>val</CODE> - The value to test
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
True if the argument is a function, false otherwise
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="!s!isNull"><!-- --></A>
|
||||
<H3>isNull</H3>
|
||||
<PRE><static> Boolean <B>isNull</B>(<Object> val)</PRE>
|
||||
|
||||
<UL>Returns true if the value passed as argument is null.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>val</CODE> - The value to test
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
True if the value is null, false otherwise
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="!s!isNumber"><!-- --></A>
|
||||
<H3>isNumber</H3>
|
||||
<PRE><static> Boolean <B>isNumber</B>(<Object> val)</PRE>
|
||||
|
||||
<UL>Returns true if the value passed as argument is either a number,
|
||||
an instance of Number or of java.lang.Number.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>val</CODE> - The value to test
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
True if the value is a number, false otherwise
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="!s!isObject"><!-- --></A>
|
||||
<H3>isObject</H3>
|
||||
<PRE><static> Boolean <B>isObject</B>(<Object> val)</PRE>
|
||||
|
||||
<UL>Returns true if the value passed as argument is either a Javascript
|
||||
object or an instance of java.lang.Object.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>val</CODE> - The value to test
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
True if the value is an object, false otherwise
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="!s!isString"><!-- --></A>
|
||||
<H3>isString</H3>
|
||||
<PRE><static> Boolean <B>isString</B>(<Object> val)</PRE>
|
||||
|
||||
<UL>Returns true if the value passed as argument is either a string literal,
|
||||
an instance of String or of java.lang.String.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>val</CODE> - The value to test
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
True if the value is a string, false otherwise
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="!s!isUndefined"><!-- --></A>
|
||||
<H3>isUndefined</H3>
|
||||
<PRE><static> Boolean <B>isUndefined</B>(<Object> val)</PRE>
|
||||
|
||||
<UL>Returns true if the value passed as argument is undefined.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>val</CODE> - The value to test
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
True if the value is undefined, false otherwise
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- 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"> <FONT CLASS="NavBarFont1">File</FONT> </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">
|
||||
<B>PREV CLASS</B><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="helma.Http.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="Global.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>
|
||||
581
modules/jala/docs/HopObject.html
Normal file
581
modules/jala/docs/HopObject.html
Normal file
|
|
@ -0,0 +1,581 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
HopObject
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title="HopObject";
|
||||
}
|
||||
</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"> <FONT CLASS="NavBarFont1">File</FONT> </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="helma.Http.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.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="HopObject.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 HopObject</H2>
|
||||
<PRE>Object
|
||||
|
|
||||
+--<b>HopObject</b>
|
||||
</PRE>
|
||||
|
||||
|
||||
<HR>
|
||||
<DL>
|
||||
<!-- Class definition -->
|
||||
<DT>class
|
||||
<B>HopObject</B>
|
||||
|
||||
|
||||
</DL>
|
||||
|
||||
<HR>
|
||||
|
||||
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
||||
|
||||
<!-- ======== END NESTED CLASS SUMMARY ======== -->
|
||||
|
||||
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- =========== END FIELD SUMMARY =========== -->
|
||||
|
||||
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
|
||||
<!-- ======== 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="#getAccessName">getAccessName</A></B>(<Object> obj, <Number> maxLength)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Constructs a name from an object which
|
||||
is unique in the underlying HopObject collection.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> Boolean</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#isClean">isClean</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns true if the internal state of this HopObject is CLEAN.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> Boolean</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#isDeleted">isDeleted</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns true if the internal state of this HopObject is DELETED.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> Boolean</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#isInvalid">isInvalid</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns true if the internal state of this HopObject is INVALID.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> Boolean</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#isModified">isModified</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns true if the internal state of this HopObject is MODIFIED.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> Boolean</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#isNew">isNew</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns true if the internal state of this HopObject is NEW.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> Boolean</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#isTransient">isTransient</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns true if the internal state of this HopObject is TRANSIENT.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> Boolean</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#isVirtual">isVirtual</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns true if the internal state of this HopObject is VIRTUAL.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
|
||||
</TABLE>
|
||||
|
||||
|
||||
|
||||
<P>
|
||||
<!-- ========== END METHOD SUMMARY =========== -->
|
||||
|
||||
|
||||
<!-- ============ FIELD DETAIL START =========== -->
|
||||
|
||||
|
||||
<!-- ============ FIELD DETAIL END =========== -->
|
||||
|
||||
<!-- ========= CONSTRUCTOR DETAIL START ======== -->
|
||||
|
||||
|
||||
<!-- 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="getAccessName"><!-- --></A>
|
||||
<H3>getAccessName</H3>
|
||||
<PRE>String <B>getAccessName</B>(<Object> obj, <Number> maxLength)</PRE>
|
||||
|
||||
<UL>Constructs a name from an object which
|
||||
is unique in the underlying HopObject collection.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>obj</CODE> - The object representing or containing the alias name. Possible object types include: <ul> <li>File</li> <li>helma.File</li> <li>java.io.File</li> <li>String</li> <li>java.lang.String</li> <li>Packages.helma.util.MimePart</li> </ul>
|
||||
</UL>
|
||||
|
||||
<UL><CODE>maxLength</CODE> - The maximum length of the alias
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The resulting alias
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="isClean"><!-- --></A>
|
||||
<H3>isClean</H3>
|
||||
<PRE>Boolean <B>isClean</B>()</PRE>
|
||||
|
||||
<UL>Returns true if the internal state of this HopObject is CLEAN.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
True if this HopObject is marked as <em>clean</em>, false otherwise.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="isDeleted"><!-- --></A>
|
||||
<H3>isDeleted</H3>
|
||||
<PRE>Boolean <B>isDeleted</B>()</PRE>
|
||||
|
||||
<UL>Returns true if the internal state of this HopObject is DELETED.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
True if this HopObject is marked as <em>deleted</em>, false otherwise.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="isInvalid"><!-- --></A>
|
||||
<H3>isInvalid</H3>
|
||||
<PRE>Boolean <B>isInvalid</B>()</PRE>
|
||||
|
||||
<UL>Returns true if the internal state of this HopObject is INVALID.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
True if this HopObject is marked as <em>invalid</em>, false otherwise.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="isModified"><!-- --></A>
|
||||
<H3>isModified</H3>
|
||||
<PRE>Boolean <B>isModified</B>()</PRE>
|
||||
|
||||
<UL>Returns true if the internal state of this HopObject is MODIFIED.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
True if this HopObject is marked as <em>modified</em>, false otherwise.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="isNew"><!-- --></A>
|
||||
<H3>isNew</H3>
|
||||
<PRE>Boolean <B>isNew</B>()</PRE>
|
||||
|
||||
<UL>Returns true if the internal state of this HopObject is NEW.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
True if this HopObject is marked as <em>new</em>, false otherwise.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="isTransient"><!-- --></A>
|
||||
<H3>isTransient</H3>
|
||||
<PRE>Boolean <B>isTransient</B>()</PRE>
|
||||
|
||||
<UL>Returns true if the internal state of this HopObject is TRANSIENT.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
True if this HopObject is marked as <em>transient</em>, false otherwise.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="isVirtual"><!-- --></A>
|
||||
<H3>isVirtual</H3>
|
||||
<PRE>Boolean <B>isVirtual</B>()</PRE>
|
||||
|
||||
<UL>Returns true if the internal state of this HopObject is VIRTUAL.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
True if this HopObject is marked as <em>virtual</em>, false otherwise.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- 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"> <FONT CLASS="NavBarFont1">File</FONT> </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="helma.Http.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.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="HopObject.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>
|
||||
323
modules/jala/docs/allclasses-frame.html
Normal file
323
modules/jala/docs/allclasses-frame.html
Normal file
|
|
@ -0,0 +1,323 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
All Classes
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title=" All Classes";
|
||||
}
|
||||
</SCRIPT>
|
||||
<BODY BGCOLOR="white" onload="asd();">
|
||||
|
||||
<H3 class="FrameHeadingFont"><B></B></H3>
|
||||
<FONT size="+1" CLASS="FrameHeadingFont">
|
||||
<B><a href="overview-summary.html" target="classFrame">All Classes</a></B></FONT>
|
||||
<BR>
|
||||
|
||||
<TABLE BORDER="0" WIDTH="100%">
|
||||
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="Global.html" TARGET="classFrame">Global</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="HopObject.html" TARGET="classFrame">HopObject</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.html" TARGET="classFrame">jala</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.AsyncRequest.html" TARGET="classFrame">jala.AsyncRequest</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.BitTorrent.html" TARGET="classFrame">jala.BitTorrent</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Captcha.html" TARGET="classFrame">jala.Captcha</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Date.html" TARGET="classFrame">jala.Date</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Date.Calendar.html" TARGET="classFrame">jala.Date.Calendar</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Date.Calendar.Renderer.html" TARGET="classFrame">jala.Date.Calendar.Renderer</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.db.html" TARGET="classFrame">jala.db</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.db.FileDatabase.html" TARGET="classFrame">jala.db.FileDatabase</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.db.RamDatabase.html" TARGET="classFrame">jala.db.RamDatabase</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.db.Server.html" TARGET="classFrame">jala.db.Server</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.DnsClient.html" TARGET="classFrame">jala.DnsClient</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.DnsClient.Record.html" TARGET="classFrame">jala.DnsClient.Record</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.html" TARGET="classFrame">jala.Form</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.Component.html" TARGET="classFrame">jala.Form.Component</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.Component.Button.html" TARGET="classFrame">jala.Form.Component.Button</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.Component.Checkbox.html" TARGET="classFrame">jala.Form.Component.Checkbox</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.Component.Date.html" TARGET="classFrame">jala.Form.Component.Date</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.Component.Fieldset.html" TARGET="classFrame">jala.Form.Component.Fieldset</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.Component.File.html" TARGET="classFrame">jala.Form.Component.File</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.Component.Hidden.html" TARGET="classFrame">jala.Form.Component.Hidden</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.Component.Image.html" TARGET="classFrame">jala.Form.Component.Image</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.Component.Input.html" TARGET="classFrame">jala.Form.Component.Input</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.Component.Password.html" TARGET="classFrame">jala.Form.Component.Password</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.Component.Radio.html" TARGET="classFrame">jala.Form.Component.Radio</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.Component.Select.html" TARGET="classFrame">jala.Form.Component.Select</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.Component.Skin.html" TARGET="classFrame">jala.Form.Component.Skin</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.Component.Submit.html" TARGET="classFrame">jala.Form.Component.Submit</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.Component.Textarea.html" TARGET="classFrame">jala.Form.Component.Textarea</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.Tracker.html" TARGET="classFrame">jala.Form.Tracker</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.History.html" TARGET="classFrame">jala.History</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.HtmlDocument.html" TARGET="classFrame">jala.HtmlDocument</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.I18n.html" TARGET="classFrame">jala.I18n</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.ImageFilter.html" TARGET="classFrame">jala.ImageFilter</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.IndexManager.html" TARGET="classFrame">jala.IndexManager</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.IndexManager.Job.html" TARGET="classFrame">jala.IndexManager.Job</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.ListRenderer.html" TARGET="classFrame">jala.ListRenderer</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.ListRenderer.ArrayList.html" TARGET="classFrame">jala.ListRenderer.ArrayList</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Mp3.html" TARGET="classFrame">jala.Mp3</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Mp3.Id3v1.html" TARGET="classFrame">jala.Mp3.Id3v1</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Mp3.Id3v2.html" TARGET="classFrame">jala.Mp3.Id3v2</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.PodcastWriter.html" TARGET="classFrame">jala.PodcastWriter</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.RemoteContent.html" TARGET="classFrame">jala.RemoteContent</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Rss20Writer.html" TARGET="classFrame">jala.Rss20Writer</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Utilities.html" TARGET="classFrame">jala.Utilities</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.XmlRpcRequest.html" TARGET="classFrame">jala.XmlRpcRequest</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.XmlWriter.html" TARGET="classFrame">jala.XmlWriter</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
</TABLE>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
322
modules/jala/docs/allclasses-noframe.html
Normal file
322
modules/jala/docs/allclasses-noframe.html
Normal file
|
|
@ -0,0 +1,322 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
Jala 1.3 All Classes
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title="Jala 1.3 All Classes";
|
||||
}
|
||||
</SCRIPT>
|
||||
<BODY BGCOLOR="white" onload="asd();">
|
||||
|
||||
<H3 CLASS="FrameHeadingFont">Jala 1.3</H3>
|
||||
<FONT size="+1" CLASS="FrameHeadingFont">
|
||||
<B><a href="overview-summary.html">All Classes</a></B></FONT>
|
||||
<BR>
|
||||
|
||||
<TABLE BORDER="0" WIDTH="100%">
|
||||
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="Global.html" >Global</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="HopObject.html" >HopObject</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.html" >jala</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.AsyncRequest.html" >jala.AsyncRequest</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.BitTorrent.html" >jala.BitTorrent</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Captcha.html" >jala.Captcha</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Date.html" >jala.Date</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Date.Calendar.html" >jala.Date.Calendar</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Date.Calendar.Renderer.html" >jala.Date.Calendar.Renderer</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.db.html" >jala.db</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.db.FileDatabase.html" >jala.db.FileDatabase</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.db.RamDatabase.html" >jala.db.RamDatabase</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.db.Server.html" >jala.db.Server</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.DnsClient.html" >jala.DnsClient</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.DnsClient.Record.html" >jala.DnsClient.Record</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.html" >jala.Form</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.Component.html" >jala.Form.Component</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.Component.Button.html" >jala.Form.Component.Button</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.Component.Checkbox.html" >jala.Form.Component.Checkbox</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.Component.Date.html" >jala.Form.Component.Date</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.Component.Fieldset.html" >jala.Form.Component.Fieldset</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.Component.File.html" >jala.Form.Component.File</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.Component.Hidden.html" >jala.Form.Component.Hidden</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.Component.Image.html" >jala.Form.Component.Image</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.Component.Input.html" >jala.Form.Component.Input</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.Component.Password.html" >jala.Form.Component.Password</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.Component.Radio.html" >jala.Form.Component.Radio</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.Component.Select.html" >jala.Form.Component.Select</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.Component.Skin.html" >jala.Form.Component.Skin</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.Component.Submit.html" >jala.Form.Component.Submit</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.Component.Textarea.html" >jala.Form.Component.Textarea</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.Tracker.html" >jala.Form.Tracker</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.History.html" >jala.History</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.HtmlDocument.html" >jala.HtmlDocument</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.I18n.html" >jala.I18n</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.ImageFilter.html" >jala.ImageFilter</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.IndexManager.html" >jala.IndexManager</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.IndexManager.Job.html" >jala.IndexManager.Job</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.ListRenderer.html" >jala.ListRenderer</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.ListRenderer.ArrayList.html" >jala.ListRenderer.ArrayList</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Mp3.html" >jala.Mp3</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Mp3.Id3v1.html" >jala.Mp3.Id3v1</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Mp3.Id3v2.html" >jala.Mp3.Id3v2</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.PodcastWriter.html" >jala.PodcastWriter</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.RemoteContent.html" >jala.RemoteContent</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Rss20Writer.html" >jala.Rss20Writer</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Utilities.html" >jala.Utilities</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.XmlRpcRequest.html" >jala.XmlRpcRequest</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.XmlWriter.html" >jala.XmlWriter</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
</TABLE>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
331
modules/jala/docs/constant-values.html
Normal file
331
modules/jala/docs/constant-values.html
Normal file
|
|
@ -0,0 +1,331 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
Jala 1.3 Constant Values
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title=" Constant Values";
|
||||
}
|
||||
</SCRIPT>
|
||||
<BODY BGCOLOR="white" onload="asd();">
|
||||
|
||||
<!-- ========== START OF NAVBAR ========== -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
|
||||
<TR>
|
||||
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
||||
<A NAME="navbar_top_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"> <FONT CLASS="NavBarFont1">File</FONT> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</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"><B>Deprecated</B></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">
|
||||
PREV
|
||||
NEXT</FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="index.html" TARGET="_top"><B>FRAMES</B></A>
|
||||
<A HREF="help-doc.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>
|
||||
</TABLE>
|
||||
<!-- =========== END OF NAVBAR =========== -->
|
||||
|
||||
<HR>
|
||||
<CENTER> <H1>Constant Field Values</H1> </CENTER>
|
||||
<HR>
|
||||
<UL>
|
||||
|
||||
<LI><A HREF="#jala.Form">jala.Form</A></LI>
|
||||
|
||||
<LI><A HREF="#jala.IndexManager">jala.IndexManager</A></LI>
|
||||
|
||||
<LI><A HREF="#jala.IndexManager.Job">jala.IndexManager.Job</A></LI>
|
||||
|
||||
<LI><A HREF="#jala.PodcastWriter">jala.PodcastWriter</A></LI>
|
||||
|
||||
<LI><A HREF="#jala.RemoteContent">jala.RemoteContent</A></LI>
|
||||
|
||||
<LI><A HREF="#jala.Utilities">jala.Utilities</A></LI>
|
||||
|
||||
</UL>
|
||||
|
||||
<HR>
|
||||
|
||||
|
||||
<A NAME="jala.Form"></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TD colspan="2">
|
||||
<B><A HREF="jala.Form.html">jala.Form</A></B>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
|
||||
<TR>
|
||||
<TD><CODE><A HREF="jala.Form.html#MINLENGTH">MINLENGTH</A></CODE></TD>
|
||||
<TD ALIGN="right"><CODE>"minlength"</CODE></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD><CODE><A HREF="jala.Form.html#MAXLENGTH">MAXLENGTH</A></CODE></TD>
|
||||
<TD ALIGN="right"><CODE>"maxlength"</CODE></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD><CODE><A HREF="jala.Form.html#REQUIRE">REQUIRE</A></CODE></TD>
|
||||
<TD ALIGN="right"><CODE>"require"</CODE></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD><CODE><A HREF="jala.Form.html#CHECKOPTIONS">CHECKOPTIONS</A></CODE></TD>
|
||||
<TD ALIGN="right"><CODE>"checkoptions"</CODE></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD><CODE><A HREF="jala.Form.html#CONTENTTYPE">CONTENTTYPE</A></CODE></TD>
|
||||
<TD ALIGN="right"><CODE>"contenttype"</CODE></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD><CODE><A HREF="jala.Form.html#MAXWIDTH">MAXWIDTH</A></CODE></TD>
|
||||
<TD ALIGN="right"><CODE>"maxwidth"</CODE></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD><CODE><A HREF="jala.Form.html#MINWIDTH">MINWIDTH</A></CODE></TD>
|
||||
<TD ALIGN="right"><CODE>"minwidth"</CODE></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD><CODE><A HREF="jala.Form.html#MAXHEIGHT">MAXHEIGHT</A></CODE></TD>
|
||||
<TD ALIGN="right"><CODE>"maxheight"</CODE></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD><CODE><A HREF="jala.Form.html#MINHEIGHT">MINHEIGHT</A></CODE></TD>
|
||||
<TD ALIGN="right"><CODE>"minheight"</CODE></TD>
|
||||
</TR>
|
||||
|
||||
</TABLE>
|
||||
<P>
|
||||
|
||||
<P>
|
||||
|
||||
<A NAME="jala.IndexManager"></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TD colspan="2">
|
||||
<B><A HREF="jala.IndexManager.html">jala.IndexManager</A></B>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
|
||||
<TR>
|
||||
<TD><CODE><A HREF="jala.IndexManager.html#MAXTRIES">MAXTRIES</A></CODE></TD>
|
||||
<TD ALIGN="right"><CODE>10</CODE></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD><CODE><A HREF="jala.IndexManager.html#NORMAL">NORMAL</A></CODE></TD>
|
||||
<TD ALIGN="right"><CODE>1</CODE></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD><CODE><A HREF="jala.IndexManager.html#REBUILDING">REBUILDING</A></CODE></TD>
|
||||
<TD ALIGN="right"><CODE>2</CODE></TD>
|
||||
</TR>
|
||||
|
||||
</TABLE>
|
||||
<P>
|
||||
|
||||
<P>
|
||||
|
||||
<A NAME="jala.IndexManager.Job"></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TD colspan="2">
|
||||
<B><A HREF="jala.IndexManager.Job.html">jala.IndexManager.Job</A></B>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
|
||||
<TR>
|
||||
<TD><CODE><A HREF="jala.IndexManager.Job.html#ADD">ADD</A></CODE></TD>
|
||||
<TD ALIGN="right"><CODE>"add"</CODE></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD><CODE><A HREF="jala.IndexManager.Job.html#REMOVE">REMOVE</A></CODE></TD>
|
||||
<TD ALIGN="right"><CODE>"remove"</CODE></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD><CODE><A HREF="jala.IndexManager.Job.html#OPTIMIZE">OPTIMIZE</A></CODE></TD>
|
||||
<TD ALIGN="right"><CODE>"optimize"</CODE></TD>
|
||||
</TR>
|
||||
|
||||
</TABLE>
|
||||
<P>
|
||||
|
||||
<P>
|
||||
|
||||
<A NAME="jala.PodcastWriter"></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TD colspan="2">
|
||||
<B><A HREF="jala.PodcastWriter.html">jala.PodcastWriter</A></B>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
|
||||
<TR>
|
||||
<TD><CODE><A HREF="jala.PodcastWriter.html#XMLHEADER">XMLHEADER</A></CODE></TD>
|
||||
<TD ALIGN="right"><CODE>'<?xml version="1.0" encoding="UTF-8"?>'</CODE></TD>
|
||||
</TR>
|
||||
|
||||
</TABLE>
|
||||
<P>
|
||||
|
||||
<P>
|
||||
|
||||
<A NAME="jala.RemoteContent"></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TD colspan="2">
|
||||
<B><A HREF="jala.RemoteContent.html">jala.RemoteContent</A></B>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
|
||||
<TR>
|
||||
<TD><CODE><A HREF="jala.RemoteContent.html#HTTP">HTTP</A></CODE></TD>
|
||||
<TD ALIGN="right"><CODE>1</CODE></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD><CODE><A HREF="jala.RemoteContent.html#XMLRPC">XMLRPC</A></CODE></TD>
|
||||
<TD ALIGN="right"><CODE>2</CODE></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD><CODE><A HREF="jala.RemoteContent.html#SUFFIX">SUFFIX</A></CODE></TD>
|
||||
<TD ALIGN="right"><CODE>".cache"</CODE></TD>
|
||||
</TR>
|
||||
|
||||
</TABLE>
|
||||
<P>
|
||||
|
||||
<P>
|
||||
|
||||
<A NAME="jala.Utilities"></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TD colspan="2">
|
||||
<B><A HREF="jala.Utilities.html">jala.Utilities</A></B>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
|
||||
<TR>
|
||||
<TD><CODE><A HREF="jala.Utilities.html#VALUE_ADDED">VALUE_ADDED</A></CODE></TD>
|
||||
<TD ALIGN="right"><CODE>1</CODE></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD><CODE><A HREF="jala.Utilities.html#VALUE_MODIFIED">VALUE_MODIFIED</A></CODE></TD>
|
||||
<TD ALIGN="right"><CODE>2</CODE></TD>
|
||||
</TR>
|
||||
|
||||
</TABLE>
|
||||
<P>
|
||||
|
||||
<P>
|
||||
|
||||
|
||||
<HR>
|
||||
|
||||
<!-- ========== 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"> <FONT CLASS="NavBarFont1">File</FONT> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</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"><B>Deprecated</B></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">
|
||||
PREV
|
||||
NEXT</FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="index.html" TARGET="_top"><B>FRAMES</B></A>
|
||||
<A HREF="help-doc.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>
|
||||
</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>
|
||||
160
modules/jala/docs/help-doc.html
Normal file
160
modules/jala/docs/help-doc.html
Normal file
|
|
@ -0,0 +1,160 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
Jala 1.3 API Help
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title=" API Help";
|
||||
}
|
||||
</SCRIPT>
|
||||
<BODY BGCOLOR="white" onload="asd();">
|
||||
|
||||
<!-- ========== START OF NAVBAR ========== -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
|
||||
<TR>
|
||||
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
||||
<A NAME="navbar_top_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"> <FONT CLASS="NavBarFont1">File</FONT> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</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"><B>Deprecated</B></FONT></A> </TD-->
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Help</B></FONT> </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">
|
||||
PREV
|
||||
NEXT</FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="index.html" TARGET="_top"><B>FRAMES</B></A>
|
||||
<A HREF="help-doc.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>
|
||||
</TABLE>
|
||||
<!-- =========== END OF NAVBAR =========== -->
|
||||
|
||||
<HR>
|
||||
<CENTER>
|
||||
<H1>
|
||||
How This API Document Is Organized</H1>
|
||||
</CENTER>
|
||||
This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.<H3>
|
||||
Class</H3>
|
||||
<BLOCKQUOTE>
|
||||
|
||||
<P>
|
||||
Each class has its own separate page. Each of these pages has three sections consisting of a class description, summary tables, and detailed member descriptions:<UL>
|
||||
<LI>Class inheritance diagram<LI>Direct Subclasses<LI>Class declaration<LI>Class description
|
||||
<P>
|
||||
<LI>Field Summary<LI>Constructor Summary<LI>Method Summary
|
||||
<P>
|
||||
<LI>Field Detail<LI>Constructor Detail<LI>Method Detail</UL>
|
||||
Each summary entry contains the first sentence from the detailed description for that item. </BLOCKQUOTE>
|
||||
<!--H3>
|
||||
Tree (Class Hierarchy)</H3>
|
||||
<BLOCKQUOTE>
|
||||
There is a <A HREF="overview-tree.html">Class Hierarchy</A> page for all classes. The hierarchy page contains a list of classes. The classes are organized by inheritance structure starting with <code>Object</code>.<UL>
|
||||
</BLOCKQUOTE-->
|
||||
<!-- H3>
|
||||
Deprecated API</H3>
|
||||
<BLOCKQUOTE>
|
||||
The <A HREF="deprecated-list.html">Deprecated API</A> page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.</BLOCKQUOTE-->
|
||||
<H3>
|
||||
Index</H3>
|
||||
<BLOCKQUOTE>
|
||||
The <A HREF="index-all.html">Index</A> contains an alphabetic list of all classes, constructors, methods, and fields.</BLOCKQUOTE>
|
||||
<H3>
|
||||
Prev/Next</H3>
|
||||
These links take you to the next or previous class, interface, package, or related page.<H3>
|
||||
Frames/No Frames</H3>
|
||||
These links show and hide the HTML frames. All pages are available with or without frames.
|
||||
<P>
|
||||
<FONT SIZE="-1">
|
||||
<EM>
|
||||
This help file applies to API documentation generated using the standard doclet.</EM>
|
||||
</FONT>
|
||||
<BR>
|
||||
<HR>
|
||||
|
||||
<!-- ========== 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"> <FONT CLASS="NavBarFont1">File</FONT> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</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"><B>Deprecated</B></FONT></A> </TD-->
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Help</B></FONT> </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">
|
||||
PREV
|
||||
NEXT</FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="index.html" TARGET="_top"><B>FRAMES</B></A>
|
||||
<A HREF="help-doc.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>
|
||||
</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>
|
||||
3562
modules/jala/docs/index-all.html
Normal file
3562
modules/jala/docs/index-all.html
Normal file
File diff suppressed because it is too large
Load diff
27
modules/jala/docs/index.html
Normal file
27
modules/jala/docs/index.html
Normal file
|
|
@ -0,0 +1,27 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
Generated Javascript Documentation
|
||||
</TITLE>
|
||||
</HEAD>
|
||||
<FRAMESET cols="20%,80%">
|
||||
|
||||
<FRAMESET rows="40%,50%">
|
||||
<FRAME src="overview-frame.html" name="overviewFrame">
|
||||
|
||||
<FRAME src="allclasses-frame.html" name="packageFrame">
|
||||
|
||||
</FRAMESET>
|
||||
|
||||
<FRAME src="overview-summary.html" name="classFrame">
|
||||
</FRAMESET>
|
||||
<NOFRAMES>
|
||||
<H2>
|
||||
Frame Alert</H2>
|
||||
|
||||
<P>
|
||||
This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client.
|
||||
<BR>
|
||||
Link to <A HREF="allclasses-frame.html">Non-frame version.</A></NOFRAMES>
|
||||
</HTML>
|
||||
510
modules/jala/docs/jala.AsyncRequest.html
Normal file
510
modules/jala/docs/jala.AsyncRequest.html
Normal file
|
|
@ -0,0 +1,510 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
jala.AsyncRequest
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title="jala.AsyncRequest";
|
||||
}
|
||||
</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-AsyncRequest.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.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.BitTorrent.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.AsyncRequest.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.AsyncRequest</H2>
|
||||
<PRE>Object
|
||||
|
|
||||
+--<b>jala.AsyncRequest</b>
|
||||
</PRE>
|
||||
|
||||
|
||||
<HR>
|
||||
<DL>
|
||||
<!-- Class definition -->
|
||||
<DT>class
|
||||
<B>jala.AsyncRequest</B>
|
||||
|
||||
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<BR/>This class is used to create requests of type "INTERNAL"
|
||||
(like cron-jobs) that are processed in a separate thread and
|
||||
therefor asynchronous.
|
||||
<BR/><B>Deprecated</B> <I>Use the <a href='http://helma.zumbrunn.net/reference/core/app.html#invokeAsync'>app.invokeAsync</a> method instead (built-in into Helma as of version 1.6)</I><BR/><BR/><I>Defined in <a href='overview-summary-AsyncRequest.js.html'>AsyncRequest.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.AsyncRequest.html#jala.AsyncRequest()">jala.AsyncRequest</A>
|
||||
</B>
|
||||
(<Object> obj, <String> funcName, <Array> args)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Creates a new AsyncRequest 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> void</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#evaluate">evaluate</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Starts this asynchronous request.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> Boolean</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#isAlive">isAlive</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns true if the underlying thread is alive
|
||||
</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="#run">run</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Starts this asynchronous request.
|
||||
</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="#setDelay">setDelay</A></B>(<Number> millis)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Defines the delay to wait before evaluating this asynchronous request.
|
||||
</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="#setTimeout">setTimeout</A></B>(<Number> seconds)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Sets the timeout of this asynchronous request.
|
||||
</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.AsyncRequest()"><!-- --></A><H3>
|
||||
jala.AsyncRequest</H3>
|
||||
<PRE><B>jala.AsyncRequest</B>(<Object> obj, <String> funcName, <Array> args)</PRE>
|
||||
|
||||
|
||||
<UL>
|
||||
Creates a new AsyncRequest instance.
|
||||
</UL>
|
||||
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>obj</CODE> - Object in whose context the method should be called
|
||||
</UL>
|
||||
|
||||
<UL><CODE>funcName</CODE> - Name of the function to call
|
||||
</UL>
|
||||
|
||||
<UL><CODE>args</CODE> - Array containing the arguments that should be passed to the function (optional). This option is <em>deprecated</em>, instead pass the arguments directly to the <a href="#run">run()</a> method.
|
||||
</UL>
|
||||
|
||||
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- Constructor return value(s) -->
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
A new instance of AsyncRequest
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
<!-- End constructor return value(s) -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES -->
|
||||
|
||||
<UL>
|
||||
<B>Deprecated</B> <I>Use the <a href='http://helma.zumbrunn.net/reference/core/app.html#invokeAsync'>app.invokeAsync</a> method instead (built-in into Helma as of version 1.6)</I><BR/><BR/>
|
||||
</UL>
|
||||
|
||||
<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="evaluate"><!-- --></A>
|
||||
<H3>evaluate</H3>
|
||||
<PRE>void <B>evaluate</B>()</PRE>
|
||||
|
||||
<UL>Starts this asynchronous request.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<UL>
|
||||
<B>Deprecated</B> <I>Use <a href="#run">run()</a> instead </I><BR/><BR/>
|
||||
</UL>
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="isAlive"><!-- --></A>
|
||||
<H3>isAlive</H3>
|
||||
<PRE>Boolean <B>isAlive</B>()</PRE>
|
||||
|
||||
<UL>Returns true if the underlying thread is alive</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
True if the underlying thread is alive, false otherwise.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="run"><!-- --></A>
|
||||
<H3>run</H3>
|
||||
<PRE>void <B>run</B>()</PRE>
|
||||
|
||||
<UL>Starts this asynchronous request. Any arguments passed to
|
||||
this method will be passed to the method executed by
|
||||
this AsyncRequest instance.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="setDelay"><!-- --></A>
|
||||
<H3>setDelay</H3>
|
||||
<PRE>void <B>setDelay</B>(<Number> millis)</PRE>
|
||||
|
||||
<UL>Defines the delay to wait before evaluating this asynchronous request.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>millis</CODE> - Milliseconds to wait
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="setTimeout"><!-- --></A>
|
||||
<H3>setTimeout</H3>
|
||||
<PRE>void <B>setTimeout</B>(<Number> seconds)</PRE>
|
||||
|
||||
<UL>Sets the timeout of this asynchronous request.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>seconds</CODE> - Thread-timeout.
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- 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-AsyncRequest.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.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.BitTorrent.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.AsyncRequest.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>
|
||||
879
modules/jala/docs/jala.BitTorrent.html
Normal file
879
modules/jala/docs/jala.BitTorrent.html
Normal file
|
|
@ -0,0 +1,879 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
jala.BitTorrent
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title="jala.BitTorrent";
|
||||
}
|
||||
</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-BitTorrent.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.AsyncRequest.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.Captcha.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.BitTorrent.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.BitTorrent</H2>
|
||||
<PRE>Object
|
||||
|
|
||||
+--<b>jala.BitTorrent</b>
|
||||
</PRE>
|
||||
|
||||
|
||||
<HR>
|
||||
<DL>
|
||||
<!-- Class definition -->
|
||||
<DT>class
|
||||
<B>jala.BitTorrent</B>
|
||||
|
||||
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<BR/>This class provides methods to create a BitTorrent
|
||||
metadata file from any desired file.
|
||||
<BR/><I>Defined in <a href='overview-summary-BitTorrent.js.html'>BitTorrent.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.BitTorrent.html#jala.BitTorrent()">jala.BitTorrent</A>
|
||||
</B>
|
||||
(<String> filePath, <String> trackerUrl)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Constructs a new BitTorrent file.
|
||||
</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> Object</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#get">get</A></B>(<String> name)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Get a torrent property.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> Date</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#getCreationDate">getCreationDate</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Get the creation date of the torrent.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> Number</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#getPieceLength">getPieceLength</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Get the piece length of the torrent.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> helma.File</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#getSourceFile">getSourceFile</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns the underlying source file.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> helma.File</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#getTorrentFile">getTorrentFile</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns the underlying torrent file.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> Array</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#keys">keys</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Get all available property names.
|
||||
</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>(<String> filename)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Saves the torrent as file.
|
||||
</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="#set">set</A></B>(<String> name, <Object> value)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Set a torrent property.
|
||||
</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="#setCreationDate">setCreationDate</A></B>(<Date> date)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Set the creation date of the torrent.
|
||||
</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="#setPieceLength">setPieceLength</A></B>(<Number> length)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Set the piece length of the torrent.
|
||||
</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="#toString">toString</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Get a string representation of the torrent.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE><static> Object</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#!s!bdecode">bdecode</A></B>(<String> code)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
The bdecode method.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE><static> String</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#!s!bencode">bencode</A></B>(<Object> obj)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
The bencode method.
|
||||
</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.BitTorrent()"><!-- --></A><H3>
|
||||
jala.BitTorrent</H3>
|
||||
<PRE><B>jala.BitTorrent</B>(<String> filePath, <String> trackerUrl)</PRE>
|
||||
|
||||
|
||||
<UL>
|
||||
Constructs a new BitTorrent file.
|
||||
</UL>
|
||||
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>filePath</CODE> - The path to the original file.
|
||||
</UL>
|
||||
|
||||
<UL><CODE>trackerUrl</CODE> - The URL string of the tracker.
|
||||
</UL>
|
||||
|
||||
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- Constructor return value(s) -->
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
A new BitTorrent file.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
<!-- 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="get"><!-- --></A>
|
||||
<H3>get</H3>
|
||||
<PRE>Object <B>get</B>(<String> name)</PRE>
|
||||
|
||||
<UL>Get a torrent property.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>name</CODE> - The name of the property.
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The value of the property.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="getCreationDate"><!-- --></A>
|
||||
<H3>getCreationDate</H3>
|
||||
<PRE>Date <B>getCreationDate</B>()</PRE>
|
||||
|
||||
<UL>Get the creation date of the torrent.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The torrent's creation date.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="getPieceLength"><!-- --></A>
|
||||
<H3>getPieceLength</H3>
|
||||
<PRE>Number <B>getPieceLength</B>()</PRE>
|
||||
|
||||
<UL>Get the piece length of the torrent.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The torrent's piece length.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="getSourceFile"><!-- --></A>
|
||||
<H3>getSourceFile</H3>
|
||||
<PRE>helma.File <B>getSourceFile</B>()</PRE>
|
||||
|
||||
<UL>Returns the underlying source file.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The source file.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="getTorrentFile"><!-- --></A>
|
||||
<H3>getTorrentFile</H3>
|
||||
<PRE>helma.File <B>getTorrentFile</B>()</PRE>
|
||||
|
||||
<UL>Returns the underlying torrent file.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The torrent file.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="keys"><!-- --></A>
|
||||
<H3>keys</H3>
|
||||
<PRE>Array <B>keys</B>()</PRE>
|
||||
|
||||
<UL>Get all available property names.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The list of property names.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="save"><!-- --></A>
|
||||
<H3>save</H3>
|
||||
<PRE>void <B>save</B>(<String> filename)</PRE>
|
||||
|
||||
<UL>Saves the torrent as file.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>filename</CODE> - An optional name for the torrent file. If no name is given it will be composed from name of source file as defined in the torrent plus the ending ".torrent".
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="set"><!-- --></A>
|
||||
<H3>set</H3>
|
||||
<PRE>void <B>set</B>(<String> name, <Object> value)</PRE>
|
||||
|
||||
<UL>Set a torrent property.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>name</CODE> - The name of the property.
|
||||
</UL>
|
||||
|
||||
<UL><CODE>value</CODE> - The property's value.
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="setCreationDate"><!-- --></A>
|
||||
<H3>setCreationDate</H3>
|
||||
<PRE>void <B>setCreationDate</B>(<Date> date)</PRE>
|
||||
|
||||
<UL>Set the creation date of the torrent.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>date</CODE> - The desired creation date.
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="setPieceLength"><!-- --></A>
|
||||
<H3>setPieceLength</H3>
|
||||
<PRE>void <B>setPieceLength</B>(<Number> length)</PRE>
|
||||
|
||||
<UL>Set the piece length of the torrent.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>length</CODE> - The desired piece length.
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="toString"><!-- --></A>
|
||||
<H3>toString</H3>
|
||||
<PRE>String <B>toString</B>()</PRE>
|
||||
|
||||
<UL>Get a string representation of the torrent.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The torrent as string.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="!s!bdecode"><!-- --></A>
|
||||
<H3>bdecode</H3>
|
||||
<PRE><static> Object <B>bdecode</B>(<String> code)</PRE>
|
||||
|
||||
<UL>The bdecode method. Turns an encoded string into
|
||||
a corresponding JavaScript object structure.
|
||||
FIXME: Handle with caution...</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>code</CODE> - The encoded string.
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The decoded JavaScript structure.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="!s!bencode"><!-- --></A>
|
||||
<H3>bencode</H3>
|
||||
<PRE><static> String <B>bencode</B>(<Object> obj)</PRE>
|
||||
|
||||
<UL>The bencode method. Turns an arbitrary JavaScript
|
||||
object structure into a corresponding encoded
|
||||
string.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>obj</CODE> - The target JavaScript object.
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The encoded string.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- 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-BitTorrent.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.AsyncRequest.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.Captcha.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.BitTorrent.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>
|
||||
461
modules/jala/docs/jala.Captcha.html
Normal file
461
modules/jala/docs/jala.Captcha.html
Normal file
|
|
@ -0,0 +1,461 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
jala.Captcha
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title="jala.Captcha";
|
||||
}
|
||||
</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-Captcha.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.BitTorrent.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.Date.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.Captcha.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.Captcha</H2>
|
||||
<PRE>Object
|
||||
|
|
||||
+--<b>jala.Captcha</b>
|
||||
</PRE>
|
||||
|
||||
|
||||
<HR>
|
||||
<DL>
|
||||
<!-- Class definition -->
|
||||
<DT>class
|
||||
<B>jala.Captcha</B>
|
||||
|
||||
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<BR/>Wrapper class for the
|
||||
<a href='http://jcaptcha.sourceforge.net/'>JCaptcha library</a>.
|
||||
A captcha (an acronym for "completely automated public
|
||||
Turing test to tell computers and humans apart") is a
|
||||
type of challenge-response test used in computing to
|
||||
determine whether or not the user is human.
|
||||
<BR/><I>Defined in <a href='overview-summary-Captcha.js.html'>Captcha.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.Captcha.html#jala.Captcha()">jala.Captcha</A>
|
||||
</B>
|
||||
()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Construct a new captcha.
|
||||
</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> com.octo.captcha.Captcha</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#getCaptcha">getCaptcha</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Get a new captcha object.
|
||||
</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="#renderImage">renderImage</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Render a new captcha image.
|
||||
</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="#toString">toString</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Get a string representation of the captcha object.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> Boolean</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#validate">validate</A></B>(<String> input)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Validate a user's input with the prompted captcha.
|
||||
</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.Captcha()"><!-- --></A><H3>
|
||||
jala.Captcha</H3>
|
||||
<PRE><B>jala.Captcha</B>()</PRE>
|
||||
|
||||
|
||||
<UL>
|
||||
Construct a new captcha.
|
||||
</UL>
|
||||
|
||||
|
||||
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- Constructor return value(s) -->
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
A new captcha.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
<!-- 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="getCaptcha"><!-- --></A>
|
||||
<H3>getCaptcha</H3>
|
||||
<PRE>com.octo.captcha.Captcha <B>getCaptcha</B>()</PRE>
|
||||
|
||||
<UL>Get a new captcha object.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
A new captcha object.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="renderImage"><!-- --></A>
|
||||
<H3>renderImage</H3>
|
||||
<PRE>void <B>renderImage</B>()</PRE>
|
||||
|
||||
<UL>Render a new captcha image.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="toString"><!-- --></A>
|
||||
<H3>toString</H3>
|
||||
<PRE>String <B>toString</B>()</PRE>
|
||||
|
||||
<UL>Get a string representation of the captcha object.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
A string representation of the captcha object.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="validate"><!-- --></A>
|
||||
<H3>validate</H3>
|
||||
<PRE>Boolean <B>validate</B>(<String> input)</PRE>
|
||||
|
||||
<UL>Validate a user's input with the prompted captcha.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>input</CODE> - The user's input.
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
True if the user's input matches the captcha.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- 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-Captcha.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.BitTorrent.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.Date.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.Captcha.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>
|
||||
580
modules/jala/docs/jala.Date.Calendar.Renderer.html
Normal file
580
modules/jala/docs/jala.Date.Calendar.Renderer.html
Normal file
|
|
@ -0,0 +1,580 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
jala.Date.Calendar.Renderer
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title="jala.Date.Calendar.Renderer";
|
||||
}
|
||||
</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-Date.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.Date.Calendar.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.db.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.Date.Calendar.Renderer.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.Date.Calendar.Renderer</H2>
|
||||
<PRE>Object
|
||||
|
|
||||
+--<b>jala.Date.Calendar.Renderer</b>
|
||||
</PRE>
|
||||
|
||||
|
||||
<HR>
|
||||
<DL>
|
||||
<!-- Class definition -->
|
||||
<DT>class
|
||||
<B>jala.Date.Calendar.Renderer</B>
|
||||
|
||||
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<BR/>A default renderer to use in conjunction with jala.Date.Calendar
|
||||
<BR/><I>Defined in <a href='overview-summary-Date.js.html'>Date.js</a></I><BR/><BR/>
|
||||
</P>
|
||||
|
||||
<HR>
|
||||
|
||||
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
||||
|
||||
<!-- ======== END NESTED CLASS SUMMARY ======== -->
|
||||
|
||||
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
|
||||
<A NAME="field_summary"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=2><FONT SIZE="+2">
|
||||
<B>Field Summary</B></FONT></TD>
|
||||
</TR>
|
||||
|
||||
<!-- This is one instance field summary -->
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <a href="jala.Date.Calendar.html">jala.Date.Calendar</a></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="#calendar">calendar</A></B></CODE>
|
||||
<BR>
|
||||
The calendar utilizing this renderer instance</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> helma.Html</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="#html">html</A></B></CODE>
|
||||
<BR>
|
||||
An instance of helma.Html used for rendering the calendar</TD>
|
||||
</TR>
|
||||
|
||||
|
||||
</TABLE>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- =========== 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.Date.Calendar.Renderer.html#jala.Date.Calendar.Renderer()">jala.Date.Calendar.Renderer</A>
|
||||
</B>
|
||||
(<<a href="jala.Date.Calendar.html">jala.Date.Calendar</a>> calendar)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns a new instance of the default calendar renderer.
|
||||
</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> void</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#renderCalendar">renderCalendar</A></B>(<Date> date, <String> body, <Date> prevMonth, <Date> nextMonth)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Renders the calendar 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="#renderDay">renderDay</A></B>(<Date> date, <Boolean> isExisting, <Boolean> isSelected)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Renders a single day within the calendar 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="#renderDayHeader">renderDayHeader</A></B>(<String> text)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Renders a single cell in the calendar day header row 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="#renderPrevNextLink">renderPrevNextLink</A></B>(<Date> date)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Renders a link to the previous or next month's calendar 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="#renderRow">renderRow</A></B>(<String> row)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Renders a single calendar row directly to response.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
|
||||
</TABLE>
|
||||
|
||||
|
||||
|
||||
<P>
|
||||
<!-- ========== END METHOD SUMMARY =========== -->
|
||||
|
||||
|
||||
<!-- ============ FIELD DETAIL START =========== -->
|
||||
|
||||
<A NAME="field_detail"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=1><FONT SIZE="+2"><B>Field Detail</B></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
|
||||
<A NAME="calendar"><!-- --></A>
|
||||
<H3>calendar</H3>
|
||||
<PRE><a href="jala.Date.Calendar.html">jala.Date.Calendar</a> <B>calendar</B></PRE>
|
||||
<UL>
|
||||
The calendar utilizing this renderer instance
|
||||
|
||||
</UL>
|
||||
<HR>
|
||||
|
||||
<A NAME="html"><!-- --></A>
|
||||
<H3>html</H3>
|
||||
<PRE>helma.Html <B>html</B></PRE>
|
||||
<UL>
|
||||
An instance of helma.Html used for rendering the calendar
|
||||
|
||||
</UL>
|
||||
<HR>
|
||||
|
||||
|
||||
|
||||
<!-- ============ 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.Date.Calendar.Renderer()"><!-- --></A><H3>
|
||||
jala.Date.Calendar.Renderer</H3>
|
||||
<PRE><B>jala.Date.Calendar.Renderer</B>(<<a href="jala.Date.Calendar.html">jala.Date.Calendar</a>> calendar)</PRE>
|
||||
|
||||
|
||||
<UL>
|
||||
Returns a new instance of the default calendar renderer.
|
||||
</UL>
|
||||
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>calendar</CODE> - The calendar utilizing this renderer
|
||||
</UL>
|
||||
|
||||
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- Constructor return value(s) -->
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
A newly created instance of jala.Date.Calendar.Renderer
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
<!-- 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="renderCalendar"><!-- --></A>
|
||||
<H3>renderCalendar</H3>
|
||||
<PRE>void <B>renderCalendar</B>(<Date> date, <String> body, <Date> prevMonth, <Date> nextMonth)</PRE>
|
||||
|
||||
<UL>Renders the calendar directly to response.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>date</CODE> - A date object representing this calendar's month and year. Please mind that the day will be set to the <em>last</em> date in this month.
|
||||
</UL>
|
||||
|
||||
<UL><CODE>body</CODE> - The rendered calendar weeks including the day header (basically the whole kernel of the table).
|
||||
</UL>
|
||||
|
||||
<UL><CODE>prevMonth</CODE> - A date object set to the last available date of the previous month. This can be used to render a navigation link to the previous month.
|
||||
</UL>
|
||||
|
||||
<UL><CODE>nextMonth</CODE> - A date object set to the first available date of the next month. This can be used to render a navigation link to the next month.
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="renderDay"><!-- --></A>
|
||||
<H3>renderDay</H3>
|
||||
<PRE>void <B>renderDay</B>(<Date> date, <Boolean> isExisting, <Boolean> isSelected)</PRE>
|
||||
|
||||
<UL>Renders a single day within the calendar directly to response.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>date</CODE> - A date instance representing the day within the calendar.
|
||||
</UL>
|
||||
|
||||
<UL><CODE>isExisting</CODE> - True if there is a child object in the calendar's collection to which the date cell should link to
|
||||
</UL>
|
||||
|
||||
<UL><CODE>isSelected</CODE> - True if this calendar day should be rendered as selected day.
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="renderDayHeader"><!-- --></A>
|
||||
<H3>renderDayHeader</H3>
|
||||
<PRE>void <B>renderDayHeader</B>(<String> text)</PRE>
|
||||
|
||||
<UL>Renders a single cell in the calendar day header row directly to response.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>text</CODE> - The text to display in the header field.
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="renderPrevNextLink"><!-- --></A>
|
||||
<H3>renderPrevNextLink</H3>
|
||||
<PRE>void <B>renderPrevNextLink</B>(<Date> date)</PRE>
|
||||
|
||||
<UL>Renders a link to the previous or next month's calendar directly to response.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>date</CODE> - A date object set to the previous or next available month. This can be null in case there is no previous or next month.
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="renderRow"><!-- --></A>
|
||||
<H3>renderRow</H3>
|
||||
<PRE>void <B>renderRow</B>(<String> row)</PRE>
|
||||
|
||||
<UL>Renders a single calendar row directly to response.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>row</CODE> - The body of the calendar row.
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- 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-Date.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.Date.Calendar.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.db.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.Date.Calendar.Renderer.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>
|
||||
911
modules/jala/docs/jala.Date.Calendar.html
Normal file
911
modules/jala/docs/jala.Date.Calendar.html
Normal file
|
|
@ -0,0 +1,911 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
jala.Date.Calendar
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title="jala.Date.Calendar";
|
||||
}
|
||||
</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-Date.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.Date.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.Date.Calendar.Renderer.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.Date.Calendar.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.Date.Calendar</H2>
|
||||
<PRE>Object
|
||||
|
|
||||
+--<b>jala.Date.Calendar</b>
|
||||
</PRE>
|
||||
|
||||
|
||||
<HR>
|
||||
<DL>
|
||||
<!-- Class definition -->
|
||||
<DT>class
|
||||
<B>jala.Date.Calendar</B>
|
||||
|
||||
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<BR/>This class represents a calendar based based on a grouped
|
||||
collection of HopObjects. It provides several methods for rendering
|
||||
the calendar plus defining locale and timezone settings.
|
||||
<BR/><I>Defined in <a href='overview-summary-Date.js.html'>Date.js</a></I><BR/><BR/>
|
||||
</P>
|
||||
|
||||
<HR>
|
||||
|
||||
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
||||
|
||||
<A NAME="inner_classes"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=2><FONT SIZE="+2">
|
||||
<B>Nested Class Summary</B></FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static class></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="jala.Date.Calendar.Renderer.html">jala.Date.Calendar.Renderer</A></B></CODE></TD>
|
||||
</TR>
|
||||
|
||||
</TABLE>
|
||||
|
||||
|
||||
<!-- ======== 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.Date.Calendar.html#jala.Date.Calendar()">jala.Date.Calendar</A>
|
||||
</B>
|
||||
(<<a href="HopObject.html">HopObject</a>> collection)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Creates a new instance of jala.Data.Calendar
|
||||
</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="#getAccessNameFormat">getAccessNameFormat</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns the format of the access name used by this calendar to access
|
||||
child group objects of the collection this calendar is operating on.
|
||||
</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="#getCalendar">getCalendar</A></B>(today)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns a rendered calendar
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> <a href="HopObject.html">HopObject</a></CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#getCollection">getCollection</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns the collection this calendar object works on
|
||||
</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="#getHrefFormat">getHrefFormat</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns the date formatting pattern used to render hrefs.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> java.util.Locale</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#getLocale">getLocale</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns the locale used within this calendar instance.
|
||||
</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="#getRenderer">getRenderer</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns the renderer used by this calendar.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> java.util.Locale</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#getTimeZone">getTimeZone</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns the locale used within this calendar instance.
|
||||
</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>(today)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Renders the calendar using either a custom renderer defined
|
||||
using <a href="#setRenderer">setRenderer()</a> or the default one.
|
||||
</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="#setAccessNameFormat">setAccessNameFormat</A></B>(<String> fmt)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Sets the format of the group name to use when trying to access
|
||||
child objects of the collection this calendar is operating on.
|
||||
</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="#setHrefFormat">setHrefFormat</A></B>(<String> fmt)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Sets the format of the hrefs to render by this calendar
|
||||
to the format pattern passed as argument.
|
||||
</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="#setLocale">setLocale</A></B>(<java.util.Locale> loc)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Sets the locale to use within this calendar object
|
||||
</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="#setRenderer">setRenderer</A></B>(<Object> r)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Sets the renderer to use.
|
||||
</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="#setTimeZone">setTimeZone</A></B>(tz)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Sets the locale to use within this calendar object
|
||||
</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.Date.Calendar()"><!-- --></A><H3>
|
||||
jala.Date.Calendar</H3>
|
||||
<PRE><B>jala.Date.Calendar</B>(<<a href="HopObject.html">HopObject</a>> collection)</PRE>
|
||||
|
||||
|
||||
<UL>
|
||||
Creates a new instance of jala.Data.Calendar
|
||||
</UL>
|
||||
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>collection</CODE> - A grouped HopObject collection to work on
|
||||
</UL>
|
||||
|
||||
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- Constructor return value(s) -->
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
A newly created jala.Date.Calendar instance
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
<!-- 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="getAccessNameFormat"><!-- --></A>
|
||||
<H3>getAccessNameFormat</H3>
|
||||
<PRE>String <B>getAccessNameFormat</B>()</PRE>
|
||||
|
||||
<UL>Returns the format of the access name used by this calendar to access
|
||||
child group objects of the collection this calendar is operating on.
|
||||
The default format is "yyyyMMdd".</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The date formatting pattern used to access child objects
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<UL>
|
||||
<B>See:</B><UL>- <a href="#setAccessNameFormat">setAccessNameFormat()</a></UL>
|
||||
</UL>
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="getCalendar"><!-- --></A>
|
||||
<H3>getCalendar</H3>
|
||||
<PRE>String <B>getCalendar</B>(today)</PRE>
|
||||
|
||||
<UL>Returns a rendered calendar</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<UL>
|
||||
<B>See:</B><UL>- <a href="#renderCalendar">renderCalendar</a></UL>
|
||||
</UL>
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="getCollection"><!-- --></A>
|
||||
<H3>getCollection</H3>
|
||||
<PRE><a href="HopObject.html">HopObject</a> <B>getCollection</B>()</PRE>
|
||||
|
||||
<UL>Returns the collection this calendar object works on</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The HopObject collection of this calendar
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="getHrefFormat"><!-- --></A>
|
||||
<H3>getHrefFormat</H3>
|
||||
<PRE>String <B>getHrefFormat</B>()</PRE>
|
||||
|
||||
<UL>Returns the date formatting pattern used to render hrefs. The default
|
||||
format is "yyyyMMdd".</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The date formatting pattern
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<UL>
|
||||
<B>See:</B><UL>- <a href="#setHrefFormat">setHrefFormat()</a></UL>
|
||||
</UL>
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="getLocale"><!-- --></A>
|
||||
<H3>getLocale</H3>
|
||||
<PRE>java.util.Locale <B>getLocale</B>()</PRE>
|
||||
|
||||
<UL>Returns the locale used within this calendar instance. By default
|
||||
the locale used by this calendar is the default locale of the
|
||||
Java Virtual Machine running Helma.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The locale of this calendar
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<UL>
|
||||
<B>See:</B><UL>- <a href="#setLocale">setLocale()</a></UL>
|
||||
</UL>
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="getRenderer"><!-- --></A>
|
||||
<H3>getRenderer</H3>
|
||||
<PRE>Object <B>getRenderer</B>()</PRE>
|
||||
|
||||
<UL>Returns the renderer used by this calendar.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The calendar renderer
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<UL>
|
||||
<B>See:</B><UL>- <a href="#setRenderer">setRenderer()</a></UL>
|
||||
</UL>
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="getTimeZone"><!-- --></A>
|
||||
<H3>getTimeZone</H3>
|
||||
<PRE>java.util.Locale <B>getTimeZone</B>()</PRE>
|
||||
|
||||
<UL>Returns the locale used within this calendar instance. By default
|
||||
the timezone used by this calendar is the default timezone
|
||||
of the Java Virtual Machine running Helma.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The locale of this calendar
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<UL>
|
||||
<B>See:</B><UL>- <a href="#setTimeZone">setTimeZone()</a></UL>
|
||||
</UL>
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="render"><!-- --></A>
|
||||
<H3>render</H3>
|
||||
<PRE>void <B>render</B>(today)</PRE>
|
||||
|
||||
<UL>Renders the calendar using either a custom renderer defined
|
||||
using <a href="#setRenderer">setRenderer()</a> or the default one.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<UL>
|
||||
<B>See:</B><UL>- <a href="#setRenderer">setRenderer()</a><BR/>- <a href="jala.Date.Calendar.Renderer.html#">jala.Date.Calendar.Renderer</a></UL>
|
||||
</UL>
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="setAccessNameFormat"><!-- --></A>
|
||||
<H3>setAccessNameFormat</H3>
|
||||
<PRE>void <B>setAccessNameFormat</B>(<String> fmt)</PRE>
|
||||
|
||||
<UL>Sets the format of the group name to use when trying to access
|
||||
child objects of the collection this calendar is operating on.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>fmt</CODE> - The date format pattern to use for accessing child objects
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<UL>
|
||||
<B>See:</B><UL>- <a href="#getAccessNameFormat">getAccessNameFormat()</a></UL>
|
||||
</UL>
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="setHrefFormat"><!-- --></A>
|
||||
<H3>setHrefFormat</H3>
|
||||
<PRE>void <B>setHrefFormat</B>(<String> fmt)</PRE>
|
||||
|
||||
<UL>Sets the format of the hrefs to render by this calendar
|
||||
to the format pattern passed as argument.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>fmt</CODE> - The date format pattern to use for rendering the href
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<UL>
|
||||
<B>See:</B><UL>- <a href="#getHrefFormat">getHrefFormat()</a></UL>
|
||||
</UL>
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="setLocale"><!-- --></A>
|
||||
<H3>setLocale</H3>
|
||||
<PRE>void <B>setLocale</B>(<java.util.Locale> loc)</PRE>
|
||||
|
||||
<UL>Sets the locale to use within this calendar object</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>loc</CODE> - The locale to use
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<UL>
|
||||
<B>See:</B><UL>- <a href="#getLocale">getLocale()</a></UL>
|
||||
</UL>
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="setRenderer"><!-- --></A>
|
||||
<H3>setRenderer</H3>
|
||||
<PRE>void <B>setRenderer</B>(<Object> r)</PRE>
|
||||
|
||||
<UL>Sets the renderer to use.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>r</CODE> - The renderer to use
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<UL>
|
||||
<B>See:</B><UL>- <a href="#getRenderer">getRenderer()</a></UL>
|
||||
</UL>
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="setTimeZone"><!-- --></A>
|
||||
<H3>setTimeZone</H3>
|
||||
<PRE>void <B>setTimeZone</B>(tz)</PRE>
|
||||
|
||||
<UL>Sets the locale to use within this calendar object</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>loc</CODE> - The locale to use
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<UL>
|
||||
<B>See:</B><UL>- <a href="#getTimeZone">getTimeZone()</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-Date.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.Date.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.Date.Calendar.Renderer.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.Date.Calendar.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>
|
||||
389
modules/jala/docs/jala.Date.html
Normal file
389
modules/jala/docs/jala.Date.html
Normal file
|
|
@ -0,0 +1,389 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
jala.Date
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title="jala.Date";
|
||||
}
|
||||
</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-Date.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.Captcha.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.Date.Calendar.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.Date.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.Date</H2>
|
||||
<PRE>Object
|
||||
|
|
||||
+--<b>jala.Date</b>
|
||||
</PRE>
|
||||
|
||||
|
||||
<HR>
|
||||
<DL>
|
||||
<!-- Class definition -->
|
||||
<DT>class
|
||||
<B>jala.Date</B>
|
||||
|
||||
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<BR/>This class provides various convenience
|
||||
methods for rendering purposes.
|
||||
<BR/><I>Defined in <a href='overview-summary-Date.js.html'>Date.js</a></I><BR/><BR/>
|
||||
</P>
|
||||
|
||||
<HR>
|
||||
|
||||
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
||||
|
||||
<A NAME="inner_classes"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=2><FONT SIZE="+2">
|
||||
<B>Nested Class Summary</B></FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static class></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="jala.Date.Calendar.html">jala.Date.Calendar</A></B></CODE></TD>
|
||||
</TR>
|
||||
|
||||
</TABLE>
|
||||
|
||||
|
||||
<!-- ======== 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.Date.html#jala.Date()">jala.Date</A>
|
||||
</B>
|
||||
()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Constructs a new Renderings object.
|
||||
</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> void</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#renderEditor">renderEditor</A></B>(<String> prefix, <Date> date, <Object> fmt)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Renders a timestamp as set of DropDown boxes, following the
|
||||
format passed as argument.
|
||||
</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="#renderEditorAsString">renderEditorAsString</A></B>(prefix, date, pattern)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns a timestamp as set of dropdown-boxes
|
||||
</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.Date()"><!-- --></A><H3>
|
||||
jala.Date</H3>
|
||||
<PRE><B>jala.Date</B>()</PRE>
|
||||
|
||||
|
||||
<UL>
|
||||
Constructs a new Renderings object.
|
||||
</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="renderEditor"><!-- --></A>
|
||||
<H3>renderEditor</H3>
|
||||
<PRE>void <B>renderEditor</B>(<String> prefix, <Date> date, <Object> fmt)</PRE>
|
||||
|
||||
<UL>Renders a timestamp as set of DropDown boxes, following the
|
||||
format passed as argument. Every <select>
|
||||
item is prefixed with a string so that it can be retrieved
|
||||
easily from the values of a submitted POST request.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>prefix</CODE> - The prefix to use for all dropdown boxes, eg. "postdate"
|
||||
</UL>
|
||||
|
||||
<UL><CODE>date</CODE> - A Date object to use as preselection (optional)
|
||||
</UL>
|
||||
|
||||
<UL><CODE>fmt</CODE> - Array containing one parameter object for every single select box that should be rendered, with the following properties set: <ul> <li>pattern - The date format pattern that should be rendered. Valid patterns are: "dd", "MM", "yyyy", "HH", "ss".</li> <li>firstOption - The string to use as first option, eg.: "choose a day"</li> </ul>
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="renderEditorAsString"><!-- --></A>
|
||||
<H3>renderEditorAsString</H3>
|
||||
<PRE>String <B>renderEditorAsString</B>(prefix, date, pattern)</PRE>
|
||||
|
||||
<UL>Returns a timestamp as set of dropdown-boxes</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<UL>
|
||||
<B>See:</B><UL>- <a href="#renderEditor">renderEditor()</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-Date.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.Captcha.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.Date.Calendar.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.Date.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>
|
||||
484
modules/jala/docs/jala.DnsClient.Record.html
Normal file
484
modules/jala/docs/jala.DnsClient.Record.html
Normal file
|
|
@ -0,0 +1,484 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
jala.DnsClient.Record
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title="jala.DnsClient.Record";
|
||||
}
|
||||
</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-DnsClient.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.DnsClient.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.Form.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.DnsClient.Record.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.DnsClient.Record</H2>
|
||||
<PRE>Object
|
||||
|
|
||||
+--<b>jala.DnsClient.Record</b>
|
||||
</PRE>
|
||||
|
||||
|
||||
<HR>
|
||||
<DL>
|
||||
<!-- Class definition -->
|
||||
<DT>class
|
||||
<B>jala.DnsClient.Record</B>
|
||||
|
||||
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<BR/>Instances of this class wrap record data as received
|
||||
from the nameserver.
|
||||
<BR/><I>Defined in <a href='overview-summary-DnsClient.js.html'>DnsClient.js</a></I><BR/><BR/>
|
||||
</P>
|
||||
|
||||
<HR>
|
||||
|
||||
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
||||
|
||||
<!-- ======== END NESTED CLASS SUMMARY ======== -->
|
||||
|
||||
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
|
||||
<A NAME="field_summary"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=2><FONT SIZE="+2">
|
||||
<B>Field Summary</B></FONT></TD>
|
||||
</TR>
|
||||
|
||||
<!-- This is one instance field summary -->
|
||||
|
||||
<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="#cname">cname</A></B></CODE>
|
||||
<BR>
|
||||
The CNAME of this record.</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="#email">email</A></B></CODE>
|
||||
<BR>
|
||||
The email address responsible for a name server.</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="#host">host</A></B></CODE>
|
||||
<BR>
|
||||
The name of the host.</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="#ipAddress">ipAddress</A></B></CODE>
|
||||
<BR>
|
||||
The IP address of the host.</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="#mx">mx</A></B></CODE>
|
||||
<BR>
|
||||
The name of the mail exchanging server.</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="#text">text</A></B></CODE>
|
||||
<BR>
|
||||
Descriptive text as received from the nameserver.</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> Number</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="#type">type</A></B></CODE>
|
||||
<BR>
|
||||
The type of the nameserver record represented by this Answer instance.</TD>
|
||||
</TR>
|
||||
|
||||
|
||||
</TABLE>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- =========== 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.DnsClient.Record.html#jala.DnsClient.Record()">jala.DnsClient.Record</A>
|
||||
</B>
|
||||
(<org.wonderly.net.dns.RR> data)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Constructs a new instance of jala.DnsClient.Record.
|
||||
</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> org.wonderly.net.dns.RR</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#getData">getData</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns the wrapped nameserver record data
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
|
||||
</TABLE>
|
||||
|
||||
|
||||
|
||||
<P>
|
||||
<!-- ========== END METHOD SUMMARY =========== -->
|
||||
|
||||
|
||||
<!-- ============ FIELD DETAIL START =========== -->
|
||||
|
||||
<A NAME="field_detail"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=1><FONT SIZE="+2"><B>Field Detail</B></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
|
||||
<A NAME="cname"><!-- --></A>
|
||||
<H3>cname</H3>
|
||||
<PRE>String <B>cname</B></PRE>
|
||||
<UL>
|
||||
The CNAME of this record. This will only be set for records
|
||||
of type CNAME
|
||||
|
||||
</UL>
|
||||
<HR>
|
||||
|
||||
<A NAME="email"><!-- --></A>
|
||||
<H3>email</H3>
|
||||
<PRE>String <B>email</B></PRE>
|
||||
<UL>
|
||||
The email address responsible for a name server. This property
|
||||
will only be set for records of type SOA
|
||||
|
||||
</UL>
|
||||
<HR>
|
||||
|
||||
<A NAME="host"><!-- --></A>
|
||||
<H3>host</H3>
|
||||
<PRE>String <B>host</B></PRE>
|
||||
<UL>
|
||||
The name of the host. This will only be set for records
|
||||
of type A, AAAA and NS.
|
||||
|
||||
</UL>
|
||||
<HR>
|
||||
|
||||
<A NAME="ipAddress"><!-- --></A>
|
||||
<H3>ipAddress</H3>
|
||||
<PRE>String <B>ipAddress</B></PRE>
|
||||
<UL>
|
||||
The IP address of the host. This will only be set for records
|
||||
of type A and AAAA
|
||||
|
||||
</UL>
|
||||
<HR>
|
||||
|
||||
<A NAME="mx"><!-- --></A>
|
||||
<H3>mx</H3>
|
||||
<PRE>String <B>mx</B></PRE>
|
||||
<UL>
|
||||
The name of the mail exchanging server. This is only set for
|
||||
records of type MX
|
||||
|
||||
</UL>
|
||||
<HR>
|
||||
|
||||
<A NAME="text"><!-- --></A>
|
||||
<H3>text</H3>
|
||||
<PRE>String <B>text</B></PRE>
|
||||
<UL>
|
||||
Descriptive text as received from the nameserver. This is only
|
||||
set for records of type TXT
|
||||
|
||||
</UL>
|
||||
<HR>
|
||||
|
||||
<A NAME="type"><!-- --></A>
|
||||
<H3>type</H3>
|
||||
<PRE>Number <B>type</B></PRE>
|
||||
<UL>
|
||||
The type of the nameserver record represented by this Answer instance.
|
||||
|
||||
</UL>
|
||||
<HR>
|
||||
|
||||
|
||||
|
||||
<!-- ============ 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.DnsClient.Record()"><!-- --></A><H3>
|
||||
jala.DnsClient.Record</H3>
|
||||
<PRE><B>jala.DnsClient.Record</B>(<org.wonderly.net.dns.RR> data)</PRE>
|
||||
|
||||
|
||||
<UL>
|
||||
Constructs a new instance of jala.DnsClient.Record.
|
||||
</UL>
|
||||
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>data</CODE> - The data as received from the nameserver
|
||||
</UL>
|
||||
|
||||
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- Constructor return value(s) -->
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
A newly constructed Record instance
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
<!-- 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="getData"><!-- --></A>
|
||||
<H3>getData</H3>
|
||||
<PRE>org.wonderly.net.dns.RR <B>getData</B>()</PRE>
|
||||
|
||||
<UL>Returns the wrapped nameserver record data</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The wrapped data
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- 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-DnsClient.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.DnsClient.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.Form.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.DnsClient.Record.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>
|
||||
591
modules/jala/docs/jala.DnsClient.html
Normal file
591
modules/jala/docs/jala.DnsClient.html
Normal file
|
|
@ -0,0 +1,591 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
jala.DnsClient
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title="jala.DnsClient";
|
||||
}
|
||||
</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-DnsClient.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.db.Server.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.DnsClient.Record.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.DnsClient.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.DnsClient</H2>
|
||||
<PRE>Object
|
||||
|
|
||||
+--<b>jala.DnsClient</b>
|
||||
</PRE>
|
||||
|
||||
|
||||
<HR>
|
||||
<DL>
|
||||
<!-- Class definition -->
|
||||
<DT>class
|
||||
<B>jala.DnsClient</B>
|
||||
|
||||
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<BR/>This is a wrapper around the Dns Client by wonderly.org
|
||||
providing methods for querying Dns servers. For more information
|
||||
about the Java DNS client visit
|
||||
<a href="https://javadns.dev.java.net/">https://javadns.dev.java.net/</a>.
|
||||
Please mind that the nameserver specified must accept queries on port
|
||||
53 TCP (the Java DNS client used doesn't support UDP nameserver queries),
|
||||
and that reverse lookups are not supported.
|
||||
<BR/><I>Defined in <a href='overview-summary-DnsClient.js.html'>DnsClient.js</a></I><BR/><BR/>
|
||||
</P>
|
||||
|
||||
<HR>
|
||||
|
||||
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
||||
|
||||
<A NAME="inner_classes"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=2><FONT SIZE="+2">
|
||||
<B>Nested Class Summary</B></FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static class></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="jala.DnsClient.Record.html">jala.DnsClient.Record</A></B></CODE></TD>
|
||||
</TR>
|
||||
|
||||
</TABLE>
|
||||
|
||||
|
||||
<!-- ======== END NESTED CLASS SUMMARY ======== -->
|
||||
|
||||
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
|
||||
<A NAME="field_summary"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=2><FONT SIZE="+2">
|
||||
<B>Field Summary</B></FONT></TD>
|
||||
</TR>
|
||||
|
||||
<!-- This is one instance field summary -->
|
||||
|
||||
<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="#nameServer">nameServer</A></B></CODE>
|
||||
<BR>
|
||||
Contains the IP Adress/FQDN of the name server to query.</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static> <final> Number</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="#!s!TYPE_A">TYPE_A</A></B></CODE>
|
||||
<BR>
|
||||
The "A" record/query type.</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static> <final> Number</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="#!s!TYPE_CNAME">TYPE_CNAME</A></B></CODE>
|
||||
<BR>
|
||||
The "CNAME" record/query type.</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static> <final> Number</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="#!s!TYPE_MX">TYPE_MX</A></B></CODE>
|
||||
<BR>
|
||||
The "MX" record/query type.</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static> <final> Number</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="#!s!TYPE_NS">TYPE_NS</A></B></CODE>
|
||||
<BR>
|
||||
The "NS" record/query type.</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static> <final> Number</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="#!s!TYPE_PTR">TYPE_PTR</A></B></CODE>
|
||||
<BR>
|
||||
The "PTR" record/query type.</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static> <final> Number</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="#!s!TYPE_SOA">TYPE_SOA</A></B></CODE>
|
||||
<BR>
|
||||
The "SOA" record/query type.</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static> <final> Number</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="#!s!TYPE_TXT">TYPE_TXT</A></B></CODE>
|
||||
<BR>
|
||||
The "TXT" record/query type.</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static> <final> Number</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="#!s!TYPE_WKS">TYPE_WKS</A></B></CODE>
|
||||
<BR>
|
||||
The "WKS" record/query type.</TD>
|
||||
</TR>
|
||||
|
||||
|
||||
</TABLE>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- =========== 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.DnsClient.html#jala.DnsClient()">jala.DnsClient</A>
|
||||
</B>
|
||||
(<String> nameServer)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Constructs a new DnsClient object.
|
||||
</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> org.wonderly.net.dns.RR</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#query">query</A></B>(<String> dName, <Number> queryType)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Queries the nameserver for a specific domain
|
||||
and the given type of record.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> org.wonderly.net.dns.RR</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#queryMailHost">queryMailHost</A></B>(<String> dName)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Convenience method to query for the MX-records
|
||||
of the domain passed as argument.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
|
||||
</TABLE>
|
||||
|
||||
|
||||
|
||||
<P>
|
||||
<!-- ========== END METHOD SUMMARY =========== -->
|
||||
|
||||
|
||||
<!-- ============ FIELD DETAIL START =========== -->
|
||||
|
||||
<A NAME="field_detail"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=1><FONT SIZE="+2"><B>Field Detail</B></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
|
||||
<A NAME="nameServer"><!-- --></A>
|
||||
<H3>nameServer</H3>
|
||||
<PRE>String <B>nameServer</B></PRE>
|
||||
<UL>
|
||||
Contains the IP Adress/FQDN of the name server to query.
|
||||
|
||||
</UL>
|
||||
<HR>
|
||||
|
||||
<A NAME="!s!TYPE_A"><!-- --></A>
|
||||
<H3>TYPE_A</H3>
|
||||
<PRE><static> <final> Number <B>TYPE_A</B></PRE>
|
||||
<UL>
|
||||
The "A" record/query type.
|
||||
|
||||
</UL>
|
||||
<HR>
|
||||
|
||||
<A NAME="!s!TYPE_CNAME"><!-- --></A>
|
||||
<H3>TYPE_CNAME</H3>
|
||||
<PRE><static> <final> Number <B>TYPE_CNAME</B></PRE>
|
||||
<UL>
|
||||
The "CNAME" record/query type.
|
||||
|
||||
</UL>
|
||||
<HR>
|
||||
|
||||
<A NAME="!s!TYPE_MX"><!-- --></A>
|
||||
<H3>TYPE_MX</H3>
|
||||
<PRE><static> <final> Number <B>TYPE_MX</B></PRE>
|
||||
<UL>
|
||||
The "MX" record/query type.
|
||||
|
||||
</UL>
|
||||
<HR>
|
||||
|
||||
<A NAME="!s!TYPE_NS"><!-- --></A>
|
||||
<H3>TYPE_NS</H3>
|
||||
<PRE><static> <final> Number <B>TYPE_NS</B></PRE>
|
||||
<UL>
|
||||
The "NS" record/query type.
|
||||
|
||||
</UL>
|
||||
<HR>
|
||||
|
||||
<A NAME="!s!TYPE_PTR"><!-- --></A>
|
||||
<H3>TYPE_PTR</H3>
|
||||
<PRE><static> <final> Number <B>TYPE_PTR</B></PRE>
|
||||
<UL>
|
||||
The "PTR" record/query type.
|
||||
|
||||
</UL>
|
||||
<HR>
|
||||
|
||||
<A NAME="!s!TYPE_SOA"><!-- --></A>
|
||||
<H3>TYPE_SOA</H3>
|
||||
<PRE><static> <final> Number <B>TYPE_SOA</B></PRE>
|
||||
<UL>
|
||||
The "SOA" record/query type.
|
||||
|
||||
</UL>
|
||||
<HR>
|
||||
|
||||
<A NAME="!s!TYPE_TXT"><!-- --></A>
|
||||
<H3>TYPE_TXT</H3>
|
||||
<PRE><static> <final> Number <B>TYPE_TXT</B></PRE>
|
||||
<UL>
|
||||
The "TXT" record/query type.
|
||||
|
||||
</UL>
|
||||
<HR>
|
||||
|
||||
<A NAME="!s!TYPE_WKS"><!-- --></A>
|
||||
<H3>TYPE_WKS</H3>
|
||||
<PRE><static> <final> Number <B>TYPE_WKS</B></PRE>
|
||||
<UL>
|
||||
The "WKS" record/query type.
|
||||
|
||||
</UL>
|
||||
<HR>
|
||||
|
||||
|
||||
|
||||
<!-- ============ 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.DnsClient()"><!-- --></A><H3>
|
||||
jala.DnsClient</H3>
|
||||
<PRE><B>jala.DnsClient</B>(<String> nameServer)</PRE>
|
||||
|
||||
|
||||
<UL>
|
||||
Constructs a new DnsClient object.
|
||||
</UL>
|
||||
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>nameServer</CODE> - IP-Address or FQDN of nameserver to query
|
||||
</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="query"><!-- --></A>
|
||||
<H3>query</H3>
|
||||
<PRE>org.wonderly.net.dns.RR <B>query</B>(<String> dName, <Number> queryType)</PRE>
|
||||
|
||||
<UL>Queries the nameserver for a specific domain
|
||||
and the given type of record.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>dName</CODE> - The domain name to query for
|
||||
</UL>
|
||||
|
||||
<UL><CODE>queryType</CODE> - The type of records to retrieve
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The records retrieved from the nameserver
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="queryMailHost"><!-- --></A>
|
||||
<H3>queryMailHost</H3>
|
||||
<PRE>org.wonderly.net.dns.RR <B>queryMailHost</B>(<String> dName)</PRE>
|
||||
|
||||
<UL>Convenience method to query for the MX-records
|
||||
of the domain passed as argument.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>dName</CODE> - The domain name to query for
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The records retrieved from the nameserver
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- 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-DnsClient.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.db.Server.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.DnsClient.Record.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.DnsClient.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>
|
||||
411
modules/jala/docs/jala.Form.Component.Button.html
Normal file
411
modules/jala/docs/jala.Form.Component.Button.html
Normal file
|
|
@ -0,0 +1,411 @@
|
|||
<!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.Button
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title="jala.Form.Component.Button";
|
||||
}
|
||||
</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.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.Form.Component.Checkbox.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.Button.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.Button</H2>
|
||||
<PRE>Object
|
||||
|
|
||||
+--<a href='jala.Form.Component.Input.html'>jala.Form.Component.Input</a>
|
||||
|
|
||||
+--<b>jala.Form.Component.Button</b>
|
||||
</PRE>
|
||||
|
||||
<DL>
|
||||
<DT>
|
||||
<B>Direct Known Subclasses:</B>
|
||||
<DD>
|
||||
<a href="jala.Form.Component.Submit.html">jala.Form.Component.Submit</a>
|
||||
</DD>
|
||||
</DL>
|
||||
|
||||
|
||||
<HR>
|
||||
<DL>
|
||||
<!-- Class definition -->
|
||||
<DT>class
|
||||
<B>jala.Form.Component.Button</B>
|
||||
|
||||
<DT>extends <a href='jala.Form.Component.Input.html'>jala.Form.Component.Input</a>
|
||||
|
||||
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<BR/>Subclass of jala.Form.Component.Input which renders a button.
|
||||
<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.Button.html#jala.Form.Component.Button()">jala.Form.Component.Button</A>
|
||||
</B>
|
||||
(<String> name)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Creates a new Button 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> void</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#render">render</A></B>(<Object> attr, <Object> value, <Object> reqData)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Renders a button to the 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="#renderControls">renderControls</A></B>(attr, value)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Creates a new attribute object for this button.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
|
||||
</TABLE>
|
||||
|
||||
|
||||
|
||||
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TD><B>Methods inherited from class <a href="jala.Form.Component.Input.html">jala.Form.Component.Input</a></B></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>
|
||||
<!-- Inherited methods -->
|
||||
<a href="jala.Form.Component.Input.html#validate">validate</a>, <a href="jala.Form.Component.Input.html#save">save</a>, <a href="jala.Form.Component.Input.html#getValue">getValue</a>, <a href="jala.Form.Component.Input.html#setValue">setValue</a>, <a href="jala.Form.Component.Input.html#renderError">renderError</a>, <a href="jala.Form.Component.Input.html#renderLabel">renderLabel</a>, <a href="jala.Form.Component.Input.html#renderHelp">renderHelp</a>, <a href="jala.Form.Component.Input.html#render_macro">render_macro</a>, <a href="jala.Form.Component.Input.html#controls_macro">controls_macro</a>, <a href="jala.Form.Component.Input.html#error_macro">error_macro</a>, <a href="jala.Form.Component.Input.html#label_macro">label_macro</a>, <a href="jala.Form.Component.Input.html#help_macro">help_macro</a>, <a href="jala.Form.Component.Input.html#id_macro">id_macro</a>, <a href="jala.Form.Component.Input.html#name_macro">name_macro</a>, <a href="jala.Form.Component.Input.html#type_macro">type_macro</a>, <a href="jala.Form.Component.Input.html#class_macro">class_macro</a>, <a href="jala.Form.Component.Input.html#getControlAttributes">getControlAttributes</a>, <a href="jala.Form.Component.Input.html#checkLength">checkLength</a>, <a href="jala.Form.Component.Input.html#checkRequirements">checkRequirements</a>, <a href="jala.Form.Component.Input.html#parseValue">parseValue</a>
|
||||
</CODE></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.Button()"><!-- --></A><H3>
|
||||
jala.Form.Component.Button</H3>
|
||||
<PRE><B>jala.Form.Component.Button</B>(<String> name)</PRE>
|
||||
|
||||
|
||||
<UL>
|
||||
Creates a new Button component instance
|
||||
</UL>
|
||||
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>name</CODE> - Name of the component, used as name of the html controls.
|
||||
</UL>
|
||||
|
||||
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- Constructor return value(s) -->
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
A newly created Button component
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
<!-- 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="render"><!-- --></A>
|
||||
<H3>render</H3>
|
||||
<PRE>void <B>render</B>(<Object> attr, <Object> value, <Object> reqData)</PRE>
|
||||
|
||||
<UL>Renders a button to the response.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>attr</CODE> - Basic attributes for this element.
|
||||
</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="renderControls"><!-- --></A>
|
||||
<H3>renderControls</H3>
|
||||
<PRE>Object <B>renderControls</B>(attr, value)</PRE>
|
||||
|
||||
<UL>Creates a new attribute object for this button.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
Object with all attributes set for this button.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- 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.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.Form.Component.Checkbox.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.Button.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>
|
||||
460
modules/jala/docs/jala.Form.Component.Checkbox.html
Normal file
460
modules/jala/docs/jala.Form.Component.Checkbox.html
Normal file
|
|
@ -0,0 +1,460 @@
|
|||
<!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.Checkbox
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title="jala.Form.Component.Checkbox";
|
||||
}
|
||||
</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.Button.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.Form.Component.Date.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.Checkbox.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.Checkbox</H2>
|
||||
<PRE>Object
|
||||
|
|
||||
+--<a href='jala.Form.Component.Input.html'>jala.Form.Component.Input</a>
|
||||
|
|
||||
+--<b>jala.Form.Component.Checkbox</b>
|
||||
</PRE>
|
||||
|
||||
|
||||
<HR>
|
||||
<DL>
|
||||
<!-- Class definition -->
|
||||
<DT>class
|
||||
<B>jala.Form.Component.Checkbox</B>
|
||||
|
||||
<DT>extends <a href='jala.Form.Component.Input.html'>jala.Form.Component.Input</a>
|
||||
|
||||
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<BR/>Subclass of jala.Form.Component.Input which renders and validates a
|
||||
checkbox.
|
||||
<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.Checkbox.html#jala.Form.Component.Checkbox()">jala.Form.Component.Checkbox</A>
|
||||
</B>
|
||||
(<String> name)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Creates a new Checkbox 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="#checkRequirements">checkRequirements</A></B>(<Object> reqData)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Validates user input from checkbox.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> Number</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#parseValue">parseValue</A></B>(<Object> reqData)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Parses the string input from the form.
|
||||
</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, reqData)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Renders an checkbox to the response.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
|
||||
</TABLE>
|
||||
|
||||
|
||||
|
||||
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TD><B>Methods inherited from class <a href="jala.Form.Component.Input.html">jala.Form.Component.Input</a></B></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>
|
||||
<!-- Inherited methods -->
|
||||
<a href="jala.Form.Component.Input.html#validate">validate</a>, <a href="jala.Form.Component.Input.html#save">save</a>, <a href="jala.Form.Component.Input.html#getValue">getValue</a>, <a href="jala.Form.Component.Input.html#setValue">setValue</a>, <a href="jala.Form.Component.Input.html#render">render</a>, <a href="jala.Form.Component.Input.html#renderError">renderError</a>, <a href="jala.Form.Component.Input.html#renderLabel">renderLabel</a>, <a href="jala.Form.Component.Input.html#renderHelp">renderHelp</a>, <a href="jala.Form.Component.Input.html#render_macro">render_macro</a>, <a href="jala.Form.Component.Input.html#controls_macro">controls_macro</a>, <a href="jala.Form.Component.Input.html#error_macro">error_macro</a>, <a href="jala.Form.Component.Input.html#label_macro">label_macro</a>, <a href="jala.Form.Component.Input.html#help_macro">help_macro</a>, <a href="jala.Form.Component.Input.html#id_macro">id_macro</a>, <a href="jala.Form.Component.Input.html#name_macro">name_macro</a>, <a href="jala.Form.Component.Input.html#type_macro">type_macro</a>, <a href="jala.Form.Component.Input.html#class_macro">class_macro</a>, <a href="jala.Form.Component.Input.html#getControlAttributes">getControlAttributes</a>, <a href="jala.Form.Component.Input.html#checkLength">checkLength</a>
|
||||
</CODE></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.Checkbox()"><!-- --></A><H3>
|
||||
jala.Form.Component.Checkbox</H3>
|
||||
<PRE><B>jala.Form.Component.Checkbox</B>(<String> name)</PRE>
|
||||
|
||||
|
||||
<UL>
|
||||
Creates a new Checkbox component instance
|
||||
</UL>
|
||||
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>name</CODE> - Name of the component, used as name of the html controls.
|
||||
</UL>
|
||||
|
||||
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- Constructor return value(s) -->
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
A newly created Checkbox component instance
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
<!-- 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="checkRequirements"><!-- --></A>
|
||||
<H3>checkRequirements</H3>
|
||||
<PRE>String <B>checkRequirements</B>(<Object> reqData)</PRE>
|
||||
|
||||
<UL>Validates user input from checkbox.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>reqData</CODE> - request data
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
null if everything is ok or string containing error message
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="parseValue"><!-- --></A>
|
||||
<H3>parseValue</H3>
|
||||
<PRE>Number <B>parseValue</B>(<Object> reqData)</PRE>
|
||||
|
||||
<UL>Parses the string input from the form. For a checked box, the value is 1,
|
||||
for an unchecked box the value is 0.</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="renderControls"><!-- --></A>
|
||||
<H3>renderControls</H3>
|
||||
<PRE>void <B>renderControls</B>(<Object> attr, <Object> value, reqData)</PRE>
|
||||
|
||||
<UL>Renders an checkbox to the response.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>attr</CODE> - Basic attributes for this element.
|
||||
</UL>
|
||||
|
||||
<UL><CODE>value</CODE> - Value to be used for rendering this element.
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- 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.Button.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.Form.Component.Date.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.Checkbox.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>
|
||||
463
modules/jala/docs/jala.Form.Component.Date.html
Normal file
463
modules/jala/docs/jala.Form.Component.Date.html
Normal file
|
|
@ -0,0 +1,463 @@
|
|||
<!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.Date
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title="jala.Form.Component.Date";
|
||||
}
|
||||
</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.Checkbox.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.Form.Component.Fieldset.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.Date.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.Date</H2>
|
||||
<PRE>Object
|
||||
|
|
||||
+--<a href='jala.Form.Component.Input.html'>jala.Form.Component.Input</a>
|
||||
|
|
||||
+--<b>jala.Form.Component.Date</b>
|
||||
</PRE>
|
||||
|
||||
|
||||
<HR>
|
||||
<DL>
|
||||
<!-- Class definition -->
|
||||
<DT>class
|
||||
<B>jala.Form.Component.Date</B>
|
||||
|
||||
<DT>extends <a href='jala.Form.Component.Input.html'>jala.Form.Component.Input</a>
|
||||
|
||||
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<BR/>Subclass of jala.Form.Component.Input which renders and validates a
|
||||
date editor.
|
||||
<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.Date.html#jala.Form.Component.Date()">jala.Form.Component.Date</A>
|
||||
</B>
|
||||
(<String> name)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Constructs a new Date 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="#checkRequirements">checkRequirements</A></B>(<Object> reqData)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Validates user input from a date editor.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> Date</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#parseValue">parseValue</A></B>(<Object> reqData)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Parses the string input from the form and converts it to a date object.
|
||||
</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 a textarea tag to the response.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
|
||||
</TABLE>
|
||||
|
||||
|
||||
|
||||
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TD><B>Methods inherited from class <a href="jala.Form.Component.Input.html">jala.Form.Component.Input</a></B></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>
|
||||
<!-- Inherited methods -->
|
||||
<a href="jala.Form.Component.Input.html#validate">validate</a>, <a href="jala.Form.Component.Input.html#save">save</a>, <a href="jala.Form.Component.Input.html#getValue">getValue</a>, <a href="jala.Form.Component.Input.html#setValue">setValue</a>, <a href="jala.Form.Component.Input.html#render">render</a>, <a href="jala.Form.Component.Input.html#renderError">renderError</a>, <a href="jala.Form.Component.Input.html#renderLabel">renderLabel</a>, <a href="jala.Form.Component.Input.html#renderHelp">renderHelp</a>, <a href="jala.Form.Component.Input.html#render_macro">render_macro</a>, <a href="jala.Form.Component.Input.html#controls_macro">controls_macro</a>, <a href="jala.Form.Component.Input.html#error_macro">error_macro</a>, <a href="jala.Form.Component.Input.html#label_macro">label_macro</a>, <a href="jala.Form.Component.Input.html#help_macro">help_macro</a>, <a href="jala.Form.Component.Input.html#id_macro">id_macro</a>, <a href="jala.Form.Component.Input.html#name_macro">name_macro</a>, <a href="jala.Form.Component.Input.html#type_macro">type_macro</a>, <a href="jala.Form.Component.Input.html#class_macro">class_macro</a>, <a href="jala.Form.Component.Input.html#getControlAttributes">getControlAttributes</a>, <a href="jala.Form.Component.Input.html#checkLength">checkLength</a>
|
||||
</CODE></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.Date()"><!-- --></A><H3>
|
||||
jala.Form.Component.Date</H3>
|
||||
<PRE><B>jala.Form.Component.Date</B>(<String> name)</PRE>
|
||||
|
||||
|
||||
<UL>
|
||||
Constructs a new Date component instance
|
||||
</UL>
|
||||
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>name</CODE> - Name of the component, used as name of the html controls.
|
||||
</UL>
|
||||
|
||||
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- Constructor return value(s) -->
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
A newly created Date component
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
<!-- 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="checkRequirements"><!-- --></A>
|
||||
<H3>checkRequirements</H3>
|
||||
<PRE>String <B>checkRequirements</B>(<Object> reqData)</PRE>
|
||||
|
||||
<UL>Validates user input from a date editor.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>reqData</CODE> - request data
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
null if everything is ok or string containing error message
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="parseValue"><!-- --></A>
|
||||
<H3>parseValue</H3>
|
||||
<PRE>Date <B>parseValue</B>(<Object> reqData)</PRE>
|
||||
|
||||
<UL>Parses the string input from the form and converts it to a date object.
|
||||
Throws an error if the string cannot be parsed.</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 date value
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- 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 a textarea tag to the response.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>attr</CODE> - Basic attributes for this element.
|
||||
</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>
|
||||
|
||||
|
||||
|
||||
<!-- ============ 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.Checkbox.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.Form.Component.Fieldset.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.Date.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>
|
||||
419
modules/jala/docs/jala.Form.Component.Fieldset.html
Normal file
419
modules/jala/docs/jala.Form.Component.Fieldset.html
Normal file
|
|
@ -0,0 +1,419 @@
|
|||
<!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.Fieldset
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title="jala.Form.Component.Fieldset";
|
||||
}
|
||||
</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.Date.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.Form.Component.File.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.Fieldset.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.Fieldset</H2>
|
||||
<PRE>Object
|
||||
|
|
||||
+--<b>jala.Form.Component.Fieldset</b>
|
||||
</PRE>
|
||||
|
||||
|
||||
<HR>
|
||||
<DL>
|
||||
<!-- Class definition -->
|
||||
<DT>class
|
||||
<B>jala.Form.Component.Fieldset</B>
|
||||
|
||||
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<BR/>Instances of this class represent a form fieldset containing
|
||||
numerous form components
|
||||
<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.Fieldset.html#jala.Form.Component.Fieldset()">jala.Form.Component.Fieldset</A>
|
||||
</B>
|
||||
(<String> name)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Constructs a new Fieldset 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> void</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#render">render</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Renders all components within the fieldset.
|
||||
</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 all components within the fieldset.
|
||||
</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 all components within the fieldset.
|
||||
</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.Fieldset()"><!-- --></A><H3>
|
||||
jala.Form.Component.Fieldset</H3>
|
||||
<PRE><B>jala.Form.Component.Fieldset</B>(<String> name)</PRE>
|
||||
|
||||
|
||||
<UL>
|
||||
Constructs a new Fieldset instance
|
||||
</UL>
|
||||
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>name</CODE> - The name of the fieldset
|
||||
</UL>
|
||||
|
||||
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- Constructor return value(s) -->
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
A newly created Fieldset instance
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
<!-- 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="render"><!-- --></A>
|
||||
<H3>render</H3>
|
||||
<PRE>void <B>render</B>()</PRE>
|
||||
|
||||
<UL>Renders all components within the fieldset.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- 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 all components within the fieldset.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>tracker</CODE> -
|
||||
</UL>
|
||||
|
||||
<UL><CODE>destObj</CODE> -
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- 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 all components within the fieldset.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>tracker</CODE> -
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- 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.Date.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.Form.Component.File.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.Fieldset.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>
|
||||
425
modules/jala/docs/jala.Form.Component.File.html
Normal file
425
modules/jala/docs/jala.Form.Component.File.html
Normal file
|
|
@ -0,0 +1,425 @@
|
|||
<!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.File
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title="jala.Form.Component.File";
|
||||
}
|
||||
</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.Fieldset.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.Form.Component.Hidden.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.File.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.File</H2>
|
||||
<PRE>Object
|
||||
|
|
||||
+--<a href='jala.Form.Component.Input.html'>jala.Form.Component.Input</a>
|
||||
|
|
||||
+--<b>jala.Form.Component.File</b>
|
||||
</PRE>
|
||||
|
||||
<DL>
|
||||
<DT>
|
||||
<B>Direct Known Subclasses:</B>
|
||||
<DD>
|
||||
<a href="jala.Form.Component.Image.html">jala.Form.Component.Image</a>
|
||||
</DD>
|
||||
</DL>
|
||||
|
||||
|
||||
<HR>
|
||||
<DL>
|
||||
<!-- Class definition -->
|
||||
<DT>class
|
||||
<B>jala.Form.Component.File</B>
|
||||
|
||||
<DT>extends <a href='jala.Form.Component.Input.html'>jala.Form.Component.Input</a>
|
||||
|
||||
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<BR/>Subclass of jala.Form.Component.Input which renders and validates a
|
||||
file upload.
|
||||
<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.File.html#jala.Form.Component.File()">jala.Form.Component.File</A>
|
||||
</B>
|
||||
(<String> name)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Creates a new File 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="#checkRequirements">checkRequirements</A></B>(<Object> reqData)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Validates a file upload by making sure it's there (if REQUIRE is set),
|
||||
checking the file size, the content type and by trying to construct an image.
|
||||
</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 a file input tag to the response.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
|
||||
</TABLE>
|
||||
|
||||
|
||||
|
||||
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TD><B>Methods inherited from class <a href="jala.Form.Component.Input.html">jala.Form.Component.Input</a></B></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>
|
||||
<!-- Inherited methods -->
|
||||
<a href="jala.Form.Component.Input.html#validate">validate</a>, <a href="jala.Form.Component.Input.html#save">save</a>, <a href="jala.Form.Component.Input.html#getValue">getValue</a>, <a href="jala.Form.Component.Input.html#setValue">setValue</a>, <a href="jala.Form.Component.Input.html#render">render</a>, <a href="jala.Form.Component.Input.html#renderError">renderError</a>, <a href="jala.Form.Component.Input.html#renderLabel">renderLabel</a>, <a href="jala.Form.Component.Input.html#renderHelp">renderHelp</a>, <a href="jala.Form.Component.Input.html#render_macro">render_macro</a>, <a href="jala.Form.Component.Input.html#controls_macro">controls_macro</a>, <a href="jala.Form.Component.Input.html#error_macro">error_macro</a>, <a href="jala.Form.Component.Input.html#label_macro">label_macro</a>, <a href="jala.Form.Component.Input.html#help_macro">help_macro</a>, <a href="jala.Form.Component.Input.html#id_macro">id_macro</a>, <a href="jala.Form.Component.Input.html#name_macro">name_macro</a>, <a href="jala.Form.Component.Input.html#type_macro">type_macro</a>, <a href="jala.Form.Component.Input.html#class_macro">class_macro</a>, <a href="jala.Form.Component.Input.html#getControlAttributes">getControlAttributes</a>, <a href="jala.Form.Component.Input.html#checkLength">checkLength</a>, <a href="jala.Form.Component.Input.html#parseValue">parseValue</a>
|
||||
</CODE></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.File()"><!-- --></A><H3>
|
||||
jala.Form.Component.File</H3>
|
||||
<PRE><B>jala.Form.Component.File</B>(<String> name)</PRE>
|
||||
|
||||
|
||||
<UL>
|
||||
Creates a new File component instance
|
||||
</UL>
|
||||
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>name</CODE> - Name of the component, used as name of the html controls.
|
||||
</UL>
|
||||
|
||||
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- Constructor return value(s) -->
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
A newly created File component
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
<!-- 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="checkRequirements"><!-- --></A>
|
||||
<H3>checkRequirements</H3>
|
||||
<PRE>String <B>checkRequirements</B>(<Object> reqData)</PRE>
|
||||
|
||||
<UL>Validates a file upload by making sure it's there (if REQUIRE is set),
|
||||
checking the file size, the content type and by trying to construct an image.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>reqData</CODE> - request data
|
||||
</UL>
|
||||
|
||||
<UL><CODE>tracker</CODE> - jala.Form.Tracker object storing possible error messages
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
null if everything is ok or string containing error message
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- 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 a file input tag to the response.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>attr</CODE> - Basic attributes for this element.
|
||||
</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>
|
||||
|
||||
|
||||
|
||||
<!-- ============ 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.Fieldset.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.Form.Component.Hidden.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.File.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>
|
||||
398
modules/jala/docs/jala.Form.Component.Hidden.html
Normal file
398
modules/jala/docs/jala.Form.Component.Hidden.html
Normal file
|
|
@ -0,0 +1,398 @@
|
|||
<!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.Hidden
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title="jala.Form.Component.Hidden";
|
||||
}
|
||||
</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.File.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.Form.Component.Image.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.Hidden.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.Hidden</H2>
|
||||
<PRE>Object
|
||||
|
|
||||
+--<a href='jala.Form.Component.Input.html'>jala.Form.Component.Input</a>
|
||||
|
|
||||
+--<b>jala.Form.Component.Hidden</b>
|
||||
</PRE>
|
||||
|
||||
|
||||
<HR>
|
||||
<DL>
|
||||
<!-- Class definition -->
|
||||
<DT>class
|
||||
<B>jala.Form.Component.Hidden</B>
|
||||
|
||||
<DT>extends <a href='jala.Form.Component.Input.html'>jala.Form.Component.Input</a>
|
||||
|
||||
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<BR/>Subclass of jala.Form.Component.Input which renders and validates a
|
||||
hidden input tag.
|
||||
<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.Hidden.html#jala.Form.Component.Hidden()">jala.Form.Component.Hidden</A>
|
||||
</B>
|
||||
(<String> name)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Constructs a newly created Hidden 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> void</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#render">render</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Renders this component 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 a hidden input tag to the response.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
|
||||
</TABLE>
|
||||
|
||||
|
||||
|
||||
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TD><B>Methods inherited from class <a href="jala.Form.Component.Input.html">jala.Form.Component.Input</a></B></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>
|
||||
<!-- Inherited methods -->
|
||||
<a href="jala.Form.Component.Input.html#validate">validate</a>, <a href="jala.Form.Component.Input.html#save">save</a>, <a href="jala.Form.Component.Input.html#getValue">getValue</a>, <a href="jala.Form.Component.Input.html#setValue">setValue</a>, <a href="jala.Form.Component.Input.html#renderError">renderError</a>, <a href="jala.Form.Component.Input.html#renderLabel">renderLabel</a>, <a href="jala.Form.Component.Input.html#renderHelp">renderHelp</a>, <a href="jala.Form.Component.Input.html#render_macro">render_macro</a>, <a href="jala.Form.Component.Input.html#controls_macro">controls_macro</a>, <a href="jala.Form.Component.Input.html#error_macro">error_macro</a>, <a href="jala.Form.Component.Input.html#label_macro">label_macro</a>, <a href="jala.Form.Component.Input.html#help_macro">help_macro</a>, <a href="jala.Form.Component.Input.html#id_macro">id_macro</a>, <a href="jala.Form.Component.Input.html#name_macro">name_macro</a>, <a href="jala.Form.Component.Input.html#type_macro">type_macro</a>, <a href="jala.Form.Component.Input.html#class_macro">class_macro</a>, <a href="jala.Form.Component.Input.html#getControlAttributes">getControlAttributes</a>, <a href="jala.Form.Component.Input.html#checkLength">checkLength</a>, <a href="jala.Form.Component.Input.html#checkRequirements">checkRequirements</a>, <a href="jala.Form.Component.Input.html#parseValue">parseValue</a>
|
||||
</CODE></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.Hidden()"><!-- --></A><H3>
|
||||
jala.Form.Component.Hidden</H3>
|
||||
<PRE><B>jala.Form.Component.Hidden</B>(<String> name)</PRE>
|
||||
|
||||
|
||||
<UL>
|
||||
Constructs a newly created Hidden component instance
|
||||
</UL>
|
||||
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>name</CODE> - Name of the component, used as name of the html controls.
|
||||
</UL>
|
||||
|
||||
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- Constructor return value(s) -->
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
A newly created Hidden component instance
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
<!-- 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="render"><!-- --></A>
|
||||
<H3>render</H3>
|
||||
<PRE>void <B>render</B>()</PRE>
|
||||
|
||||
<UL>Renders this component directly to response. For a hidden tag, this is
|
||||
just an input element, no div tag or anything.</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 a hidden input tag to the response.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>attr</CODE> - Basic attributes for this element.
|
||||
</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>
|
||||
|
||||
|
||||
|
||||
<!-- ============ 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.File.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.Form.Component.Image.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.Hidden.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>
|
||||
376
modules/jala/docs/jala.Form.Component.Image.html
Normal file
376
modules/jala/docs/jala.Form.Component.Image.html
Normal file
|
|
@ -0,0 +1,376 @@
|
|||
<!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.Image
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title="jala.Form.Component.Image";
|
||||
}
|
||||
</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.Hidden.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.Form.Component.Input.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.Image.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.Image</H2>
|
||||
<PRE>Object
|
||||
|
|
||||
+--<a href='jala.Form.Component.Input.html'>jala.Form.Component.Input</a>
|
||||
|
|
||||
+--<a href='jala.Form.Component.File.html'>jala.Form.Component.File</a>
|
||||
|
|
||||
+--<b>jala.Form.Component.Image</b>
|
||||
</PRE>
|
||||
|
||||
|
||||
<HR>
|
||||
<DL>
|
||||
<!-- Class definition -->
|
||||
<DT>class
|
||||
<B>jala.Form.Component.Image</B>
|
||||
|
||||
<DT>extends <a href='jala.Form.Component.File.html'>jala.Form.Component.File</a>
|
||||
|
||||
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<BR/>Subclass of jala.Form.Component.File which renders a file upload
|
||||
and validates uploaded files as images.
|
||||
<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.Image.html#jala.Form.Component.Image()">jala.Form.Component.Image</A>
|
||||
</B>
|
||||
()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Creates a new Image 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="#checkRequirements">checkRequirements</A></B>(<Object> reqData)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Validates an image upload by making sure it's there (if REQUIRE is set),
|
||||
checking the file size, the content type and by trying to construct an image.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
|
||||
</TABLE>
|
||||
|
||||
|
||||
|
||||
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TD><B>Methods inherited from class <a href="jala.Form.Component.File.html">jala.Form.Component.File</a></B></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>
|
||||
<!-- Inherited methods -->
|
||||
<a href="jala.Form.Component.File.html#renderControls">renderControls</a>
|
||||
</CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
|
||||
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TD><B>Methods inherited from class <a href="jala.Form.Component.Input.html">jala.Form.Component.Input</a></B></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>
|
||||
<!-- Inherited methods -->
|
||||
<a href="jala.Form.Component.Input.html#validate">validate</a>, <a href="jala.Form.Component.Input.html#save">save</a>, <a href="jala.Form.Component.Input.html#getValue">getValue</a>, <a href="jala.Form.Component.Input.html#setValue">setValue</a>, <a href="jala.Form.Component.Input.html#render">render</a>, <a href="jala.Form.Component.Input.html#renderError">renderError</a>, <a href="jala.Form.Component.Input.html#renderLabel">renderLabel</a>, <a href="jala.Form.Component.Input.html#renderHelp">renderHelp</a>, <a href="jala.Form.Component.Input.html#render_macro">render_macro</a>, <a href="jala.Form.Component.Input.html#controls_macro">controls_macro</a>, <a href="jala.Form.Component.Input.html#error_macro">error_macro</a>, <a href="jala.Form.Component.Input.html#label_macro">label_macro</a>, <a href="jala.Form.Component.Input.html#help_macro">help_macro</a>, <a href="jala.Form.Component.Input.html#id_macro">id_macro</a>, <a href="jala.Form.Component.Input.html#name_macro">name_macro</a>, <a href="jala.Form.Component.Input.html#type_macro">type_macro</a>, <a href="jala.Form.Component.Input.html#class_macro">class_macro</a>, <a href="jala.Form.Component.Input.html#getControlAttributes">getControlAttributes</a>, <a href="jala.Form.Component.Input.html#checkLength">checkLength</a>, <a href="jala.Form.Component.Input.html#parseValue">parseValue</a>
|
||||
</CODE></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.Image()"><!-- --></A><H3>
|
||||
jala.Form.Component.Image</H3>
|
||||
<PRE><B>jala.Form.Component.Image</B>()</PRE>
|
||||
|
||||
|
||||
<UL>
|
||||
Creates a new Image component instance
|
||||
</UL>
|
||||
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>name</CODE> - Name of the component, used as name of the html controls.
|
||||
</UL>
|
||||
|
||||
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- Constructor return value(s) -->
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
A newly created Image component
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
<!-- 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="checkRequirements"><!-- --></A>
|
||||
<H3>checkRequirements</H3>
|
||||
<PRE>String <B>checkRequirements</B>(<Object> reqData)</PRE>
|
||||
|
||||
<UL>Validates an image upload by making sure it's there (if REQUIRE is set),
|
||||
checking the file size, the content type and by trying to construct an image.
|
||||
If the file is an image, width and height limitations set by require are
|
||||
checked.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>reqData</CODE> - request data
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- 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.Hidden.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.Form.Component.Input.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.Image.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>
|
||||
1258
modules/jala/docs/jala.Form.Component.Input.html
Normal file
1258
modules/jala/docs/jala.Form.Component.Input.html
Normal file
File diff suppressed because it is too large
Load diff
362
modules/jala/docs/jala.Form.Component.Password.html
Normal file
362
modules/jala/docs/jala.Form.Component.Password.html
Normal file
|
|
@ -0,0 +1,362 @@
|
|||
<!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.Password
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title="jala.Form.Component.Password";
|
||||
}
|
||||
</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.Input.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.Form.Component.Radio.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.Password.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.Password</H2>
|
||||
<PRE>Object
|
||||
|
|
||||
+--<a href='jala.Form.Component.Input.html'>jala.Form.Component.Input</a>
|
||||
|
|
||||
+--<b>jala.Form.Component.Password</b>
|
||||
</PRE>
|
||||
|
||||
|
||||
<HR>
|
||||
<DL>
|
||||
<!-- Class definition -->
|
||||
<DT>class
|
||||
<B>jala.Form.Component.Password</B>
|
||||
|
||||
<DT>extends <a href='jala.Form.Component.Input.html'>jala.Form.Component.Input</a>
|
||||
|
||||
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<BR/>Subclass of jala.Form.Component.Input which renders and validates a
|
||||
password input tag.
|
||||
<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.Password.html#jala.Form.Component.Password()">jala.Form.Component.Password</A>
|
||||
</B>
|
||||
(<String> name)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Constructs a newly created Password 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> void</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#renderControls">renderControls</A></B>(<Object> attr, <Object> value, <Object> reqData)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Renders a password input tag to the response.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
|
||||
</TABLE>
|
||||
|
||||
|
||||
|
||||
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TD><B>Methods inherited from class <a href="jala.Form.Component.Input.html">jala.Form.Component.Input</a></B></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>
|
||||
<!-- Inherited methods -->
|
||||
<a href="jala.Form.Component.Input.html#validate">validate</a>, <a href="jala.Form.Component.Input.html#save">save</a>, <a href="jala.Form.Component.Input.html#getValue">getValue</a>, <a href="jala.Form.Component.Input.html#setValue">setValue</a>, <a href="jala.Form.Component.Input.html#render">render</a>, <a href="jala.Form.Component.Input.html#renderError">renderError</a>, <a href="jala.Form.Component.Input.html#renderLabel">renderLabel</a>, <a href="jala.Form.Component.Input.html#renderHelp">renderHelp</a>, <a href="jala.Form.Component.Input.html#render_macro">render_macro</a>, <a href="jala.Form.Component.Input.html#controls_macro">controls_macro</a>, <a href="jala.Form.Component.Input.html#error_macro">error_macro</a>, <a href="jala.Form.Component.Input.html#label_macro">label_macro</a>, <a href="jala.Form.Component.Input.html#help_macro">help_macro</a>, <a href="jala.Form.Component.Input.html#id_macro">id_macro</a>, <a href="jala.Form.Component.Input.html#name_macro">name_macro</a>, <a href="jala.Form.Component.Input.html#type_macro">type_macro</a>, <a href="jala.Form.Component.Input.html#class_macro">class_macro</a>, <a href="jala.Form.Component.Input.html#getControlAttributes">getControlAttributes</a>, <a href="jala.Form.Component.Input.html#checkLength">checkLength</a>, <a href="jala.Form.Component.Input.html#checkRequirements">checkRequirements</a>, <a href="jala.Form.Component.Input.html#parseValue">parseValue</a>
|
||||
</CODE></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.Password()"><!-- --></A><H3>
|
||||
jala.Form.Component.Password</H3>
|
||||
<PRE><B>jala.Form.Component.Password</B>(<String> name)</PRE>
|
||||
|
||||
|
||||
<UL>
|
||||
Constructs a newly created Password component instance
|
||||
</UL>
|
||||
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>name</CODE> - Name of the component, used as name of the html controls.
|
||||
</UL>
|
||||
|
||||
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- Constructor return value(s) -->
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
A newly created Password component instance
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
<!-- 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="renderControls"><!-- --></A>
|
||||
<H3>renderControls</H3>
|
||||
<PRE>void <B>renderControls</B>(<Object> attr, <Object> value, <Object> reqData)</PRE>
|
||||
|
||||
<UL>Renders a password input tag to the response.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>attr</CODE> - Basic attributes for this element.
|
||||
</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>
|
||||
|
||||
|
||||
|
||||
<!-- ============ 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.Input.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.Form.Component.Radio.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.Password.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>
|
||||
431
modules/jala/docs/jala.Form.Component.Radio.html
Normal file
431
modules/jala/docs/jala.Form.Component.Radio.html
Normal file
|
|
@ -0,0 +1,431 @@
|
|||
<!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.Radio
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title="jala.Form.Component.Radio";
|
||||
}
|
||||
</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.Password.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.Form.Component.Select.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.Radio.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.Radio</H2>
|
||||
<PRE>Object
|
||||
|
|
||||
+--<a href='jala.Form.Component.Input.html'>jala.Form.Component.Input</a>
|
||||
|
|
||||
+--<a href='jala.Form.Component.Select.html'>jala.Form.Component.Select</a>
|
||||
|
|
||||
+--<b>jala.Form.Component.Radio</b>
|
||||
</PRE>
|
||||
|
||||
|
||||
<HR>
|
||||
<DL>
|
||||
<!-- Class definition -->
|
||||
<DT>class
|
||||
<B>jala.Form.Component.Radio</B>
|
||||
|
||||
<DT>extends <a href='jala.Form.Component.Select.html'>jala.Form.Component.Select</a>
|
||||
|
||||
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<BR/>Subclass of jala.Form.Component.Input which renders and validates a
|
||||
set of radio buttons.
|
||||
<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.Radio.html#jala.Form.Component.Radio()">jala.Form.Component.Radio</A>
|
||||
</B>
|
||||
(<String> name)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Creates a new Radio 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="#checkRequirements">checkRequirements</A></B>(<Object> reqData)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Validates user input from a set of radio buttons and makes sure that
|
||||
option value list contains the user input.
|
||||
</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)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Renders a set of radio buttons to the response.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
|
||||
</TABLE>
|
||||
|
||||
|
||||
|
||||
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TD><B>Methods inherited from class <a href="jala.Form.Component.Select.html">jala.Form.Component.Select</a></B></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>
|
||||
<!-- Inherited methods -->
|
||||
<a href="jala.Form.Component.Select.html#parseOptions">parseOptions</a>, <a href="jala.Form.Component.Select.html#checkOptions">checkOptions</a>
|
||||
</CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
|
||||
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TD><B>Methods inherited from class <a href="jala.Form.Component.Input.html">jala.Form.Component.Input</a></B></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>
|
||||
<!-- Inherited methods -->
|
||||
<a href="jala.Form.Component.Input.html#validate">validate</a>, <a href="jala.Form.Component.Input.html#save">save</a>, <a href="jala.Form.Component.Input.html#getValue">getValue</a>, <a href="jala.Form.Component.Input.html#setValue">setValue</a>, <a href="jala.Form.Component.Input.html#render">render</a>, <a href="jala.Form.Component.Input.html#renderError">renderError</a>, <a href="jala.Form.Component.Input.html#renderLabel">renderLabel</a>, <a href="jala.Form.Component.Input.html#renderHelp">renderHelp</a>, <a href="jala.Form.Component.Input.html#render_macro">render_macro</a>, <a href="jala.Form.Component.Input.html#controls_macro">controls_macro</a>, <a href="jala.Form.Component.Input.html#error_macro">error_macro</a>, <a href="jala.Form.Component.Input.html#label_macro">label_macro</a>, <a href="jala.Form.Component.Input.html#help_macro">help_macro</a>, <a href="jala.Form.Component.Input.html#id_macro">id_macro</a>, <a href="jala.Form.Component.Input.html#name_macro">name_macro</a>, <a href="jala.Form.Component.Input.html#type_macro">type_macro</a>, <a href="jala.Form.Component.Input.html#class_macro">class_macro</a>, <a href="jala.Form.Component.Input.html#getControlAttributes">getControlAttributes</a>, <a href="jala.Form.Component.Input.html#checkLength">checkLength</a>, <a href="jala.Form.Component.Input.html#parseValue">parseValue</a>
|
||||
</CODE></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.Radio()"><!-- --></A><H3>
|
||||
jala.Form.Component.Radio</H3>
|
||||
<PRE><B>jala.Form.Component.Radio</B>(<String> name)</PRE>
|
||||
|
||||
|
||||
<UL>
|
||||
Creates a new Radio component instance
|
||||
</UL>
|
||||
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>name</CODE> - Name of the component, used as name of the html controls.
|
||||
</UL>
|
||||
|
||||
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- Constructor return value(s) -->
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
A newly created Radio component
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
<!-- 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="checkRequirements"><!-- --></A>
|
||||
<H3>checkRequirements</H3>
|
||||
<PRE>String <B>checkRequirements</B>(<Object> reqData)</PRE>
|
||||
|
||||
<UL>Validates user input from a set of radio buttons and makes sure that
|
||||
option value list contains the user input.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>reqData</CODE> - request data
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
null if everything is ok or string containing error message
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<UL>
|
||||
<B>See:</B><UL>- <a href="jala.Form.Component.Select.html#checkOptions">jala.Form.Component.Select.checkOptions()</a></UL>
|
||||
</UL>
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="renderControls"><!-- --></A>
|
||||
<H3>renderControls</H3>
|
||||
<PRE>void <B>renderControls</B>(<Object> attr, <Object> value)</PRE>
|
||||
|
||||
<UL>Renders a set of radio buttons to the response.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>attr</CODE> - Basic attributes for this element.
|
||||
</UL>
|
||||
|
||||
<UL><CODE>value</CODE> - Value to be used for rendering this element.
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- 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.Password.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.Form.Component.Select.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.Radio.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>
|
||||
524
modules/jala/docs/jala.Form.Component.Select.html
Normal file
524
modules/jala/docs/jala.Form.Component.Select.html
Normal file
|
|
@ -0,0 +1,524 @@
|
|||
<!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.Select
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title="jala.Form.Component.Select";
|
||||
}
|
||||
</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.Radio.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.Form.Component.Skin.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.Select.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.Select</H2>
|
||||
<PRE>Object
|
||||
|
|
||||
+--<a href='jala.Form.Component.Input.html'>jala.Form.Component.Input</a>
|
||||
|
|
||||
+--<b>jala.Form.Component.Select</b>
|
||||
</PRE>
|
||||
|
||||
<DL>
|
||||
<DT>
|
||||
<B>Direct Known Subclasses:</B>
|
||||
<DD>
|
||||
<a href="jala.Form.Component.Radio.html">jala.Form.Component.Radio</a>
|
||||
</DD>
|
||||
</DL>
|
||||
|
||||
|
||||
<HR>
|
||||
<DL>
|
||||
<!-- Class definition -->
|
||||
<DT>class
|
||||
<B>jala.Form.Component.Select</B>
|
||||
|
||||
<DT>extends <a href='jala.Form.Component.Input.html'>jala.Form.Component.Input</a>
|
||||
|
||||
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<BR/>Subclass of jala.Form.Component.Input which renders and validates a
|
||||
dropdown element.
|
||||
<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.Select.html#jala.Form.Component.Select()">jala.Form.Component.Select</A>
|
||||
</B>
|
||||
(<String> name)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Constructs a new Select 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="#checkOptions">checkOptions</A></B>(<Object> reqData)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Checks user input for optiongroups: Unless require("checkoptions")
|
||||
has ben set to false, the user input must exist in the option array.
|
||||
</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>
|
||||
|
||||
Validates user input from a dropdown element by making sure that
|
||||
the option value list contains the user input.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> Array</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#parseOptions">parseOptions</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Creates an array of options for a dropdown element or a
|
||||
group of radiobuttons.
|
||||
</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 a dropdown element to the response.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
|
||||
</TABLE>
|
||||
|
||||
|
||||
|
||||
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TD><B>Methods inherited from class <a href="jala.Form.Component.Input.html">jala.Form.Component.Input</a></B></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>
|
||||
<!-- Inherited methods -->
|
||||
<a href="jala.Form.Component.Input.html#validate">validate</a>, <a href="jala.Form.Component.Input.html#save">save</a>, <a href="jala.Form.Component.Input.html#getValue">getValue</a>, <a href="jala.Form.Component.Input.html#setValue">setValue</a>, <a href="jala.Form.Component.Input.html#render">render</a>, <a href="jala.Form.Component.Input.html#renderError">renderError</a>, <a href="jala.Form.Component.Input.html#renderLabel">renderLabel</a>, <a href="jala.Form.Component.Input.html#renderHelp">renderHelp</a>, <a href="jala.Form.Component.Input.html#render_macro">render_macro</a>, <a href="jala.Form.Component.Input.html#controls_macro">controls_macro</a>, <a href="jala.Form.Component.Input.html#error_macro">error_macro</a>, <a href="jala.Form.Component.Input.html#label_macro">label_macro</a>, <a href="jala.Form.Component.Input.html#help_macro">help_macro</a>, <a href="jala.Form.Component.Input.html#id_macro">id_macro</a>, <a href="jala.Form.Component.Input.html#name_macro">name_macro</a>, <a href="jala.Form.Component.Input.html#type_macro">type_macro</a>, <a href="jala.Form.Component.Input.html#class_macro">class_macro</a>, <a href="jala.Form.Component.Input.html#getControlAttributes">getControlAttributes</a>, <a href="jala.Form.Component.Input.html#checkLength">checkLength</a>, <a href="jala.Form.Component.Input.html#parseValue">parseValue</a>
|
||||
</CODE></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.Select()"><!-- --></A><H3>
|
||||
jala.Form.Component.Select</H3>
|
||||
<PRE><B>jala.Form.Component.Select</B>(<String> name)</PRE>
|
||||
|
||||
|
||||
<UL>
|
||||
Constructs a new Select component instance
|
||||
</UL>
|
||||
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>name</CODE> - Name of the component, used as name of the html controls.
|
||||
</UL>
|
||||
|
||||
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- Constructor return value(s) -->
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
A newly created Select component
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
<!-- 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="checkOptions"><!-- --></A>
|
||||
<H3>checkOptions</H3>
|
||||
<PRE>String <B>checkOptions</B>(<Object> reqData)</PRE>
|
||||
|
||||
<UL>Checks user input for optiongroups: Unless require("checkoptions")
|
||||
has ben set to false, the user input must exist in the option array.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>reqData</CODE> - request data
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
null if everything is ok or string containing error message
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="checkRequirements"><!-- --></A>
|
||||
<H3>checkRequirements</H3>
|
||||
<PRE>String <B>checkRequirements</B>(<Object> reqData)</PRE>
|
||||
|
||||
<UL>Validates user input from a dropdown element by making sure that
|
||||
the option value list contains the user input.</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="jala.Form.Component.Select.html#checkOptions">jala.Form.Component.Select.checkOptions()</a></UL>
|
||||
</UL>
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="parseOptions"><!-- --></A>
|
||||
<H3>parseOptions</H3>
|
||||
<PRE>Array <B>parseOptions</B>()</PRE>
|
||||
|
||||
<UL>Creates an array of options for a dropdown element or a
|
||||
group of radiobuttons. If options field of this element's
|
||||
config is an array, that array is returned.
|
||||
If options is a function, its return value is returned.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
array of options
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- 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 a dropdown element to the response.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>attr</CODE> - Basic attributes for this element.
|
||||
</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>
|
||||
|
||||
|
||||
|
||||
<!-- ============ 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.Radio.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.Form.Component.Skin.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.Select.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>
|
||||
344
modules/jala/docs/jala.Form.Component.Skin.html
Normal file
344
modules/jala/docs/jala.Form.Component.Skin.html
Normal file
|
|
@ -0,0 +1,344 @@
|
|||
<!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.Skin
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title="jala.Form.Component.Skin";
|
||||
}
|
||||
</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.Select.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.Form.Component.Submit.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.Skin.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.Skin</H2>
|
||||
<PRE>Object
|
||||
|
|
||||
+--<a href='jala.Form.Component.html'>jala.Form.Component</a>
|
||||
|
|
||||
+--<b>jala.Form.Component.Skin</b>
|
||||
</PRE>
|
||||
|
||||
|
||||
<HR>
|
||||
<DL>
|
||||
<!-- Class definition -->
|
||||
<DT>class
|
||||
<B>jala.Form.Component.Skin</B>
|
||||
|
||||
<DT>extends <a href='jala.Form.Component.html'>jala.Form.Component</a>
|
||||
|
||||
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<BR/>Subclass of jala.Form.Component that allows rendering a skin
|
||||
within a form.
|
||||
<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.Skin.html#jala.Form.Component.Skin()">jala.Form.Component.Skin</A>
|
||||
</B>
|
||||
(<String> name)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
|
||||
</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> void</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#render">render</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Renders the skin named by this component to the response.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
|
||||
</TABLE>
|
||||
|
||||
|
||||
|
||||
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TD><B>Methods inherited from class <a href="jala.Form.Component.html">jala.Form.Component</a></B></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>
|
||||
<!-- Inherited methods -->
|
||||
<a href="jala.Form.Component.html#createDomId">createDomId</a>, <a href="jala.Form.Component.html#validate">validate</a>, <a href="jala.Form.Component.html#save">save</a>
|
||||
</CODE></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.Skin()"><!-- --></A><H3>
|
||||
jala.Form.Component.Skin</H3>
|
||||
<PRE><B>jala.Form.Component.Skin</B>(<String> name)</PRE>
|
||||
|
||||
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>name</CODE> - The name of the component, used as the name of the skin
|
||||
</UL>
|
||||
|
||||
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- Constructor return value(s) -->
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
A newly created Skin component instance
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
<!-- 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="render"><!-- --></A>
|
||||
<H3>render</H3>
|
||||
<PRE>void <B>render</B>()</PRE>
|
||||
|
||||
<UL>Renders the skin named by this component to the response.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- 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.Select.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.Form.Component.Submit.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.Skin.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>
|
||||
370
modules/jala/docs/jala.Form.Component.Submit.html
Normal file
370
modules/jala/docs/jala.Form.Component.Submit.html
Normal file
|
|
@ -0,0 +1,370 @@
|
|||
<!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.Submit
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title="jala.Form.Component.Submit";
|
||||
}
|
||||
</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.Skin.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.Form.Component.Textarea.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.Submit.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.Submit</H2>
|
||||
<PRE>Object
|
||||
|
|
||||
+--<a href='jala.Form.Component.Input.html'>jala.Form.Component.Input</a>
|
||||
|
|
||||
+--<a href='jala.Form.Component.Button.html'>jala.Form.Component.Button</a>
|
||||
|
|
||||
+--<b>jala.Form.Component.Submit</b>
|
||||
</PRE>
|
||||
|
||||
|
||||
<HR>
|
||||
<DL>
|
||||
<!-- Class definition -->
|
||||
<DT>class
|
||||
<B>jala.Form.Component.Submit</B>
|
||||
|
||||
<DT>extends <a href='jala.Form.Component.Button.html'>jala.Form.Component.Button</a>
|
||||
|
||||
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<BR/>Subclass of jala.Form.Component.Button which renders a submit button.
|
||||
<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.Submit.html#jala.Form.Component.Submit()">jala.Form.Component.Submit</A>
|
||||
</B>
|
||||
(<String> name)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Creates a new Submit 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> Object</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#renderControls">renderControls</A></B>(attr, value)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Creates a new attribute object for this button.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
|
||||
</TABLE>
|
||||
|
||||
|
||||
|
||||
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TD><B>Methods inherited from class <a href="jala.Form.Component.Button.html">jala.Form.Component.Button</a></B></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>
|
||||
<!-- Inherited methods -->
|
||||
<a href="jala.Form.Component.Button.html#render">render</a>
|
||||
</CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
|
||||
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TD><B>Methods inherited from class <a href="jala.Form.Component.Input.html">jala.Form.Component.Input</a></B></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>
|
||||
<!-- Inherited methods -->
|
||||
<a href="jala.Form.Component.Input.html#validate">validate</a>, <a href="jala.Form.Component.Input.html#save">save</a>, <a href="jala.Form.Component.Input.html#getValue">getValue</a>, <a href="jala.Form.Component.Input.html#setValue">setValue</a>, <a href="jala.Form.Component.Input.html#renderError">renderError</a>, <a href="jala.Form.Component.Input.html#renderLabel">renderLabel</a>, <a href="jala.Form.Component.Input.html#renderHelp">renderHelp</a>, <a href="jala.Form.Component.Input.html#render_macro">render_macro</a>, <a href="jala.Form.Component.Input.html#controls_macro">controls_macro</a>, <a href="jala.Form.Component.Input.html#error_macro">error_macro</a>, <a href="jala.Form.Component.Input.html#label_macro">label_macro</a>, <a href="jala.Form.Component.Input.html#help_macro">help_macro</a>, <a href="jala.Form.Component.Input.html#id_macro">id_macro</a>, <a href="jala.Form.Component.Input.html#name_macro">name_macro</a>, <a href="jala.Form.Component.Input.html#type_macro">type_macro</a>, <a href="jala.Form.Component.Input.html#class_macro">class_macro</a>, <a href="jala.Form.Component.Input.html#getControlAttributes">getControlAttributes</a>, <a href="jala.Form.Component.Input.html#checkLength">checkLength</a>, <a href="jala.Form.Component.Input.html#checkRequirements">checkRequirements</a>, <a href="jala.Form.Component.Input.html#parseValue">parseValue</a>
|
||||
</CODE></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.Submit()"><!-- --></A><H3>
|
||||
jala.Form.Component.Submit</H3>
|
||||
<PRE><B>jala.Form.Component.Submit</B>(<String> name)</PRE>
|
||||
|
||||
|
||||
<UL>
|
||||
Creates a new Submit component instance
|
||||
</UL>
|
||||
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>name</CODE> - Name of the component, used as name of the html controls.
|
||||
</UL>
|
||||
|
||||
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- Constructor return value(s) -->
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
A newly created Submit component
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
<!-- 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="renderControls"><!-- --></A>
|
||||
<H3>renderControls</H3>
|
||||
<PRE>Object <B>renderControls</B>(attr, value)</PRE>
|
||||
|
||||
<UL>Creates a new attribute object for this button.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
Object with all attributes set for this button.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- 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.Skin.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.Form.Component.Textarea.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.Submit.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>
|
||||
362
modules/jala/docs/jala.Form.Component.Textarea.html
Normal file
362
modules/jala/docs/jala.Form.Component.Textarea.html
Normal file
|
|
@ -0,0 +1,362 @@
|
|||
<!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.Textarea
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title="jala.Form.Component.Textarea";
|
||||
}
|
||||
</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.Submit.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.Form.Tracker.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.Textarea.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.Textarea</H2>
|
||||
<PRE>Object
|
||||
|
|
||||
+--<a href='jala.Form.Component.Input.html'>jala.Form.Component.Input</a>
|
||||
|
|
||||
+--<b>jala.Form.Component.Textarea</b>
|
||||
</PRE>
|
||||
|
||||
|
||||
<HR>
|
||||
<DL>
|
||||
<!-- Class definition -->
|
||||
<DT>class
|
||||
<B>jala.Form.Component.Textarea</B>
|
||||
|
||||
<DT>extends <a href='jala.Form.Component.Input.html'>jala.Form.Component.Input</a>
|
||||
|
||||
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<BR/>Subclass of jala.Form.Component.Input which renders and validates a
|
||||
textarea 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.Textarea.html#jala.Form.Component.Textarea()">jala.Form.Component.Textarea</A>
|
||||
</B>
|
||||
(<String> name)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Constructs a new Textarea component.
|
||||
</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> void</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#renderControls">renderControls</A></B>(<Object> attr, <Object> value, <Object> reqData)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Renders a textarea input field to the response.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
|
||||
</TABLE>
|
||||
|
||||
|
||||
|
||||
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TD><B>Methods inherited from class <a href="jala.Form.Component.Input.html">jala.Form.Component.Input</a></B></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>
|
||||
<!-- Inherited methods -->
|
||||
<a href="jala.Form.Component.Input.html#validate">validate</a>, <a href="jala.Form.Component.Input.html#save">save</a>, <a href="jala.Form.Component.Input.html#getValue">getValue</a>, <a href="jala.Form.Component.Input.html#setValue">setValue</a>, <a href="jala.Form.Component.Input.html#render">render</a>, <a href="jala.Form.Component.Input.html#renderError">renderError</a>, <a href="jala.Form.Component.Input.html#renderLabel">renderLabel</a>, <a href="jala.Form.Component.Input.html#renderHelp">renderHelp</a>, <a href="jala.Form.Component.Input.html#render_macro">render_macro</a>, <a href="jala.Form.Component.Input.html#controls_macro">controls_macro</a>, <a href="jala.Form.Component.Input.html#error_macro">error_macro</a>, <a href="jala.Form.Component.Input.html#label_macro">label_macro</a>, <a href="jala.Form.Component.Input.html#help_macro">help_macro</a>, <a href="jala.Form.Component.Input.html#id_macro">id_macro</a>, <a href="jala.Form.Component.Input.html#name_macro">name_macro</a>, <a href="jala.Form.Component.Input.html#type_macro">type_macro</a>, <a href="jala.Form.Component.Input.html#class_macro">class_macro</a>, <a href="jala.Form.Component.Input.html#getControlAttributes">getControlAttributes</a>, <a href="jala.Form.Component.Input.html#checkLength">checkLength</a>, <a href="jala.Form.Component.Input.html#checkRequirements">checkRequirements</a>, <a href="jala.Form.Component.Input.html#parseValue">parseValue</a>
|
||||
</CODE></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.Textarea()"><!-- --></A><H3>
|
||||
jala.Form.Component.Textarea</H3>
|
||||
<PRE><B>jala.Form.Component.Textarea</B>(<String> name)</PRE>
|
||||
|
||||
|
||||
<UL>
|
||||
Constructs a new Textarea component.
|
||||
</UL>
|
||||
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>name</CODE> - Name of the component, used as name of the html controls.
|
||||
</UL>
|
||||
|
||||
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- Constructor return value(s) -->
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
A newly created Textarea component instance
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
<!-- 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="renderControls"><!-- --></A>
|
||||
<H3>renderControls</H3>
|
||||
<PRE>void <B>renderControls</B>(<Object> attr, <Object> value, <Object> reqData)</PRE>
|
||||
|
||||
<UL>Renders a textarea input field to the response.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>attr</CODE> - Basic attributes for this element.
|
||||
</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>
|
||||
|
||||
|
||||
|
||||
<!-- ============ 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.Submit.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.Form.Tracker.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.Textarea.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>
|
||||
550
modules/jala/docs/jala.Form.Component.html
Normal file
550
modules/jala/docs/jala.Form.Component.html
Normal file
|
|
@ -0,0 +1,550 @@
|
|||
<!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
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title="jala.Form.Component";
|
||||
}
|
||||
</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.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.Form.Component.Button.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.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</H2>
|
||||
<PRE>Object
|
||||
|
|
||||
+--<b>jala.Form.Component</b>
|
||||
</PRE>
|
||||
|
||||
<DL>
|
||||
<DT>
|
||||
<B>Direct Known Subclasses:</B>
|
||||
<DD>
|
||||
<a href="jala.Form.Component.Skin.html">jala.Form.Component.Skin</a>
|
||||
</DD>
|
||||
</DL>
|
||||
|
||||
|
||||
<HR>
|
||||
<DL>
|
||||
<!-- Class definition -->
|
||||
<DT>class
|
||||
<B>jala.Form.Component</B>
|
||||
|
||||
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<I>Defined in <a href='overview-summary-Form.js.html'>Form.js</a></I><BR/><BR/>
|
||||
</P>
|
||||
|
||||
<HR>
|
||||
|
||||
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
||||
|
||||
<A NAME="inner_classes"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=2><FONT SIZE="+2">
|
||||
<B>Nested Class Summary</B></FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static class></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="jala.Form.Component.Fieldset.html">jala.Form.Component.Fieldset</A></B></CODE></TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static class></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="jala.Form.Component.Skin.html">jala.Form.Component.Skin</A></B></CODE></TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static class></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="jala.Form.Component.Input.html">jala.Form.Component.Input</A></B></CODE></TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static class></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="jala.Form.Component.Password.html">jala.Form.Component.Password</A></B></CODE></TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static class></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="jala.Form.Component.Hidden.html">jala.Form.Component.Hidden</A></B></CODE></TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static class></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="jala.Form.Component.Textarea.html">jala.Form.Component.Textarea</A></B></CODE></TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static class></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="jala.Form.Component.Date.html">jala.Form.Component.Date</A></B></CODE></TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static class></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="jala.Form.Component.Select.html">jala.Form.Component.Select</A></B></CODE></TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static class></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="jala.Form.Component.Radio.html">jala.Form.Component.Radio</A></B></CODE></TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static class></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="jala.Form.Component.Checkbox.html">jala.Form.Component.Checkbox</A></B></CODE></TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static class></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="jala.Form.Component.File.html">jala.Form.Component.File</A></B></CODE></TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static class></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="jala.Form.Component.Image.html">jala.Form.Component.Image</A></B></CODE></TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static class></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="jala.Form.Component.Button.html">jala.Form.Component.Button</A></B></CODE></TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static class></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="jala.Form.Component.Submit.html">jala.Form.Component.Submit</A></B></CODE></TD>
|
||||
</TR>
|
||||
|
||||
</TABLE>
|
||||
|
||||
|
||||
<!-- ======== 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.html#jala.Form.Component()">jala.Form.Component</A>
|
||||
</B>
|
||||
(name)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
The abstract base class for all components.
|
||||
</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="#createDomId">createDomId</A></B>(<String> idPart)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Creates a DOM identifier based on the name of the form,
|
||||
the name of the component and an additional string.
|
||||
</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>
|
||||
|
||||
Function to render a 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>(destObj, val)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Function to save the data of a component.
|
||||
</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="#validate">validate</A></B>(<<a href="jala.Form.Tracker.html">jala.Form.Tracker</a>> tracker)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Function to validate a 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()"><!-- --></A><H3>
|
||||
jala.Form.Component</H3>
|
||||
<PRE><B>jala.Form.Component</B>(name)</PRE>
|
||||
|
||||
|
||||
<UL>
|
||||
The abstract base class for all components.
|
||||
</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="createDomId"><!-- --></A>
|
||||
<H3>createDomId</H3>
|
||||
<PRE>String <B>createDomId</B>(<String> idPart)</PRE>
|
||||
|
||||
<UL>Creates a DOM identifier based on the name of the form,
|
||||
the name of the component and an additional string.
|
||||
The items will be chained using camel casing.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>idPart</CODE> - Optional string appended to component's id.
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The DOM Id
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="render"><!-- --></A>
|
||||
<H3>render</H3>
|
||||
<PRE>void <B>render</B>()</PRE>
|
||||
|
||||
<UL>Function to render a component.
|
||||
Subclasses of jala.Form.Component may override this function.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="save"><!-- --></A>
|
||||
<H3>save</H3>
|
||||
<PRE>void <B>save</B>(destObj, val)</PRE>
|
||||
|
||||
<UL>Function to save the data of a component.
|
||||
Subclasses of jala.Form.Component may override this function.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="validate"><!-- --></A>
|
||||
<H3>validate</H3>
|
||||
<PRE>Object <B>validate</B>(<<a href="jala.Form.Tracker.html">jala.Form.Tracker</a>> tracker)</PRE>
|
||||
|
||||
<UL>Function to validate a component.
|
||||
Subclasses of jala.Form.Component may override this function.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>tracker</CODE> - object tracking errors and holding parsed values and request data.
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- 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.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.Form.Component.Button.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.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>
|
||||
441
modules/jala/docs/jala.Form.Tracker.html
Normal file
441
modules/jala/docs/jala.Form.Tracker.html
Normal file
|
|
@ -0,0 +1,441 @@
|
|||
<!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.Tracker
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title="jala.Form.Tracker";
|
||||
}
|
||||
</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.Textarea.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.History.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.Tracker.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.Tracker</H2>
|
||||
<PRE>Object
|
||||
|
|
||||
+--<b>jala.Form.Tracker</b>
|
||||
</PRE>
|
||||
|
||||
|
||||
<HR>
|
||||
<DL>
|
||||
<!-- Class definition -->
|
||||
<DT>class
|
||||
<B>jala.Form.Tracker</B>
|
||||
|
||||
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<BR/>Instances of this class can contain error-messages and values
|
||||
<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 =========== -->
|
||||
|
||||
<A NAME="field_summary"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=2><FONT SIZE="+2">
|
||||
<B>Field Summary</B></FONT></TD>
|
||||
</TR>
|
||||
|
||||
<!-- This is one instance field summary -->
|
||||
|
||||
<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="#errors">errors</A></B></CODE>
|
||||
<BR>
|
||||
A map containing error messages</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="#reqData">reqData</A></B></CODE>
|
||||
<BR>
|
||||
A map containing input from request data</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="#values">values</A></B></CODE>
|
||||
<BR>
|
||||
A map containing parsed values (only for those fields that didn't
|
||||
fail during checkRequirements method).</TD>
|
||||
</TR>
|
||||
|
||||
|
||||
</TABLE>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- =========== 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.Tracker.html#jala.Form.Tracker()">jala.Form.Tracker</A>
|
||||
</B>
|
||||
(reqData)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
A generic container for error-messages and values
|
||||
</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> Number</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#countErrors">countErrors</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns the number of components for which this instance has
|
||||
tracked an error.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> Boolean</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#hasError">hasError</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns true if an error has been set for at least one component.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
|
||||
</TABLE>
|
||||
|
||||
|
||||
|
||||
<P>
|
||||
<!-- ========== END METHOD SUMMARY =========== -->
|
||||
|
||||
|
||||
<!-- ============ FIELD DETAIL START =========== -->
|
||||
|
||||
<A NAME="field_detail"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=1><FONT SIZE="+2"><B>Field Detail</B></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
|
||||
<A NAME="errors"><!-- --></A>
|
||||
<H3>errors</H3>
|
||||
<PRE>Object <B>errors</B></PRE>
|
||||
<UL>
|
||||
A map containing error messages
|
||||
|
||||
</UL>
|
||||
<HR>
|
||||
|
||||
<A NAME="reqData"><!-- --></A>
|
||||
<H3>reqData</H3>
|
||||
<PRE>Object <B>reqData</B></PRE>
|
||||
<UL>
|
||||
A map containing input from request data
|
||||
|
||||
</UL>
|
||||
<HR>
|
||||
|
||||
<A NAME="values"><!-- --></A>
|
||||
<H3>values</H3>
|
||||
<PRE>Object <B>values</B></PRE>
|
||||
<UL>
|
||||
A map containing parsed values (only for those fields that didn't
|
||||
fail during checkRequirements method).
|
||||
|
||||
</UL>
|
||||
<HR>
|
||||
|
||||
|
||||
|
||||
<!-- ============ 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.Tracker()"><!-- --></A><H3>
|
||||
jala.Form.Tracker</H3>
|
||||
<PRE><B>jala.Form.Tracker</B>(reqData)</PRE>
|
||||
|
||||
|
||||
<UL>
|
||||
A generic container for error-messages and values
|
||||
</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="countErrors"><!-- --></A>
|
||||
<H3>countErrors</H3>
|
||||
<PRE>Number <B>countErrors</B>()</PRE>
|
||||
|
||||
<UL>Returns the number of components for which this instance has
|
||||
tracked an error.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
Number of components that did not validate.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="hasError"><!-- --></A>
|
||||
<H3>hasError</H3>
|
||||
<PRE>Boolean <B>hasError</B>()</PRE>
|
||||
|
||||
<UL>Returns true if an error has been set for at least one component.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
true if form encountered an error.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- 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.Textarea.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.History.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.Tracker.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>
|
||||
2034
modules/jala/docs/jala.Form.html
Normal file
2034
modules/jala/docs/jala.Form.html
Normal file
File diff suppressed because it is too large
Load diff
635
modules/jala/docs/jala.History.html
Normal file
635
modules/jala/docs/jala.History.html
Normal file
|
|
@ -0,0 +1,635 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
jala.History
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title="jala.History";
|
||||
}
|
||||
</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-History.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.Tracker.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.HtmlDocument.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.History.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.History</H2>
|
||||
<PRE>Object
|
||||
|
|
||||
+--<b>jala.History</b>
|
||||
</PRE>
|
||||
|
||||
|
||||
<HR>
|
||||
<DL>
|
||||
<!-- Class definition -->
|
||||
<DT>class
|
||||
<B>jala.History</B>
|
||||
|
||||
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<BR/>This class is an implementation of a Browser-like history
|
||||
stack suitable to use in any Helma application. The difference
|
||||
to a Browser's history is that this implementation ignores
|
||||
POST requests and checks if Urls in the stack are still valid to
|
||||
prevent eg. redirections to a HopObject's url that has been deleted.
|
||||
Plus it is capable to create new "intermediate" history-stacks
|
||||
and this way maintain a "history of histories" which is needed for
|
||||
eg. editing sessions in a popup window that should use their own
|
||||
request history without interfering with the history of the
|
||||
main window.
|
||||
<BR/><I>Defined in <a href='overview-summary-History.js.html'>History.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.History.html#jala.History()">jala.History</A>
|
||||
</B>
|
||||
()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Constructs a new History object.
|
||||
</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> void</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#add">add</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Initializes a new history stack, adds
|
||||
it to the array of stacks (which makes it
|
||||
the default one to use for further requests)
|
||||
and records the current request Url.
|
||||
</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="#clear">clear</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Clears the currently active history stack
|
||||
</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="#dump">dump</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns the contents of all history stacks
|
||||
as 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="#peek">peek</A></B>(<Number> offset)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Retrieves the request Url at the given position
|
||||
in the current history stack.
|
||||
</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="#pop">pop</A></B>(<Number> offset)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Retrieves the first valid request Url in history
|
||||
stack starting with a given offset.
|
||||
</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="#push">push</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Records a request Url in the currently active
|
||||
history stack.
|
||||
</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="#redirect">redirect</A></B>(<Number> offset)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Redirects the client back to the first valid
|
||||
request in history.
|
||||
</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="#remove">remove</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Removes the current history stack
|
||||
</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.History()"><!-- --></A><H3>
|
||||
jala.History</H3>
|
||||
<PRE><B>jala.History</B>()</PRE>
|
||||
|
||||
|
||||
<UL>
|
||||
Constructs a new History object.
|
||||
</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="add"><!-- --></A>
|
||||
<H3>add</H3>
|
||||
<PRE>void <B>add</B>()</PRE>
|
||||
|
||||
<UL>Initializes a new history stack, adds
|
||||
it to the array of stacks (which makes it
|
||||
the default one to use for further requests)
|
||||
and records the current request Url.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="clear"><!-- --></A>
|
||||
<H3>clear</H3>
|
||||
<PRE>void <B>clear</B>()</PRE>
|
||||
|
||||
<UL>Clears the currently active history stack</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="dump"><!-- --></A>
|
||||
<H3>dump</H3>
|
||||
<PRE>String <B>dump</B>()</PRE>
|
||||
|
||||
<UL>Returns the contents of all history stacks
|
||||
as string</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The history stacks as string
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="peek"><!-- --></A>
|
||||
<H3>peek</H3>
|
||||
<PRE>String <B>peek</B>(<Number> offset)</PRE>
|
||||
|
||||
<UL>Retrieves the request Url at the given position
|
||||
in the current history stack. If no offset is given
|
||||
the last Url in the stack is returned. This method
|
||||
<em>does not alter the stack contents</em>!</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>offset</CODE> - The index position in history stack to start searching at
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The Url of the request
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="pop"><!-- --></A>
|
||||
<H3>pop</H3>
|
||||
<PRE>String <B>pop</B>(<Number> offset)</PRE>
|
||||
|
||||
<UL>Retrieves the first valid request Url in history
|
||||
stack starting with a given offset. The default offset is 1.
|
||||
Any valid Url found is removed from the stack, therefor
|
||||
this method <em>alters the contents of the history stack</em>.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>offset</CODE> - The index position in history stack to start searching at
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The Url of the request
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="push"><!-- --></A>
|
||||
<H3>push</H3>
|
||||
<PRE>void <B>push</B>()</PRE>
|
||||
|
||||
<UL>Records a request Url in the currently active
|
||||
history stack.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="redirect"><!-- --></A>
|
||||
<H3>redirect</H3>
|
||||
<PRE>void <B>redirect</B>(<Number> offset)</PRE>
|
||||
|
||||
<UL>Redirects the client back to the first valid
|
||||
request in history. Please mind that searching for
|
||||
a valid Url starts at <em>history.length - 2</em>.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>offset</CODE> - The index position in the stack to start searching at
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="remove"><!-- --></A>
|
||||
<H3>remove</H3>
|
||||
<PRE>void <B>remove</B>()</PRE>
|
||||
|
||||
<UL>Removes the current history stack</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- 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-History.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.Tracker.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.HtmlDocument.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.History.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>
|
||||
483
modules/jala/docs/jala.HtmlDocument.html
Normal file
483
modules/jala/docs/jala.HtmlDocument.html
Normal file
|
|
@ -0,0 +1,483 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
jala.HtmlDocument
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title="jala.HtmlDocument";
|
||||
}
|
||||
</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-HtmlDocument.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.History.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.I18n.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.HtmlDocument.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.HtmlDocument</H2>
|
||||
<PRE>Object
|
||||
|
|
||||
+--<b>jala.HtmlDocument</b>
|
||||
</PRE>
|
||||
|
||||
|
||||
<HR>
|
||||
<DL>
|
||||
<!-- Class definition -->
|
||||
<DT>class
|
||||
<B>jala.HtmlDocument</B>
|
||||
|
||||
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<BR/>This class provides easy access to the elements of
|
||||
an arbitrary HTML document. By using TagSoup, Dom4J and Jaxen
|
||||
even invalid HTML can be parsed, turned into an object tree
|
||||
and easily be processed with XPath expressions.
|
||||
<BR/><I>Defined in <a href='overview-summary-HtmlDocument.js.html'>HtmlDocument.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.HtmlDocument.html#jala.HtmlDocument()">jala.HtmlDocument</A>
|
||||
</B>
|
||||
(<String> source)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Construct a new HTML document.
|
||||
</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> Array</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#getAll">getAll</A></B>(<String> elementName)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Retrieves all elements by name from the document.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> Array</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#getLinks">getLinks</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Get all link elements of the HTML document.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> org.dom4j.tree.DefaultElement</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#scrape">scrape</A></B>(<String> xpathExpr)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Get all document nodes from an XPath expression.
|
||||
</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="#toString">toString</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Get a string representation of the HTML document.
|
||||
</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.HtmlDocument()"><!-- --></A><H3>
|
||||
jala.HtmlDocument</H3>
|
||||
<PRE><B>jala.HtmlDocument</B>(<String> source)</PRE>
|
||||
|
||||
|
||||
<UL>
|
||||
Construct a new HTML document.
|
||||
</UL>
|
||||
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>source</CODE> - The HTML source code.
|
||||
</UL>
|
||||
|
||||
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- Constructor return value(s) -->
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
A new HTML document.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
<!-- 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="getAll"><!-- --></A>
|
||||
<H3>getAll</H3>
|
||||
<PRE>Array <B>getAll</B>(<String> elementName)</PRE>
|
||||
|
||||
<UL>Retrieves all elements by name from the document.
|
||||
The returned object structure is compatible for usage
|
||||
in <a href="jala.XmlWriter.html#">jala.XmlWriter</a>.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>elementName</CODE> - The name of the desired element
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The list of available elements in the document
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="getLinks"><!-- --></A>
|
||||
<H3>getLinks</H3>
|
||||
<PRE>Array <B>getLinks</B>()</PRE>
|
||||
|
||||
<UL>Get all link elements of the HTML document.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
A list of link elements.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="scrape"><!-- --></A>
|
||||
<H3>scrape</H3>
|
||||
<PRE>org.dom4j.tree.DefaultElement <B>scrape</B>(<String> xpathExpr)</PRE>
|
||||
|
||||
<UL>Get all document nodes from an XPath expression.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>xpathExpr</CODE> - An XPath expression.
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
A list of HTML elements.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="toString"><!-- --></A>
|
||||
<H3>toString</H3>
|
||||
<PRE>String <B>toString</B>()</PRE>
|
||||
|
||||
<UL>Get a string representation of the HTML document.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
A string representation of the HTML document.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- 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-HtmlDocument.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.History.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.I18n.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.HtmlDocument.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>
|
||||
951
modules/jala/docs/jala.I18n.html
Normal file
951
modules/jala/docs/jala.I18n.html
Normal file
|
|
@ -0,0 +1,951 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
jala.I18n
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title="jala.I18n";
|
||||
}
|
||||
</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-I18n.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.HtmlDocument.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.ImageFilter.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.I18n.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.I18n</H2>
|
||||
<PRE>Object
|
||||
|
|
||||
+--<b>jala.I18n</b>
|
||||
</PRE>
|
||||
|
||||
|
||||
<HR>
|
||||
<DL>
|
||||
<!-- Class definition -->
|
||||
<DT>class
|
||||
<B>jala.I18n</B>
|
||||
|
||||
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<BR/>This class provides various functions and macros for
|
||||
internationalization of Helma applications.
|
||||
<BR/><I>Defined in <a href='overview-summary-I18n.js.html'>I18n.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.I18n.html#jala.I18n()">jala.I18n</A>
|
||||
</B>
|
||||
()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Constructs a new instance of jala.I18n
|
||||
</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="#formatMessage">formatMessage</A></B>(<String> message, <Array> values)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Converts the message passed as argument into an instance
|
||||
of java.text.MessageFormat, and formats it using the
|
||||
replacement values passed.
|
||||
</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="#getCatalog">getCatalog</A></B>(locale)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Helper method to get the message catalog
|
||||
corresponding to the actual locale.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> java.util.Locale</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#getLocale">getLocale</A></B>(localeId)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns the locale for the given id, which is expected to follow
|
||||
the form <code>language[_COUNTRY][_variant]</code>, where <code>language</code>
|
||||
is a valid ISO Language Code (eg.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> Function</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#getLocaleGetter">getLocaleGetter</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Get the method for retrieving the locale.
|
||||
</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="#getMessages">getMessages</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Get the message object.
|
||||
</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="#gettext">gettext</A></B>(<String> key )
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns a localized message for the message key passed as
|
||||
argument.
|
||||
</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="#markgettext">markgettext</A></B>(<String> key)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
A simple proxy method which is used to mark a message string
|
||||
for the i18n parser as to be translated.
|
||||
</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="#message_macro">message_macro</A></B>(param)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns a translated message.
|
||||
</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="#ngettext">ngettext</A></B>(<String> singularKey, <String> pluralKey, <Number> amount )
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns a localized message for the message key passed as
|
||||
argument.
|
||||
</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="#setHandler">setHandler</A></B>(<Object> handler)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Set (overwrite) the default handler containing
|
||||
the messages (ie.
|
||||
</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="#setLocaleGetter">setLocaleGetter</A></B>(<Function> func)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Set the method for retrieving the locale.
|
||||
</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="#setMessages">setMessages</A></B>(<Object> msgObject)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Overwrite the default object containing
|
||||
the messages (ie.
|
||||
</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="#translate">translate</A></B>(singularKey, pluralKey, <Number> amount)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Tries to "translate" the given message key into a localized
|
||||
message.
|
||||
</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.I18n()"><!-- --></A><H3>
|
||||
jala.I18n</H3>
|
||||
<PRE><B>jala.I18n</B>()</PRE>
|
||||
|
||||
|
||||
<UL>
|
||||
Constructs a new instance of jala.I18n
|
||||
</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="formatMessage"><!-- --></A>
|
||||
<H3>formatMessage</H3>
|
||||
<PRE>String <B>formatMessage</B>(<String> message, <Array> values)</PRE>
|
||||
|
||||
<UL>Converts the message passed as argument into an instance
|
||||
of java.text.MessageFormat, and formats it using the
|
||||
replacement values passed.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>message</CODE> - The message to format
|
||||
</UL>
|
||||
|
||||
<UL><CODE>values</CODE> - An optional array containing replacement values
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The formatted message or, if the formatting fails, the message passed as argument.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<UL>
|
||||
<B>See:</B><UL>- http://java.sun.com/j2se/1.5.0/docs/api/java/text/MessageFormat.html</UL>
|
||||
</UL>
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="getCatalog"><!-- --></A>
|
||||
<H3>getCatalog</H3>
|
||||
<PRE>Object <B>getCatalog</B>(locale)</PRE>
|
||||
|
||||
<UL>Helper method to get the message catalog
|
||||
corresponding to the actual locale.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The message catalog.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="getLocale"><!-- --></A>
|
||||
<H3>getLocale</H3>
|
||||
<PRE>java.util.Locale <B>getLocale</B>(localeId)</PRE>
|
||||
|
||||
<UL>Returns the locale for the given id, which is expected to follow
|
||||
the form <code>language[_COUNTRY][_variant]</code>, where <code>language</code>
|
||||
is a valid ISO Language Code (eg. "de"), <code>COUNTRY</code> a valid ISO
|
||||
Country Code (eg. "AT"), and variant an identifier for the variant to use.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The locale for the given id
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="getLocaleGetter"><!-- --></A>
|
||||
<H3>getLocaleGetter</H3>
|
||||
<PRE>Function <B>getLocaleGetter</B>()</PRE>
|
||||
|
||||
<UL>Get the method for retrieving the locale.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The getter method
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="getMessages"><!-- --></A>
|
||||
<H3>getMessages</H3>
|
||||
<PRE>Object <B>getMessages</B>()</PRE>
|
||||
|
||||
<UL>Get the message object.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The object containing the messages
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="gettext"><!-- --></A>
|
||||
<H3>gettext</H3>
|
||||
<PRE>String <B>gettext</B>(<String> key )</PRE>
|
||||
|
||||
<UL>Returns a localized message for the message key passed as
|
||||
argument. If no localization is found, the message key
|
||||
is returned. Any additional arguments passed to this function
|
||||
will be used as replacement values during message rendering.
|
||||
To reference these values the message can contain placeholders
|
||||
following "{number}" notation, where <code>number</code> must
|
||||
match the number of the additional argument (starting with zero).</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>key</CODE> - The message to localize
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The translated message
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<UL>
|
||||
<B>See:</B><UL>- <a href="#translate">translate()</a><BR/>- <a href="#formatMessage">formatMessage()</a></UL>
|
||||
</UL>
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="markgettext"><!-- --></A>
|
||||
<H3>markgettext</H3>
|
||||
<PRE>String <B>markgettext</B>(<String> key)</PRE>
|
||||
|
||||
<UL>A simple proxy method which is used to mark a message string
|
||||
for the i18n parser as to be translated.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>key</CODE> - The message that should be seen by the i18n parser as to be translated.
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The message in unmodified form
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="message_macro"><!-- --></A>
|
||||
<H3>message_macro</H3>
|
||||
<PRE>String <B>message_macro</B>(param)</PRE>
|
||||
|
||||
<UL>Returns a translated message. The following macro attributes
|
||||
are accepted:
|
||||
<ul>
|
||||
<li>text: The message to translate (required)</li>
|
||||
<li>plural: The plural form of the message</li>
|
||||
<li>values: A list of replacement values. Use a comma to separate more
|
||||
than one value. Each value is either interpreted as a global property
|
||||
(if it doesn't containg a dot) or as a property name of the given macro
|
||||
handler object (eg. "user.name"). If the value of the property is a
|
||||
HopObject or an Array this macro uses the size() resp. length of the
|
||||
object, otherwise the string representation of the object will be used.</li>
|
||||
</ul></UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The translated message
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<UL>
|
||||
<B>See:</B><UL>- <a href="#gettext">gettext()</a><BR/>- <a href="#ngettext">ngettext()</a></UL>
|
||||
</UL>
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="ngettext"><!-- --></A>
|
||||
<H3>ngettext</H3>
|
||||
<PRE>String <B>ngettext</B>(<String> singularKey, <String> pluralKey, <Number> amount )</PRE>
|
||||
|
||||
<UL>Returns a localized message for the message key passed as
|
||||
argument. In contrast to gettext() this method
|
||||
can handle plural forms based on the amount passed as argument.
|
||||
If no localization is found, the appropriate message key is
|
||||
returned. Any additional arguments passed to this function
|
||||
will be used as replacement values during message rendering.
|
||||
To reference these values the message can contain placeholders
|
||||
following "{number}" notation, where <code>number</code> must
|
||||
match the number of the additional argument (starting with zero).</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>singularKey</CODE> - The singular message to localize
|
||||
</UL>
|
||||
|
||||
<UL><CODE>pluralKey</CODE> - The plural form of the message to localize
|
||||
</UL>
|
||||
|
||||
<UL><CODE>amount</CODE> - The amount which is used to determine whether the singular or plural form of the message should be returned.
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The translated message
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<UL>
|
||||
<B>See:</B><UL>- <a href="#translate">translate()</a><BR/>- <a href="#formatMessage">formatMessage()</a></UL>
|
||||
</UL>
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="setHandler"><!-- --></A>
|
||||
<H3>setHandler</H3>
|
||||
<PRE>void <B>setHandler</B>(<Object> handler)</PRE>
|
||||
|
||||
<UL>Set (overwrite) the default handler containing
|
||||
the messages (ie. a vanilla EcmaScript object).</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>handler</CODE> - The handler containing the message object
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<UL>
|
||||
<B>Deprecated</B> <I>Use <a href="#setMessages">setMessages()</a> instead </I><BR/><BR/>
|
||||
</UL>
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="setLocaleGetter"><!-- --></A>
|
||||
<H3>setLocaleGetter</H3>
|
||||
<PRE>void <B>setLocaleGetter</B>(<Function> func)</PRE>
|
||||
|
||||
<UL>Set the method for retrieving the locale.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>func</CODE> - The getter method
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="setMessages"><!-- --></A>
|
||||
<H3>setMessages</H3>
|
||||
<PRE>void <B>setMessages</B>(<Object> msgObject)</PRE>
|
||||
|
||||
<UL>Overwrite the default object containing
|
||||
the messages (ie. a vanilla EcmaScript object).</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>msgObject</CODE> - The object containing the messages
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="translate"><!-- --></A>
|
||||
<H3>translate</H3>
|
||||
<PRE>String <B>translate</B>(singularKey, pluralKey, <Number> amount)</PRE>
|
||||
|
||||
<UL>Tries to "translate" the given message key into a localized
|
||||
message.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>amount</CODE> - A number to determine whether to use the singular or plural form of the message
|
||||
</UL>
|
||||
|
||||
<UL><CODE>key</CODE> - The message to translate (required)
|
||||
</UL>
|
||||
|
||||
<UL><CODE>plural</CODE> - The plural form of the message to translate
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The localized message or the appropriate key if no localized message was found
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- 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-I18n.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.HtmlDocument.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.ImageFilter.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.I18n.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>
|
||||
510
modules/jala/docs/jala.ImageFilter.html
Normal file
510
modules/jala/docs/jala.ImageFilter.html
Normal file
|
|
@ -0,0 +1,510 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
jala.ImageFilter
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title="jala.ImageFilter";
|
||||
}
|
||||
</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-ImageFilter.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.I18n.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.IndexManager.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.ImageFilter.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.ImageFilter</H2>
|
||||
<PRE>Object
|
||||
|
|
||||
+--<b>jala.ImageFilter</b>
|
||||
</PRE>
|
||||
|
||||
|
||||
<HR>
|
||||
<DL>
|
||||
<!-- Class definition -->
|
||||
<DT>class
|
||||
<B>jala.ImageFilter</B>
|
||||
|
||||
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<BR/>This class provides several image manipulating
|
||||
methods. Most of this filter library is based on filters created
|
||||
by Janne Kipinä for JAlbum. For more information have a look
|
||||
at http://www.ratol.fi/~jakipina/java/
|
||||
<BR/><I>Defined in <a href='overview-summary-ImageFilter.js.html'>ImageFilter.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.ImageFilter.html#jala.ImageFilter()">jala.ImageFilter</A>
|
||||
</B>
|
||||
(<Object> img)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Constructs a new ImageFilter object
|
||||
</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> void</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#gaussianBlur">gaussianBlur</A></B>(<Number> radius, <Number> amount)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Performs a gaussian blur operation on the image
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> byte[]</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#getBytes">getBytes</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns the wrapped image as byte array, to use eg.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> helma.image.ImageWrapper</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#getImage">getImage</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns the image that has been worked on
|
||||
</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="#sharpen">sharpen</A></B>(<Number> amount)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Sharpens the image using a plain sharpening kernel.
|
||||
</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="#unsharpMask">unsharpMask</A></B>(<Number> radius, <Number> amount)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Performs an unsharp mask operation on the image
|
||||
</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.ImageFilter()"><!-- --></A><H3>
|
||||
jala.ImageFilter</H3>
|
||||
<PRE><B>jala.ImageFilter</B>(<Object> img)</PRE>
|
||||
|
||||
|
||||
<UL>
|
||||
Constructs a new ImageFilter object
|
||||
</UL>
|
||||
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>img</CODE> - Either <ul> <li>an instance of helma.image.ImageWrapper</li> <li>the path to the image file as String</li> <li>an instance of helma.File representing the image file</li> <li>an instance of java.io.File representing the image file</li> </ul>
|
||||
</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="gaussianBlur"><!-- --></A>
|
||||
<H3>gaussianBlur</H3>
|
||||
<PRE>void <B>gaussianBlur</B>(<Number> radius, <Number> amount)</PRE>
|
||||
|
||||
<UL>Performs a gaussian blur operation on the image</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>radius</CODE> - The radius
|
||||
</UL>
|
||||
|
||||
<UL><CODE>amount</CODE> - The amount
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="getBytes"><!-- --></A>
|
||||
<H3>getBytes</H3>
|
||||
<PRE>byte[] <B>getBytes</B>()</PRE>
|
||||
|
||||
<UL>Returns the wrapped image as byte array, to use eg. in conjunction
|
||||
with res.writeBinary()</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The wrapped image as byte array
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="getImage"><!-- --></A>
|
||||
<H3>getImage</H3>
|
||||
<PRE>helma.image.ImageWrapper <B>getImage</B>()</PRE>
|
||||
|
||||
<UL>Returns the image that has been worked on</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
An instance of helma.image.ImageWrapper
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="sharpen"><!-- --></A>
|
||||
<H3>sharpen</H3>
|
||||
<PRE>void <B>sharpen</B>(<Number> amount)</PRE>
|
||||
|
||||
<UL>Sharpens the image using a plain sharpening kernel.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>amount</CODE> - The amount of sharpening to apply
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="unsharpMask"><!-- --></A>
|
||||
<H3>unsharpMask</H3>
|
||||
<PRE>void <B>unsharpMask</B>(<Number> radius, <Number> amount)</PRE>
|
||||
|
||||
<UL>Performs an unsharp mask operation on the image</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>radius</CODE> - The radius
|
||||
</UL>
|
||||
|
||||
<UL><CODE>amount</CODE> - The amount
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- 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-ImageFilter.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.I18n.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.IndexManager.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.ImageFilter.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>
|
||||
447
modules/jala/docs/jala.IndexManager.Job.html
Normal file
447
modules/jala/docs/jala.IndexManager.Job.html
Normal file
|
|
@ -0,0 +1,447 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
jala.IndexManager.Job
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title="jala.IndexManager.Job";
|
||||
}
|
||||
</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-IndexManager.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.IndexManager.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.ListRenderer.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.IndexManager.Job.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.IndexManager.Job</H2>
|
||||
<PRE>Object
|
||||
|
|
||||
+--<b>jala.IndexManager.Job</b>
|
||||
</PRE>
|
||||
|
||||
|
||||
<HR>
|
||||
<DL>
|
||||
<!-- Class definition -->
|
||||
<DT>class
|
||||
<B>jala.IndexManager.Job</B>
|
||||
|
||||
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<BR/>Instances of this class represent a single index
|
||||
manipulation job to be processed by the index manager.
|
||||
<BR/><I>Defined in <a href='overview-summary-IndexManager.js.html'>IndexManager.js</a></I><BR/><BR/><B>See:</B><UL>- <a href="jala.IndexManager.Job.html#">jala.IndexManager.Job</a></UL>
|
||||
</P>
|
||||
|
||||
<HR>
|
||||
|
||||
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
||||
|
||||
<!-- ======== END NESTED CLASS SUMMARY ======== -->
|
||||
|
||||
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
|
||||
<A NAME="field_summary"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=2><FONT SIZE="+2">
|
||||
<B>Field Summary</B></FONT></TD>
|
||||
</TR>
|
||||
|
||||
<!-- This is one instance field summary -->
|
||||
|
||||
<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="#callback">callback</A></B></CODE>
|
||||
<BR>
|
||||
The data needed to process this job.</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> Date</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="#createtime">createtime</A></B></CODE>
|
||||
<BR>
|
||||
The date and time at which this job was created.</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> Number</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="#errors">errors</A></B></CODE>
|
||||
<BR>
|
||||
An internal error counter which is increased whenever processing
|
||||
the job failed.</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> Number</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="#type">type</A></B></CODE>
|
||||
<BR>
|
||||
The type of the job</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static> <final> Number</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="#!s!ADD">ADD</A></B></CODE>
|
||||
<BR>
|
||||
Constant defining an add job</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static> <final> Number</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="#!s!OPTIMIZE">OPTIMIZE</A></B></CODE>
|
||||
<BR>
|
||||
Constant defining an optimizing job</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static> <final> Number</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="#!s!REMOVE">REMOVE</A></B></CODE>
|
||||
<BR>
|
||||
Constant defining a removal job</TD>
|
||||
</TR>
|
||||
|
||||
|
||||
</TABLE>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- =========== 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.IndexManager.Job.html#jala.IndexManager.Job()">jala.IndexManager.Job</A>
|
||||
</B>
|
||||
(<Number> type, callback)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Creates a new Job instance.
|
||||
</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<!-- ======== END CONSTRUCTOR SUMMARY ======== -->
|
||||
|
||||
|
||||
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
|
||||
|
||||
|
||||
<P>
|
||||
<!-- ========== END METHOD SUMMARY =========== -->
|
||||
|
||||
|
||||
<!-- ============ FIELD DETAIL START =========== -->
|
||||
|
||||
<A NAME="field_detail"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=1><FONT SIZE="+2"><B>Field Detail</B></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
|
||||
<A NAME="callback"><!-- --></A>
|
||||
<H3>callback</H3>
|
||||
<PRE>Object <B>callback</B></PRE>
|
||||
<UL>
|
||||
The data needed to process this job. For adding jobs this property
|
||||
must contain the helma.Search.Document instance to add to
|
||||
the index. For removal job this property must contain the unique identifier
|
||||
of the document that should be removed from the index. For optimizing
|
||||
jobs this property is null.
|
||||
|
||||
</UL>
|
||||
<HR>
|
||||
|
||||
<A NAME="createtime"><!-- --></A>
|
||||
<H3>createtime</H3>
|
||||
<PRE>Date <B>createtime</B></PRE>
|
||||
<UL>
|
||||
The date and time at which this job was created.
|
||||
|
||||
</UL>
|
||||
<HR>
|
||||
|
||||
<A NAME="errors"><!-- --></A>
|
||||
<H3>errors</H3>
|
||||
<PRE>Number <B>errors</B></PRE>
|
||||
<UL>
|
||||
An internal error counter which is increased whenever processing
|
||||
the job failed.
|
||||
|
||||
</UL>
|
||||
<HR>
|
||||
|
||||
<A NAME="type"><!-- --></A>
|
||||
<H3>type</H3>
|
||||
<PRE>Number <B>type</B></PRE>
|
||||
<UL>
|
||||
The type of the job
|
||||
|
||||
</UL>
|
||||
<HR>
|
||||
|
||||
<A NAME="!s!ADD"><!-- --></A>
|
||||
<H3>ADD</H3>
|
||||
<PRE><static> <final> Number <B>ADD</B></PRE>
|
||||
<UL>
|
||||
Constant defining an add job
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="constant-values.html#java.awt.AWTEvent.COMPONENT_EVENT_MASK">Constant Field Values</A></DL>
|
||||
</DL>
|
||||
|
||||
|
||||
</UL>
|
||||
<HR>
|
||||
|
||||
<A NAME="!s!OPTIMIZE"><!-- --></A>
|
||||
<H3>OPTIMIZE</H3>
|
||||
<PRE><static> <final> Number <B>OPTIMIZE</B></PRE>
|
||||
<UL>
|
||||
Constant defining an optimizing job
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="constant-values.html#java.awt.AWTEvent.COMPONENT_EVENT_MASK">Constant Field Values</A></DL>
|
||||
</DL>
|
||||
|
||||
|
||||
</UL>
|
||||
<HR>
|
||||
|
||||
<A NAME="!s!REMOVE"><!-- --></A>
|
||||
<H3>REMOVE</H3>
|
||||
<PRE><static> <final> Number <B>REMOVE</B></PRE>
|
||||
<UL>
|
||||
Constant defining a removal job
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="constant-values.html#java.awt.AWTEvent.COMPONENT_EVENT_MASK">Constant Field Values</A></DL>
|
||||
</DL>
|
||||
|
||||
|
||||
</UL>
|
||||
<HR>
|
||||
|
||||
|
||||
|
||||
<!-- ============ 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.IndexManager.Job()"><!-- --></A><H3>
|
||||
jala.IndexManager.Job</H3>
|
||||
<PRE><B>jala.IndexManager.Job</B>(<Number> type, callback)</PRE>
|
||||
|
||||
|
||||
<UL>
|
||||
Creates a new Job instance.
|
||||
</UL>
|
||||
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>type</CODE> - The type of job, which can be either jala.IndexManager.Job.ADD, jala.IndexManager.Job.REMOVE or jala.IndexManager.Job.OPTIMIZE.
|
||||
</UL>
|
||||
|
||||
<UL><CODE>id</CODE> - The Id of the job
|
||||
</UL>
|
||||
|
||||
<UL><CODE>data</CODE> - The data needed to process the job.
|
||||
</UL>
|
||||
|
||||
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- Constructor return value(s) -->
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
A newly created Job instance.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
<!-- End constructor return value(s) -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES -->
|
||||
|
||||
<UL>
|
||||
<B>See:</B><UL>- <a href="jala.IndexManager.Job.html#">jala.IndexManager.Job</a></UL>
|
||||
</UL>
|
||||
|
||||
<HR/>
|
||||
<!-- END ADDITIONAL ATTRIBUTES -->
|
||||
|
||||
<!-- ========= CONSTRUCTOR DETAIL END ======== -->
|
||||
|
||||
|
||||
<!-- ============ METHOD DETAIL START ========== -->
|
||||
|
||||
|
||||
<!-- ============ 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-IndexManager.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.IndexManager.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.ListRenderer.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.IndexManager.Job.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>
|
||||
615
modules/jala/docs/jala.IndexManager.html
Normal file
615
modules/jala/docs/jala.IndexManager.html
Normal file
|
|
@ -0,0 +1,615 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
jala.IndexManager
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title="jala.IndexManager";
|
||||
}
|
||||
</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-IndexManager.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.ImageFilter.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.IndexManager.Job.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.IndexManager.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.IndexManager</H2>
|
||||
<PRE>Object
|
||||
|
|
||||
+--<b>jala.IndexManager</b>
|
||||
</PRE>
|
||||
|
||||
|
||||
<HR>
|
||||
<DL>
|
||||
<!-- Class definition -->
|
||||
<DT>class
|
||||
<B>jala.IndexManager</B>
|
||||
|
||||
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<BR/>This class basically sits on top of a helma.Search.Index instance
|
||||
and provides methods for adding, removing and optimizing the underlying index.
|
||||
All methods generate jobs that are put into an internal queue which is
|
||||
processed asynchronously by a separate worker thread. This means all calls
|
||||
to add(), remove() and optimize() will return immediately, but the changes to
|
||||
the index will be done within a short delay. Please keep in mind to change the
|
||||
status of this IndexManager instance to REBUILDING before starting to rebuild
|
||||
the index, as this ensures that all add/remove/optimize jobs will stay in the
|
||||
queue and will only be processed after switching the status back to NORMAL.
|
||||
This ensures that objects that have been modified during a rebuilding process
|
||||
are re-indexed properly afterwards.
|
||||
<BR/><I>Defined in <a href='overview-summary-IndexManager.js.html'>IndexManager.js</a></I><BR/><BR/><B>See:</B><UL>- helma.Search.createIndex</UL>
|
||||
</P>
|
||||
|
||||
<HR>
|
||||
|
||||
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
||||
|
||||
<A NAME="inner_classes"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=2><FONT SIZE="+2">
|
||||
<B>Nested Class Summary</B></FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static class></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="jala.IndexManager.Job.html">jala.IndexManager.Job</A></B></CODE></TD>
|
||||
</TR>
|
||||
|
||||
</TABLE>
|
||||
|
||||
|
||||
<!-- ======== END NESTED CLASS SUMMARY ======== -->
|
||||
|
||||
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
|
||||
<A NAME="field_summary"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=2><FONT SIZE="+2">
|
||||
<B>Field Summary</B></FONT></TD>
|
||||
</TR>
|
||||
|
||||
<!-- This is one instance field summary -->
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static> <final> Number</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="#!s!MAXTRIES">MAXTRIES</A></B></CODE>
|
||||
<BR>
|
||||
Constant defining the maximum number of tries to add/remove
|
||||
an object to/from the underlying index.</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static> <final> Number</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="#!s!NORMAL">NORMAL</A></B></CODE>
|
||||
<BR>
|
||||
Constant defining normal mode of this index manager.</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static> <final> Number</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="#!s!REBUILDING">REBUILDING</A></B></CODE>
|
||||
<BR>
|
||||
Constant defining rebuilding mode of this index manager.</TD>
|
||||
</TR>
|
||||
|
||||
|
||||
</TABLE>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- =========== 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.IndexManager.html#jala.IndexManager()">jala.IndexManager</A>
|
||||
</B>
|
||||
(<String> name, <helma.File> dir, <String> lang)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Constructs a new IndexManager object.
|
||||
</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> Boolean</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#add">add</A></B>(<helma.Search.Document> doc)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Queues the document object passed as argument for addition to the underlying
|
||||
index.
|
||||
</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="#log">log</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Helper function that prefixes every log message with
|
||||
the name of the IndexManager.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> Boolean</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#optimize">optimize</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Queues the optimization of the underlying index.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> Boolean</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#remove">remove</A></B>(<Number> id)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Queues the removal of all index documents whose identifier value ("id" by default)
|
||||
matches the number passed as argument.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
|
||||
</TABLE>
|
||||
|
||||
|
||||
|
||||
<P>
|
||||
<!-- ========== END METHOD SUMMARY =========== -->
|
||||
|
||||
|
||||
<!-- ============ FIELD DETAIL START =========== -->
|
||||
|
||||
<A NAME="field_detail"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=1><FONT SIZE="+2"><B>Field Detail</B></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
|
||||
<A NAME="!s!MAXTRIES"><!-- --></A>
|
||||
<H3>MAXTRIES</H3>
|
||||
<PRE><static> <final> Number <B>MAXTRIES</B></PRE>
|
||||
<UL>
|
||||
Constant defining the maximum number of tries to add/remove
|
||||
an object to/from the underlying index.
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="constant-values.html#java.awt.AWTEvent.COMPONENT_EVENT_MASK">Constant Field Values</A></DL>
|
||||
</DL>
|
||||
|
||||
|
||||
</UL>
|
||||
<HR>
|
||||
|
||||
<A NAME="!s!NORMAL"><!-- --></A>
|
||||
<H3>NORMAL</H3>
|
||||
<PRE><static> <final> Number <B>NORMAL</B></PRE>
|
||||
<UL>
|
||||
Constant defining normal mode of this index manager.
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="constant-values.html#java.awt.AWTEvent.COMPONENT_EVENT_MASK">Constant Field Values</A></DL>
|
||||
</DL>
|
||||
|
||||
|
||||
</UL>
|
||||
<HR>
|
||||
|
||||
<A NAME="!s!REBUILDING"><!-- --></A>
|
||||
<H3>REBUILDING</H3>
|
||||
<PRE><static> <final> Number <B>REBUILDING</B></PRE>
|
||||
<UL>
|
||||
Constant defining rebuilding mode of this index manager.
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="constant-values.html#java.awt.AWTEvent.COMPONENT_EVENT_MASK">Constant Field Values</A></DL>
|
||||
</DL>
|
||||
|
||||
|
||||
</UL>
|
||||
<HR>
|
||||
|
||||
|
||||
|
||||
<!-- ============ 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.IndexManager()"><!-- --></A><H3>
|
||||
jala.IndexManager</H3>
|
||||
<PRE><B>jala.IndexManager</B>(<String> name, <helma.File> dir, <String> lang)</PRE>
|
||||
|
||||
|
||||
<UL>
|
||||
Constructs a new IndexManager object.
|
||||
</UL>
|
||||
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>name</CODE> - The name of the index, which is the name of the directory the index already resides or will be created in.
|
||||
</UL>
|
||||
|
||||
<UL><CODE>dir</CODE> - The base directory where this index's directory is already existing or will be created in.
|
||||
</UL>
|
||||
|
||||
<UL><CODE>lang</CODE> - The language of the documents in this index. This leads to the proper Lucene analyzer being used for indexing documents.
|
||||
</UL>
|
||||
|
||||
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- Constructor return value(s) -->
|
||||
|
||||
<!-- End constructor return value(s) -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES -->
|
||||
|
||||
<UL>
|
||||
<B>See:</B><UL>- helma.Search.createIndex</UL>
|
||||
</UL>
|
||||
|
||||
<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="add"><!-- --></A>
|
||||
<H3>add</H3>
|
||||
<PRE>Boolean <B>add</B>(<helma.Search.Document> doc)</PRE>
|
||||
|
||||
<UL>Queues the document object passed as argument for addition to the underlying
|
||||
index. This includes that all existing documents with the same identifier will
|
||||
be removed before the object passed as argument is added.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>doc</CODE> - The document object that should be added to the underlying index.
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
True if the job was added successfully to the internal queue, false otherwise.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<UL>
|
||||
<B>See:</B><UL>- helma.Search.Document</UL>
|
||||
</UL>
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="log"><!-- --></A>
|
||||
<H3>log</H3>
|
||||
<PRE>void <B>log</B>()</PRE>
|
||||
|
||||
<UL>Helper function that prefixes every log message with
|
||||
the name of the IndexManager.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>level</CODE> - An optional logging level. Accepted values
|
||||
</UL>
|
||||
|
||||
<UL><CODE>msg</CODE> - The log message are "debug", "info", "warn" and "error".
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="optimize"><!-- --></A>
|
||||
<H3>optimize</H3>
|
||||
<PRE>Boolean <B>optimize</B>()</PRE>
|
||||
|
||||
<UL>Queues the optimization of the underlying index.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
True if the optimizing job was added, false otherwise, which means that there is already an optimizing job waiting in the queue.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="remove"><!-- --></A>
|
||||
<H3>remove</H3>
|
||||
<PRE>Boolean <B>remove</B>(<Number> id)</PRE>
|
||||
|
||||
<UL>Queues the removal of all index documents whose identifier value ("id" by default)
|
||||
matches the number passed as argument.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>id</CODE> - The identifier value
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
True if the removal job was added successfully to the queue, false otherwise.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- 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-IndexManager.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.ImageFilter.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.IndexManager.Job.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.IndexManager.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>
|
||||
547
modules/jala/docs/jala.ListRenderer.ArrayList.html
Normal file
547
modules/jala/docs/jala.ListRenderer.ArrayList.html
Normal file
|
|
@ -0,0 +1,547 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
jala.ListRenderer.ArrayList
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title="jala.ListRenderer.ArrayList";
|
||||
}
|
||||
</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-ListRenderer.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.ListRenderer.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.Mp3.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.ListRenderer.ArrayList.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.ListRenderer.ArrayList</H2>
|
||||
<PRE>Object
|
||||
|
|
||||
+--<b>jala.ListRenderer.ArrayList</b>
|
||||
</PRE>
|
||||
|
||||
|
||||
<HR>
|
||||
<DL>
|
||||
<!-- Class definition -->
|
||||
<DT>class
|
||||
<B>jala.ListRenderer.ArrayList</B>
|
||||
|
||||
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<BR/>A simple wrapper around an array to use in conjunction
|
||||
with jala.ListRenderer. This wrapper can either handle complete arrays
|
||||
or subsections of an array. In the latter case the wrapper needs offset
|
||||
and total size information as argument to mimick a complete array.
|
||||
<BR/><I>Defined in <a href='overview-summary-ListRenderer.js.html'>ListRenderer.js</a></I><BR/><BR/>
|
||||
</P>
|
||||
|
||||
<HR>
|
||||
|
||||
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
||||
|
||||
<!-- ======== END NESTED CLASS SUMMARY ======== -->
|
||||
|
||||
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
|
||||
<A NAME="field_summary"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=2><FONT SIZE="+2">
|
||||
<B>Field Summary</B></FONT></TD>
|
||||
</TR>
|
||||
|
||||
<!-- This is one instance field summary -->
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> Number</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="#length">length</A></B></CODE>
|
||||
<BR>
|
||||
The length of this ArrayList instance.</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> Number</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="#offset">offset</A></B></CODE>
|
||||
<BR>
|
||||
The offset of this ArrayList instance.</TD>
|
||||
</TR>
|
||||
|
||||
|
||||
</TABLE>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- =========== 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.ListRenderer.ArrayList.html#jala.ListRenderer.ArrayList()">jala.ListRenderer.ArrayList</A>
|
||||
</B>
|
||||
(<Array> arr, <Number> offset, <Number> total)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Creates a new ArrayList 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> Object</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#get">get</A></B>(<Number> idx)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns the element at the index position passed
|
||||
as argument.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> Boolean</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#isSubset">isSubset</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns true if this ArrayList is a subsection of a bigger array
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> Number</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#size">size</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns the size of this ArrayList, which is either
|
||||
the length of the wrapped array or the total size
|
||||
passed as argument to the constructor (in case the wrapped
|
||||
array is just a subsection).
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> Number</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#subsetSize">subsetSize</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns the actual size of this ArrayList's wrapped array.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
|
||||
</TABLE>
|
||||
|
||||
|
||||
|
||||
<P>
|
||||
<!-- ========== END METHOD SUMMARY =========== -->
|
||||
|
||||
|
||||
<!-- ============ FIELD DETAIL START =========== -->
|
||||
|
||||
<A NAME="field_detail"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=1><FONT SIZE="+2"><B>Field Detail</B></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
|
||||
<A NAME="length"><!-- --></A>
|
||||
<H3>length</H3>
|
||||
<PRE>Number <B>length</B></PRE>
|
||||
<UL>
|
||||
The length of this ArrayList instance.
|
||||
|
||||
</UL>
|
||||
<HR>
|
||||
|
||||
<A NAME="offset"><!-- --></A>
|
||||
<H3>offset</H3>
|
||||
<PRE>Number <B>offset</B></PRE>
|
||||
<UL>
|
||||
The offset of this ArrayList instance. This might be > zero for
|
||||
ArrayList instances wrapping just a subsection, that is
|
||||
mimicking a bigger list.
|
||||
|
||||
</UL>
|
||||
<HR>
|
||||
|
||||
|
||||
|
||||
<!-- ============ 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.ListRenderer.ArrayList()"><!-- --></A><H3>
|
||||
jala.ListRenderer.ArrayList</H3>
|
||||
<PRE><B>jala.ListRenderer.ArrayList</B>(<Array> arr, <Number> offset, <Number> total)</PRE>
|
||||
|
||||
|
||||
<UL>
|
||||
Creates a new ArrayList instance.
|
||||
</UL>
|
||||
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>arr</CODE> - The array (or a subsection of an array) to wrap
|
||||
</UL>
|
||||
|
||||
<UL><CODE>offset</CODE> - An optional offset to use (mandatory if the array is just a subsection).
|
||||
</UL>
|
||||
|
||||
<UL><CODE>total</CODE> - An optional total size of the array. This argument is mandatory if the wrapped array is just a subsection.
|
||||
</UL>
|
||||
|
||||
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- Constructor return value(s) -->
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
A newly created ArrayList instance
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
<!-- 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="get"><!-- --></A>
|
||||
<H3>get</H3>
|
||||
<PRE>Object <B>get</B>(<Number> idx)</PRE>
|
||||
|
||||
<UL>Returns the element at the index position passed
|
||||
as argument. If the wrapped array is just a subsection
|
||||
the index position passed will be corrected using
|
||||
the offset.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>idx</CODE> - The index position of the element to return
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The element at the given index position
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="isSubset"><!-- --></A>
|
||||
<H3>isSubset</H3>
|
||||
<PRE>Boolean <B>isSubset</B>()</PRE>
|
||||
|
||||
<UL>Returns true if this ArrayList is a subsection of a bigger array</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
True if this ArrayList is a subsection of a bigger array
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="size"><!-- --></A>
|
||||
<H3>size</H3>
|
||||
<PRE>Number <B>size</B>()</PRE>
|
||||
|
||||
<UL>Returns the size of this ArrayList, which is either
|
||||
the length of the wrapped array or the total size
|
||||
passed as argument to the constructor (in case the wrapped
|
||||
array is just a subsection).</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The size of this ArrayList instance
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="subsetSize"><!-- --></A>
|
||||
<H3>subsetSize</H3>
|
||||
<PRE>Number <B>subsetSize</B>()</PRE>
|
||||
|
||||
<UL>Returns the actual size of this ArrayList's wrapped array.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The actual size of this ArrayList's wrapped array.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- 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-ListRenderer.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.ListRenderer.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.Mp3.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.ListRenderer.ArrayList.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>
|
||||
2339
modules/jala/docs/jala.ListRenderer.html
Normal file
2339
modules/jala/docs/jala.ListRenderer.html
Normal file
File diff suppressed because it is too large
Load diff
1102
modules/jala/docs/jala.Mp3.Id3v1.html
Normal file
1102
modules/jala/docs/jala.Mp3.Id3v1.html
Normal file
File diff suppressed because it is too large
Load diff
1733
modules/jala/docs/jala.Mp3.Id3v2.html
Normal file
1733
modules/jala/docs/jala.Mp3.Id3v2.html
Normal file
File diff suppressed because it is too large
Load diff
1481
modules/jala/docs/jala.Mp3.html
Normal file
1481
modules/jala/docs/jala.Mp3.html
Normal file
File diff suppressed because it is too large
Load diff
416
modules/jala/docs/jala.PodcastWriter.html
Normal file
416
modules/jala/docs/jala.PodcastWriter.html
Normal file
|
|
@ -0,0 +1,416 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
jala.PodcastWriter
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title="jala.PodcastWriter";
|
||||
}
|
||||
</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-PodcastWriter.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.Mp3.Id3v2.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.RemoteContent.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.PodcastWriter.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.PodcastWriter</H2>
|
||||
<PRE>Object
|
||||
|
|
||||
+--<a href='jala.XmlWriter.html'>jala.XmlWriter</a>
|
||||
|
|
||||
+--<a href='jala.Rss20Writer.html'>jala.Rss20Writer</a>
|
||||
|
|
||||
+--<b>jala.PodcastWriter</b>
|
||||
</PRE>
|
||||
|
||||
|
||||
<HR>
|
||||
<DL>
|
||||
<!-- Class definition -->
|
||||
<DT>class
|
||||
<B>jala.PodcastWriter</B>
|
||||
|
||||
<DT>extends <a href='jala.Rss20Writer.html'>jala.Rss20Writer</a>
|
||||
|
||||
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<BR/>Class to create, modify and render standard-compliant
|
||||
RSS 2.0 feeds including support for Apple's Podcast specification.
|
||||
<BR/><I>Defined in <a href='overview-summary-PodcastWriter.js.html'>PodcastWriter.js</a></I><BR/><BR/>
|
||||
</P>
|
||||
|
||||
<HR>
|
||||
|
||||
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
||||
|
||||
<!-- ======== END NESTED CLASS SUMMARY ======== -->
|
||||
|
||||
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
|
||||
<A NAME="field_summary"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=2><FONT SIZE="+2">
|
||||
<B>Field Summary</B></FONT></TD>
|
||||
</TR>
|
||||
|
||||
<!-- This is one instance field summary -->
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static> <final> String</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="#!s!XMLHEADER">XMLHEADER</A></B></CODE>
|
||||
<BR>
|
||||
A typical XML header as default.</TD>
|
||||
</TR>
|
||||
|
||||
|
||||
</TABLE>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- =========== 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.PodcastWriter.html#jala.PodcastWriter()">jala.PodcastWriter</A>
|
||||
</B>
|
||||
(<String> header)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
|
||||
</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> void</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#addItunesCategory">addItunesCategory</A></B>(<String> name, <String> subName, <jala.XmlWriter.XmlElement> parent)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Add an iTunes Podcast category.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
|
||||
</TABLE>
|
||||
|
||||
|
||||
|
||||
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TD><B>Methods inherited from class <a href="jala.Rss20Writer.html">jala.Rss20Writer</a></B></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>
|
||||
<!-- Inherited methods -->
|
||||
<a href="jala.Rss20Writer.html#getRoot">getRoot</a>, <a href="jala.Rss20Writer.html#extendChannel">extendChannel</a>, <a href="jala.Rss20Writer.html#getChannel">getChannel</a>, <a href="jala.Rss20Writer.html#setChannel">setChannel</a>, <a href="jala.Rss20Writer.html#extendItem">extendItem</a>, <a href="jala.Rss20Writer.html#createItem">createItem</a>, <a href="jala.Rss20Writer.html#addItem">addItem</a>, <a href="jala.Rss20Writer.html#addCategory">addCategory</a>, <a href="jala.Rss20Writer.html#setImage">setImage</a>, <a href="jala.Rss20Writer.html#setTextInput">setTextInput</a>
|
||||
</CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
|
||||
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TD><B>Methods inherited from class <a href="jala.XmlWriter.html">jala.XmlWriter</a></B></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>
|
||||
<!-- Inherited methods -->
|
||||
<a href="jala.XmlWriter.html#createElement">createElement</a>, <a href="jala.XmlWriter.html#extend">extend</a>, <a href="jala.XmlWriter.html#addNamespace">addNamespace</a>, <a href="jala.XmlWriter.html#write">write</a>, <a href="jala.XmlWriter.html#toString">toString</a>, <a href="jala.XmlWriter.html#clone">clone</a>
|
||||
</CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
|
||||
<P>
|
||||
<!-- ========== END METHOD SUMMARY =========== -->
|
||||
|
||||
|
||||
<!-- ============ FIELD DETAIL START =========== -->
|
||||
|
||||
<A NAME="field_detail"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=1><FONT SIZE="+2"><B>Field Detail</B></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
|
||||
<A NAME="!s!XMLHEADER"><!-- --></A>
|
||||
<H3>XMLHEADER</H3>
|
||||
<PRE><static> <final> String <B>XMLHEADER</B></PRE>
|
||||
<UL>
|
||||
A typical XML header as default.
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="constant-values.html#java.awt.AWTEvent.COMPONENT_EVENT_MASK">Constant Field Values</A></DL>
|
||||
</DL>
|
||||
|
||||
|
||||
</UL>
|
||||
<HR>
|
||||
|
||||
|
||||
|
||||
<!-- ============ 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.PodcastWriter()"><!-- --></A><H3>
|
||||
jala.PodcastWriter</H3>
|
||||
<PRE><B>jala.PodcastWriter</B>(<String> header)</PRE>
|
||||
|
||||
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>header</CODE> - Optional XML header.
|
||||
</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="addItunesCategory"><!-- --></A>
|
||||
<H3>addItunesCategory</H3>
|
||||
<PRE>void <B>addItunesCategory</B>(<String> name, <String> subName, <jala.XmlWriter.XmlElement> parent)</PRE>
|
||||
|
||||
<UL>Add an iTunes Podcast category.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>name</CODE> - The category's name.
|
||||
</UL>
|
||||
|
||||
<UL><CODE>subName</CODE> - The (optional) sub-category's name.
|
||||
</UL>
|
||||
|
||||
<UL><CODE>parent</CODE> - Optional parent element to add the category to.
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- 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-PodcastWriter.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.Mp3.Id3v2.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.RemoteContent.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.PodcastWriter.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>
|
||||
892
modules/jala/docs/jala.RemoteContent.html
Normal file
892
modules/jala/docs/jala.RemoteContent.html
Normal file
|
|
@ -0,0 +1,892 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
jala.RemoteContent
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title="jala.RemoteContent";
|
||||
}
|
||||
</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-RemoteContent.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.PodcastWriter.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.Rss20Writer.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.RemoteContent.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.RemoteContent</H2>
|
||||
<PRE>Object
|
||||
|
|
||||
+--helma.Http
|
||||
|
|
||||
+--<b>jala.RemoteContent</b>
|
||||
</PRE>
|
||||
|
||||
|
||||
<HR>
|
||||
<DL>
|
||||
<!-- Class definition -->
|
||||
<DT>class
|
||||
<B>jala.RemoteContent</B>
|
||||
|
||||
<DT>extends helma.Http
|
||||
|
||||
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<BR/>API to define, fetch and update content
|
||||
from a remote site.
|
||||
<BR/><I>Defined in <a href='overview-summary-RemoteContent.js.html'>RemoteContent.js</a></I><BR/><BR/>
|
||||
</P>
|
||||
|
||||
<HR>
|
||||
|
||||
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
||||
|
||||
<!-- ======== END NESTED CLASS SUMMARY ======== -->
|
||||
|
||||
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
|
||||
<A NAME="field_summary"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=2><FONT SIZE="+2">
|
||||
<B>Field Summary</B></FONT></TD>
|
||||
</TR>
|
||||
|
||||
<!-- This is one instance field summary -->
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static> <final> File</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="#!s!CACHEDIR">CACHEDIR</A></B></CODE>
|
||||
<BR>
|
||||
The default cache directory.</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static> <final> int</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="#!s!HTTP">HTTP</A></B></CODE>
|
||||
<BR>
|
||||
A constant representing the HTTP retrieval method.</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static> <final> String</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="#!s!SUFFIX">SUFFIX</A></B></CODE>
|
||||
<BR>
|
||||
The default name of the cache directory.</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static> <final> int</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="#!s!XMLRPC">XMLRPC</A></B></CODE>
|
||||
<BR>
|
||||
A constant representing the XML-RPC retrieval method.</TD>
|
||||
</TR>
|
||||
|
||||
|
||||
</TABLE>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- =========== 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.RemoteContent.html#jala.RemoteContent()">jala.RemoteContent</A>
|
||||
</B>
|
||||
(<String> url, <Integer> method, <File> storage)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Construct a new remote content handler.
|
||||
</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> void</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#clear">clear</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Flushes (empties) the cached remote content.
|
||||
</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="#get">get</A></B>(<String> key)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Get an arbitrary property of the remote content.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> Array</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#getKeys">getKeys</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Get all available property names.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> Boolean</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#needsUpdate">needsUpdate</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Tests whether the remote content needs to be updated.
|
||||
</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="#setInterval">setInterval</A></B>(<Number> interval)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Set the interval the remote content's
|
||||
cache is bound to be updated.
|
||||
</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="#toString">toString</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Get a string representation of the remote content.
|
||||
</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="#update">update</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Get the updated and cached remote content.
|
||||
</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="#valueOf">valueOf</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Get the value of the remote content.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE><static> void</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#!s!exec">exec</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Apply a custom method on all remote content in a file-based cache.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE><static> void</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#!s!flush">flush</A></B>(<File> cache)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Remove all remote content from a file-based cache.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE><static> void</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#!s!forEach">forEach</A></B>(<Function> callback, <File> cache)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Apply a custom method on all remote content in a file-based cache.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
|
||||
</TABLE>
|
||||
|
||||
|
||||
|
||||
<P>
|
||||
<!-- ========== END METHOD SUMMARY =========== -->
|
||||
|
||||
|
||||
<!-- ============ FIELD DETAIL START =========== -->
|
||||
|
||||
<A NAME="field_detail"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=1><FONT SIZE="+2"><B>Field Detail</B></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
|
||||
<A NAME="!s!CACHEDIR"><!-- --></A>
|
||||
<H3>CACHEDIR</H3>
|
||||
<PRE><static> <final> File <B>CACHEDIR</B></PRE>
|
||||
<UL>
|
||||
The default cache directory.
|
||||
|
||||
</UL>
|
||||
<HR>
|
||||
|
||||
<A NAME="!s!HTTP"><!-- --></A>
|
||||
<H3>HTTP</H3>
|
||||
<PRE><static> <final> int <B>HTTP</B></PRE>
|
||||
<UL>
|
||||
A constant representing the HTTP retrieval method.
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="constant-values.html#java.awt.AWTEvent.COMPONENT_EVENT_MASK">Constant Field Values</A></DL>
|
||||
</DL>
|
||||
|
||||
|
||||
</UL>
|
||||
<HR>
|
||||
|
||||
<A NAME="!s!SUFFIX"><!-- --></A>
|
||||
<H3>SUFFIX</H3>
|
||||
<PRE><static> <final> String <B>SUFFIX</B></PRE>
|
||||
<UL>
|
||||
The default name of the cache directory.
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="constant-values.html#java.awt.AWTEvent.COMPONENT_EVENT_MASK">Constant Field Values</A></DL>
|
||||
</DL>
|
||||
|
||||
|
||||
</UL>
|
||||
<HR>
|
||||
|
||||
<A NAME="!s!XMLRPC"><!-- --></A>
|
||||
<H3>XMLRPC</H3>
|
||||
<PRE><static> <final> int <B>XMLRPC</B></PRE>
|
||||
<UL>
|
||||
A constant representing the XML-RPC retrieval method.
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="constant-values.html#java.awt.AWTEvent.COMPONENT_EVENT_MASK">Constant Field Values</A></DL>
|
||||
</DL>
|
||||
|
||||
|
||||
</UL>
|
||||
<HR>
|
||||
|
||||
|
||||
|
||||
<!-- ============ 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.RemoteContent()"><!-- --></A><H3>
|
||||
jala.RemoteContent</H3>
|
||||
<PRE><B>jala.RemoteContent</B>(<String> url, <Integer> method, <File> storage)</PRE>
|
||||
|
||||
|
||||
<UL>
|
||||
Construct a new remote content handler.
|
||||
</UL>
|
||||
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>url</CODE> - The URL string of the remote site.
|
||||
</UL>
|
||||
|
||||
<UL><CODE>method</CODE> - The method to retrieve the remote content.
|
||||
</UL>
|
||||
|
||||
<UL><CODE>storage</CODE> - The cache directory.
|
||||
</UL>
|
||||
|
||||
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- Constructor return value(s) -->
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
A new remote content handler.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
<!-- 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="clear"><!-- --></A>
|
||||
<H3>clear</H3>
|
||||
<PRE>void <B>clear</B>()</PRE>
|
||||
|
||||
<UL>Flushes (empties) the cached remote content.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="get"><!-- --></A>
|
||||
<H3>get</H3>
|
||||
<PRE>Object <B>get</B>(<String> key)</PRE>
|
||||
|
||||
<UL>Get an arbitrary property of the remote content.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>key</CODE> - The name of the property.
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The value of the property.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="getKeys"><!-- --></A>
|
||||
<H3>getKeys</H3>
|
||||
<PRE>Array <B>getKeys</B>()</PRE>
|
||||
|
||||
<UL>Get all available property names.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The list of property names.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="needsUpdate"><!-- --></A>
|
||||
<H3>needsUpdate</H3>
|
||||
<PRE>Boolean <B>needsUpdate</B>()</PRE>
|
||||
|
||||
<UL>Tests whether the remote content needs to be updated.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
True if the remote content needs to be updated.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="setInterval"><!-- --></A>
|
||||
<H3>setInterval</H3>
|
||||
<PRE>void <B>setInterval</B>(<Number> interval)</PRE>
|
||||
|
||||
<UL>Set the interval the remote content's
|
||||
cache is bound to be updated.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>interval</CODE> - The interval value in milliseconds.
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="toString"><!-- --></A>
|
||||
<H3>toString</H3>
|
||||
<PRE>String <B>toString</B>()</PRE>
|
||||
|
||||
<UL>Get a string representation of the remote content.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The remote content as string.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="update"><!-- --></A>
|
||||
<H3>update</H3>
|
||||
<PRE>String <B>update</B>()</PRE>
|
||||
|
||||
<UL>Get the updated and cached remote content.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The content as retrieved from the remote site.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="valueOf"><!-- --></A>
|
||||
<H3>valueOf</H3>
|
||||
<PRE>Object <B>valueOf</B>()</PRE>
|
||||
|
||||
<UL>Get the value of the remote content.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The remote content including response header data.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="!s!exec"><!-- --></A>
|
||||
<H3>exec</H3>
|
||||
<PRE><static> void <B>exec</B>()</PRE>
|
||||
|
||||
<UL>Apply a custom method on all remote content in a file-based cache.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>callback</CODE> - The callback method to be executed for each remote content file.
|
||||
</UL>
|
||||
|
||||
<UL><CODE>cache</CODE> - An optional target directory.
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<UL>
|
||||
<B>Deprecated</B> <I>Use <a href="#!s!forEach">forEach()</a> instead. </I><BR/><BR/>
|
||||
</UL>
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="!s!flush"><!-- --></A>
|
||||
<H3>flush</H3>
|
||||
<PRE><static> void <B>flush</B>(<File> cache)</PRE>
|
||||
|
||||
<UL>Remove all remote content from a file-based cache.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>cache</CODE> - An optional target directory.
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="!s!forEach"><!-- --></A>
|
||||
<H3>forEach</H3>
|
||||
<PRE><static> void <B>forEach</B>(<Function> callback, <File> cache)</PRE>
|
||||
|
||||
<UL>Apply a custom method on all remote content in a file-based cache.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>callback</CODE> - The callback method to be executed for each remote content file.
|
||||
</UL>
|
||||
|
||||
<UL><CODE>cache</CODE> - An optional target directory.
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- 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-RemoteContent.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.PodcastWriter.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.Rss20Writer.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.RemoteContent.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>
|
||||
760
modules/jala/docs/jala.Rss20Writer.html
Normal file
760
modules/jala/docs/jala.Rss20Writer.html
Normal file
|
|
@ -0,0 +1,760 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
jala.Rss20Writer
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title="jala.Rss20Writer";
|
||||
}
|
||||
</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-Rss20Writer.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.RemoteContent.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.Utilities.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.Rss20Writer.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.Rss20Writer</H2>
|
||||
<PRE>Object
|
||||
|
|
||||
+--<a href='jala.XmlWriter.html'>jala.XmlWriter</a>
|
||||
|
|
||||
+--<b>jala.Rss20Writer</b>
|
||||
</PRE>
|
||||
|
||||
<DL>
|
||||
<DT>
|
||||
<B>Direct Known Subclasses:</B>
|
||||
<DD>
|
||||
<a href="jala.PodcastWriter.html">jala.PodcastWriter</a>
|
||||
</DD>
|
||||
</DL>
|
||||
|
||||
|
||||
<HR>
|
||||
<DL>
|
||||
<!-- Class definition -->
|
||||
<DT>class
|
||||
<B>jala.Rss20Writer</B>
|
||||
|
||||
<DT>extends <a href='jala.XmlWriter.html'>jala.XmlWriter</a>
|
||||
|
||||
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<BR/>Class to create, modify and render standard-compliant
|
||||
RSS 2.0 feeds.
|
||||
<BR/><I>Defined in <a href='overview-summary-Rss20Writer.js.html'>Rss20Writer.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.Rss20Writer.html#jala.Rss20Writer()">jala.Rss20Writer</A>
|
||||
</B>
|
||||
(<String> header)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
|
||||
</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> void</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#addCategory">addCategory</A></B>(<String> name, <String> domain, <jala.XmlWriter.XmlElement> parent)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Add a category element to an arbitrary element.
|
||||
</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="#addItem">addItem</A></B>(<jala.XmlWriter.XmlElement> item)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Add an item element to the channel element.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> jala.XmlWriter.XmlElement</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#createItem">createItem</A></B>(<Object> data)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Get a new and innocent item element.
|
||||
</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="#extendChannel">extendChannel</A></B>(<Array> ext)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Add child elements to the channel template.
|
||||
</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="#extendItem">extendItem</A></B>(<Array> ext)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Add child elements to the item template.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> jala.XmlWriter.XmlElement</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#getChannel">getChannel</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Get the writer's channel element.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> jala.XmlWriter.XmlElement</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#getRoot">getRoot</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Get the writer's root element.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> jala.XmlWriter.XmlElement</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#setChannel">setChannel</A></B>(<Object> data)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Populate the channel element with data.
|
||||
</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="#setImage">setImage</A></B>(<Object> data)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Populate the image element with data.
|
||||
</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="#setTextInput">setTextInput</A></B>(<Object> data)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Populate the textInput element with data.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
|
||||
</TABLE>
|
||||
|
||||
|
||||
|
||||
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TD><B>Methods inherited from class <a href="jala.XmlWriter.html">jala.XmlWriter</a></B></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>
|
||||
<!-- Inherited methods -->
|
||||
<a href="jala.XmlWriter.html#createElement">createElement</a>, <a href="jala.XmlWriter.html#extend">extend</a>, <a href="jala.XmlWriter.html#addNamespace">addNamespace</a>, <a href="jala.XmlWriter.html#write">write</a>, <a href="jala.XmlWriter.html#toString">toString</a>, <a href="jala.XmlWriter.html#clone">clone</a>
|
||||
</CODE></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.Rss20Writer()"><!-- --></A><H3>
|
||||
jala.Rss20Writer</H3>
|
||||
<PRE><B>jala.Rss20Writer</B>(<String> header)</PRE>
|
||||
|
||||
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>header</CODE> - Optional XML header.
|
||||
</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="addCategory"><!-- --></A>
|
||||
<H3>addCategory</H3>
|
||||
<PRE>void <B>addCategory</B>(<String> name, <String> domain, <jala.XmlWriter.XmlElement> parent)</PRE>
|
||||
|
||||
<UL>Add a category element to an arbitrary element.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>name</CODE> - The name of the category.
|
||||
</UL>
|
||||
|
||||
<UL><CODE>domain</CODE> - The domain of the category.
|
||||
</UL>
|
||||
|
||||
<UL><CODE>parent</CODE> - The optional parent element.
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="addItem"><!-- --></A>
|
||||
<H3>addItem</H3>
|
||||
<PRE>void <B>addItem</B>(<jala.XmlWriter.XmlElement> item)</PRE>
|
||||
|
||||
<UL>Add an item element to the channel element.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>item</CODE> - The item element to add.
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="createItem"><!-- --></A>
|
||||
<H3>createItem</H3>
|
||||
<PRE>jala.XmlWriter.XmlElement <B>createItem</B>(<Object> data)</PRE>
|
||||
|
||||
<UL>Get a new and innocent item element.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>data</CODE> - An XmlWriter-compliant object structure.
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
A new and innocent item element.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="extendChannel"><!-- --></A>
|
||||
<H3>extendChannel</H3>
|
||||
<PRE>void <B>extendChannel</B>(<Array> ext)</PRE>
|
||||
|
||||
<UL>Add child elements to the channel template.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>ext</CODE> - List of additional child elements.
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="extendItem"><!-- --></A>
|
||||
<H3>extendItem</H3>
|
||||
<PRE>void <B>extendItem</B>(<Array> ext)</PRE>
|
||||
|
||||
<UL>Add child elements to the item template.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>ext</CODE> - List of additional child elements.
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="getChannel"><!-- --></A>
|
||||
<H3>getChannel</H3>
|
||||
<PRE>jala.XmlWriter.XmlElement <B>getChannel</B>()</PRE>
|
||||
|
||||
<UL>Get the writer's channel element.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The writer's channel element.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="getRoot"><!-- --></A>
|
||||
<H3>getRoot</H3>
|
||||
<PRE>jala.XmlWriter.XmlElement <B>getRoot</B>()</PRE>
|
||||
|
||||
<UL>Get the writer's root element.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The writer's root element.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="setChannel"><!-- --></A>
|
||||
<H3>setChannel</H3>
|
||||
<PRE>jala.XmlWriter.XmlElement <B>setChannel</B>(<Object> data)</PRE>
|
||||
|
||||
<UL>Populate the channel element with data.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>data</CODE> - An XmlWriter-compliant object structure.
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The populated channel element.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="setImage"><!-- --></A>
|
||||
<H3>setImage</H3>
|
||||
<PRE>void <B>setImage</B>(<Object> data)</PRE>
|
||||
|
||||
<UL>Populate the image element with data.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>data</CODE> - An XmlWriter-compliant object structure.
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="setTextInput"><!-- --></A>
|
||||
<H3>setTextInput</H3>
|
||||
<PRE>void <B>setTextInput</B>(<Object> data)</PRE>
|
||||
|
||||
<UL>Populate the textInput element with data.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>data</CODE> - An XmlWriter-compliant object structure.
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- 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-Rss20Writer.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.RemoteContent.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.Utilities.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.Rss20Writer.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>
|
||||
586
modules/jala/docs/jala.Utilities.html
Normal file
586
modules/jala/docs/jala.Utilities.html
Normal file
|
|
@ -0,0 +1,586 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
jala.Utilities
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title="jala.Utilities";
|
||||
}
|
||||
</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-Utilities.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.Rss20Writer.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.XmlRpcRequest.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.Utilities.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.Utilities</H2>
|
||||
<PRE>Object
|
||||
|
|
||||
+--<b>jala.Utilities</b>
|
||||
</PRE>
|
||||
|
||||
|
||||
<HR>
|
||||
<DL>
|
||||
<!-- Class definition -->
|
||||
<DT>class
|
||||
<B>jala.Utilities</B>
|
||||
|
||||
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<BR/>This class contains various convenience methods
|
||||
which do not fit in any other class.
|
||||
<BR/><I>Defined in <a href='overview-summary-Utilities.js.html'>Utilities.js</a></I><BR/><BR/>
|
||||
</P>
|
||||
|
||||
<HR>
|
||||
|
||||
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
||||
|
||||
<!-- ======== END NESTED CLASS SUMMARY ======== -->
|
||||
|
||||
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
|
||||
<A NAME="field_summary"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=2><FONT SIZE="+2">
|
||||
<B>Field Summary</B></FONT></TD>
|
||||
</TR>
|
||||
|
||||
<!-- This is one instance field summary -->
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static> <final> Number</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="#!s!VALUE_ADDED">VALUE_ADDED</A></B></CODE>
|
||||
<BR>
|
||||
Static field indicating ad added object property.</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static> <final> Number</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="#!s!VALUE_MODIFIED">VALUE_MODIFIED</A></B></CODE>
|
||||
<BR>
|
||||
Static field indicating a modified object property.</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static> <final> Number</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="#!s!VALUE_REMOVED">VALUE_REMOVED</A></B></CODE>
|
||||
<BR>
|
||||
Static field indicating a removed object property.</TD>
|
||||
</TR>
|
||||
|
||||
|
||||
</TABLE>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- =========== 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.Utilities.html#jala.Utilities()">jala.Utilities</A>
|
||||
</B>
|
||||
()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Construct a utility object.
|
||||
</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="#createPassword">createPassword</A></B>(<Number> len, <Number> level)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Creates a random password with different levels of security.
|
||||
</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="#diffObjects">diffObjects</A></B>(<Object> obj1, <Object> obj2)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns an array containing the properties that are
|
||||
added, removed or modified in one object compared to another.
|
||||
</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="#patchObject">patchObject</A></B>(<Object> obj, <Object> diff)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Patches an object with a "diff" object created by the
|
||||
<a href="#diffObjects">diffObjects()</a> 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="#toString">toString</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Return a string representation of the utitility object.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
|
||||
</TABLE>
|
||||
|
||||
|
||||
|
||||
<P>
|
||||
<!-- ========== END METHOD SUMMARY =========== -->
|
||||
|
||||
|
||||
<!-- ============ FIELD DETAIL START =========== -->
|
||||
|
||||
<A NAME="field_detail"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=1><FONT SIZE="+2"><B>Field Detail</B></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
|
||||
<A NAME="!s!VALUE_ADDED"><!-- --></A>
|
||||
<H3>VALUE_ADDED</H3>
|
||||
<PRE><static> <final> Number <B>VALUE_ADDED</B></PRE>
|
||||
<UL>
|
||||
Static field indicating ad added object property.
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="constant-values.html#java.awt.AWTEvent.COMPONENT_EVENT_MASK">Constant Field Values</A></DL>
|
||||
</DL>
|
||||
|
||||
|
||||
</UL>
|
||||
<HR>
|
||||
|
||||
<A NAME="!s!VALUE_MODIFIED"><!-- --></A>
|
||||
<H3>VALUE_MODIFIED</H3>
|
||||
<PRE><static> <final> Number <B>VALUE_MODIFIED</B></PRE>
|
||||
<UL>
|
||||
Static field indicating a modified object property.
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="constant-values.html#java.awt.AWTEvent.COMPONENT_EVENT_MASK">Constant Field Values</A></DL>
|
||||
</DL>
|
||||
|
||||
|
||||
</UL>
|
||||
<HR>
|
||||
|
||||
<A NAME="!s!VALUE_REMOVED"><!-- --></A>
|
||||
<H3>VALUE_REMOVED</H3>
|
||||
<PRE><static> <final> Number <B>VALUE_REMOVED</B></PRE>
|
||||
<UL>
|
||||
Static field indicating a removed object property.
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="constant-values.html#java.awt.AWTEvent.COMPONENT_EVENT_MASK">Constant Field Values</A></DL>
|
||||
</DL>
|
||||
|
||||
|
||||
</UL>
|
||||
<HR>
|
||||
|
||||
|
||||
|
||||
<!-- ============ 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.Utilities()"><!-- --></A><H3>
|
||||
jala.Utilities</H3>
|
||||
<PRE><B>jala.Utilities</B>()</PRE>
|
||||
|
||||
|
||||
<UL>
|
||||
Construct a utility object.
|
||||
</UL>
|
||||
|
||||
|
||||
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- Constructor return value(s) -->
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
A new utitilty object.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
<!-- 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="createPassword"><!-- --></A>
|
||||
<H3>createPassword</H3>
|
||||
<PRE>String <B>createPassword</B>(<Number> len, <Number> level)</PRE>
|
||||
|
||||
<UL>Creates a random password with different levels of security.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>len</CODE> - The length of the password (default: 8)
|
||||
</UL>
|
||||
|
||||
<UL><CODE>level</CODE> - The security level <ul> <li>0 - containing only vowels or consonants (default)</li> <li>1 - throws in a number at random position</li> <li>2 - throws in a number and a special character at random position</li> </ul>
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The resulting password
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="diffObjects"><!-- --></A>
|
||||
<H3>diffObjects</H3>
|
||||
<PRE>Object <B>diffObjects</B>(<Object> obj1, <Object> obj2)</PRE>
|
||||
|
||||
<UL>Returns an array containing the properties that are
|
||||
added, removed or modified in one object compared to another.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>obj1</CODE> - The first of two objects which should be compared
|
||||
</UL>
|
||||
|
||||
<UL><CODE>obj2</CODE> - The second of two objects which should be compared
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
An Object containing all properties that are added, removed or modified in the second object compared to the first. Each property contains a status field with an integer value which can be checked against the static jala.Utility fields VALUE_ADDED, VALUE_MODIFIED and VALUE_REMOVED.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="patchObject"><!-- --></A>
|
||||
<H3>patchObject</H3>
|
||||
<PRE>Object <B>patchObject</B>(<Object> obj, <Object> diff)</PRE>
|
||||
|
||||
<UL>Patches an object with a "diff" object created by the
|
||||
<a href="#diffObjects">diffObjects()</a> method.
|
||||
Please mind that this method is recursive, it descends
|
||||
along the "diff" object structure.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>obj</CODE> - The Object the diff should be applied to
|
||||
</UL>
|
||||
|
||||
<UL><CODE>diff</CODE> - A "diff" object created by the <a href="#diffObjects">diffObjects()</a> method
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The patched Object with all differences applied
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="toString"><!-- --></A>
|
||||
<H3>toString</H3>
|
||||
<PRE>String <B>toString</B>()</PRE>
|
||||
|
||||
<UL>Return a string representation of the utitility object.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
[jala.Utilities Object]
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- 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-Utilities.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.Rss20Writer.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.XmlRpcRequest.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.Utilities.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>
|
||||
1235
modules/jala/docs/jala.XmlRpcRequest.html
Normal file
1235
modules/jala/docs/jala.XmlRpcRequest.html
Normal file
File diff suppressed because it is too large
Load diff
633
modules/jala/docs/jala.XmlWriter.html
Normal file
633
modules/jala/docs/jala.XmlWriter.html
Normal file
|
|
@ -0,0 +1,633 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
jala.XmlWriter
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title="jala.XmlWriter";
|
||||
}
|
||||
</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-XmlWriter.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.XmlRpcRequest.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<B>NEXT CLASS</B></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="index.html" TARGET="_top"><B>FRAMES</B></A>
|
||||
<A HREF="jala.XmlWriter.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.XmlWriter</H2>
|
||||
<PRE>Object
|
||||
|
|
||||
+--<b>jala.XmlWriter</b>
|
||||
</PRE>
|
||||
|
||||
<DL>
|
||||
<DT>
|
||||
<B>Direct Known Subclasses:</B>
|
||||
<DD>
|
||||
<a href="jala.Rss20Writer.html">jala.Rss20Writer</a>
|
||||
</DD>
|
||||
</DL>
|
||||
|
||||
|
||||
<HR>
|
||||
<DL>
|
||||
<!-- Class definition -->
|
||||
<DT>class
|
||||
<B>jala.XmlWriter</B>
|
||||
|
||||
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<BR/>This class defines a generic interface to write
|
||||
arbitrary and validating XML source code. This is done
|
||||
by first applying data objects onto template objects,
|
||||
both in a specified format. Then, the resulting object
|
||||
tree is transformed into XML. Moreover, template objects
|
||||
can be extended with other template objects to provide
|
||||
full flexibility in inheriting subclasses.
|
||||
<BR/><I>Defined in <a href='overview-summary-XmlWriter.js.html'>XmlWriter.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.XmlWriter.html#jala.XmlWriter()">jala.XmlWriter</A>
|
||||
</B>
|
||||
(<String> header)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Construct a new XML writer.
|
||||
</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> jala.XmlWriter.XmlElement</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#addNamespace">addNamespace</A></B>(<String> name, <String> url)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Add a namespace to this writer.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> <a href="jala.XmlWriter.html">jala.XmlWriter</a></CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#clone">clone</A></B>(obj)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Clone this XML writer.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> jala.XmlWriter.XmlElement</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#createElement">createElement</A></B>(<Object> data)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Get a newly created XML element.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> <a href="jala.XmlWriter.html">jala.XmlWriter</a></CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#extend">extend</A></B>(<Object> template, <Object> ext)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Extend a template object.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> jala.XmlWriter.XmlElement</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#getRoot">getRoot</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Get the root XML element of this writer.
|
||||
</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="#toString">toString</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Get the XML output as string.
|
||||
</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="#write">write</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Write the XML to the response buffer.
|
||||
</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.XmlWriter()"><!-- --></A><H3>
|
||||
jala.XmlWriter</H3>
|
||||
<PRE><B>jala.XmlWriter</B>(<String> header)</PRE>
|
||||
|
||||
|
||||
<UL>
|
||||
Construct a new XML writer.
|
||||
</UL>
|
||||
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>header</CODE> - An optional XML header.
|
||||
</UL>
|
||||
|
||||
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- Constructor return value(s) -->
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
A new XML writer.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
<!-- 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="addNamespace"><!-- --></A>
|
||||
<H3>addNamespace</H3>
|
||||
<PRE>jala.XmlWriter.XmlElement <B>addNamespace</B>(<String> name, <String> url)</PRE>
|
||||
|
||||
<UL>Add a namespace to this writer.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>name</CODE> - The name of the namespace.
|
||||
</UL>
|
||||
|
||||
<UL><CODE>url</CODE> - The URL string of the namespace.
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The XML root element.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="clone"><!-- --></A>
|
||||
<H3>clone</H3>
|
||||
<PRE><a href="jala.XmlWriter.html">jala.XmlWriter</a> <B>clone</B>(obj)</PRE>
|
||||
|
||||
<UL>Clone this XML writer.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>The</CODE> - clone templare.
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The cloned XML writer.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="createElement"><!-- --></A>
|
||||
<H3>createElement</H3>
|
||||
<PRE>jala.XmlWriter.XmlElement <B>createElement</B>(<Object> data)</PRE>
|
||||
|
||||
<UL>Get a newly created XML element.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>data</CODE> - The XML data as object tree.
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The resulting XML element.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="extend"><!-- --></A>
|
||||
<H3>extend</H3>
|
||||
<PRE><a href="jala.XmlWriter.html">jala.XmlWriter</a> <B>extend</B>(<Object> template, <Object> ext)</PRE>
|
||||
|
||||
<UL>Extend a template object.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>template</CODE> - The template object.
|
||||
</UL>
|
||||
|
||||
<UL><CODE>ext</CODE> - The extension object.
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The XML writer.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="getRoot"><!-- --></A>
|
||||
<H3>getRoot</H3>
|
||||
<PRE>jala.XmlWriter.XmlElement <B>getRoot</B>()</PRE>
|
||||
|
||||
<UL>Get the root XML element of this writer.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The root XML element.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="toString"><!-- --></A>
|
||||
<H3>toString</H3>
|
||||
<PRE>String <B>toString</B>()</PRE>
|
||||
|
||||
<UL>Get the XML output as string.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The XML output.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="write"><!-- --></A>
|
||||
<H3>write</H3>
|
||||
<PRE>void <B>write</B>()</PRE>
|
||||
|
||||
<UL>Write the XML to the response buffer.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- 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-XmlWriter.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.XmlRpcRequest.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<B>NEXT CLASS</B></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="index.html" TARGET="_top"><B>FRAMES</B></A>
|
||||
<A HREF="jala.XmlWriter.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>
|
||||
475
modules/jala/docs/jala.db.DataType.html
Normal file
475
modules/jala/docs/jala.db.DataType.html
Normal file
|
|
@ -0,0 +1,475 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
jala.db.DataType
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title="jala.db.DataType";
|
||||
}
|
||||
</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-Database.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.0</B>
|
||||
</EM>
|
||||
</TD
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="jala.db.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.db.FileDatabase.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.db.DataType.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.db.DataType</H2>
|
||||
<PRE>Object
|
||||
|
|
||||
+--<b>jala.db.DataType</b>
|
||||
</PRE>
|
||||
|
||||
|
||||
<HR>
|
||||
<DL>
|
||||
<!-- Class definition -->
|
||||
<DT>class
|
||||
<B>jala.db.DataType</B>
|
||||
|
||||
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<BR/>Instances of this class represent a data type. Each instance
|
||||
contains the code number as defined in java.sql.Types, the name of
|
||||
the data type as defined in java.sql.Types and optional creation parameters
|
||||
allowed for this data type.
|
||||
<BR/><I>Defined in <a href='overview-summary-Database.js.html'>Database.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.db.DataType.html#jala.db.DataType()">jala.db.DataType</A>
|
||||
</B>
|
||||
(<Number> type, <String> typeName, <String> params)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns a newly created DataType 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="#getParams">getParams</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns the creation parameter string of this data type
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> Number</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#getType">getType</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns the sql type code number as defined in java.sql.Types
|
||||
</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="#getTypeName">getTypeName</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns the type name of this data type, which can be
|
||||
used in sql queries.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> Boolean</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#needsQuotes">needsQuotes</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns true if values for this data type should be surrounded
|
||||
by (single) quotes.
|
||||
</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.db.DataType()"><!-- --></A><H3>
|
||||
jala.db.DataType</H3>
|
||||
<PRE><B>jala.db.DataType</B>(<Number> type, <String> typeName, <String> params)</PRE>
|
||||
|
||||
|
||||
<UL>
|
||||
Returns a newly created DataType instance.
|
||||
</UL>
|
||||
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>type</CODE> - The sql code number of this data type
|
||||
</UL>
|
||||
|
||||
<UL><CODE>typeName</CODE> - The type name of this data type, as used within sql statements
|
||||
</UL>
|
||||
|
||||
<UL><CODE>params</CODE> - Optional creation parameters allowed for this data type.
|
||||
</UL>
|
||||
|
||||
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- Constructor return value(s) -->
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
A newly created instance of DataType.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
<!-- 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="getParams"><!-- --></A>
|
||||
<H3>getParams</H3>
|
||||
<PRE>String <B>getParams</B>()</PRE>
|
||||
|
||||
<UL>Returns the creation parameter string of this data type</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The creation parameter string of this data type
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="getType"><!-- --></A>
|
||||
<H3>getType</H3>
|
||||
<PRE>Number <B>getType</B>()</PRE>
|
||||
|
||||
<UL>Returns the sql type code number as defined in java.sql.Types</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The sql type code number of this data type
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="getTypeName"><!-- --></A>
|
||||
<H3>getTypeName</H3>
|
||||
<PRE>String <B>getTypeName</B>()</PRE>
|
||||
|
||||
<UL>Returns the type name of this data type, which can be
|
||||
used in sql queries.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The type name of this data type
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="needsQuotes"><!-- --></A>
|
||||
<H3>needsQuotes</H3>
|
||||
<PRE>Boolean <B>needsQuotes</B>()</PRE>
|
||||
|
||||
<UL>Returns true if values for this data type should be surrounded
|
||||
by (single) quotes.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
True if values for this data type should be surrounded by quotes, false if not
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- 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-Database.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.0</B>
|
||||
</EM>
|
||||
</TD
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="jala.db.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.db.FileDatabase.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.db.DataType.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 Wed Apr 4 17:06:49 2007</div>
|
||||
</BODY>
|
||||
</HTML>
|
||||
637
modules/jala/docs/jala.db.FileDatabase.html
Normal file
637
modules/jala/docs/jala.db.FileDatabase.html
Normal file
|
|
@ -0,0 +1,637 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
jala.db.FileDatabase
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title="jala.db.FileDatabase";
|
||||
}
|
||||
</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-Database.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.db.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.db.RamDatabase.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.db.FileDatabase.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.db.FileDatabase</H2>
|
||||
<PRE>Object
|
||||
|
|
||||
+--<a href='jala.db.RamDatabase.html'>jala.db.RamDatabase</a>
|
||||
|
|
||||
+--<b>jala.db.FileDatabase</b>
|
||||
</PRE>
|
||||
|
||||
|
||||
<HR>
|
||||
<DL>
|
||||
<!-- Class definition -->
|
||||
<DT>class
|
||||
<B>jala.db.FileDatabase</B>
|
||||
|
||||
<DT>extends <a href='jala.db.RamDatabase.html'>jala.db.RamDatabase</a>
|
||||
|
||||
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<BR/>Instances of this class represent a file based in-process database
|
||||
<br /><strong>Important:</strong> You need the h2.jar in directory "lib/ext"
|
||||
of your helma installation for this library to work, which you can get
|
||||
at http://www.h2database.com/.
|
||||
<BR/><I>Defined in <a href='overview-summary-Database.js.html'>Database.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.db.FileDatabase.html#jala.db.FileDatabase()">jala.db.FileDatabase</A>
|
||||
</B>
|
||||
(<String> name, <helma.File> directory, <String> username, <String> password)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns a newly created instance of FileDatabase.
|
||||
</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> Boolean</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#backup">backup</A></B>(<helma.File> file)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Creates a backup of this database, using the file passed as argument.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> helma.File</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#getDirectory">getDirectory</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns the directory where the database files are stored.
|
||||
</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="#getName">getName</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns the name of the database.
|
||||
</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="#getPassword">getPassword</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns the password of this database
|
||||
</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="#getUsername">getUsername</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns the username of this database
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> Boolean</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#remove">remove</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Deletes all files of this database on disk.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> Boolean</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#restore">restore</A></B>(<helma.File> backupFile)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Restores this database using a backup on disk.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
|
||||
</TABLE>
|
||||
|
||||
|
||||
|
||||
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TD><B>Methods inherited from class <a href="jala.db.RamDatabase.html">jala.db.RamDatabase</a></B></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>
|
||||
<!-- Inherited methods -->
|
||||
<a href="jala.db.RamDatabase.html#getUrl">getUrl</a>, <a href="jala.db.RamDatabase.html#getProperties">getProperties</a>, <a href="jala.db.RamDatabase.html#getConnection">getConnection</a>, <a href="jala.db.RamDatabase.html#shutdown">shutdown</a>, <a href="jala.db.RamDatabase.html#dropTable">dropTable</a>, <a href="jala.db.RamDatabase.html#tableExists">tableExists</a>, <a href="jala.db.RamDatabase.html#copyTables">copyTables</a>, <a href="jala.db.RamDatabase.html#runScript">runScript</a>, <a href="jala.db.RamDatabase.html#dump">dump</a>
|
||||
</CODE></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.db.FileDatabase()"><!-- --></A><H3>
|
||||
jala.db.FileDatabase</H3>
|
||||
<PRE><B>jala.db.FileDatabase</B>(<String> name, <helma.File> directory, <String> username, <String> password)</PRE>
|
||||
|
||||
|
||||
<UL>
|
||||
Returns a newly created instance of FileDatabase.
|
||||
</UL>
|
||||
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>name</CODE> - The name of the database. This name is used as prefix for all database files
|
||||
</UL>
|
||||
|
||||
<UL><CODE>directory</CODE> - The directory where the database files should be stored in.
|
||||
</UL>
|
||||
|
||||
<UL><CODE>username</CODE> - Optional username (defaults to "sa"). This username is used when creating the database, so the same should be used when creating subsequent instances of jala.db.FileDatabase pointing to the same database
|
||||
</UL>
|
||||
|
||||
<UL><CODE>password</CODE> - Optional password (defaults to "").
|
||||
</UL>
|
||||
|
||||
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- Constructor return value(s) -->
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
A newly created FileDatabase instance
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
<!-- 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="backup"><!-- --></A>
|
||||
<H3>backup</H3>
|
||||
<PRE>Boolean <B>backup</B>(<helma.File> file)</PRE>
|
||||
|
||||
<UL>Creates a backup of this database, using the file passed as argument. The
|
||||
result will be a zipped file containing the database files</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>file</CODE> - The file to write the backup to
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
True if the database backup was created successfully, false otherwise
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="getDirectory"><!-- --></A>
|
||||
<H3>getDirectory</H3>
|
||||
<PRE>helma.File <B>getDirectory</B>()</PRE>
|
||||
|
||||
<UL>Returns the directory where the database files are stored.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The directory where this database is stored.
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="getName"><!-- --></A>
|
||||
<H3>getName</H3>
|
||||
<PRE>String <B>getName</B>()</PRE>
|
||||
|
||||
<UL>Returns the name of the database. This name is used as prefix
|
||||
for all files of this database in the specified directory</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The name of the database
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="getPassword"><!-- --></A>
|
||||
<H3>getPassword</H3>
|
||||
<PRE>String <B>getPassword</B>()</PRE>
|
||||
|
||||
<UL>Returns the password of this database</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The password of this database
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="getUsername"><!-- --></A>
|
||||
<H3>getUsername</H3>
|
||||
<PRE>String <B>getUsername</B>()</PRE>
|
||||
|
||||
<UL>Returns the username of this database</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The username of this database
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="remove"><!-- --></A>
|
||||
<H3>remove</H3>
|
||||
<PRE>Boolean <B>remove</B>()</PRE>
|
||||
|
||||
<UL>Deletes all files of this database on disk. Note that this also
|
||||
closes the database before removing it.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
True in case the database was removed successfully, false otherwise
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="restore"><!-- --></A>
|
||||
<H3>restore</H3>
|
||||
<PRE>Boolean <B>restore</B>(<helma.File> backupFile)</PRE>
|
||||
|
||||
<UL>Restores this database using a backup on disk.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>backupFile</CODE> - The backup file to use for restore
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
True if the database was successfully restored, false otherwise
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- 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-Database.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.db.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.db.RamDatabase.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.db.FileDatabase.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>
|
||||
886
modules/jala/docs/jala.db.RamDatabase.html
Normal file
886
modules/jala/docs/jala.db.RamDatabase.html
Normal file
|
|
@ -0,0 +1,886 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
jala.db.RamDatabase
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title="jala.db.RamDatabase";
|
||||
}
|
||||
</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-Database.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.db.FileDatabase.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.db.Server.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.db.RamDatabase.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.db.RamDatabase</H2>
|
||||
<PRE>Object
|
||||
|
|
||||
+--<b>jala.db.RamDatabase</b>
|
||||
</PRE>
|
||||
|
||||
<DL>
|
||||
<DT>
|
||||
<B>Direct Known Subclasses:</B>
|
||||
<DD>
|
||||
<a href="jala.db.FileDatabase.html">jala.db.FileDatabase</a>
|
||||
</DD>
|
||||
</DL>
|
||||
|
||||
|
||||
<HR>
|
||||
<DL>
|
||||
<!-- Class definition -->
|
||||
<DT>class
|
||||
<B>jala.db.RamDatabase</B>
|
||||
|
||||
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<BR/>Instances of this class represent an in-memory sql database.
|
||||
<br /><strong>Important:</strong> You need the h2.jar in directory "lib/ext"
|
||||
of your helma installation for this library to work, which you can get
|
||||
at http://www.h2database.com/.
|
||||
<BR/><I>Defined in <a href='overview-summary-Database.js.html'>Database.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.db.RamDatabase.html#jala.db.RamDatabase()">jala.db.RamDatabase</A>
|
||||
</B>
|
||||
(<String> name, <String> username, <String> password)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns a newly created RamDatabase 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> void</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#copyTables">copyTables</A></B>(<helma.Database> database, <Array> tables)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Copies all tables in the database passed as argument into this embedded database.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> Boolean</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#dropTable">dropTable</A></B>(<String> tableName)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Drops the table with the given name
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> Boolean</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#dump">dump</A></B>(<helma.File> file, <Object> props)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Dumps the database schema and data into a file
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> helma.Database</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#getConnection">getConnection</A></B>(props)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns a connection to this database
|
||||
</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="#getName">getName</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns the name of the database
|
||||
</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="#getPassword">getPassword</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns the password of this database
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> helma.util.ResourceProperties</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#getProperties">getProperties</A></B>(<Object> props)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns a properties object containing the connection properties
|
||||
for this database.
|
||||
</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="#getUrl">getUrl</A></B>(<Object> props)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns the JDBC Url to connect to this database
|
||||
</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="#getUsername">getUsername</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns the username of this database
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> Boolean</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#runScript">runScript</A></B>(<helma.File> file, <Object> props, <String> charset, <Boolean> continueOnError)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Runs the script file passed as argument in the context of this database.
|
||||
</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="#shutdown">shutdown</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Stops this in-process database by issueing a "SHUTDOWN" sql command.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> Boolean</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#tableExists">tableExists</A></B>(<String> name)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns true if the table exists already in the database
|
||||
</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.db.RamDatabase()"><!-- --></A><H3>
|
||||
jala.db.RamDatabase</H3>
|
||||
<PRE><B>jala.db.RamDatabase</B>(<String> name, <String> username, <String> password)</PRE>
|
||||
|
||||
|
||||
<UL>
|
||||
Returns a newly created RamDatabase instance.
|
||||
</UL>
|
||||
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>name</CODE> - The name of the database. If not given a private un-named database is created, that can only be accessed through this instance of jala.db.RamDatabase
|
||||
</UL>
|
||||
|
||||
<UL><CODE>username</CODE> - Optional username (defaults to "sa"). This username is used when creating the database, so the same should be used when creating subsequent instances of jala.db.RamDatabase pointing to a named database.
|
||||
</UL>
|
||||
|
||||
<UL><CODE>password</CODE> - Optional password (defaults to "").
|
||||
</UL>
|
||||
|
||||
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- Constructor return value(s) -->
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
A newly created instance of RamDatabase
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
<!-- 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="copyTables"><!-- --></A>
|
||||
<H3>copyTables</H3>
|
||||
<PRE>void <B>copyTables</B>(<helma.Database> database, <Array> tables)</PRE>
|
||||
|
||||
<UL>Copies all tables in the database passed as argument into this embedded database.
|
||||
If any of the tables already exists in this database, they will be removed before
|
||||
re-created. Please mind that this method ignores any indexes in the source database,
|
||||
but respects the primary key settings.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>database</CODE> - The database to copy the tables from
|
||||
</UL>
|
||||
|
||||
<UL><CODE>tables</CODE> - An optional array containing the names of the tables to copy. If not given all tables are copied
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="dropTable"><!-- --></A>
|
||||
<H3>dropTable</H3>
|
||||
<PRE>Boolean <B>dropTable</B>(<String> tableName)</PRE>
|
||||
|
||||
<UL>Drops the table with the given name</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>tableName</CODE> - The name of the table
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
True if the table was successfully dropped, false otherwise
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="dump"><!-- --></A>
|
||||
<H3>dump</H3>
|
||||
<PRE>Boolean <B>dump</B>(<helma.File> file, <Object> props)</PRE>
|
||||
|
||||
<UL>Dumps the database schema and data into a file</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>file</CODE> - The file where the database dump will be
|
||||
</UL>
|
||||
|
||||
<UL><CODE>props</CODE> - Optional object containing connection properties
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
True in case the database was successfully dumped, false otherwise
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="getConnection"><!-- --></A>
|
||||
<H3>getConnection</H3>
|
||||
<PRE>helma.Database <B>getConnection</B>(props)</PRE>
|
||||
|
||||
<UL>Returns a connection to this database</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>An</CODE> - optional parameter object containing connection properties to add to the connection Url.
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
A connection to this database
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="getName"><!-- --></A>
|
||||
<H3>getName</H3>
|
||||
<PRE>String <B>getName</B>()</PRE>
|
||||
|
||||
<UL>Returns the name of the database</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The name of the database
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="getPassword"><!-- --></A>
|
||||
<H3>getPassword</H3>
|
||||
<PRE>String <B>getPassword</B>()</PRE>
|
||||
|
||||
<UL>Returns the password of this database</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The password of this database
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="getProperties"><!-- --></A>
|
||||
<H3>getProperties</H3>
|
||||
<PRE>helma.util.ResourceProperties <B>getProperties</B>(<Object> props)</PRE>
|
||||
|
||||
<UL>Returns a properties object containing the connection properties
|
||||
for this database.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>props</CODE> - An optional parameter object containing connection properties to add to the connection Url.
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
A properties object containing the connection properties
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="getUrl"><!-- --></A>
|
||||
<H3>getUrl</H3>
|
||||
<PRE>String <B>getUrl</B>(<Object> props)</PRE>
|
||||
|
||||
<UL>Returns the JDBC Url to connect to this database</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>props</CODE> - Optional connection properties to add
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The JDBC url to use for connecting to this database
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="getUsername"><!-- --></A>
|
||||
<H3>getUsername</H3>
|
||||
<PRE>String <B>getUsername</B>()</PRE>
|
||||
|
||||
<UL>Returns the username of this database</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The username of this database
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="runScript"><!-- --></A>
|
||||
<H3>runScript</H3>
|
||||
<PRE>Boolean <B>runScript</B>(<helma.File> file, <Object> props, <String> charset, <Boolean> continueOnError)</PRE>
|
||||
|
||||
<UL>Runs the script file passed as argument in the context of this database.
|
||||
Use this method to eg. create and/or populate a database.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>file</CODE> - The script file to run
|
||||
</UL>
|
||||
|
||||
<UL><CODE>props</CODE> - Optional object containing connection properties
|
||||
</UL>
|
||||
|
||||
<UL><CODE>charset</CODE> - Optional character set to use (defaults to "UTF-8")
|
||||
</UL>
|
||||
|
||||
<UL><CODE>continueOnError</CODE> - Optional flag indicating whether to continue on error or not (defaults to false)
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
True in case the script was executed successfully, false otherwise
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="shutdown"><!-- --></A>
|
||||
<H3>shutdown</H3>
|
||||
<PRE>void <B>shutdown</B>()</PRE>
|
||||
|
||||
<UL>Stops this in-process database by issueing a "SHUTDOWN" sql command.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="tableExists"><!-- --></A>
|
||||
<H3>tableExists</H3>
|
||||
<PRE>Boolean <B>tableExists</B>(<String> name)</PRE>
|
||||
|
||||
<UL>Returns true if the table exists already in the database</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>name</CODE> - The name of the table
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
True if the table exists, false otherwise
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- 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-Database.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.db.FileDatabase.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.db.Server.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.db.RamDatabase.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>
|
||||
850
modules/jala/docs/jala.db.Server.html
Normal file
850
modules/jala/docs/jala.db.Server.html
Normal file
|
|
@ -0,0 +1,850 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
jala.db.Server
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title="jala.db.Server";
|
||||
}
|
||||
</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-Database.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.db.RamDatabase.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.DnsClient.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.db.Server.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.db.Server</H2>
|
||||
<PRE>Object
|
||||
|
|
||||
+--<b>jala.db.Server</b>
|
||||
</PRE>
|
||||
|
||||
|
||||
<HR>
|
||||
<DL>
|
||||
<!-- Class definition -->
|
||||
<DT>class
|
||||
<B>jala.db.Server</B>
|
||||
|
||||
|
||||
</DL>
|
||||
|
||||
<P>
|
||||
<BR/>Instances of this class represent a H2 database listener that
|
||||
allows multiple databases to be accessed via tcp.
|
||||
<br /><strong>Important:</strong> You need the h2.jar in directory "lib/ext"
|
||||
of your helma installation for this library to work, which you can get
|
||||
at http://www.h2database.com/.
|
||||
<BR/><I>Defined in <a href='overview-summary-Database.js.html'>Database.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.db.Server.html#jala.db.Server()">jala.db.Server</A>
|
||||
</B>
|
||||
(<helma.File> baseDir, <Number> port)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns a new Server 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> Boolean</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#createOnDemand">createOnDemand</A></B>(<Boolean> bool)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
If called with boolean true as argument, this server creates databases
|
||||
on-the-fly, otherwise it only accepts connections to already existing
|
||||
databases.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> helma.Database</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#getConnection">getConnection</A></B>(<String> name, <String> username, <String> password, <Object> props)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns a connection to a database within this server.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> helma.File</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#getDirectory">getDirectory</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns the directory used by this server instance
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> Number</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#getPort">getPort</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns the port this server listens on
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> helma.util.ResourceProperties</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#getProperties">getProperties</A></B>(<String> name, <String> username, <String> password, <Object> props)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns a properties object containing the connection properties
|
||||
of the database with the given name.
|
||||
</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="#getUrl">getUrl</A></B>(<String> name, <Object> props)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns the JDBC Url to use for connections to a given database.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> Boolean</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#isPublic">isPublic</A></B>(<Boolean> bool)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
If called with boolean true as argument, this server accepts connections
|
||||
from outside localhost.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> Boolean</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#isRunning">isRunning</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Returns true if the database server is running.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> Boolean</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#start">start</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Starts the database server.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> Boolean</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#stop">stop</A></B>()
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Stops the database server.
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||||
<FONT SIZE="-1">
|
||||
<CODE> Boolean</CODE>
|
||||
</FONT>
|
||||
</TD>
|
||||
<TD>
|
||||
<CODE>
|
||||
<B>
|
||||
<A HREF="#useSsl">useSsl</A></B>(<Boolean> bool)
|
||||
</CODE>
|
||||
<BR>
|
||||
|
||||
Toggles the use of Ssl encryption within this server.
|
||||
</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.db.Server()"><!-- --></A><H3>
|
||||
jala.db.Server</H3>
|
||||
<PRE><B>jala.db.Server</B>(<helma.File> baseDir, <Number> port)</PRE>
|
||||
|
||||
|
||||
<UL>
|
||||
Returns a new Server instance.
|
||||
</UL>
|
||||
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>baseDir</CODE> - The directory where the database files are located or should be stored
|
||||
</UL>
|
||||
|
||||
<UL><CODE>port</CODE> - The port to listen on (defaults to 9001)
|
||||
</UL>
|
||||
|
||||
<UL><CODE>createOnDemand</CODE> - If true this server will create non-existing databases on-the-fly, if false it only accepts connections to already existing databases in the given base directory
|
||||
</UL>
|
||||
|
||||
<UL><CODE>makePublic</CODE> - If true this database is reachable from outside, if false it's only reachable from localhost
|
||||
</UL>
|
||||
|
||||
<UL><CODE>useSsl</CODE> - If true SSL will be used to encrypt the connection
|
||||
</UL>
|
||||
|
||||
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- Constructor return value(s) -->
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
A newly created Server instance
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
<!-- 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="createOnDemand"><!-- --></A>
|
||||
<H3>createOnDemand</H3>
|
||||
<PRE>Boolean <B>createOnDemand</B>(<Boolean> bool)</PRE>
|
||||
|
||||
<UL>If called with boolean true as argument, this server creates databases
|
||||
on-the-fly, otherwise it only accepts connections to already existing
|
||||
databases. This should be set before starting the server.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>bool</CODE> - If true this server creates non-existing databases on demand, if false it only allows connections to existing databases. If no argument is given, this method returns the current setting.
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The current setting if no argument is given, or void
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="getConnection"><!-- --></A>
|
||||
<H3>getConnection</H3>
|
||||
<PRE>helma.Database <B>getConnection</B>(<String> name, <String> username, <String> password, <Object> props)</PRE>
|
||||
|
||||
<UL>Returns a connection to a database within this server.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>name</CODE> - The name of the database running within this server
|
||||
</UL>
|
||||
|
||||
<UL><CODE>username</CODE> - Optional username to use for this connection
|
||||
</UL>
|
||||
|
||||
<UL><CODE>password</CODE> - Optional password to use for this connection
|
||||
</UL>
|
||||
|
||||
<UL><CODE>props</CODE> - An optional parameter object containing connection properties to add to the connection Url.
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
A connection to the specified database
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="getDirectory"><!-- --></A>
|
||||
<H3>getDirectory</H3>
|
||||
<PRE>helma.File <B>getDirectory</B>()</PRE>
|
||||
|
||||
<UL>Returns the directory used by this server instance</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The directory where the databases used by this server are located in
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="getPort"><!-- --></A>
|
||||
<H3>getPort</H3>
|
||||
<PRE>Number <B>getPort</B>()</PRE>
|
||||
|
||||
<UL>Returns the port this server listens on</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The port this server listens on
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="getProperties"><!-- --></A>
|
||||
<H3>getProperties</H3>
|
||||
<PRE>helma.util.ResourceProperties <B>getProperties</B>(<String> name, <String> username, <String> password, <Object> props)</PRE>
|
||||
|
||||
<UL>Returns a properties object containing the connection properties
|
||||
of the database with the given name.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>name</CODE> - The name of the database
|
||||
</UL>
|
||||
|
||||
<UL><CODE>username</CODE> - Optional username to use for this connection
|
||||
</UL>
|
||||
|
||||
<UL><CODE>password</CODE> - Optional password to use for this connection
|
||||
</UL>
|
||||
|
||||
<UL><CODE>props</CODE> - An optional parameter object containing connection properties to add to the connection Url.
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
A properties object containing the connection properties
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="getUrl"><!-- --></A>
|
||||
<H3>getUrl</H3>
|
||||
<PRE>String <B>getUrl</B>(<String> name, <Object> props)</PRE>
|
||||
|
||||
<UL>Returns the JDBC Url to use for connections to a given database.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>name</CODE> - An optional name of a database running
|
||||
</UL>
|
||||
|
||||
<UL><CODE>props</CODE> - Optional connection properties to add
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The JDBC Url to use for connecting to a database within this sever
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="isPublic"><!-- --></A>
|
||||
<H3>isPublic</H3>
|
||||
<PRE>Boolean <B>isPublic</B>(<Boolean> bool)</PRE>
|
||||
|
||||
<UL>If called with boolean true as argument, this server accepts connections
|
||||
from outside localhost. This should be set before starting the server.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>bool</CODE> - If true this server accepts connections from outside localhost. If no argument is given, this method returns the current setting.
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The current setting if no argument is given, or void
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="isRunning"><!-- --></A>
|
||||
<H3>isRunning</H3>
|
||||
<PRE>Boolean <B>isRunning</B>()</PRE>
|
||||
|
||||
<UL>Returns true if the database server is running.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
True if the database server is running
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="start"><!-- --></A>
|
||||
<H3>start</H3>
|
||||
<PRE>Boolean <B>start</B>()</PRE>
|
||||
|
||||
<UL>Starts the database server.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
True in case the server started successfully, false otherwise
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="stop"><!-- --></A>
|
||||
<H3>stop</H3>
|
||||
<PRE>Boolean <B>stop</B>()</PRE>
|
||||
|
||||
<UL>Stops the database server.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
True if stopping the server was successful, false otherwise
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES END -->
|
||||
<HR>
|
||||
|
||||
<A NAME="useSsl"><!-- --></A>
|
||||
<H3>useSsl</H3>
|
||||
<PRE>Boolean <B>useSsl</B>(<Boolean> bool)</PRE>
|
||||
|
||||
<UL>Toggles the use of Ssl encryption within this server. This should be set
|
||||
before starting the server.</UL>
|
||||
|
||||
|
||||
<!-- METHOD PARAMETERS START -->
|
||||
|
||||
<UL>
|
||||
<B>Parameters:</B>
|
||||
|
||||
<UL><CODE>bool</CODE> - If true SSL encryption will be used, false otherwise. If no argument is given, this method returns the current setting.
|
||||
</UL>
|
||||
|
||||
</UL>
|
||||
|
||||
<!-- METHOD PARAMETERS END -->
|
||||
|
||||
|
||||
<UL>
|
||||
<B>Returns:</B>
|
||||
<UL>
|
||||
The current setting if no argument is given, or void
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES START -->
|
||||
|
||||
<!-- 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-Database.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.db.RamDatabase.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.DnsClient.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.db.Server.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>
|
||||
243
modules/jala/docs/jala.db.html
Normal file
243
modules/jala/docs/jala.db.html
Normal file
|
|
@ -0,0 +1,243 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
jala.db
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title="jala.db";
|
||||
}
|
||||
</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"> <FONT CLASS="NavBarFont1">File</FONT> </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.Date.Calendar.Renderer.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.db.FileDatabase.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.db.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.db</H2>
|
||||
<PRE>Object
|
||||
|
|
||||
+--<b>jala.db</b>
|
||||
</PRE>
|
||||
|
||||
|
||||
<HR>
|
||||
<DL>
|
||||
<!-- Class definition -->
|
||||
<DT>class
|
||||
<B>jala.db</B>
|
||||
|
||||
|
||||
</DL>
|
||||
|
||||
<HR>
|
||||
|
||||
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
||||
|
||||
<A NAME="inner_classes"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=2><FONT SIZE="+2">
|
||||
<B>Nested Class Summary</B></FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static class></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="jala.db.Server.html">jala.db.Server</A></B></CODE></TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static class></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="jala.db.DataType.html">jala.db.DataType</A></B></CODE></TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static class></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="jala.db.RamDatabase.html">jala.db.RamDatabase</A></B></CODE></TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static class></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="jala.db.FileDatabase.html">jala.db.FileDatabase</A></B></CODE></TD>
|
||||
</TR>
|
||||
|
||||
</TABLE>
|
||||
|
||||
|
||||
<!-- ======== END NESTED CLASS SUMMARY ======== -->
|
||||
|
||||
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- =========== END FIELD SUMMARY =========== -->
|
||||
|
||||
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
|
||||
<!-- ======== END CONSTRUCTOR SUMMARY ======== -->
|
||||
|
||||
|
||||
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
|
||||
|
||||
|
||||
<P>
|
||||
<!-- ========== END METHOD SUMMARY =========== -->
|
||||
|
||||
|
||||
<!-- ============ FIELD DETAIL START =========== -->
|
||||
|
||||
|
||||
<!-- ============ FIELD DETAIL END =========== -->
|
||||
|
||||
<!-- ========= CONSTRUCTOR DETAIL START ======== -->
|
||||
|
||||
|
||||
<!-- Constructor return value(s) -->
|
||||
|
||||
<!-- End constructor return value(s) -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES -->
|
||||
|
||||
<HR/>
|
||||
<!-- END ADDITIONAL ATTRIBUTES -->
|
||||
|
||||
<!-- ========= CONSTRUCTOR DETAIL END ======== -->
|
||||
|
||||
|
||||
<!-- ============ METHOD DETAIL START ========== -->
|
||||
|
||||
|
||||
<!-- ============ 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"> <FONT CLASS="NavBarFont1">File</FONT> </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.Date.Calendar.Renderer.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.db.FileDatabase.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.db.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>
|
||||
423
modules/jala/docs/jala.html
Normal file
423
modules/jala/docs/jala.html
Normal file
|
|
@ -0,0 +1,423 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
jala
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title="jala";
|
||||
}
|
||||
</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"> <FONT CLASS="NavBarFont1">File</FONT> </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="HopObject.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.AsyncRequest.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.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</H2>
|
||||
<PRE>Object
|
||||
|
|
||||
+--<b>jala</b>
|
||||
</PRE>
|
||||
|
||||
|
||||
<HR>
|
||||
<DL>
|
||||
<!-- Class definition -->
|
||||
<DT>class
|
||||
<B>jala</B>
|
||||
|
||||
|
||||
</DL>
|
||||
|
||||
<HR>
|
||||
|
||||
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
||||
|
||||
<A NAME="inner_classes"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=2><FONT SIZE="+2">
|
||||
<B>Nested Class Summary</B></FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static class></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="jala.AsyncRequest.html">jala.AsyncRequest</A></B></CODE></TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static class></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="jala.BitTorrent.html">jala.BitTorrent</A></B></CODE></TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static class></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="jala.Captcha.html">jala.Captcha</A></B></CODE></TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static class></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="jala.Date.html">jala.Date</A></B></CODE></TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static class></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="jala.DnsClient.html">jala.DnsClient</A></B></CODE></TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static class></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="jala.Form.html">jala.Form</A></B></CODE></TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static class></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="jala.History.html">jala.History</A></B></CODE></TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static class></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="jala.HtmlDocument.html">jala.HtmlDocument</A></B></CODE></TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static class></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="jala.I18n.html">jala.I18n</A></B></CODE></TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static class></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="jala.ImageFilter.html">jala.ImageFilter</A></B></CODE></TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static class></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="jala.IndexManager.html">jala.IndexManager</A></B></CODE></TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static class></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="jala.ListRenderer.html">jala.ListRenderer</A></B></CODE></TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static class></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="jala.Mp3.html">jala.Mp3</A></B></CODE></TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static class></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="jala.PodcastWriter.html">jala.PodcastWriter</A></B></CODE></TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static class></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="jala.RemoteContent.html">jala.RemoteContent</A></B></CODE></TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static class></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="jala.Rss20Writer.html">jala.Rss20Writer</A></B></CODE></TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static class></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="jala.Utilities.html">jala.Utilities</A></B></CODE></TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static class></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="jala.XmlRpcRequest.html">jala.XmlRpcRequest</A></B></CODE></TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static class></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="jala.XmlWriter.html">jala.XmlWriter</A></B></CODE></TD>
|
||||
</TR>
|
||||
|
||||
</TABLE>
|
||||
|
||||
|
||||
<!-- ======== END NESTED CLASS SUMMARY ======== -->
|
||||
|
||||
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
|
||||
<A NAME="field_summary"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=2><FONT SIZE="+2">
|
||||
<B>Field Summary</B></FONT></TD>
|
||||
</TR>
|
||||
|
||||
<!-- This is one instance field summary -->
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static> <final> <a href="jala.Date.html">jala.Date</a></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="#!s!date">date</A></B></CODE>
|
||||
<BR>
|
||||
Default date class instance.</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static> Object</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="#!s!db">db</A></B></CODE>
|
||||
<BR>
|
||||
Namespace declaration</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static> <final> <a href="jala.I18n.html">jala.I18n</a></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="#!s!i18n">i18n</A></B></CODE>
|
||||
<BR>
|
||||
Default i18n class instance.</TD>
|
||||
</TR>
|
||||
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE><static> <final> <a href="jala.Utilities.html">jala.Utilities</a></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="#!s!util">util</A></B></CODE>
|
||||
<BR>
|
||||
Default utility class instance.</TD>
|
||||
</TR>
|
||||
|
||||
|
||||
</TABLE>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- =========== END FIELD SUMMARY =========== -->
|
||||
|
||||
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
|
||||
<!-- ======== END CONSTRUCTOR SUMMARY ======== -->
|
||||
|
||||
|
||||
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
|
||||
|
||||
|
||||
<P>
|
||||
<!-- ========== END METHOD SUMMARY =========== -->
|
||||
|
||||
|
||||
<!-- ============ FIELD DETAIL START =========== -->
|
||||
|
||||
<A NAME="field_detail"><!-- --></A>
|
||||
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=1><FONT SIZE="+2"><B>Field Detail</B></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
|
||||
<A NAME="!s!date"><!-- --></A>
|
||||
<H3>date</H3>
|
||||
<PRE><static> <final> <a href="jala.Date.html">jala.Date</a> <B>date</B></PRE>
|
||||
<UL>
|
||||
Default date class instance.
|
||||
|
||||
</UL>
|
||||
<HR>
|
||||
|
||||
<A NAME="!s!db"><!-- --></A>
|
||||
<H3>db</H3>
|
||||
<PRE><static> Object <B>db</B></PRE>
|
||||
<UL>
|
||||
Namespace declaration
|
||||
|
||||
</UL>
|
||||
<HR>
|
||||
|
||||
<A NAME="!s!i18n"><!-- --></A>
|
||||
<H3>i18n</H3>
|
||||
<PRE><static> <final> <a href="jala.I18n.html">jala.I18n</a> <B>i18n</B></PRE>
|
||||
<UL>
|
||||
Default i18n class instance.
|
||||
|
||||
</UL>
|
||||
<HR>
|
||||
|
||||
<A NAME="!s!util"><!-- --></A>
|
||||
<H3>util</H3>
|
||||
<PRE><static> <final> <a href="jala.Utilities.html">jala.Utilities</a> <B>util</B></PRE>
|
||||
<UL>
|
||||
Default utility class instance.
|
||||
|
||||
</UL>
|
||||
<HR>
|
||||
|
||||
|
||||
|
||||
<!-- ============ FIELD DETAIL END =========== -->
|
||||
|
||||
<!-- ========= CONSTRUCTOR DETAIL START ======== -->
|
||||
|
||||
|
||||
<!-- Constructor return value(s) -->
|
||||
|
||||
<!-- End constructor return value(s) -->
|
||||
|
||||
<!-- ADDITIONAL ATTRIBUTES -->
|
||||
|
||||
<HR/>
|
||||
<!-- END ADDITIONAL ATTRIBUTES -->
|
||||
|
||||
<!-- ========= CONSTRUCTOR DETAIL END ======== -->
|
||||
|
||||
|
||||
<!-- ============ METHOD DETAIL START ========== -->
|
||||
|
||||
|
||||
<!-- ============ 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"> <FONT CLASS="NavBarFont1">File</FONT> </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="HopObject.html"><B>PREV CLASS</B></A><!--
|
||||
NEXT CLASS
|
||||
-->
|
||||
<A HREF="jala.AsyncRequest.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.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>
|
||||
36
modules/jala/docs/overview-AsyncRequest.js.html
Normal file
36
modules/jala/docs/overview-AsyncRequest.js.html
Normal file
|
|
@ -0,0 +1,36 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
AsyncRequest.js
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title=" AsyncRequest.js";
|
||||
}
|
||||
</SCRIPT>
|
||||
<BODY BGCOLOR="white" onload="asd();">
|
||||
|
||||
<H3 class="FrameHeadingFont"><B></B></H3>
|
||||
<FONT size="+1" CLASS="FrameHeadingFont">
|
||||
<B><a href="overview-summary-AsyncRequest.js.html"
|
||||
target="classFrame">AsyncRequest.js</a></B></FONT>
|
||||
<BR>
|
||||
|
||||
<TABLE BORDER="0" WIDTH="100%">
|
||||
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.AsyncRequest.html" TARGET="classFrame">jala.AsyncRequest</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
</TABLE>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
36
modules/jala/docs/overview-BitTorrent.js.html
Normal file
36
modules/jala/docs/overview-BitTorrent.js.html
Normal file
|
|
@ -0,0 +1,36 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
BitTorrent.js
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title=" BitTorrent.js";
|
||||
}
|
||||
</SCRIPT>
|
||||
<BODY BGCOLOR="white" onload="asd();">
|
||||
|
||||
<H3 class="FrameHeadingFont"><B></B></H3>
|
||||
<FONT size="+1" CLASS="FrameHeadingFont">
|
||||
<B><a href="overview-summary-BitTorrent.js.html"
|
||||
target="classFrame">BitTorrent.js</a></B></FONT>
|
||||
<BR>
|
||||
|
||||
<TABLE BORDER="0" WIDTH="100%">
|
||||
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.BitTorrent.html" TARGET="classFrame">jala.BitTorrent</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
</TABLE>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
36
modules/jala/docs/overview-Captcha.js.html
Normal file
36
modules/jala/docs/overview-Captcha.js.html
Normal file
|
|
@ -0,0 +1,36 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
Captcha.js
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title=" Captcha.js";
|
||||
}
|
||||
</SCRIPT>
|
||||
<BODY BGCOLOR="white" onload="asd();">
|
||||
|
||||
<H3 class="FrameHeadingFont"><B></B></H3>
|
||||
<FONT size="+1" CLASS="FrameHeadingFont">
|
||||
<B><a href="overview-summary-Captcha.js.html"
|
||||
target="classFrame">Captcha.js</a></B></FONT>
|
||||
<BR>
|
||||
|
||||
<TABLE BORDER="0" WIDTH="100%">
|
||||
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Captcha.html" TARGET="classFrame">jala.Captcha</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
</TABLE>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
48
modules/jala/docs/overview-Database.js.html
Normal file
48
modules/jala/docs/overview-Database.js.html
Normal file
|
|
@ -0,0 +1,48 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
Database.js
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title=" Database.js";
|
||||
}
|
||||
</SCRIPT>
|
||||
<BODY BGCOLOR="white" onload="asd();">
|
||||
|
||||
<H3 class="FrameHeadingFont"><B></B></H3>
|
||||
<FONT size="+1" CLASS="FrameHeadingFont">
|
||||
<B><a href="overview-summary-Database.js.html"
|
||||
target="classFrame">Database.js</a></B></FONT>
|
||||
<BR>
|
||||
|
||||
<TABLE BORDER="0" WIDTH="100%">
|
||||
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.db.FileDatabase.html" TARGET="classFrame">jala.db.FileDatabase</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.db.RamDatabase.html" TARGET="classFrame">jala.db.RamDatabase</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.db.Server.html" TARGET="classFrame">jala.db.Server</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
</TABLE>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
48
modules/jala/docs/overview-Date.js.html
Normal file
48
modules/jala/docs/overview-Date.js.html
Normal file
|
|
@ -0,0 +1,48 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
Date.js
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title=" Date.js";
|
||||
}
|
||||
</SCRIPT>
|
||||
<BODY BGCOLOR="white" onload="asd();">
|
||||
|
||||
<H3 class="FrameHeadingFont"><B></B></H3>
|
||||
<FONT size="+1" CLASS="FrameHeadingFont">
|
||||
<B><a href="overview-summary-Date.js.html"
|
||||
target="classFrame">Date.js</a></B></FONT>
|
||||
<BR>
|
||||
|
||||
<TABLE BORDER="0" WIDTH="100%">
|
||||
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Date.html" TARGET="classFrame">jala.Date</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Date.Calendar.html" TARGET="classFrame">jala.Date.Calendar</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Date.Calendar.Renderer.html" TARGET="classFrame">jala.Date.Calendar.Renderer</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
</TABLE>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
42
modules/jala/docs/overview-DnsClient.js.html
Normal file
42
modules/jala/docs/overview-DnsClient.js.html
Normal file
|
|
@ -0,0 +1,42 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
DnsClient.js
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title=" DnsClient.js";
|
||||
}
|
||||
</SCRIPT>
|
||||
<BODY BGCOLOR="white" onload="asd();">
|
||||
|
||||
<H3 class="FrameHeadingFont"><B></B></H3>
|
||||
<FONT size="+1" CLASS="FrameHeadingFont">
|
||||
<B><a href="overview-summary-DnsClient.js.html"
|
||||
target="classFrame">DnsClient.js</a></B></FONT>
|
||||
<BR>
|
||||
|
||||
<TABLE BORDER="0" WIDTH="100%">
|
||||
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.DnsClient.html" TARGET="classFrame">jala.DnsClient</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.DnsClient.Record.html" TARGET="classFrame">jala.DnsClient.Record</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
</TABLE>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
132
modules/jala/docs/overview-Form.js.html
Normal file
132
modules/jala/docs/overview-Form.js.html
Normal file
|
|
@ -0,0 +1,132 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
Form.js
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title=" Form.js";
|
||||
}
|
||||
</SCRIPT>
|
||||
<BODY BGCOLOR="white" onload="asd();">
|
||||
|
||||
<H3 class="FrameHeadingFont"><B></B></H3>
|
||||
<FONT size="+1" CLASS="FrameHeadingFont">
|
||||
<B><a href="overview-summary-Form.js.html"
|
||||
target="classFrame">Form.js</a></B></FONT>
|
||||
<BR>
|
||||
|
||||
<TABLE BORDER="0" WIDTH="100%">
|
||||
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.html" TARGET="classFrame">jala.Form</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.Component.html" TARGET="classFrame">jala.Form.Component</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.Component.Button.html" TARGET="classFrame">jala.Form.Component.Button</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.Component.Checkbox.html" TARGET="classFrame">jala.Form.Component.Checkbox</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.Component.Date.html" TARGET="classFrame">jala.Form.Component.Date</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.Component.Fieldset.html" TARGET="classFrame">jala.Form.Component.Fieldset</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.Component.File.html" TARGET="classFrame">jala.Form.Component.File</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.Component.Hidden.html" TARGET="classFrame">jala.Form.Component.Hidden</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.Component.Image.html" TARGET="classFrame">jala.Form.Component.Image</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.Component.Input.html" TARGET="classFrame">jala.Form.Component.Input</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.Component.Password.html" TARGET="classFrame">jala.Form.Component.Password</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.Component.Radio.html" TARGET="classFrame">jala.Form.Component.Radio</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.Component.Select.html" TARGET="classFrame">jala.Form.Component.Select</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.Component.Skin.html" TARGET="classFrame">jala.Form.Component.Skin</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.Component.Submit.html" TARGET="classFrame">jala.Form.Component.Submit</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.Component.Textarea.html" TARGET="classFrame">jala.Form.Component.Textarea</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Form.Tracker.html" TARGET="classFrame">jala.Form.Tracker</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
</TABLE>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
30
modules/jala/docs/overview-Global.js.html
Normal file
30
modules/jala/docs/overview-Global.js.html
Normal file
|
|
@ -0,0 +1,30 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
Global.js
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title=" Global.js";
|
||||
}
|
||||
</SCRIPT>
|
||||
<BODY BGCOLOR="white" onload="asd();">
|
||||
|
||||
<H3 class="FrameHeadingFont"><B></B></H3>
|
||||
<FONT size="+1" CLASS="FrameHeadingFont">
|
||||
<B><a href="overview-summary-Global.js.html"
|
||||
target="classFrame">Global.js</a></B></FONT>
|
||||
<BR>
|
||||
|
||||
<TABLE BORDER="0" WIDTH="100%">
|
||||
|
||||
|
||||
</TABLE>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
36
modules/jala/docs/overview-History.js.html
Normal file
36
modules/jala/docs/overview-History.js.html
Normal file
|
|
@ -0,0 +1,36 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
History.js
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title=" History.js";
|
||||
}
|
||||
</SCRIPT>
|
||||
<BODY BGCOLOR="white" onload="asd();">
|
||||
|
||||
<H3 class="FrameHeadingFont"><B></B></H3>
|
||||
<FONT size="+1" CLASS="FrameHeadingFont">
|
||||
<B><a href="overview-summary-History.js.html"
|
||||
target="classFrame">History.js</a></B></FONT>
|
||||
<BR>
|
||||
|
||||
<TABLE BORDER="0" WIDTH="100%">
|
||||
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.History.html" TARGET="classFrame">jala.History</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
</TABLE>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
30
modules/jala/docs/overview-HopObject.js.html
Normal file
30
modules/jala/docs/overview-HopObject.js.html
Normal file
|
|
@ -0,0 +1,30 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
HopObject.js
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title=" HopObject.js";
|
||||
}
|
||||
</SCRIPT>
|
||||
<BODY BGCOLOR="white" onload="asd();">
|
||||
|
||||
<H3 class="FrameHeadingFont"><B></B></H3>
|
||||
<FONT size="+1" CLASS="FrameHeadingFont">
|
||||
<B><a href="overview-summary-HopObject.js.html"
|
||||
target="classFrame">HopObject.js</a></B></FONT>
|
||||
<BR>
|
||||
|
||||
<TABLE BORDER="0" WIDTH="100%">
|
||||
|
||||
|
||||
</TABLE>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
36
modules/jala/docs/overview-HtmlDocument.js.html
Normal file
36
modules/jala/docs/overview-HtmlDocument.js.html
Normal file
|
|
@ -0,0 +1,36 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
HtmlDocument.js
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title=" HtmlDocument.js";
|
||||
}
|
||||
</SCRIPT>
|
||||
<BODY BGCOLOR="white" onload="asd();">
|
||||
|
||||
<H3 class="FrameHeadingFont"><B></B></H3>
|
||||
<FONT size="+1" CLASS="FrameHeadingFont">
|
||||
<B><a href="overview-summary-HtmlDocument.js.html"
|
||||
target="classFrame">HtmlDocument.js</a></B></FONT>
|
||||
<BR>
|
||||
|
||||
<TABLE BORDER="0" WIDTH="100%">
|
||||
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.HtmlDocument.html" TARGET="classFrame">jala.HtmlDocument</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
</TABLE>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
36
modules/jala/docs/overview-I18n.js.html
Normal file
36
modules/jala/docs/overview-I18n.js.html
Normal file
|
|
@ -0,0 +1,36 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
I18n.js
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title=" I18n.js";
|
||||
}
|
||||
</SCRIPT>
|
||||
<BODY BGCOLOR="white" onload="asd();">
|
||||
|
||||
<H3 class="FrameHeadingFont"><B></B></H3>
|
||||
<FONT size="+1" CLASS="FrameHeadingFont">
|
||||
<B><a href="overview-summary-I18n.js.html"
|
||||
target="classFrame">I18n.js</a></B></FONT>
|
||||
<BR>
|
||||
|
||||
<TABLE BORDER="0" WIDTH="100%">
|
||||
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.I18n.html" TARGET="classFrame">jala.I18n</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
</TABLE>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
36
modules/jala/docs/overview-ImageFilter.js.html
Normal file
36
modules/jala/docs/overview-ImageFilter.js.html
Normal file
|
|
@ -0,0 +1,36 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
ImageFilter.js
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title=" ImageFilter.js";
|
||||
}
|
||||
</SCRIPT>
|
||||
<BODY BGCOLOR="white" onload="asd();">
|
||||
|
||||
<H3 class="FrameHeadingFont"><B></B></H3>
|
||||
<FONT size="+1" CLASS="FrameHeadingFont">
|
||||
<B><a href="overview-summary-ImageFilter.js.html"
|
||||
target="classFrame">ImageFilter.js</a></B></FONT>
|
||||
<BR>
|
||||
|
||||
<TABLE BORDER="0" WIDTH="100%">
|
||||
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.ImageFilter.html" TARGET="classFrame">jala.ImageFilter</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
</TABLE>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
42
modules/jala/docs/overview-IndexManager.js.html
Normal file
42
modules/jala/docs/overview-IndexManager.js.html
Normal file
|
|
@ -0,0 +1,42 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
IndexManager.js
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title=" IndexManager.js";
|
||||
}
|
||||
</SCRIPT>
|
||||
<BODY BGCOLOR="white" onload="asd();">
|
||||
|
||||
<H3 class="FrameHeadingFont"><B></B></H3>
|
||||
<FONT size="+1" CLASS="FrameHeadingFont">
|
||||
<B><a href="overview-summary-IndexManager.js.html"
|
||||
target="classFrame">IndexManager.js</a></B></FONT>
|
||||
<BR>
|
||||
|
||||
<TABLE BORDER="0" WIDTH="100%">
|
||||
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.IndexManager.html" TARGET="classFrame">jala.IndexManager</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.IndexManager.Job.html" TARGET="classFrame">jala.IndexManager.Job</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
</TABLE>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
42
modules/jala/docs/overview-ListRenderer.js.html
Normal file
42
modules/jala/docs/overview-ListRenderer.js.html
Normal file
|
|
@ -0,0 +1,42 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
ListRenderer.js
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title=" ListRenderer.js";
|
||||
}
|
||||
</SCRIPT>
|
||||
<BODY BGCOLOR="white" onload="asd();">
|
||||
|
||||
<H3 class="FrameHeadingFont"><B></B></H3>
|
||||
<FONT size="+1" CLASS="FrameHeadingFont">
|
||||
<B><a href="overview-summary-ListRenderer.js.html"
|
||||
target="classFrame">ListRenderer.js</a></B></FONT>
|
||||
<BR>
|
||||
|
||||
<TABLE BORDER="0" WIDTH="100%">
|
||||
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.ListRenderer.html" TARGET="classFrame">jala.ListRenderer</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.ListRenderer.ArrayList.html" TARGET="classFrame">jala.ListRenderer.ArrayList</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
</TABLE>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
48
modules/jala/docs/overview-Mp3.js.html
Normal file
48
modules/jala/docs/overview-Mp3.js.html
Normal file
|
|
@ -0,0 +1,48 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
Mp3.js
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title=" Mp3.js";
|
||||
}
|
||||
</SCRIPT>
|
||||
<BODY BGCOLOR="white" onload="asd();">
|
||||
|
||||
<H3 class="FrameHeadingFont"><B></B></H3>
|
||||
<FONT size="+1" CLASS="FrameHeadingFont">
|
||||
<B><a href="overview-summary-Mp3.js.html"
|
||||
target="classFrame">Mp3.js</a></B></FONT>
|
||||
<BR>
|
||||
|
||||
<TABLE BORDER="0" WIDTH="100%">
|
||||
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Mp3.html" TARGET="classFrame">jala.Mp3</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Mp3.Id3v1.html" TARGET="classFrame">jala.Mp3.Id3v1</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Mp3.Id3v2.html" TARGET="classFrame">jala.Mp3.Id3v2</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
</TABLE>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
36
modules/jala/docs/overview-PodcastWriter.js.html
Normal file
36
modules/jala/docs/overview-PodcastWriter.js.html
Normal file
|
|
@ -0,0 +1,36 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
PodcastWriter.js
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title=" PodcastWriter.js";
|
||||
}
|
||||
</SCRIPT>
|
||||
<BODY BGCOLOR="white" onload="asd();">
|
||||
|
||||
<H3 class="FrameHeadingFont"><B></B></H3>
|
||||
<FONT size="+1" CLASS="FrameHeadingFont">
|
||||
<B><a href="overview-summary-PodcastWriter.js.html"
|
||||
target="classFrame">PodcastWriter.js</a></B></FONT>
|
||||
<BR>
|
||||
|
||||
<TABLE BORDER="0" WIDTH="100%">
|
||||
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.PodcastWriter.html" TARGET="classFrame">jala.PodcastWriter</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
</TABLE>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
36
modules/jala/docs/overview-RemoteContent.js.html
Normal file
36
modules/jala/docs/overview-RemoteContent.js.html
Normal file
|
|
@ -0,0 +1,36 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
RemoteContent.js
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title=" RemoteContent.js";
|
||||
}
|
||||
</SCRIPT>
|
||||
<BODY BGCOLOR="white" onload="asd();">
|
||||
|
||||
<H3 class="FrameHeadingFont"><B></B></H3>
|
||||
<FONT size="+1" CLASS="FrameHeadingFont">
|
||||
<B><a href="overview-summary-RemoteContent.js.html"
|
||||
target="classFrame">RemoteContent.js</a></B></FONT>
|
||||
<BR>
|
||||
|
||||
<TABLE BORDER="0" WIDTH="100%">
|
||||
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.RemoteContent.html" TARGET="classFrame">jala.RemoteContent</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
</TABLE>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
36
modules/jala/docs/overview-Rss20Writer.js.html
Normal file
36
modules/jala/docs/overview-Rss20Writer.js.html
Normal file
|
|
@ -0,0 +1,36 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
Rss20Writer.js
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title=" Rss20Writer.js";
|
||||
}
|
||||
</SCRIPT>
|
||||
<BODY BGCOLOR="white" onload="asd();">
|
||||
|
||||
<H3 class="FrameHeadingFont"><B></B></H3>
|
||||
<FONT size="+1" CLASS="FrameHeadingFont">
|
||||
<B><a href="overview-summary-Rss20Writer.js.html"
|
||||
target="classFrame">Rss20Writer.js</a></B></FONT>
|
||||
<BR>
|
||||
|
||||
<TABLE BORDER="0" WIDTH="100%">
|
||||
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Rss20Writer.html" TARGET="classFrame">jala.Rss20Writer</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
</TABLE>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
36
modules/jala/docs/overview-Utilities.js.html
Normal file
36
modules/jala/docs/overview-Utilities.js.html
Normal file
|
|
@ -0,0 +1,36 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
Utilities.js
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title=" Utilities.js";
|
||||
}
|
||||
</SCRIPT>
|
||||
<BODY BGCOLOR="white" onload="asd();">
|
||||
|
||||
<H3 class="FrameHeadingFont"><B></B></H3>
|
||||
<FONT size="+1" CLASS="FrameHeadingFont">
|
||||
<B><a href="overview-summary-Utilities.js.html"
|
||||
target="classFrame">Utilities.js</a></B></FONT>
|
||||
<BR>
|
||||
|
||||
<TABLE BORDER="0" WIDTH="100%">
|
||||
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.Utilities.html" TARGET="classFrame">jala.Utilities</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
</TABLE>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
36
modules/jala/docs/overview-XmlRpcRequest.js.html
Normal file
36
modules/jala/docs/overview-XmlRpcRequest.js.html
Normal file
|
|
@ -0,0 +1,36 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
XmlRpcRequest.js
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title=" XmlRpcRequest.js";
|
||||
}
|
||||
</SCRIPT>
|
||||
<BODY BGCOLOR="white" onload="asd();">
|
||||
|
||||
<H3 class="FrameHeadingFont"><B></B></H3>
|
||||
<FONT size="+1" CLASS="FrameHeadingFont">
|
||||
<B><a href="overview-summary-XmlRpcRequest.js.html"
|
||||
target="classFrame">XmlRpcRequest.js</a></B></FONT>
|
||||
<BR>
|
||||
|
||||
<TABLE BORDER="0" WIDTH="100%">
|
||||
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.XmlRpcRequest.html" TARGET="classFrame">jala.XmlRpcRequest</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
</TABLE>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
36
modules/jala/docs/overview-XmlWriter.js.html
Normal file
36
modules/jala/docs/overview-XmlWriter.js.html
Normal file
|
|
@ -0,0 +1,36 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
XmlWriter.js
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title=" XmlWriter.js";
|
||||
}
|
||||
</SCRIPT>
|
||||
<BODY BGCOLOR="white" onload="asd();">
|
||||
|
||||
<H3 class="FrameHeadingFont"><B></B></H3>
|
||||
<FONT size="+1" CLASS="FrameHeadingFont">
|
||||
<B><a href="overview-summary-XmlWriter.js.html"
|
||||
target="classFrame">XmlWriter.js</a></B></FONT>
|
||||
<BR>
|
||||
|
||||
<TABLE BORDER="0" WIDTH="100%">
|
||||
|
||||
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="jala.XmlWriter.html" TARGET="classFrame">jala.XmlWriter</A>
|
||||
<BR>
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
|
||||
</TABLE>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
30
modules/jala/docs/overview-all.js.html
Normal file
30
modules/jala/docs/overview-all.js.html
Normal file
|
|
@ -0,0 +1,30 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
all.js
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title=" all.js";
|
||||
}
|
||||
</SCRIPT>
|
||||
<BODY BGCOLOR="white" onload="asd();">
|
||||
|
||||
<H3 class="FrameHeadingFont"><B></B></H3>
|
||||
<FONT size="+1" CLASS="FrameHeadingFont">
|
||||
<B><a href="overview-summary-all.js.html"
|
||||
target="classFrame">all.js</a></B></FONT>
|
||||
<BR>
|
||||
|
||||
<TABLE BORDER="0" WIDTH="100%">
|
||||
|
||||
|
||||
</TABLE>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
85
modules/jala/docs/overview-frame.html
Normal file
85
modules/jala/docs/overview-frame.html
Normal file
|
|
@ -0,0 +1,85 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>
|
||||
Overview ()
|
||||
</TITLE>
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||||
</HEAD>
|
||||
<SCRIPT>
|
||||
function asd()
|
||||
{
|
||||
parent.document.title="Overview ()";
|
||||
}
|
||||
</SCRIPT>
|
||||
<BODY BGCOLOR="white" onload="asd();">
|
||||
|
||||
<H3 class="FrameHeadingFont"><B>Jala 1.3</B></H3>
|
||||
<TABLE BORDER="0" WIDTH="100%">
|
||||
<TR>
|
||||
<B></B></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<TABLE BORDER="0" WIDTH="100%">
|
||||
<TR>
|
||||
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="allclasses-frame.html" TARGET="packageFrame">All Classes</A></FONT>
|
||||
<P>
|
||||
<FONT size="+1" CLASS="FrameHeadingFont">
|
||||
Files</FONT>
|
||||
<BR>
|
||||
|
||||
<FONT CLASS="FrameItemFont"><A HREF="overview-all.js.html" TARGET="packageFrame">all.js</A></FONT><BR>
|
||||
|
||||
<FONT CLASS="FrameItemFont"><A HREF="overview-AsyncRequest.js.html" TARGET="packageFrame">AsyncRequest.js</A></FONT><BR>
|
||||
|
||||
<FONT CLASS="FrameItemFont"><A HREF="overview-BitTorrent.js.html" TARGET="packageFrame">BitTorrent.js</A></FONT><BR>
|
||||
|
||||
<FONT CLASS="FrameItemFont"><A HREF="overview-Captcha.js.html" TARGET="packageFrame">Captcha.js</A></FONT><BR>
|
||||
|
||||
<FONT CLASS="FrameItemFont"><A HREF="overview-Database.js.html" TARGET="packageFrame">Database.js</A></FONT><BR>
|
||||
|
||||
<FONT CLASS="FrameItemFont"><A HREF="overview-Date.js.html" TARGET="packageFrame">Date.js</A></FONT><BR>
|
||||
|
||||
<FONT CLASS="FrameItemFont"><A HREF="overview-DnsClient.js.html" TARGET="packageFrame">DnsClient.js</A></FONT><BR>
|
||||
|
||||
<FONT CLASS="FrameItemFont"><A HREF="overview-Form.js.html" TARGET="packageFrame">Form.js</A></FONT><BR>
|
||||
|
||||
<FONT CLASS="FrameItemFont"><A HREF="overview-Global.js.html" TARGET="packageFrame">Global.js</A></FONT><BR>
|
||||
|
||||
<FONT CLASS="FrameItemFont"><A HREF="overview-History.js.html" TARGET="packageFrame">History.js</A></FONT><BR>
|
||||
|
||||
<FONT CLASS="FrameItemFont"><A HREF="overview-HopObject.js.html" TARGET="packageFrame">HopObject.js</A></FONT><BR>
|
||||
|
||||
<FONT CLASS="FrameItemFont"><A HREF="overview-HtmlDocument.js.html" TARGET="packageFrame">HtmlDocument.js</A></FONT><BR>
|
||||
|
||||
<FONT CLASS="FrameItemFont"><A HREF="overview-I18n.js.html" TARGET="packageFrame">I18n.js</A></FONT><BR>
|
||||
|
||||
<FONT CLASS="FrameItemFont"><A HREF="overview-ImageFilter.js.html" TARGET="packageFrame">ImageFilter.js</A></FONT><BR>
|
||||
|
||||
<FONT CLASS="FrameItemFont"><A HREF="overview-IndexManager.js.html" TARGET="packageFrame">IndexManager.js</A></FONT><BR>
|
||||
|
||||
<FONT CLASS="FrameItemFont"><A HREF="overview-ListRenderer.js.html" TARGET="packageFrame">ListRenderer.js</A></FONT><BR>
|
||||
|
||||
<FONT CLASS="FrameItemFont"><A HREF="overview-Mp3.js.html" TARGET="packageFrame">Mp3.js</A></FONT><BR>
|
||||
|
||||
<FONT CLASS="FrameItemFont"><A HREF="overview-PodcastWriter.js.html" TARGET="packageFrame">PodcastWriter.js</A></FONT><BR>
|
||||
|
||||
<FONT CLASS="FrameItemFont"><A HREF="overview-RemoteContent.js.html" TARGET="packageFrame">RemoteContent.js</A></FONT><BR>
|
||||
|
||||
<FONT CLASS="FrameItemFont"><A HREF="overview-Rss20Writer.js.html" TARGET="packageFrame">Rss20Writer.js</A></FONT><BR>
|
||||
|
||||
<FONT CLASS="FrameItemFont"><A HREF="overview-Utilities.js.html" TARGET="packageFrame">Utilities.js</A></FONT><BR>
|
||||
|
||||
<FONT CLASS="FrameItemFont"><A HREF="overview-XmlRpcRequest.js.html" TARGET="packageFrame">XmlRpcRequest.js</A></FONT><BR>
|
||||
|
||||
<FONT CLASS="FrameItemFont"><A HREF="overview-XmlWriter.js.html" TARGET="packageFrame">XmlWriter.js</A></FONT><BR>
|
||||
|
||||
</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<P>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
170
modules/jala/docs/overview-summary-AsyncRequest.js.html
Normal file
170
modules/jala/docs/overview-summary-AsyncRequest.js.html
Normal file
|
|
@ -0,0 +1,170 @@
|
|||
<!doctype html public "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
|
||||
<html>
|
||||
<head>
|
||||
<title>
|
||||
Jala 1.3 Overview
|
||||
</title>
|
||||
<link rel ="stylesheet" type="text/css" href="stylesheet.css" title="Style">
|
||||
<script>
|
||||
function asd() {
|
||||
|
||||
parent.document.title="AsyncRequest.js Overview";
|
||||
|
||||
}
|
||||
</script>
|
||||
</head>
|
||||
<body bgcolor="white" onload="asd();">
|
||||
|
||||
<!-- ========== START OF NAVBAR ========== -->
|
||||
<a name="navbar_top"><!-- --></a>
|
||||
<table border="0" width="100%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td colspan=2 bgcolor="#EEEEFF" class="NavBarCell1">
|
||||
<a name="navbar_top_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="#FFFFFF" class="NavBarCell1Rev"> <font class="NavBarFont1Rev"><b>File</b></font> </td>
|
||||
|
||||
|
||||
<td bgcolor="#FFFFFF" class="NavBarCell1"> <font class="NavBarFont1">Class</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="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 bgcolor="#EEEEFF" align="right" valign="top">
|
||||
<em>
|
||||
<b>Jala 1.3</b></em>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
PREV
|
||||
NEXT</font></td>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
<a href="index.html" target="_top"><b>FRAMES</b></a>
|
||||
<a href="overview-summary.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>
|
||||
</table>
|
||||
<!-- =========== END OF NAVBAR =========== -->
|
||||
|
||||
<hr>
|
||||
<center>
|
||||
|
||||
<h2>AsyncRequest.js</h2>
|
||||
|
||||
</center>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4>Summary</h4>
|
||||
<p>
|
||||
|
||||
Fields and methods of the jala.AsyncRequest class.<BR/><BR/>
|
||||
|
||||
</p>
|
||||
|
||||
<hr>
|
||||
|
||||
|
||||
<table border="1" cellpadding="3" cellspacing="0" width="100%">
|
||||
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
|
||||
<td colspan=2><font size="+2">
|
||||
|
||||
<b>Class Summary</b>
|
||||
|
||||
</font></td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td width="15%"><b><a href="jala.AsyncRequest.html">jala.AsyncRequest</a></b></td>
|
||||
<td>This class is used to create requests of type "INTERNAL"
|
||||
(like cron-jobs) that are processed in a separate thread and
|
||||
therefor asynchronous.</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
<hr/>
|
||||
|
||||
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
|
||||
<!-- ========== END METHOD SUMMARY =========== -->
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- ========== START OF NAVBAR ========== -->
|
||||
<a name="navbar_top"><!-- --></a>
|
||||
<table border="0" width="100%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td colspan=2 bgcolor="#EEEEFF" class="NavBarCell1">
|
||||
<a name="navbar_top_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="#FFFFFF" class="NavBarCell1Rev"> <font class="NavBarFont1Rev"><b>File</b></font> </td>
|
||||
|
||||
|
||||
<td bgcolor="#FFFFFF" class="NavBarCell1"> <font class="NavBarFont1">Class</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="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 bgcolor="#EEEEFF" align="right" valign="top"><em>
|
||||
<b>Jala 1.3</b></em>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
PREV
|
||||
NEXT</font></td>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
<a href="index.html" target="_top"><b>FRAMES</b></a>
|
||||
<a href="overview-summary.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>
|
||||
</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>
|
||||
169
modules/jala/docs/overview-summary-BitTorrent.js.html
Normal file
169
modules/jala/docs/overview-summary-BitTorrent.js.html
Normal file
|
|
@ -0,0 +1,169 @@
|
|||
<!doctype html public "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
|
||||
<html>
|
||||
<head>
|
||||
<title>
|
||||
Jala 1.3 Overview
|
||||
</title>
|
||||
<link rel ="stylesheet" type="text/css" href="stylesheet.css" title="Style">
|
||||
<script>
|
||||
function asd() {
|
||||
|
||||
parent.document.title="BitTorrent.js Overview";
|
||||
|
||||
}
|
||||
</script>
|
||||
</head>
|
||||
<body bgcolor="white" onload="asd();">
|
||||
|
||||
<!-- ========== START OF NAVBAR ========== -->
|
||||
<a name="navbar_top"><!-- --></a>
|
||||
<table border="0" width="100%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td colspan=2 bgcolor="#EEEEFF" class="NavBarCell1">
|
||||
<a name="navbar_top_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="#FFFFFF" class="NavBarCell1Rev"> <font class="NavBarFont1Rev"><b>File</b></font> </td>
|
||||
|
||||
|
||||
<td bgcolor="#FFFFFF" class="NavBarCell1"> <font class="NavBarFont1">Class</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="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 bgcolor="#EEEEFF" align="right" valign="top">
|
||||
<em>
|
||||
<b>Jala 1.3</b></em>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
PREV
|
||||
NEXT</font></td>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
<a href="index.html" target="_top"><b>FRAMES</b></a>
|
||||
<a href="overview-summary.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>
|
||||
</table>
|
||||
<!-- =========== END OF NAVBAR =========== -->
|
||||
|
||||
<hr>
|
||||
<center>
|
||||
|
||||
<h2>BitTorrent.js</h2>
|
||||
|
||||
</center>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4>Summary</h4>
|
||||
<p>
|
||||
|
||||
Fields and methods of the jala.BitTorrent class.<BR/><BR/>
|
||||
|
||||
</p>
|
||||
|
||||
<hr>
|
||||
|
||||
|
||||
<table border="1" cellpadding="3" cellspacing="0" width="100%">
|
||||
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
|
||||
<td colspan=2><font size="+2">
|
||||
|
||||
<b>Class Summary</b>
|
||||
|
||||
</font></td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td width="15%"><b><a href="jala.BitTorrent.html">jala.BitTorrent</a></b></td>
|
||||
<td>This class provides methods to create a BitTorrent
|
||||
metadata file from any desired file.</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
<hr/>
|
||||
|
||||
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
|
||||
<!-- ========== END METHOD SUMMARY =========== -->
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- ========== START OF NAVBAR ========== -->
|
||||
<a name="navbar_top"><!-- --></a>
|
||||
<table border="0" width="100%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td colspan=2 bgcolor="#EEEEFF" class="NavBarCell1">
|
||||
<a name="navbar_top_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="#FFFFFF" class="NavBarCell1Rev"> <font class="NavBarFont1Rev"><b>File</b></font> </td>
|
||||
|
||||
|
||||
<td bgcolor="#FFFFFF" class="NavBarCell1"> <font class="NavBarFont1">Class</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="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 bgcolor="#EEEEFF" align="right" valign="top"><em>
|
||||
<b>Jala 1.3</b></em>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
PREV
|
||||
NEXT</font></td>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
<a href="index.html" target="_top"><b>FRAMES</b></a>
|
||||
<a href="overview-summary.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>
|
||||
</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>
|
||||
169
modules/jala/docs/overview-summary-Captcha.js.html
Normal file
169
modules/jala/docs/overview-summary-Captcha.js.html
Normal file
|
|
@ -0,0 +1,169 @@
|
|||
<!doctype html public "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
|
||||
<html>
|
||||
<head>
|
||||
<title>
|
||||
Jala 1.3 Overview
|
||||
</title>
|
||||
<link rel ="stylesheet" type="text/css" href="stylesheet.css" title="Style">
|
||||
<script>
|
||||
function asd() {
|
||||
|
||||
parent.document.title="Captcha.js Overview";
|
||||
|
||||
}
|
||||
</script>
|
||||
</head>
|
||||
<body bgcolor="white" onload="asd();">
|
||||
|
||||
<!-- ========== START OF NAVBAR ========== -->
|
||||
<a name="navbar_top"><!-- --></a>
|
||||
<table border="0" width="100%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td colspan=2 bgcolor="#EEEEFF" class="NavBarCell1">
|
||||
<a name="navbar_top_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="#FFFFFF" class="NavBarCell1Rev"> <font class="NavBarFont1Rev"><b>File</b></font> </td>
|
||||
|
||||
|
||||
<td bgcolor="#FFFFFF" class="NavBarCell1"> <font class="NavBarFont1">Class</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="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 bgcolor="#EEEEFF" align="right" valign="top">
|
||||
<em>
|
||||
<b>Jala 1.3</b></em>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
PREV
|
||||
NEXT</font></td>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
<a href="index.html" target="_top"><b>FRAMES</b></a>
|
||||
<a href="overview-summary.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>
|
||||
</table>
|
||||
<!-- =========== END OF NAVBAR =========== -->
|
||||
|
||||
<hr>
|
||||
<center>
|
||||
|
||||
<h2>Captcha.js</h2>
|
||||
|
||||
</center>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4>Summary</h4>
|
||||
<p>
|
||||
|
||||
Fields and methods of the jala.Captcha class.<BR/><BR/>
|
||||
|
||||
</p>
|
||||
|
||||
<hr>
|
||||
|
||||
|
||||
<table border="1" cellpadding="3" cellspacing="0" width="100%">
|
||||
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
|
||||
<td colspan=2><font size="+2">
|
||||
|
||||
<b>Class Summary</b>
|
||||
|
||||
</font></td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td width="15%"><b><a href="jala.Captcha.html">jala.Captcha</a></b></td>
|
||||
<td>Wrapper class for the
|
||||
<a href='http://jcaptcha.sourceforge.net/'>JCaptcha library</a>.</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
<hr/>
|
||||
|
||||
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
|
||||
<!-- ========== END METHOD SUMMARY =========== -->
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- ========== START OF NAVBAR ========== -->
|
||||
<a name="navbar_top"><!-- --></a>
|
||||
<table border="0" width="100%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td colspan=2 bgcolor="#EEEEFF" class="NavBarCell1">
|
||||
<a name="navbar_top_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="#FFFFFF" class="NavBarCell1Rev"> <font class="NavBarFont1Rev"><b>File</b></font> </td>
|
||||
|
||||
|
||||
<td bgcolor="#FFFFFF" class="NavBarCell1"> <font class="NavBarFont1">Class</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="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 bgcolor="#EEEEFF" align="right" valign="top"><em>
|
||||
<b>Jala 1.3</b></em>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
PREV
|
||||
NEXT</font></td>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
<a href="index.html" target="_top"><b>FRAMES</b></a>
|
||||
<a href="overview-summary.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>
|
||||
</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>
|
||||
182
modules/jala/docs/overview-summary-Database.js.html
Normal file
182
modules/jala/docs/overview-summary-Database.js.html
Normal file
|
|
@ -0,0 +1,182 @@
|
|||
<!doctype html public "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
|
||||
<html>
|
||||
<head>
|
||||
<title>
|
||||
Jala 1.3 Overview
|
||||
</title>
|
||||
<link rel ="stylesheet" type="text/css" href="stylesheet.css" title="Style">
|
||||
<script>
|
||||
function asd() {
|
||||
|
||||
parent.document.title="Database.js Overview";
|
||||
|
||||
}
|
||||
</script>
|
||||
</head>
|
||||
<body bgcolor="white" onload="asd();">
|
||||
|
||||
<!-- ========== START OF NAVBAR ========== -->
|
||||
<a name="navbar_top"><!-- --></a>
|
||||
<table border="0" width="100%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td colspan=2 bgcolor="#EEEEFF" class="NavBarCell1">
|
||||
<a name="navbar_top_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="#FFFFFF" class="NavBarCell1Rev"> <font class="NavBarFont1Rev"><b>File</b></font> </td>
|
||||
|
||||
|
||||
<td bgcolor="#FFFFFF" class="NavBarCell1"> <font class="NavBarFont1">Class</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="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 bgcolor="#EEEEFF" align="right" valign="top">
|
||||
<em>
|
||||
<b>Jala 1.3</b></em>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
PREV
|
||||
NEXT</font></td>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
<a href="index.html" target="_top"><b>FRAMES</b></a>
|
||||
<a href="overview-summary.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>
|
||||
</table>
|
||||
<!-- =========== END OF NAVBAR =========== -->
|
||||
|
||||
<hr>
|
||||
<center>
|
||||
|
||||
<h2>Database.js</h2>
|
||||
|
||||
</center>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4>Summary</h4>
|
||||
<p>
|
||||
|
||||
Fields and methods of the jala.db package.<BR/><BR/>
|
||||
|
||||
</p>
|
||||
|
||||
<hr>
|
||||
|
||||
|
||||
<table border="1" cellpadding="3" cellspacing="0" width="100%">
|
||||
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
|
||||
<td colspan=2><font size="+2">
|
||||
|
||||
<b>Class Summary</b>
|
||||
|
||||
</font></td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td width="15%"><b><a href="jala.db.FileDatabase.html">jala.db.FileDatabase</a></b></td>
|
||||
<td>Instances of this class represent a file based in-process database
|
||||
<br /><strong>Important:</strong> You need the h2.jar in directory "lib/ext"
|
||||
of your helma installation for this library to work, which you can get
|
||||
at http://www.h2database.com/.</td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td width="15%"><b><a href="jala.db.RamDatabase.html">jala.db.RamDatabase</a></b></td>
|
||||
<td>Instances of this class represent an in-memory sql database.</td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td width="15%"><b><a href="jala.db.Server.html">jala.db.Server</a></b></td>
|
||||
<td>Instances of this class represent a H2 database listener that
|
||||
allows multiple databases to be accessed via tcp.</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
<hr/>
|
||||
|
||||
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
|
||||
<!-- ========== END METHOD SUMMARY =========== -->
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- ========== START OF NAVBAR ========== -->
|
||||
<a name="navbar_top"><!-- --></a>
|
||||
<table border="0" width="100%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td colspan=2 bgcolor="#EEEEFF" class="NavBarCell1">
|
||||
<a name="navbar_top_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="#FFFFFF" class="NavBarCell1Rev"> <font class="NavBarFont1Rev"><b>File</b></font> </td>
|
||||
|
||||
|
||||
<td bgcolor="#FFFFFF" class="NavBarCell1"> <font class="NavBarFont1">Class</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="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 bgcolor="#EEEEFF" align="right" valign="top"><em>
|
||||
<b>Jala 1.3</b></em>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
PREV
|
||||
NEXT</font></td>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
<a href="index.html" target="_top"><b>FRAMES</b></a>
|
||||
<a href="overview-summary.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>
|
||||
</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>
|
||||
181
modules/jala/docs/overview-summary-Date.js.html
Normal file
181
modules/jala/docs/overview-summary-Date.js.html
Normal file
|
|
@ -0,0 +1,181 @@
|
|||
<!doctype html public "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
|
||||
<html>
|
||||
<head>
|
||||
<title>
|
||||
Jala 1.3 Overview
|
||||
</title>
|
||||
<link rel ="stylesheet" type="text/css" href="stylesheet.css" title="Style">
|
||||
<script>
|
||||
function asd() {
|
||||
|
||||
parent.document.title="Date.js Overview";
|
||||
|
||||
}
|
||||
</script>
|
||||
</head>
|
||||
<body bgcolor="white" onload="asd();">
|
||||
|
||||
<!-- ========== START OF NAVBAR ========== -->
|
||||
<a name="navbar_top"><!-- --></a>
|
||||
<table border="0" width="100%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td colspan=2 bgcolor="#EEEEFF" class="NavBarCell1">
|
||||
<a name="navbar_top_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="#FFFFFF" class="NavBarCell1Rev"> <font class="NavBarFont1Rev"><b>File</b></font> </td>
|
||||
|
||||
|
||||
<td bgcolor="#FFFFFF" class="NavBarCell1"> <font class="NavBarFont1">Class</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="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 bgcolor="#EEEEFF" align="right" valign="top">
|
||||
<em>
|
||||
<b>Jala 1.3</b></em>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
PREV
|
||||
NEXT</font></td>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
<a href="index.html" target="_top"><b>FRAMES</b></a>
|
||||
<a href="overview-summary.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>
|
||||
</table>
|
||||
<!-- =========== END OF NAVBAR =========== -->
|
||||
|
||||
<hr>
|
||||
<center>
|
||||
|
||||
<h2>Date.js</h2>
|
||||
|
||||
</center>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4>Summary</h4>
|
||||
<p>
|
||||
|
||||
Fields and methods of the jala.Date class.<BR/><BR/>
|
||||
|
||||
</p>
|
||||
|
||||
<hr>
|
||||
|
||||
|
||||
<table border="1" cellpadding="3" cellspacing="0" width="100%">
|
||||
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
|
||||
<td colspan=2><font size="+2">
|
||||
|
||||
<b>Class Summary</b>
|
||||
|
||||
</font></td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td width="15%"><b><a href="jala.Date.html">jala.Date</a></b></td>
|
||||
<td>This class provides various convenience
|
||||
methods for rendering purposes.</td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td width="15%"><b><a href="jala.Date.Calendar.html">jala.Date.Calendar</a></b></td>
|
||||
<td>This class represents a calendar based based on a grouped
|
||||
collection of HopObjects.</td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td width="15%"><b><a href="jala.Date.Calendar.Renderer.html">jala.Date.Calendar.Renderer</a></b></td>
|
||||
<td>A default renderer to use in conjunction with jala.Date.Calendar
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
<hr/>
|
||||
|
||||
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
|
||||
<!-- ========== END METHOD SUMMARY =========== -->
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- ========== START OF NAVBAR ========== -->
|
||||
<a name="navbar_top"><!-- --></a>
|
||||
<table border="0" width="100%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td colspan=2 bgcolor="#EEEEFF" class="NavBarCell1">
|
||||
<a name="navbar_top_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="#FFFFFF" class="NavBarCell1Rev"> <font class="NavBarFont1Rev"><b>File</b></font> </td>
|
||||
|
||||
|
||||
<td bgcolor="#FFFFFF" class="NavBarCell1"> <font class="NavBarFont1">Class</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="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 bgcolor="#EEEEFF" align="right" valign="top"><em>
|
||||
<b>Jala 1.3</b></em>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
PREV
|
||||
NEXT</font></td>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
<a href="index.html" target="_top"><b>FRAMES</b></a>
|
||||
<a href="overview-summary.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>
|
||||
</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>
|
||||
175
modules/jala/docs/overview-summary-DnsClient.js.html
Normal file
175
modules/jala/docs/overview-summary-DnsClient.js.html
Normal file
|
|
@ -0,0 +1,175 @@
|
|||
<!doctype html public "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
|
||||
<html>
|
||||
<head>
|
||||
<title>
|
||||
Jala 1.3 Overview
|
||||
</title>
|
||||
<link rel ="stylesheet" type="text/css" href="stylesheet.css" title="Style">
|
||||
<script>
|
||||
function asd() {
|
||||
|
||||
parent.document.title="DnsClient.js Overview";
|
||||
|
||||
}
|
||||
</script>
|
||||
</head>
|
||||
<body bgcolor="white" onload="asd();">
|
||||
|
||||
<!-- ========== START OF NAVBAR ========== -->
|
||||
<a name="navbar_top"><!-- --></a>
|
||||
<table border="0" width="100%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td colspan=2 bgcolor="#EEEEFF" class="NavBarCell1">
|
||||
<a name="navbar_top_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="#FFFFFF" class="NavBarCell1Rev"> <font class="NavBarFont1Rev"><b>File</b></font> </td>
|
||||
|
||||
|
||||
<td bgcolor="#FFFFFF" class="NavBarCell1"> <font class="NavBarFont1">Class</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="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 bgcolor="#EEEEFF" align="right" valign="top">
|
||||
<em>
|
||||
<b>Jala 1.3</b></em>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
PREV
|
||||
NEXT</font></td>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
<a href="index.html" target="_top"><b>FRAMES</b></a>
|
||||
<a href="overview-summary.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>
|
||||
</table>
|
||||
<!-- =========== END OF NAVBAR =========== -->
|
||||
|
||||
<hr>
|
||||
<center>
|
||||
|
||||
<h2>DnsClient.js</h2>
|
||||
|
||||
</center>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4>Summary</h4>
|
||||
<p>
|
||||
|
||||
Fields and methods of the jala.DnsClient class.<BR/><BR/>
|
||||
|
||||
</p>
|
||||
|
||||
<hr>
|
||||
|
||||
|
||||
<table border="1" cellpadding="3" cellspacing="0" width="100%">
|
||||
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
|
||||
<td colspan=2><font size="+2">
|
||||
|
||||
<b>Class Summary</b>
|
||||
|
||||
</font></td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td width="15%"><b><a href="jala.DnsClient.html">jala.DnsClient</a></b></td>
|
||||
<td>This is a wrapper around the Dns Client by wonderly.org
|
||||
providing methods for querying Dns servers.</td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td width="15%"><b><a href="jala.DnsClient.Record.html">jala.DnsClient.Record</a></b></td>
|
||||
<td>Instances of this class wrap record data as received
|
||||
from the nameserver.</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
<hr/>
|
||||
|
||||
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
|
||||
<!-- ========== END METHOD SUMMARY =========== -->
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- ========== START OF NAVBAR ========== -->
|
||||
<a name="navbar_top"><!-- --></a>
|
||||
<table border="0" width="100%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td colspan=2 bgcolor="#EEEEFF" class="NavBarCell1">
|
||||
<a name="navbar_top_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="#FFFFFF" class="NavBarCell1Rev"> <font class="NavBarFont1Rev"><b>File</b></font> </td>
|
||||
|
||||
|
||||
<td bgcolor="#FFFFFF" class="NavBarCell1"> <font class="NavBarFont1">Class</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="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 bgcolor="#EEEEFF" align="right" valign="top"><em>
|
||||
<b>Jala 1.3</b></em>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
PREV
|
||||
NEXT</font></td>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
<a href="index.html" target="_top"><b>FRAMES</b></a>
|
||||
<a href="overview-summary.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>
|
||||
</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>
|
||||
264
modules/jala/docs/overview-summary-Form.js.html
Normal file
264
modules/jala/docs/overview-summary-Form.js.html
Normal file
|
|
@ -0,0 +1,264 @@
|
|||
<!doctype html public "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
|
||||
<html>
|
||||
<head>
|
||||
<title>
|
||||
Jala 1.3 Overview
|
||||
</title>
|
||||
<link rel ="stylesheet" type="text/css" href="stylesheet.css" title="Style">
|
||||
<script>
|
||||
function asd() {
|
||||
|
||||
parent.document.title="Form.js Overview";
|
||||
|
||||
}
|
||||
</script>
|
||||
</head>
|
||||
<body bgcolor="white" onload="asd();">
|
||||
|
||||
<!-- ========== START OF NAVBAR ========== -->
|
||||
<a name="navbar_top"><!-- --></a>
|
||||
<table border="0" width="100%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td colspan=2 bgcolor="#EEEEFF" class="NavBarCell1">
|
||||
<a name="navbar_top_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="#FFFFFF" class="NavBarCell1Rev"> <font class="NavBarFont1Rev"><b>File</b></font> </td>
|
||||
|
||||
|
||||
<td bgcolor="#FFFFFF" class="NavBarCell1"> <font class="NavBarFont1">Class</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="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 bgcolor="#EEEEFF" align="right" valign="top">
|
||||
<em>
|
||||
<b>Jala 1.3</b></em>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
PREV
|
||||
NEXT</font></td>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
<a href="index.html" target="_top"><b>FRAMES</b></a>
|
||||
<a href="overview-summary.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>
|
||||
</table>
|
||||
<!-- =========== END OF NAVBAR =========== -->
|
||||
|
||||
<hr>
|
||||
<center>
|
||||
|
||||
<h2>Form.js</h2>
|
||||
|
||||
</center>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4>Summary</h4>
|
||||
<p>
|
||||
|
||||
This class can be used to render forms and to validate
|
||||
and store user submits. Further types of form components can be added
|
||||
by subclassing jala.Form.Component.Input.<BR/><BR/>
|
||||
|
||||
</p>
|
||||
|
||||
<hr>
|
||||
|
||||
|
||||
<table border="1" cellpadding="3" cellspacing="0" width="100%">
|
||||
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
|
||||
<td colspan=2><font size="+2">
|
||||
|
||||
<b>Class Summary</b>
|
||||
|
||||
</font></td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td width="15%"><b><a href="jala.Form.html">jala.Form</a></b></td>
|
||||
<td>A class that renders forms, validates submitted form data and
|
||||
stores the data in a specified object.</td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td width="15%"><b><a href="jala.Form.Component.html">jala.Form.Component</a></b></td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td width="15%"><b><a href="jala.Form.Component.Button.html">jala.Form.Component.Button</a></b></td>
|
||||
<td>Subclass of jala.Form.Component.Input which renders a button.</td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td width="15%"><b><a href="jala.Form.Component.Checkbox.html">jala.Form.Component.Checkbox</a></b></td>
|
||||
<td>Subclass of jala.Form.Component.Input which renders and validates a
|
||||
checkbox.</td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td width="15%"><b><a href="jala.Form.Component.Date.html">jala.Form.Component.Date</a></b></td>
|
||||
<td>Subclass of jala.Form.Component.Input which renders and validates a
|
||||
date editor.</td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td width="15%"><b><a href="jala.Form.Component.Fieldset.html">jala.Form.Component.Fieldset</a></b></td>
|
||||
<td>Instances of this class represent a form fieldset containing
|
||||
numerous form components
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td width="15%"><b><a href="jala.Form.Component.File.html">jala.Form.Component.File</a></b></td>
|
||||
<td>Subclass of jala.Form.Component.Input which renders and validates a
|
||||
file upload.</td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td width="15%"><b><a href="jala.Form.Component.Hidden.html">jala.Form.Component.Hidden</a></b></td>
|
||||
<td>Subclass of jala.Form.Component.Input which renders and validates a
|
||||
hidden input tag.</td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td width="15%"><b><a href="jala.Form.Component.Image.html">jala.Form.Component.Image</a></b></td>
|
||||
<td>Subclass of jala.Form.Component.File which renders a file upload
|
||||
and validates uploaded files as images.</td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td width="15%"><b><a href="jala.Form.Component.Input.html">jala.Form.Component.Input</a></b></td>
|
||||
<td>Instances of this class represent a single form input field.</td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td width="15%"><b><a href="jala.Form.Component.Password.html">jala.Form.Component.Password</a></b></td>
|
||||
<td>Subclass of jala.Form.Component.Input which renders and validates a
|
||||
password input tag.</td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td width="15%"><b><a href="jala.Form.Component.Radio.html">jala.Form.Component.Radio</a></b></td>
|
||||
<td>Subclass of jala.Form.Component.Input which renders and validates a
|
||||
set of radio buttons.</td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td width="15%"><b><a href="jala.Form.Component.Select.html">jala.Form.Component.Select</a></b></td>
|
||||
<td>Subclass of jala.Form.Component.Input which renders and validates a
|
||||
dropdown element.</td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td width="15%"><b><a href="jala.Form.Component.Skin.html">jala.Form.Component.Skin</a></b></td>
|
||||
<td>Subclass of jala.Form.Component that allows rendering a skin
|
||||
within a form.</td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td width="15%"><b><a href="jala.Form.Component.Submit.html">jala.Form.Component.Submit</a></b></td>
|
||||
<td>Subclass of jala.Form.Component.Button which renders a submit button.</td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td width="15%"><b><a href="jala.Form.Component.Textarea.html">jala.Form.Component.Textarea</a></b></td>
|
||||
<td>Subclass of jala.Form.Component.Input which renders and validates a
|
||||
textarea input field.</td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td width="15%"><b><a href="jala.Form.Tracker.html">jala.Form.Tracker</a></b></td>
|
||||
<td>Instances of this class can contain error-messages and values
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
<hr/>
|
||||
|
||||
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
|
||||
<!-- ========== END METHOD SUMMARY =========== -->
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- ========== START OF NAVBAR ========== -->
|
||||
<a name="navbar_top"><!-- --></a>
|
||||
<table border="0" width="100%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td colspan=2 bgcolor="#EEEEFF" class="NavBarCell1">
|
||||
<a name="navbar_top_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="#FFFFFF" class="NavBarCell1Rev"> <font class="NavBarFont1Rev"><b>File</b></font> </td>
|
||||
|
||||
|
||||
<td bgcolor="#FFFFFF" class="NavBarCell1"> <font class="NavBarFont1">Class</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="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 bgcolor="#EEEEFF" align="right" valign="top"><em>
|
||||
<b>Jala 1.3</b></em>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
PREV
|
||||
NEXT</font></td>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
<a href="index.html" target="_top"><b>FRAMES</b></a>
|
||||
<a href="overview-summary.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>
|
||||
</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>
|
||||
324
modules/jala/docs/overview-summary-Global.js.html
Normal file
324
modules/jala/docs/overview-summary-Global.js.html
Normal file
|
|
@ -0,0 +1,324 @@
|
|||
<!doctype html public "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
|
||||
<html>
|
||||
<head>
|
||||
<title>
|
||||
Jala 1.3 Overview
|
||||
</title>
|
||||
<link rel ="stylesheet" type="text/css" href="stylesheet.css" title="Style">
|
||||
<script>
|
||||
function asd() {
|
||||
|
||||
parent.document.title="Global.js Overview";
|
||||
|
||||
}
|
||||
</script>
|
||||
</head>
|
||||
<body bgcolor="white" onload="asd();">
|
||||
|
||||
<!-- ========== START OF NAVBAR ========== -->
|
||||
<a name="navbar_top"><!-- --></a>
|
||||
<table border="0" width="100%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td colspan=2 bgcolor="#EEEEFF" class="NavBarCell1">
|
||||
<a name="navbar_top_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="#FFFFFF" class="NavBarCell1Rev"> <font class="NavBarFont1Rev"><b>File</b></font> </td>
|
||||
|
||||
|
||||
<td bgcolor="#FFFFFF" class="NavBarCell1"> <font class="NavBarFont1">Class</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="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 bgcolor="#EEEEFF" align="right" valign="top">
|
||||
<em>
|
||||
<b>Jala 1.3</b></em>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
PREV
|
||||
NEXT</font></td>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
<a href="index.html" target="_top"><b>FRAMES</b></a>
|
||||
<a href="overview-summary.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>
|
||||
</table>
|
||||
<!-- =========== END OF NAVBAR =========== -->
|
||||
|
||||
<hr>
|
||||
<center>
|
||||
|
||||
<h2>Global.js</h2>
|
||||
|
||||
</center>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4>Summary</h4>
|
||||
<p>
|
||||
|
||||
Fields and methods of the Global prototype.<BR/><BR/>
|
||||
|
||||
</p>
|
||||
|
||||
<hr>
|
||||
|
||||
|
||||
|
||||
<!-- ========== 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>static Boolean</code>
|
||||
</font>
|
||||
</td>
|
||||
<td>
|
||||
<code>
|
||||
<b>
|
||||
<a href="Global.html#!s!isArray">isArray</a></b>(<Object> val)
|
||||
</code>
|
||||
<br>
|
||||
|
||||
Returns true if the value passed as argument is an array.
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td align="right" valign="top" width="1%">
|
||||
<font size="-1">
|
||||
<code>static Boolean</code>
|
||||
</font>
|
||||
</td>
|
||||
<td>
|
||||
<code>
|
||||
<b>
|
||||
<a href="Global.html#!s!isBoolean">isBoolean</a></b>(<Object> val)
|
||||
</code>
|
||||
<br>
|
||||
|
||||
Returns true if the value passed as argument is either a boolean
|
||||
literal or an instance of Boolean.
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td align="right" valign="top" width="1%">
|
||||
<font size="-1">
|
||||
<code>static Boolean</code>
|
||||
</font>
|
||||
</td>
|
||||
<td>
|
||||
<code>
|
||||
<b>
|
||||
<a href="Global.html#!s!isDate">isDate</a></b>(<Object> val)
|
||||
</code>
|
||||
<br>
|
||||
|
||||
Returns true if the value passed as argument is either a Javascript date
|
||||
or an instance of java.util.Date.
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td align="right" valign="top" width="1%">
|
||||
<font size="-1">
|
||||
<code>static Boolean</code>
|
||||
</font>
|
||||
</td>
|
||||
<td>
|
||||
<code>
|
||||
<b>
|
||||
<a href="Global.html#!s!isFunction">isFunction</a></b>(<Object> val)
|
||||
</code>
|
||||
<br>
|
||||
|
||||
Returns true if the value passed as argument is a function.
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td align="right" valign="top" width="1%">
|
||||
<font size="-1">
|
||||
<code>static Boolean</code>
|
||||
</font>
|
||||
</td>
|
||||
<td>
|
||||
<code>
|
||||
<b>
|
||||
<a href="Global.html#!s!isNull">isNull</a></b>(<Object> val)
|
||||
</code>
|
||||
<br>
|
||||
|
||||
Returns true if the value passed as argument is null.
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td align="right" valign="top" width="1%">
|
||||
<font size="-1">
|
||||
<code>static Boolean</code>
|
||||
</font>
|
||||
</td>
|
||||
<td>
|
||||
<code>
|
||||
<b>
|
||||
<a href="Global.html#!s!isNumber">isNumber</a></b>(<Object> val)
|
||||
</code>
|
||||
<br>
|
||||
|
||||
Returns true if the value passed as argument is either a number,
|
||||
an instance of Number or of java.lang.Number.
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td align="right" valign="top" width="1%">
|
||||
<font size="-1">
|
||||
<code>static Boolean</code>
|
||||
</font>
|
||||
</td>
|
||||
<td>
|
||||
<code>
|
||||
<b>
|
||||
<a href="Global.html#!s!isObject">isObject</a></b>(<Object> val)
|
||||
</code>
|
||||
<br>
|
||||
|
||||
Returns true if the value passed as argument is either a Javascript
|
||||
object or an instance of java.lang.Object.
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td align="right" valign="top" width="1%">
|
||||
<font size="-1">
|
||||
<code>static Boolean</code>
|
||||
</font>
|
||||
</td>
|
||||
<td>
|
||||
<code>
|
||||
<b>
|
||||
<a href="Global.html#!s!isString">isString</a></b>(<Object> val)
|
||||
</code>
|
||||
<br>
|
||||
|
||||
Returns true if the value passed as argument is either a string literal,
|
||||
an instance of String or of java.lang.String.
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td align="right" valign="top" width="1%">
|
||||
<font size="-1">
|
||||
<code>static Boolean</code>
|
||||
</font>
|
||||
</td>
|
||||
<td>
|
||||
<code>
|
||||
<b>
|
||||
<a href="Global.html#!s!isUndefined">isUndefined</a></b>(<Object> val)
|
||||
</code>
|
||||
<br>
|
||||
|
||||
Returns true if the value passed as argument is undefined.
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
|
||||
</table>
|
||||
<p>
|
||||
|
||||
<!-- ========== END METHOD SUMMARY =========== -->
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- ========== START OF NAVBAR ========== -->
|
||||
<a name="navbar_top"><!-- --></a>
|
||||
<table border="0" width="100%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td colspan=2 bgcolor="#EEEEFF" class="NavBarCell1">
|
||||
<a name="navbar_top_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="#FFFFFF" class="NavBarCell1Rev"> <font class="NavBarFont1Rev"><b>File</b></font> </td>
|
||||
|
||||
|
||||
<td bgcolor="#FFFFFF" class="NavBarCell1"> <font class="NavBarFont1">Class</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="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 bgcolor="#EEEEFF" align="right" valign="top"><em>
|
||||
<b>Jala 1.3</b></em>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
PREV
|
||||
NEXT</font></td>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
<a href="index.html" target="_top"><b>FRAMES</b></a>
|
||||
<a href="overview-summary.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>
|
||||
</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>
|
||||
169
modules/jala/docs/overview-summary-History.js.html
Normal file
169
modules/jala/docs/overview-summary-History.js.html
Normal file
|
|
@ -0,0 +1,169 @@
|
|||
<!doctype html public "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
|
||||
<html>
|
||||
<head>
|
||||
<title>
|
||||
Jala 1.3 Overview
|
||||
</title>
|
||||
<link rel ="stylesheet" type="text/css" href="stylesheet.css" title="Style">
|
||||
<script>
|
||||
function asd() {
|
||||
|
||||
parent.document.title="History.js Overview";
|
||||
|
||||
}
|
||||
</script>
|
||||
</head>
|
||||
<body bgcolor="white" onload="asd();">
|
||||
|
||||
<!-- ========== START OF NAVBAR ========== -->
|
||||
<a name="navbar_top"><!-- --></a>
|
||||
<table border="0" width="100%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td colspan=2 bgcolor="#EEEEFF" class="NavBarCell1">
|
||||
<a name="navbar_top_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="#FFFFFF" class="NavBarCell1Rev"> <font class="NavBarFont1Rev"><b>File</b></font> </td>
|
||||
|
||||
|
||||
<td bgcolor="#FFFFFF" class="NavBarCell1"> <font class="NavBarFont1">Class</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="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 bgcolor="#EEEEFF" align="right" valign="top">
|
||||
<em>
|
||||
<b>Jala 1.3</b></em>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
PREV
|
||||
NEXT</font></td>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
<a href="index.html" target="_top"><b>FRAMES</b></a>
|
||||
<a href="overview-summary.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>
|
||||
</table>
|
||||
<!-- =========== END OF NAVBAR =========== -->
|
||||
|
||||
<hr>
|
||||
<center>
|
||||
|
||||
<h2>History.js</h2>
|
||||
|
||||
</center>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4>Summary</h4>
|
||||
<p>
|
||||
|
||||
Fields and methods of the jala.History class.<BR/><BR/>
|
||||
|
||||
</p>
|
||||
|
||||
<hr>
|
||||
|
||||
|
||||
<table border="1" cellpadding="3" cellspacing="0" width="100%">
|
||||
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
|
||||
<td colspan=2><font size="+2">
|
||||
|
||||
<b>Class Summary</b>
|
||||
|
||||
</font></td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td width="15%"><b><a href="jala.History.html">jala.History</a></b></td>
|
||||
<td>This class is an implementation of a Browser-like history
|
||||
stack suitable to use in any Helma application.</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
<hr/>
|
||||
|
||||
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
|
||||
<!-- ========== END METHOD SUMMARY =========== -->
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- ========== START OF NAVBAR ========== -->
|
||||
<a name="navbar_top"><!-- --></a>
|
||||
<table border="0" width="100%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td colspan=2 bgcolor="#EEEEFF" class="NavBarCell1">
|
||||
<a name="navbar_top_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="#FFFFFF" class="NavBarCell1Rev"> <font class="NavBarFont1Rev"><b>File</b></font> </td>
|
||||
|
||||
|
||||
<td bgcolor="#FFFFFF" class="NavBarCell1"> <font class="NavBarFont1">Class</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="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 bgcolor="#EEEEFF" align="right" valign="top"><em>
|
||||
<b>Jala 1.3</b></em>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
PREV
|
||||
NEXT</font></td>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
<a href="index.html" target="_top"><b>FRAMES</b></a>
|
||||
<a href="overview-summary.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>
|
||||
</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>
|
||||
151
modules/jala/docs/overview-summary-HopObject.js.html
Normal file
151
modules/jala/docs/overview-summary-HopObject.js.html
Normal file
|
|
@ -0,0 +1,151 @@
|
|||
<!doctype html public "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
|
||||
<html>
|
||||
<head>
|
||||
<title>
|
||||
Jala 1.3 Overview
|
||||
</title>
|
||||
<link rel ="stylesheet" type="text/css" href="stylesheet.css" title="Style">
|
||||
<script>
|
||||
function asd() {
|
||||
|
||||
parent.document.title="HopObject.js Overview";
|
||||
|
||||
}
|
||||
</script>
|
||||
</head>
|
||||
<body bgcolor="white" onload="asd();">
|
||||
|
||||
<!-- ========== START OF NAVBAR ========== -->
|
||||
<a name="navbar_top"><!-- --></a>
|
||||
<table border="0" width="100%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td colspan=2 bgcolor="#EEEEFF" class="NavBarCell1">
|
||||
<a name="navbar_top_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="#FFFFFF" class="NavBarCell1Rev"> <font class="NavBarFont1Rev"><b>File</b></font> </td>
|
||||
|
||||
|
||||
<td bgcolor="#FFFFFF" class="NavBarCell1"> <font class="NavBarFont1">Class</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="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 bgcolor="#EEEEFF" align="right" valign="top">
|
||||
<em>
|
||||
<b>Jala 1.3</b></em>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
PREV
|
||||
NEXT</font></td>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
<a href="index.html" target="_top"><b>FRAMES</b></a>
|
||||
<a href="overview-summary.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>
|
||||
</table>
|
||||
<!-- =========== END OF NAVBAR =========== -->
|
||||
|
||||
<hr>
|
||||
<center>
|
||||
|
||||
<h2>HopObject.js</h2>
|
||||
|
||||
</center>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4>Summary</h4>
|
||||
<p>
|
||||
|
||||
Additional fields and methods of the HopObject class.<BR/><BR/>
|
||||
|
||||
</p>
|
||||
|
||||
<hr>
|
||||
|
||||
|
||||
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
|
||||
<!-- ========== END METHOD SUMMARY =========== -->
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- ========== START OF NAVBAR ========== -->
|
||||
<a name="navbar_top"><!-- --></a>
|
||||
<table border="0" width="100%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td colspan=2 bgcolor="#EEEEFF" class="NavBarCell1">
|
||||
<a name="navbar_top_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="#FFFFFF" class="NavBarCell1Rev"> <font class="NavBarFont1Rev"><b>File</b></font> </td>
|
||||
|
||||
|
||||
<td bgcolor="#FFFFFF" class="NavBarCell1"> <font class="NavBarFont1">Class</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="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 bgcolor="#EEEEFF" align="right" valign="top"><em>
|
||||
<b>Jala 1.3</b></em>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
PREV
|
||||
NEXT</font></td>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
<a href="index.html" target="_top"><b>FRAMES</b></a>
|
||||
<a href="overview-summary.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>
|
||||
</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>
|
||||
169
modules/jala/docs/overview-summary-HtmlDocument.js.html
Normal file
169
modules/jala/docs/overview-summary-HtmlDocument.js.html
Normal file
|
|
@ -0,0 +1,169 @@
|
|||
<!doctype html public "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
|
||||
<html>
|
||||
<head>
|
||||
<title>
|
||||
Jala 1.3 Overview
|
||||
</title>
|
||||
<link rel ="stylesheet" type="text/css" href="stylesheet.css" title="Style">
|
||||
<script>
|
||||
function asd() {
|
||||
|
||||
parent.document.title="HtmlDocument.js Overview";
|
||||
|
||||
}
|
||||
</script>
|
||||
</head>
|
||||
<body bgcolor="white" onload="asd();">
|
||||
|
||||
<!-- ========== START OF NAVBAR ========== -->
|
||||
<a name="navbar_top"><!-- --></a>
|
||||
<table border="0" width="100%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td colspan=2 bgcolor="#EEEEFF" class="NavBarCell1">
|
||||
<a name="navbar_top_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="#FFFFFF" class="NavBarCell1Rev"> <font class="NavBarFont1Rev"><b>File</b></font> </td>
|
||||
|
||||
|
||||
<td bgcolor="#FFFFFF" class="NavBarCell1"> <font class="NavBarFont1">Class</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="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 bgcolor="#EEEEFF" align="right" valign="top">
|
||||
<em>
|
||||
<b>Jala 1.3</b></em>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
PREV
|
||||
NEXT</font></td>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
<a href="index.html" target="_top"><b>FRAMES</b></a>
|
||||
<a href="overview-summary.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>
|
||||
</table>
|
||||
<!-- =========== END OF NAVBAR =========== -->
|
||||
|
||||
<hr>
|
||||
<center>
|
||||
|
||||
<h2>HtmlDocument.js</h2>
|
||||
|
||||
</center>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4>Summary</h4>
|
||||
<p>
|
||||
|
||||
Fields and methods of the jala.HtmlDocument class.<BR/><BR/>
|
||||
|
||||
</p>
|
||||
|
||||
<hr>
|
||||
|
||||
|
||||
<table border="1" cellpadding="3" cellspacing="0" width="100%">
|
||||
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
|
||||
<td colspan=2><font size="+2">
|
||||
|
||||
<b>Class Summary</b>
|
||||
|
||||
</font></td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td width="15%"><b><a href="jala.HtmlDocument.html">jala.HtmlDocument</a></b></td>
|
||||
<td>This class provides easy access to the elements of
|
||||
an arbitrary HTML document.</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
<hr/>
|
||||
|
||||
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
|
||||
<!-- ========== END METHOD SUMMARY =========== -->
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- ========== START OF NAVBAR ========== -->
|
||||
<a name="navbar_top"><!-- --></a>
|
||||
<table border="0" width="100%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td colspan=2 bgcolor="#EEEEFF" class="NavBarCell1">
|
||||
<a name="navbar_top_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="#FFFFFF" class="NavBarCell1Rev"> <font class="NavBarFont1Rev"><b>File</b></font> </td>
|
||||
|
||||
|
||||
<td bgcolor="#FFFFFF" class="NavBarCell1"> <font class="NavBarFont1">Class</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="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 bgcolor="#EEEEFF" align="right" valign="top"><em>
|
||||
<b>Jala 1.3</b></em>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
PREV
|
||||
NEXT</font></td>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
<a href="index.html" target="_top"><b>FRAMES</b></a>
|
||||
<a href="overview-summary.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>
|
||||
</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>
|
||||
170
modules/jala/docs/overview-summary-I18n.js.html
Normal file
170
modules/jala/docs/overview-summary-I18n.js.html
Normal file
|
|
@ -0,0 +1,170 @@
|
|||
<!doctype html public "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
|
||||
<html>
|
||||
<head>
|
||||
<title>
|
||||
Jala 1.3 Overview
|
||||
</title>
|
||||
<link rel ="stylesheet" type="text/css" href="stylesheet.css" title="Style">
|
||||
<script>
|
||||
function asd() {
|
||||
|
||||
parent.document.title="I18n.js Overview";
|
||||
|
||||
}
|
||||
</script>
|
||||
</head>
|
||||
<body bgcolor="white" onload="asd();">
|
||||
|
||||
<!-- ========== START OF NAVBAR ========== -->
|
||||
<a name="navbar_top"><!-- --></a>
|
||||
<table border="0" width="100%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td colspan=2 bgcolor="#EEEEFF" class="NavBarCell1">
|
||||
<a name="navbar_top_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="#FFFFFF" class="NavBarCell1Rev"> <font class="NavBarFont1Rev"><b>File</b></font> </td>
|
||||
|
||||
|
||||
<td bgcolor="#FFFFFF" class="NavBarCell1"> <font class="NavBarFont1">Class</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="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 bgcolor="#EEEEFF" align="right" valign="top">
|
||||
<em>
|
||||
<b>Jala 1.3</b></em>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
PREV
|
||||
NEXT</font></td>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
<a href="index.html" target="_top"><b>FRAMES</b></a>
|
||||
<a href="overview-summary.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>
|
||||
</table>
|
||||
<!-- =========== END OF NAVBAR =========== -->
|
||||
|
||||
<hr>
|
||||
<center>
|
||||
|
||||
<h2>I18n.js</h2>
|
||||
|
||||
</center>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4>Summary</h4>
|
||||
<p>
|
||||
|
||||
Methods and macros for internationalization
|
||||
of Helma applications.<BR/><BR/>
|
||||
|
||||
</p>
|
||||
|
||||
<hr>
|
||||
|
||||
|
||||
<table border="1" cellpadding="3" cellspacing="0" width="100%">
|
||||
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
|
||||
<td colspan=2><font size="+2">
|
||||
|
||||
<b>Class Summary</b>
|
||||
|
||||
</font></td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td width="15%"><b><a href="jala.I18n.html">jala.I18n</a></b></td>
|
||||
<td>This class provides various functions and macros for
|
||||
internationalization of Helma applications.</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
<hr/>
|
||||
|
||||
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
|
||||
<!-- ========== END METHOD SUMMARY =========== -->
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- ========== START OF NAVBAR ========== -->
|
||||
<a name="navbar_top"><!-- --></a>
|
||||
<table border="0" width="100%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td colspan=2 bgcolor="#EEEEFF" class="NavBarCell1">
|
||||
<a name="navbar_top_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="#FFFFFF" class="NavBarCell1Rev"> <font class="NavBarFont1Rev"><b>File</b></font> </td>
|
||||
|
||||
|
||||
<td bgcolor="#FFFFFF" class="NavBarCell1"> <font class="NavBarFont1">Class</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="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 bgcolor="#EEEEFF" align="right" valign="top"><em>
|
||||
<b>Jala 1.3</b></em>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
PREV
|
||||
NEXT</font></td>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
<a href="index.html" target="_top"><b>FRAMES</b></a>
|
||||
<a href="overview-summary.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>
|
||||
</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>
|
||||
169
modules/jala/docs/overview-summary-ImageFilter.js.html
Normal file
169
modules/jala/docs/overview-summary-ImageFilter.js.html
Normal file
|
|
@ -0,0 +1,169 @@
|
|||
<!doctype html public "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
|
||||
<html>
|
||||
<head>
|
||||
<title>
|
||||
Jala 1.3 Overview
|
||||
</title>
|
||||
<link rel ="stylesheet" type="text/css" href="stylesheet.css" title="Style">
|
||||
<script>
|
||||
function asd() {
|
||||
|
||||
parent.document.title="ImageFilter.js Overview";
|
||||
|
||||
}
|
||||
</script>
|
||||
</head>
|
||||
<body bgcolor="white" onload="asd();">
|
||||
|
||||
<!-- ========== START OF NAVBAR ========== -->
|
||||
<a name="navbar_top"><!-- --></a>
|
||||
<table border="0" width="100%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td colspan=2 bgcolor="#EEEEFF" class="NavBarCell1">
|
||||
<a name="navbar_top_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="#FFFFFF" class="NavBarCell1Rev"> <font class="NavBarFont1Rev"><b>File</b></font> </td>
|
||||
|
||||
|
||||
<td bgcolor="#FFFFFF" class="NavBarCell1"> <font class="NavBarFont1">Class</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="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 bgcolor="#EEEEFF" align="right" valign="top">
|
||||
<em>
|
||||
<b>Jala 1.3</b></em>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
PREV
|
||||
NEXT</font></td>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
<a href="index.html" target="_top"><b>FRAMES</b></a>
|
||||
<a href="overview-summary.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>
|
||||
</table>
|
||||
<!-- =========== END OF NAVBAR =========== -->
|
||||
|
||||
<hr>
|
||||
<center>
|
||||
|
||||
<h2>ImageFilter.js</h2>
|
||||
|
||||
</center>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4>Summary</h4>
|
||||
<p>
|
||||
|
||||
Fields and methods of the jala.ImageFilter class.<BR/><BR/>
|
||||
|
||||
</p>
|
||||
|
||||
<hr>
|
||||
|
||||
|
||||
<table border="1" cellpadding="3" cellspacing="0" width="100%">
|
||||
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
|
||||
<td colspan=2><font size="+2">
|
||||
|
||||
<b>Class Summary</b>
|
||||
|
||||
</font></td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td width="15%"><b><a href="jala.ImageFilter.html">jala.ImageFilter</a></b></td>
|
||||
<td>This class provides several image manipulating
|
||||
methods.</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
<hr/>
|
||||
|
||||
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
|
||||
<!-- ========== END METHOD SUMMARY =========== -->
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- ========== START OF NAVBAR ========== -->
|
||||
<a name="navbar_top"><!-- --></a>
|
||||
<table border="0" width="100%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td colspan=2 bgcolor="#EEEEFF" class="NavBarCell1">
|
||||
<a name="navbar_top_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="#FFFFFF" class="NavBarCell1Rev"> <font class="NavBarFont1Rev"><b>File</b></font> </td>
|
||||
|
||||
|
||||
<td bgcolor="#FFFFFF" class="NavBarCell1"> <font class="NavBarFont1">Class</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="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 bgcolor="#EEEEFF" align="right" valign="top"><em>
|
||||
<b>Jala 1.3</b></em>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
PREV
|
||||
NEXT</font></td>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
<a href="index.html" target="_top"><b>FRAMES</b></a>
|
||||
<a href="overview-summary.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>
|
||||
</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>
|
||||
175
modules/jala/docs/overview-summary-IndexManager.js.html
Normal file
175
modules/jala/docs/overview-summary-IndexManager.js.html
Normal file
|
|
@ -0,0 +1,175 @@
|
|||
<!doctype html public "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
|
||||
<html>
|
||||
<head>
|
||||
<title>
|
||||
Jala 1.3 Overview
|
||||
</title>
|
||||
<link rel ="stylesheet" type="text/css" href="stylesheet.css" title="Style">
|
||||
<script>
|
||||
function asd() {
|
||||
|
||||
parent.document.title="IndexManager.js Overview";
|
||||
|
||||
}
|
||||
</script>
|
||||
</head>
|
||||
<body bgcolor="white" onload="asd();">
|
||||
|
||||
<!-- ========== START OF NAVBAR ========== -->
|
||||
<a name="navbar_top"><!-- --></a>
|
||||
<table border="0" width="100%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td colspan=2 bgcolor="#EEEEFF" class="NavBarCell1">
|
||||
<a name="navbar_top_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="#FFFFFF" class="NavBarCell1Rev"> <font class="NavBarFont1Rev"><b>File</b></font> </td>
|
||||
|
||||
|
||||
<td bgcolor="#FFFFFF" class="NavBarCell1"> <font class="NavBarFont1">Class</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="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 bgcolor="#EEEEFF" align="right" valign="top">
|
||||
<em>
|
||||
<b>Jala 1.3</b></em>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
PREV
|
||||
NEXT</font></td>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
<a href="index.html" target="_top"><b>FRAMES</b></a>
|
||||
<a href="overview-summary.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>
|
||||
</table>
|
||||
<!-- =========== END OF NAVBAR =========== -->
|
||||
|
||||
<hr>
|
||||
<center>
|
||||
|
||||
<h2>IndexManager.js</h2>
|
||||
|
||||
</center>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4>Summary</h4>
|
||||
<p>
|
||||
|
||||
Fields and methods of the jala.IndexManager class.<BR/><BR/>
|
||||
|
||||
</p>
|
||||
|
||||
<hr>
|
||||
|
||||
|
||||
<table border="1" cellpadding="3" cellspacing="0" width="100%">
|
||||
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
|
||||
<td colspan=2><font size="+2">
|
||||
|
||||
<b>Class Summary</b>
|
||||
|
||||
</font></td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td width="15%"><b><a href="jala.IndexManager.html">jala.IndexManager</a></b></td>
|
||||
<td>This class basically sits on top of a helma.Search.Index instance
|
||||
and provides methods for adding, removing and optimizing the underlying index.</td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td width="15%"><b><a href="jala.IndexManager.Job.html">jala.IndexManager.Job</a></b></td>
|
||||
<td>Instances of this class represent a single index
|
||||
manipulation job to be processed by the index manager.</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
<hr/>
|
||||
|
||||
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
|
||||
<!-- ========== END METHOD SUMMARY =========== -->
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- ========== START OF NAVBAR ========== -->
|
||||
<a name="navbar_top"><!-- --></a>
|
||||
<table border="0" width="100%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td colspan=2 bgcolor="#EEEEFF" class="NavBarCell1">
|
||||
<a name="navbar_top_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="#FFFFFF" class="NavBarCell1Rev"> <font class="NavBarFont1Rev"><b>File</b></font> </td>
|
||||
|
||||
|
||||
<td bgcolor="#FFFFFF" class="NavBarCell1"> <font class="NavBarFont1">Class</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="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 bgcolor="#EEEEFF" align="right" valign="top"><em>
|
||||
<b>Jala 1.3</b></em>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
PREV
|
||||
NEXT</font></td>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
<a href="index.html" target="_top"><b>FRAMES</b></a>
|
||||
<a href="overview-summary.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>
|
||||
</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>
|
||||
174
modules/jala/docs/overview-summary-ListRenderer.js.html
Normal file
174
modules/jala/docs/overview-summary-ListRenderer.js.html
Normal file
|
|
@ -0,0 +1,174 @@
|
|||
<!doctype html public "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
|
||||
<html>
|
||||
<head>
|
||||
<title>
|
||||
Jala 1.3 Overview
|
||||
</title>
|
||||
<link rel ="stylesheet" type="text/css" href="stylesheet.css" title="Style">
|
||||
<script>
|
||||
function asd() {
|
||||
|
||||
parent.document.title="ListRenderer.js Overview";
|
||||
|
||||
}
|
||||
</script>
|
||||
</head>
|
||||
<body bgcolor="white" onload="asd();">
|
||||
|
||||
<!-- ========== START OF NAVBAR ========== -->
|
||||
<a name="navbar_top"><!-- --></a>
|
||||
<table border="0" width="100%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td colspan=2 bgcolor="#EEEEFF" class="NavBarCell1">
|
||||
<a name="navbar_top_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="#FFFFFF" class="NavBarCell1Rev"> <font class="NavBarFont1Rev"><b>File</b></font> </td>
|
||||
|
||||
|
||||
<td bgcolor="#FFFFFF" class="NavBarCell1"> <font class="NavBarFont1">Class</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="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 bgcolor="#EEEEFF" align="right" valign="top">
|
||||
<em>
|
||||
<b>Jala 1.3</b></em>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
PREV
|
||||
NEXT</font></td>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
<a href="index.html" target="_top"><b>FRAMES</b></a>
|
||||
<a href="overview-summary.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>
|
||||
</table>
|
||||
<!-- =========== END OF NAVBAR =========== -->
|
||||
|
||||
<hr>
|
||||
<center>
|
||||
|
||||
<h2>ListRenderer.js</h2>
|
||||
|
||||
</center>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4>Summary</h4>
|
||||
<p>
|
||||
|
||||
Fields and methods of the jala.ListRenderer class.<BR/><BR/>
|
||||
|
||||
</p>
|
||||
|
||||
<hr>
|
||||
|
||||
|
||||
<table border="1" cellpadding="3" cellspacing="0" width="100%">
|
||||
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
|
||||
<td colspan=2><font size="+2">
|
||||
|
||||
<b>Class Summary</b>
|
||||
|
||||
</font></td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td width="15%"><b><a href="jala.ListRenderer.html">jala.ListRenderer</a></b></td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td width="15%"><b><a href="jala.ListRenderer.ArrayList.html">jala.ListRenderer.ArrayList</a></b></td>
|
||||
<td>A simple wrapper around an array to use in conjunction
|
||||
with jala.ListRenderer.</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
<hr/>
|
||||
|
||||
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
|
||||
<!-- ========== END METHOD SUMMARY =========== -->
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- ========== START OF NAVBAR ========== -->
|
||||
<a name="navbar_top"><!-- --></a>
|
||||
<table border="0" width="100%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td colspan=2 bgcolor="#EEEEFF" class="NavBarCell1">
|
||||
<a name="navbar_top_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="#FFFFFF" class="NavBarCell1Rev"> <font class="NavBarFont1Rev"><b>File</b></font> </td>
|
||||
|
||||
|
||||
<td bgcolor="#FFFFFF" class="NavBarCell1"> <font class="NavBarFont1">Class</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="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 bgcolor="#EEEEFF" align="right" valign="top"><em>
|
||||
<b>Jala 1.3</b></em>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
PREV
|
||||
NEXT</font></td>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
<a href="index.html" target="_top"><b>FRAMES</b></a>
|
||||
<a href="overview-summary.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>
|
||||
</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>
|
||||
179
modules/jala/docs/overview-summary-Mp3.js.html
Normal file
179
modules/jala/docs/overview-summary-Mp3.js.html
Normal file
|
|
@ -0,0 +1,179 @@
|
|||
<!doctype html public "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
|
||||
<html>
|
||||
<head>
|
||||
<title>
|
||||
Jala 1.3 Overview
|
||||
</title>
|
||||
<link rel ="stylesheet" type="text/css" href="stylesheet.css" title="Style">
|
||||
<script>
|
||||
function asd() {
|
||||
|
||||
parent.document.title="Mp3.js Overview";
|
||||
|
||||
}
|
||||
</script>
|
||||
</head>
|
||||
<body bgcolor="white" onload="asd();">
|
||||
|
||||
<!-- ========== START OF NAVBAR ========== -->
|
||||
<a name="navbar_top"><!-- --></a>
|
||||
<table border="0" width="100%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td colspan=2 bgcolor="#EEEEFF" class="NavBarCell1">
|
||||
<a name="navbar_top_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="#FFFFFF" class="NavBarCell1Rev"> <font class="NavBarFont1Rev"><b>File</b></font> </td>
|
||||
|
||||
|
||||
<td bgcolor="#FFFFFF" class="NavBarCell1"> <font class="NavBarFont1">Class</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="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 bgcolor="#EEEEFF" align="right" valign="top">
|
||||
<em>
|
||||
<b>Jala 1.3</b></em>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
PREV
|
||||
NEXT</font></td>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
<a href="index.html" target="_top"><b>FRAMES</b></a>
|
||||
<a href="overview-summary.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>
|
||||
</table>
|
||||
<!-- =========== END OF NAVBAR =========== -->
|
||||
|
||||
<hr>
|
||||
<center>
|
||||
|
||||
<h2>Mp3.js</h2>
|
||||
|
||||
</center>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4>Summary</h4>
|
||||
<p>
|
||||
|
||||
Fields and methods of the jala.audio package.<BR/><BR/>
|
||||
|
||||
</p>
|
||||
|
||||
<hr>
|
||||
|
||||
|
||||
<table border="1" cellpadding="3" cellspacing="0" width="100%">
|
||||
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
|
||||
<td colspan=2><font size="+2">
|
||||
|
||||
<b>Class Summary</b>
|
||||
|
||||
</font></td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td width="15%"><b><a href="jala.Mp3.html">jala.Mp3</a></b></td>
|
||||
<td>This is a class representing an MP3 file
|
||||
providing methods to access its metadata.</td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td width="15%"><b><a href="jala.Mp3.Id3v1.html">jala.Mp3.Id3v1</a></b></td>
|
||||
<td>This class represents an Id3v1 tag.</td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td width="15%"><b><a href="jala.Mp3.Id3v2.html">jala.Mp3.Id3v2</a></b></td>
|
||||
<td>This class represents an Id3v2 tag.</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
<hr/>
|
||||
|
||||
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
|
||||
<!-- ========== END METHOD SUMMARY =========== -->
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- ========== START OF NAVBAR ========== -->
|
||||
<a name="navbar_top"><!-- --></a>
|
||||
<table border="0" width="100%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td colspan=2 bgcolor="#EEEEFF" class="NavBarCell1">
|
||||
<a name="navbar_top_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="#FFFFFF" class="NavBarCell1Rev"> <font class="NavBarFont1Rev"><b>File</b></font> </td>
|
||||
|
||||
|
||||
<td bgcolor="#FFFFFF" class="NavBarCell1"> <font class="NavBarFont1">Class</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="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 bgcolor="#EEEEFF" align="right" valign="top"><em>
|
||||
<b>Jala 1.3</b></em>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
PREV
|
||||
NEXT</font></td>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
<a href="index.html" target="_top"><b>FRAMES</b></a>
|
||||
<a href="overview-summary.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>
|
||||
</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>
|
||||
169
modules/jala/docs/overview-summary-PodcastWriter.js.html
Normal file
169
modules/jala/docs/overview-summary-PodcastWriter.js.html
Normal file
|
|
@ -0,0 +1,169 @@
|
|||
<!doctype html public "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
|
||||
<html>
|
||||
<head>
|
||||
<title>
|
||||
Jala 1.3 Overview
|
||||
</title>
|
||||
<link rel ="stylesheet" type="text/css" href="stylesheet.css" title="Style">
|
||||
<script>
|
||||
function asd() {
|
||||
|
||||
parent.document.title="PodcastWriter.js Overview";
|
||||
|
||||
}
|
||||
</script>
|
||||
</head>
|
||||
<body bgcolor="white" onload="asd();">
|
||||
|
||||
<!-- ========== START OF NAVBAR ========== -->
|
||||
<a name="navbar_top"><!-- --></a>
|
||||
<table border="0" width="100%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td colspan=2 bgcolor="#EEEEFF" class="NavBarCell1">
|
||||
<a name="navbar_top_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="#FFFFFF" class="NavBarCell1Rev"> <font class="NavBarFont1Rev"><b>File</b></font> </td>
|
||||
|
||||
|
||||
<td bgcolor="#FFFFFF" class="NavBarCell1"> <font class="NavBarFont1">Class</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="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 bgcolor="#EEEEFF" align="right" valign="top">
|
||||
<em>
|
||||
<b>Jala 1.3</b></em>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
PREV
|
||||
NEXT</font></td>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
<a href="index.html" target="_top"><b>FRAMES</b></a>
|
||||
<a href="overview-summary.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>
|
||||
</table>
|
||||
<!-- =========== END OF NAVBAR =========== -->
|
||||
|
||||
<hr>
|
||||
<center>
|
||||
|
||||
<h2>PodcastWriter.js</h2>
|
||||
|
||||
</center>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4>Summary</h4>
|
||||
<p>
|
||||
|
||||
Fields and methods of the jala.PodcastWriter class.<BR/><BR/>
|
||||
|
||||
</p>
|
||||
|
||||
<hr>
|
||||
|
||||
|
||||
<table border="1" cellpadding="3" cellspacing="0" width="100%">
|
||||
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
|
||||
<td colspan=2><font size="+2">
|
||||
|
||||
<b>Class Summary</b>
|
||||
|
||||
</font></td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td width="15%"><b><a href="jala.PodcastWriter.html">jala.PodcastWriter</a></b></td>
|
||||
<td>Class to create, modify and render standard-compliant
|
||||
RSS 2.0 feeds including support for Apple's Podcast specification.</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
<hr/>
|
||||
|
||||
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
|
||||
<!-- ========== END METHOD SUMMARY =========== -->
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- ========== START OF NAVBAR ========== -->
|
||||
<a name="navbar_top"><!-- --></a>
|
||||
<table border="0" width="100%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td colspan=2 bgcolor="#EEEEFF" class="NavBarCell1">
|
||||
<a name="navbar_top_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="#FFFFFF" class="NavBarCell1Rev"> <font class="NavBarFont1Rev"><b>File</b></font> </td>
|
||||
|
||||
|
||||
<td bgcolor="#FFFFFF" class="NavBarCell1"> <font class="NavBarFont1">Class</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="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 bgcolor="#EEEEFF" align="right" valign="top"><em>
|
||||
<b>Jala 1.3</b></em>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
PREV
|
||||
NEXT</font></td>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
<a href="index.html" target="_top"><b>FRAMES</b></a>
|
||||
<a href="overview-summary.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>
|
||||
</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>
|
||||
169
modules/jala/docs/overview-summary-RemoteContent.js.html
Normal file
169
modules/jala/docs/overview-summary-RemoteContent.js.html
Normal file
|
|
@ -0,0 +1,169 @@
|
|||
<!doctype html public "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
|
||||
<html>
|
||||
<head>
|
||||
<title>
|
||||
Jala 1.3 Overview
|
||||
</title>
|
||||
<link rel ="stylesheet" type="text/css" href="stylesheet.css" title="Style">
|
||||
<script>
|
||||
function asd() {
|
||||
|
||||
parent.document.title="RemoteContent.js Overview";
|
||||
|
||||
}
|
||||
</script>
|
||||
</head>
|
||||
<body bgcolor="white" onload="asd();">
|
||||
|
||||
<!-- ========== START OF NAVBAR ========== -->
|
||||
<a name="navbar_top"><!-- --></a>
|
||||
<table border="0" width="100%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td colspan=2 bgcolor="#EEEEFF" class="NavBarCell1">
|
||||
<a name="navbar_top_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="#FFFFFF" class="NavBarCell1Rev"> <font class="NavBarFont1Rev"><b>File</b></font> </td>
|
||||
|
||||
|
||||
<td bgcolor="#FFFFFF" class="NavBarCell1"> <font class="NavBarFont1">Class</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="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 bgcolor="#EEEEFF" align="right" valign="top">
|
||||
<em>
|
||||
<b>Jala 1.3</b></em>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
PREV
|
||||
NEXT</font></td>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
<a href="index.html" target="_top"><b>FRAMES</b></a>
|
||||
<a href="overview-summary.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>
|
||||
</table>
|
||||
<!-- =========== END OF NAVBAR =========== -->
|
||||
|
||||
<hr>
|
||||
<center>
|
||||
|
||||
<h2>RemoteContent.js</h2>
|
||||
|
||||
</center>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4>Summary</h4>
|
||||
<p>
|
||||
|
||||
Fields and methods of the jala.RemoteContent class.<BR/><BR/>
|
||||
|
||||
</p>
|
||||
|
||||
<hr>
|
||||
|
||||
|
||||
<table border="1" cellpadding="3" cellspacing="0" width="100%">
|
||||
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
|
||||
<td colspan=2><font size="+2">
|
||||
|
||||
<b>Class Summary</b>
|
||||
|
||||
</font></td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td width="15%"><b><a href="jala.RemoteContent.html">jala.RemoteContent</a></b></td>
|
||||
<td>API to define, fetch and update content
|
||||
from a remote site.</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
<hr/>
|
||||
|
||||
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
|
||||
<!-- ========== END METHOD SUMMARY =========== -->
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- ========== START OF NAVBAR ========== -->
|
||||
<a name="navbar_top"><!-- --></a>
|
||||
<table border="0" width="100%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td colspan=2 bgcolor="#EEEEFF" class="NavBarCell1">
|
||||
<a name="navbar_top_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="#FFFFFF" class="NavBarCell1Rev"> <font class="NavBarFont1Rev"><b>File</b></font> </td>
|
||||
|
||||
|
||||
<td bgcolor="#FFFFFF" class="NavBarCell1"> <font class="NavBarFont1">Class</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="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 bgcolor="#EEEEFF" align="right" valign="top"><em>
|
||||
<b>Jala 1.3</b></em>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
PREV
|
||||
NEXT</font></td>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
<a href="index.html" target="_top"><b>FRAMES</b></a>
|
||||
<a href="overview-summary.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>
|
||||
</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>
|
||||
169
modules/jala/docs/overview-summary-Rss20Writer.js.html
Normal file
169
modules/jala/docs/overview-summary-Rss20Writer.js.html
Normal file
|
|
@ -0,0 +1,169 @@
|
|||
<!doctype html public "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
|
||||
<html>
|
||||
<head>
|
||||
<title>
|
||||
Jala 1.3 Overview
|
||||
</title>
|
||||
<link rel ="stylesheet" type="text/css" href="stylesheet.css" title="Style">
|
||||
<script>
|
||||
function asd() {
|
||||
|
||||
parent.document.title="Rss20Writer.js Overview";
|
||||
|
||||
}
|
||||
</script>
|
||||
</head>
|
||||
<body bgcolor="white" onload="asd();">
|
||||
|
||||
<!-- ========== START OF NAVBAR ========== -->
|
||||
<a name="navbar_top"><!-- --></a>
|
||||
<table border="0" width="100%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td colspan=2 bgcolor="#EEEEFF" class="NavBarCell1">
|
||||
<a name="navbar_top_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="#FFFFFF" class="NavBarCell1Rev"> <font class="NavBarFont1Rev"><b>File</b></font> </td>
|
||||
|
||||
|
||||
<td bgcolor="#FFFFFF" class="NavBarCell1"> <font class="NavBarFont1">Class</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="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 bgcolor="#EEEEFF" align="right" valign="top">
|
||||
<em>
|
||||
<b>Jala 1.3</b></em>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
PREV
|
||||
NEXT</font></td>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
<a href="index.html" target="_top"><b>FRAMES</b></a>
|
||||
<a href="overview-summary.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>
|
||||
</table>
|
||||
<!-- =========== END OF NAVBAR =========== -->
|
||||
|
||||
<hr>
|
||||
<center>
|
||||
|
||||
<h2>Rss20Writer.js</h2>
|
||||
|
||||
</center>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4>Summary</h4>
|
||||
<p>
|
||||
|
||||
Fields and methods of the jala.Rss20Writer class.<BR/><BR/>
|
||||
|
||||
</p>
|
||||
|
||||
<hr>
|
||||
|
||||
|
||||
<table border="1" cellpadding="3" cellspacing="0" width="100%">
|
||||
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
|
||||
<td colspan=2><font size="+2">
|
||||
|
||||
<b>Class Summary</b>
|
||||
|
||||
</font></td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td width="15%"><b><a href="jala.Rss20Writer.html">jala.Rss20Writer</a></b></td>
|
||||
<td>Class to create, modify and render standard-compliant
|
||||
RSS 2.0 feeds.</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
<hr/>
|
||||
|
||||
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
|
||||
<!-- ========== END METHOD SUMMARY =========== -->
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- ========== START OF NAVBAR ========== -->
|
||||
<a name="navbar_top"><!-- --></a>
|
||||
<table border="0" width="100%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td colspan=2 bgcolor="#EEEEFF" class="NavBarCell1">
|
||||
<a name="navbar_top_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="#FFFFFF" class="NavBarCell1Rev"> <font class="NavBarFont1Rev"><b>File</b></font> </td>
|
||||
|
||||
|
||||
<td bgcolor="#FFFFFF" class="NavBarCell1"> <font class="NavBarFont1">Class</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="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 bgcolor="#EEEEFF" align="right" valign="top"><em>
|
||||
<b>Jala 1.3</b></em>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
PREV
|
||||
NEXT</font></td>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
<a href="index.html" target="_top"><b>FRAMES</b></a>
|
||||
<a href="overview-summary.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>
|
||||
</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>
|
||||
169
modules/jala/docs/overview-summary-Utilities.js.html
Normal file
169
modules/jala/docs/overview-summary-Utilities.js.html
Normal file
|
|
@ -0,0 +1,169 @@
|
|||
<!doctype html public "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
|
||||
<html>
|
||||
<head>
|
||||
<title>
|
||||
Jala 1.3 Overview
|
||||
</title>
|
||||
<link rel ="stylesheet" type="text/css" href="stylesheet.css" title="Style">
|
||||
<script>
|
||||
function asd() {
|
||||
|
||||
parent.document.title="Utilities.js Overview";
|
||||
|
||||
}
|
||||
</script>
|
||||
</head>
|
||||
<body bgcolor="white" onload="asd();">
|
||||
|
||||
<!-- ========== START OF NAVBAR ========== -->
|
||||
<a name="navbar_top"><!-- --></a>
|
||||
<table border="0" width="100%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td colspan=2 bgcolor="#EEEEFF" class="NavBarCell1">
|
||||
<a name="navbar_top_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="#FFFFFF" class="NavBarCell1Rev"> <font class="NavBarFont1Rev"><b>File</b></font> </td>
|
||||
|
||||
|
||||
<td bgcolor="#FFFFFF" class="NavBarCell1"> <font class="NavBarFont1">Class</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="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 bgcolor="#EEEEFF" align="right" valign="top">
|
||||
<em>
|
||||
<b>Jala 1.3</b></em>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
PREV
|
||||
NEXT</font></td>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
<a href="index.html" target="_top"><b>FRAMES</b></a>
|
||||
<a href="overview-summary.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>
|
||||
</table>
|
||||
<!-- =========== END OF NAVBAR =========== -->
|
||||
|
||||
<hr>
|
||||
<center>
|
||||
|
||||
<h2>Utilities.js</h2>
|
||||
|
||||
</center>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4>Summary</h4>
|
||||
<p>
|
||||
|
||||
Fields and methods of the jala.Utilities class.<BR/><BR/>
|
||||
|
||||
</p>
|
||||
|
||||
<hr>
|
||||
|
||||
|
||||
<table border="1" cellpadding="3" cellspacing="0" width="100%">
|
||||
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
|
||||
<td colspan=2><font size="+2">
|
||||
|
||||
<b>Class Summary</b>
|
||||
|
||||
</font></td>
|
||||
</tr>
|
||||
|
||||
<tr bgcolor="white" class="TableRowColor">
|
||||
<td width="15%"><b><a href="jala.Utilities.html">jala.Utilities</a></b></td>
|
||||
<td>This class contains various convenience methods
|
||||
which do not fit in any other class.</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
<hr/>
|
||||
|
||||
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
|
||||
<!-- ========== END METHOD SUMMARY =========== -->
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- ========== START OF NAVBAR ========== -->
|
||||
<a name="navbar_top"><!-- --></a>
|
||||
<table border="0" width="100%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td colspan=2 bgcolor="#EEEEFF" class="NavBarCell1">
|
||||
<a name="navbar_top_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="#FFFFFF" class="NavBarCell1Rev"> <font class="NavBarFont1Rev"><b>File</b></font> </td>
|
||||
|
||||
|
||||
<td bgcolor="#FFFFFF" class="NavBarCell1"> <font class="NavBarFont1">Class</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="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 bgcolor="#EEEEFF" align="right" valign="top"><em>
|
||||
<b>Jala 1.3</b></em>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
PREV
|
||||
NEXT</font></td>
|
||||
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
||||
<a href="index.html" target="_top"><b>FRAMES</b></a>
|
||||
<a href="overview-summary.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>
|
||||
</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>
|
||||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Add a link
Reference in a new issue