2339 lines
54 KiB
HTML
2339 lines
54 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
|
<!--NewPage-->
|
|
<HTML>
|
|
<HEAD>
|
|
<TITLE>
|
|
jala.ListRenderer
|
|
</TITLE>
|
|
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
|
</HEAD>
|
|
<SCRIPT>
|
|
function asd()
|
|
{
|
|
parent.document.title="jala.ListRenderer";
|
|
}
|
|
</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.IndexManager.Job.html"><B>PREV CLASS</B></A><!--
|
|
NEXT CLASS
|
|
-->
|
|
<A HREF="jala.ListRenderer.ArrayList.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.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</H2>
|
|
<PRE>Object
|
|
|
|
|
+--<b>jala.ListRenderer</b>
|
|
</PRE>
|
|
|
|
|
|
<HR>
|
|
<DL>
|
|
<!-- Class definition -->
|
|
<DT>class
|
|
<B>jala.ListRenderer</B>
|
|
|
|
|
|
</DL>
|
|
|
|
<P>
|
|
<BR/><BR/><I>Defined in <a href='overview-summary-ListRenderer.js.html'>ListRenderer.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.ListRenderer.ArrayList.html">jala.ListRenderer.ArrayList</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> Object</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="#!s!defaultRenderer">defaultRenderer</A></B></CODE>
|
|
<BR>
|
|
Default Renderer object containing functions
|
|
used for rendering different list items (eg.</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.html#jala.ListRenderer()">jala.ListRenderer</A>
|
|
</B>
|
|
(<HopObject|ArrayList|Array> coll, <Object> renderer)
|
|
</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> Number</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#currentEnd_macro">currentEnd_macro</A></B>()
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns the end item number in the current page
|
|
</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="#currentPage_macro">currentPage_macro</A></B>()
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns the current page number
|
|
</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="#currentStart_macro">currentStart_macro</A></B>()
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns the start item number in the current page
|
|
</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="#getBaseHref">getBaseHref</A></B>()
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns the base href of this ListRenderer instance
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> HopObject|Array</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#getCollection">getCollection</A></B>()
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns the collection this ListRenderer instance operates on
|
|
</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="#getCurrentPage">getCurrentPage</A></B>()
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns the current page index.
|
|
</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="#getEndIndex">getEndIndex</A></B>()
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns the zero-based index position of the last item of the current page
|
|
in the collection this ListRenderer operates on.
|
|
</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="#getItemSkin">getItemSkin</A></B>()
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns the name of the skin rendered for a single list item
|
|
</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="#getList">getList</A></B>(<Object> param)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns the rendered list of collection items as string
|
|
</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="#getMaxPages">getMaxPages</A></B>()
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns the maximum number of pages handled by this ListRenderer instance
|
|
</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="#getNextLink">getNextLink</A></B>(<Object> param)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns a rendered link to the previous page 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="#getPageHref">getPageHref</A></B>(<Number> page)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns the href of a page.
|
|
</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="#getPageNavigation">getPageNavigation</A></B>(<Object> param)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns the rendered page navigation bar as string
|
|
</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="#getPageSize">getPageSize</A></B>()
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns the number of items displayed on one page
|
|
</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="#getPrevLink">getPrevLink</A></B>(<Object> param)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns a rendered link to the previous page as string.
|
|
</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 ListRenderer 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="#getStartIndex">getStartIndex</A></B>()
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns the zero-based index position of the first item of the current page
|
|
in the collection this ListRenderer operates on.
|
|
</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="#getTotalPages">getTotalPages</A></B>()
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns the total number of pages handled by this ListRenderer instance
|
|
(which is the collection size divided by the page size).
|
|
</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="#getUrlParameterName">getUrlParameterName</A></B>()
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns the name of the URL parameter name containing the index
|
|
of the page to display
|
|
</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="#getUrlParameters">getUrlParameters</A></B>()
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns any additional URL parameters included in every navigation link
|
|
rendered by this ListRenderer 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="#limit_macro">limit_macro</A></B>(<Object> param)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Either renders the maximum number of items per page, or
|
|
sets the limit to a given number.
|
|
</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="#nextLink_macro">nextLink_macro</A></B>(<Object> param)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns a rendered link to the next page.
|
|
</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="#pageNavigation_macro">pageNavigation_macro</A></B>(<Object> param)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns the rendered page navigation bar.
|
|
</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="#prevLink_macro">prevLink_macro</A></B>(<Object> param)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns a rendered link to the previous page.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#render_macro">render_macro</A></B>(<Object> param)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Renders the current page of this list.
|
|
</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="#renderList">renderList</A></B>(<Object> param)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Renders the list of items for one page directly to response.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> String</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#renderListAsString">renderListAsString</A></B>(<Object> param)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns the rendered list of collection items 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="#renderNextLink">renderNextLink</A></B>(<Object> param)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Renders a link to the next page directly to response.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> String</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#renderNextLinkAsString">renderNextLinkAsString</A></B>(param)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns a rendered link to the previous page as string
|
|
</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="#renderPageNavigation">renderPageNavigation</A></B>(<Object> param)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Renders the page navigation bar directly to response.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> String</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#renderPageNavigationAsString">renderPageNavigationAsString</A></B>(param)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns the rendered page navigation bar 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="#renderPrevLink">renderPrevLink</A></B>(<Object> param)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Renders a link to the previous page directly to response.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> String</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#renderPrevLinkAsString">renderPrevLinkAsString</A></B>(<Object> param)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns a rendered link to the previous page 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="#setBaseHref">setBaseHref</A></B>(<String> href)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Sets the base href of this ListRenderer 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="#setCollection">setCollection</A></B>(<HopObject|ArrayList|Array> coll)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Sets the collection of this ListRenderer
|
|
</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="#setItemSkin">setItemSkin</A></B>(<String> name)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Sets the name of the skin to render for every list item
|
|
</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="#setMaxPages">setMaxPages</A></B>(<Number> pages)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Sets the maximum number of pages to display
|
|
</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="#setPageSize">setPageSize</A></B>(<Number> size)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Sets the number of items to display on a single page
|
|
</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 be used by this ListRenderer 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="#setUrlParameterName">setUrlParameterName</A></B>(<String> name)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Sets the name of the URL parameter name containing the index of the page
|
|
to display
|
|
</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="#setUrlParameters">setUrlParameters</A></B>(<String> params)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Sets additional parameters to include in every navigation link
|
|
</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_macro">size_macro</A></B>()
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns the total number of items
|
|
</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="#totalPages_macro">totalPages_macro</A></B>()
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns the total number of pages
|
|
</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!defaultRenderer"><!-- --></A>
|
|
<H3>defaultRenderer</H3>
|
|
<PRE><static> <final> Object <B>defaultRenderer</B></PRE>
|
|
<UL>
|
|
Default Renderer object containing functions
|
|
used for rendering different list items (eg. page navigation,
|
|
prev/next links and list items).
|
|
|
|
</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()"><!-- --></A><H3>
|
|
jala.ListRenderer</H3>
|
|
<PRE><B>jala.ListRenderer</B>(<HopObject|ArrayList|Array> coll, <Object> renderer)</PRE>
|
|
|
|
|
|
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>coll</CODE> - The collection this ListRenderer operates on, or - for backwards compatibility only - a parameter object containing the collection and any other optional configuration parameters.
|
|
</UL>
|
|
|
|
<UL><CODE>renderer</CODE> - An optional renderer to use. If this is set, any rendering method defined in this renderer overrides the default renderer.
|
|
</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="currentEnd_macro"><!-- --></A>
|
|
<H3>currentEnd_macro</H3>
|
|
<PRE>Number <B>currentEnd_macro</B>()</PRE>
|
|
|
|
<UL>Returns the end item number in the current page</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
The end item number in the current page
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="currentPage_macro"><!-- --></A>
|
|
<H3>currentPage_macro</H3>
|
|
<PRE>Number <B>currentPage_macro</B>()</PRE>
|
|
|
|
<UL>Returns the current page number</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
The current page number
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="currentStart_macro"><!-- --></A>
|
|
<H3>currentStart_macro</H3>
|
|
<PRE>Number <B>currentStart_macro</B>()</PRE>
|
|
|
|
<UL>Returns the start item number in the current page</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
The start item number in the current page
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="getBaseHref"><!-- --></A>
|
|
<H3>getBaseHref</H3>
|
|
<PRE>String <B>getBaseHref</B>()</PRE>
|
|
|
|
<UL>Returns the base href of this ListRenderer instance</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
The base href of this ListRenderer instance
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="getCollection"><!-- --></A>
|
|
<H3>getCollection</H3>
|
|
<PRE>HopObject|Array <B>getCollection</B>()</PRE>
|
|
|
|
<UL>Returns the collection this ListRenderer instance operates on</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
The collection of this ListRenderer
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="getCurrentPage"><!-- --></A>
|
|
<H3>getCurrentPage</H3>
|
|
<PRE>Number <B>getCurrentPage</B>()</PRE>
|
|
|
|
<UL>Returns the current page index. This is either the page url parameter
|
|
or the page number 1.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
The current page number (starts with 1).
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<UL>
|
|
<B>See:</B><UL>- <a href="#setUrlParameterName">setUrlParameterName()</a></UL>
|
|
</UL>
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="getEndIndex"><!-- --></A>
|
|
<H3>getEndIndex</H3>
|
|
<PRE>Number <B>getEndIndex</B>()</PRE>
|
|
|
|
<UL>Returns the zero-based index position of the last item of the current page
|
|
in the collection this ListRenderer operates on.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
The index position of the last item in the list
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="getItemSkin"><!-- --></A>
|
|
<H3>getItemSkin</H3>
|
|
<PRE>Number <B>getItemSkin</B>()</PRE>
|
|
|
|
<UL>Returns the name of the skin rendered for a single list item</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
The name of the list item skin
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="getList"><!-- --></A>
|
|
<H3>getList</H3>
|
|
<PRE>String <B>getList</B>(<Object> param)</PRE>
|
|
|
|
<UL>Returns the rendered list of collection items as string</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>param</CODE> - Object containing extra parameters (e.g. from a macro call).
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
The rendered list
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<UL>
|
|
<B>See:</B><UL>- <a href="#renderList">renderList()</a></UL>
|
|
</UL>
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="getMaxPages"><!-- --></A>
|
|
<H3>getMaxPages</H3>
|
|
<PRE>Number <B>getMaxPages</B>()</PRE>
|
|
|
|
<UL>Returns the maximum number of pages handled by this ListRenderer instance</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
The maximum number of pages
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="getNextLink"><!-- --></A>
|
|
<H3>getNextLink</H3>
|
|
<PRE>String <B>getNextLink</B>(<Object> param)</PRE>
|
|
|
|
<UL>Returns a rendered link to the previous page as string. For performance
|
|
reasons this method caches the rendered link in the local cache of this
|
|
ListRenderer instance.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>param</CODE> - Object containing extra parameters (e.g. from a macro call).
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
A rendered link to the previous page
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<UL>
|
|
<B>See:</B><UL>- <a href="#renderNextLink">renderNextLink()</a></UL>
|
|
</UL>
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="getPageHref"><!-- --></A>
|
|
<H3>getPageHref</H3>
|
|
<PRE>String <B>getPageHref</B>(<Number> page)</PRE>
|
|
|
|
<UL>Returns the href of a page. If no argument is given, the href
|
|
of the current page is returned. Any URL parameters set with
|
|
<a href="#setUrlParameters">setUrlParameters()</a> are added to the href.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>page</CODE> - The optional page number to include in the href.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
The href of the page
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<UL>
|
|
<B>See:</B><UL>- <a href="#setUrlParameters">setUrlParameters()</a><BR/>- <a href="#setUrlParameterName">setUrlParameterName()</a></UL>
|
|
</UL>
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="getPageNavigation"><!-- --></A>
|
|
<H3>getPageNavigation</H3>
|
|
<PRE>String <B>getPageNavigation</B>(<Object> param)</PRE>
|
|
|
|
<UL>Returns the rendered page navigation bar as string</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>param</CODE> - Object containing extra parameters (e.g. from a macro call).
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
The rendered page navigation
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<UL>
|
|
<B>See:</B><UL>- <a href="#renderPageNavigation">renderPageNavigation()</a></UL>
|
|
</UL>
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="getPageSize"><!-- --></A>
|
|
<H3>getPageSize</H3>
|
|
<PRE>Number <B>getPageSize</B>()</PRE>
|
|
|
|
<UL>Returns the number of items displayed on one page</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
The number of items displayed on a single page
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="getPrevLink"><!-- --></A>
|
|
<H3>getPrevLink</H3>
|
|
<PRE>String <B>getPrevLink</B>(<Object> param)</PRE>
|
|
|
|
<UL>Returns a rendered link to the previous page as string. For performance
|
|
reasons this method caches the rendered link in the local cache of this
|
|
ListRenderer instance.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>param</CODE> - Object containing extra parameters (e.g. from a macro call).
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
A rendered link to the previous page
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<UL>
|
|
<B>See:</B><UL>- <a href="#renderPrevLink">renderPrevLink()</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 ListRenderer instance</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="getStartIndex"><!-- --></A>
|
|
<H3>getStartIndex</H3>
|
|
<PRE>Number <B>getStartIndex</B>()</PRE>
|
|
|
|
<UL>Returns the zero-based index position of the first item of the current page
|
|
in the collection this ListRenderer operates on.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
The index position of the first item in the list
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="getTotalPages"><!-- --></A>
|
|
<H3>getTotalPages</H3>
|
|
<PRE>Number <B>getTotalPages</B>()</PRE>
|
|
|
|
<UL>Returns the total number of pages handled by this ListRenderer instance
|
|
(which is the collection size divided by the page size).</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
The total number of pages
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="getUrlParameterName"><!-- --></A>
|
|
<H3>getUrlParameterName</H3>
|
|
<PRE>String <B>getUrlParameterName</B>()</PRE>
|
|
|
|
<UL>Returns the name of the URL parameter name containing the index
|
|
of the page to display</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
The name of the page URL parameter name
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="getUrlParameters"><!-- --></A>
|
|
<H3>getUrlParameters</H3>
|
|
<PRE>String <B>getUrlParameters</B>()</PRE>
|
|
|
|
<UL>Returns any additional URL parameters included in every navigation link
|
|
rendered by this ListRenderer instance.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
A string containing additional URL parameters
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="limit_macro"><!-- --></A>
|
|
<H3>limit_macro</H3>
|
|
<PRE>Number <B>limit_macro</B>(<Object> param)</PRE>
|
|
|
|
<UL>Either renders the maximum number of items per page, or
|
|
sets the limit to a given number.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>param</CODE> - Extra macro parameters: <ul> <li>to - The maximum number of items per page to be set. </ul> If no limit is set, this macro returns the current number of items per page.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
The current maximum number of items per page
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="nextLink_macro"><!-- --></A>
|
|
<H3>nextLink_macro</H3>
|
|
<PRE>String <B>nextLink_macro</B>(<Object> param)</PRE>
|
|
|
|
<UL>Returns a rendered link to the next page.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>param</CODE> - Extra macro parameters: <ul> <li>type - The type of renderer to be applied.</li> </ul>
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
A rendered link to the next page
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<UL>
|
|
<B>See:</B><UL>- <a href="#renderNextLink">renderNextLink()</a></UL>
|
|
</UL>
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="pageNavigation_macro"><!-- --></A>
|
|
<H3>pageNavigation_macro</H3>
|
|
<PRE>String <B>pageNavigation_macro</B>(<Object> param)</PRE>
|
|
|
|
<UL>Returns the rendered page navigation bar.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>param</CODE> - Extra macro parameters: <ul> <li>type - The type of renderer to be applied.</li> </ul>
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
The rendered page navigation bar
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<UL>
|
|
<B>See:</B><UL>- <a href="#getPageNavigation">getPageNavigation()</a></UL>
|
|
</UL>
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="prevLink_macro"><!-- --></A>
|
|
<H3>prevLink_macro</H3>
|
|
<PRE>String <B>prevLink_macro</B>(<Object> param)</PRE>
|
|
|
|
<UL>Returns a rendered link to the previous page.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>param</CODE> - Extra macro parameters: <ul> <li>type - The type of renderer to be applied.</li> </ul>
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
A rendered link to the previous page
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<UL>
|
|
<B>See:</B><UL>- <a href="#renderPrevLink">renderPrevLink()</a></UL>
|
|
</UL>
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="render_macro"><!-- --></A>
|
|
<H3>render_macro</H3>
|
|
<PRE>void <B>render_macro</B>(<Object> param)</PRE>
|
|
|
|
<UL>Renders the current page of this list.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>param</CODE> - Extra macro parameters: <ul> <li>skin - The name of the list skin to render for each item in the list.</li> <li>type - The type of renderer to be applied.</li> </ul>
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<UL>
|
|
<B>See:</B><UL>- <a href="#renderList">renderList()</a></UL>
|
|
</UL>
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="renderList"><!-- --></A>
|
|
<H3>renderList</H3>
|
|
<PRE>void <B>renderList</B>(<Object> param)</PRE>
|
|
|
|
<UL>Renders the list of items for one page directly to response.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>param</CODE> - Object containing extra parameters (e.g. from a macro call).
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<UL>
|
|
<B>See:</B><UL>- <a href="#getList">getList()</a></UL>
|
|
</UL>
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="renderListAsString"><!-- --></A>
|
|
<H3>renderListAsString</H3>
|
|
<PRE>String <B>renderListAsString</B>(<Object> param)</PRE>
|
|
|
|
<UL>Returns the rendered list of collection items as string</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>param</CODE> - Object containing extra parameters (e.g. from a macro call).
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
The rendered list
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<UL>
|
|
<B>Deprecated</B> <I>Use <a href="#getList">getList()</a> instead</I><BR/><BR/><B>See:</B><UL>- <a href="#renderList">renderList()</a></UL>
|
|
</UL>
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="renderNextLink"><!-- --></A>
|
|
<H3>renderNextLink</H3>
|
|
<PRE>void <B>renderNextLink</B>(<Object> param)</PRE>
|
|
|
|
<UL>Renders a link to the next page directly to response.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>param</CODE> - Object containing extra parameters (e.g. from a macro call).
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<UL>
|
|
<B>See:</B><UL>- <a href="#getNextLink">getNextLink()</a></UL>
|
|
</UL>
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="renderNextLinkAsString"><!-- --></A>
|
|
<H3>renderNextLinkAsString</H3>
|
|
<PRE>String <B>renderNextLinkAsString</B>(param)</PRE>
|
|
|
|
<UL>Returns a rendered link to the previous page as string</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
A rendered link to the next page
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<UL>
|
|
<B>Deprecated</B> <I>Use <a href="#getNextLink">getNextLink()</a> instead</I><BR/><BR/>
|
|
</UL>
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="renderPageNavigation"><!-- --></A>
|
|
<H3>renderPageNavigation</H3>
|
|
<PRE>Object <B>renderPageNavigation</B>(<Object> param)</PRE>
|
|
|
|
<UL>Renders the page navigation bar directly to response. For performance reasons
|
|
this method caches the rendered page navigation in the local cache of this
|
|
ListRenderer instance.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>param</CODE> - Object containing extra parameters (e.g. from a macro call).
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<UL>
|
|
<B>See:</B><UL>- <a href="#getPageNavigation">getPageNavigation()</a></UL>
|
|
</UL>
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="renderPageNavigationAsString"><!-- --></A>
|
|
<H3>renderPageNavigationAsString</H3>
|
|
<PRE>String <B>renderPageNavigationAsString</B>(param)</PRE>
|
|
|
|
<UL>Returns the rendered page navigation bar as string</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
The rendered page navigation bar
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<UL>
|
|
<B>Deprecated</B> <I>Use <a href="#getPageNavigation">getPageNavigation()</a> instead</I><BR/><BR/>
|
|
</UL>
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="renderPrevLink"><!-- --></A>
|
|
<H3>renderPrevLink</H3>
|
|
<PRE>void <B>renderPrevLink</B>(<Object> param)</PRE>
|
|
|
|
<UL>Renders a link to the previous page directly to response.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>param</CODE> - Object containing extra parameters (e.g. from a macro call).
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<UL>
|
|
<B>See:</B><UL>- <a href="#getPrevLink">getPrevLink()</a></UL>
|
|
</UL>
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="renderPrevLinkAsString"><!-- --></A>
|
|
<H3>renderPrevLinkAsString</H3>
|
|
<PRE>String <B>renderPrevLinkAsString</B>(<Object> param)</PRE>
|
|
|
|
<UL>Returns a rendered link to the previous page as string</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>param</CODE> - Object containing extra parameters (e.g. from a macro call).
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
A rendered link to the previous page
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<UL>
|
|
<B>Deprecated</B> <I>Use <a href="#getPrevLink">getPrevLink()</a> instead</I><BR/><BR/>
|
|
</UL>
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="setBaseHref"><!-- --></A>
|
|
<H3>setBaseHref</H3>
|
|
<PRE>void <B>setBaseHref</B>(<String> href)</PRE>
|
|
|
|
<UL>Sets the base href of this ListRenderer instance. All links rendered
|
|
will start with the href passed as argument</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>href</CODE> - The base href to use for rendering links
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="setCollection"><!-- --></A>
|
|
<H3>setCollection</H3>
|
|
<PRE>void <B>setCollection</B>(<HopObject|ArrayList|Array> coll)</PRE>
|
|
|
|
<UL>Sets the collection of this ListRenderer</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>coll</CODE> - The collection this ListRenderer instance should operate on
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="setItemSkin"><!-- --></A>
|
|
<H3>setItemSkin</H3>
|
|
<PRE>void <B>setItemSkin</B>(<String> name)</PRE>
|
|
|
|
<UL>Sets the name of the skin to render for every list item</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>name</CODE> - The name of the skin to render for every list item
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="setMaxPages"><!-- --></A>
|
|
<H3>setMaxPages</H3>
|
|
<PRE>void <B>setMaxPages</B>(<Number> pages)</PRE>
|
|
|
|
<UL>Sets the maximum number of pages to display</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>pages</CODE> - The maximum number of pages to display
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="setPageSize"><!-- --></A>
|
|
<H3>setPageSize</H3>
|
|
<PRE>void <B>setPageSize</B>(<Number> size)</PRE>
|
|
|
|
<UL>Sets the number of items to display on a single page</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>size</CODE> - The number of items to display on one page
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="setRenderer"><!-- --></A>
|
|
<H3>setRenderer</H3>
|
|
<PRE>void <B>setRenderer</B>(<Object> r)</PRE>
|
|
|
|
<UL>Sets the renderer to be used by this ListRenderer instance</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>r</CODE> - The renderer to use
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="setUrlParameterName"><!-- --></A>
|
|
<H3>setUrlParameterName</H3>
|
|
<PRE>void <B>setUrlParameterName</B>(<String> name)</PRE>
|
|
|
|
<UL>Sets the name of the URL parameter name containing the index of the page
|
|
to display</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>name</CODE> - The name of the page URL parameter
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="setUrlParameters"><!-- --></A>
|
|
<H3>setUrlParameters</H3>
|
|
<PRE>void <B>setUrlParameters</B>(<String> params)</PRE>
|
|
|
|
<UL>Sets additional parameters to include in every navigation link</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>params</CODE> - A string to append to every navigation URL
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="size_macro"><!-- --></A>
|
|
<H3>size_macro</H3>
|
|
<PRE>Number <B>size_macro</B>()</PRE>
|
|
|
|
<UL>Returns the total number of items</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
The total number of items in the collection this ListRenderer instance is working on
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="totalPages_macro"><!-- --></A>
|
|
<H3>totalPages_macro</H3>
|
|
<PRE>Number <B>totalPages_macro</B>()</PRE>
|
|
|
|
<UL>Returns the total number of pages</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
The total number of pages available
|
|
</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.IndexManager.Job.html"><B>PREV CLASS</B></A><!--
|
|
NEXT CLASS
|
|
-->
|
|
<A HREF="jala.ListRenderer.ArrayList.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.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>
|