WebSphere Commerce Accelerator: Dynamic list Java methods

Develop > Presentation layer > Customize WebSphere Commerce Accelerator, Organization Administration Console, or Administration Console > Tools framework > Dynamic lists

Dynamic list Java methods

These Java methods are in the class com.ibm.commerce.tools.common.ui.taglibs.com and should be used to create the dynamic list.
"/wcs/javascript/tools/common/dynamiclist.js" has to be included in the JSP page to make these Java methods function properly.
Java Method Description
public static void addControlPanel(String xmlfile, int totalpage, int totalitem, Locale loc) Deprecated

Note:

This method is deprecated and is listed here for reference only. See the following equivalent JavaScript function: parent.set_t_page_item(totalitem,listsize);

Adds the control panel to the scroll control frame. The following parameters are supported:

xmlfile

A required string parameter which is an XML file that defines the page.

totalpage

A required integer parameter corresponding to the total number of pages for the list.

totalitem

A required integer parameter corresponding to the total number of entries in the list.

loc

A required locale parameter corresponding to the national language in which the page is displayed.

Throws: ECSystemException
public static void startDlistTable(String tableid, int width)
This method begins the table definition. It is equivalent to the following HTML code:
<table cellpadding="1" cellspacing="0" border="0" width="100%" bgcolor="#6D6D7C">
<tr><td>
<table id="tableid" class="list" border="0" cellpadding="0" cellspacing="0" width="width">
The following parameters are supported:

tableid

A required string parameter specifying the ID for the table.

width

An optional integer parameter specifying the width for the table.

Throws: ECSystemException
public static void endDlistTable()
This method ends the table definition. It is equivalent to the following HTML code:
</table>
</td></tr>
</table>
public static void startDlistRowHeading()
This method begins a heading row definition. It is equivalent to the following HTML code:
<tr>
public static void endDlistRowHeading()
This method ends a heading row definition. It is equivalent to the following HTML code:
</tr>
public static void addDlistColumnHeading(String hvalue, Boolean wrap, int width, String svalue, Boolean sort, String fnc) This method inserts a column into a row. The following parameters are supported:

hvalue

A required string parameter which specifies a heading name for this column. The value should be a key in a resource bundle file.

wrap (opt)

An optional Boolean parameter which determines if the text in this column will wrap.

width (opt)

An optional string parameter which specifies the width of this column, represented by a percentage. If this is not required, set this value to null.

svalue (opt)

An optional string parameter that specifies the value sent back to the databean for sorting purposes. If you do not intend to make the column sortable, set this to null.

sort (opt)

An optional Boolean parameter that determines if this column requires sorting.

fnc (opt)

An optional string parameter that specifies the JavaScript function to be executed when a user clicks this column header.

Throws: ECSystemException
public static void addDlistCheckHeading(Boolean check, String checkfnc) This method adds a Select All or Deselect All check box. The following parameters are supported:

check

A required Boolean parameter which determines whether the Select All check box is included.

checkfnc

An optional string parameter which sets a user defined function. The default value is null.
public static void endDlistRow()
End row definition, equivalent to HTML code:
</TR>
public static void startDlistRow(int row) This method begins a row definition. The following parameters are supported:

row

A required integer parameter which determines the row style. This parameter accepts the following values, 1 (color 1) or 2 (color 2). These should be alternated to improve table readability. These colors are specified in a cascading style sheet specified in the panel's JSP page.

public static void addDlistCheck(String name, String fnc, String value) This method adds a check box column so that list entries are selectable. The following parameters are supported:

name

A required string parameter, which specifies a name for the check box. This name should be unique.

fnc

A required string parameter that specifies a user defined function for this check box. If no function is defined, set this to none.

value

An optional string parameter that specifies a value for the check box. The default value is null.

Throws: ECSystemException
public static void addDlistColumn(String content, String link, String sty) This method adds a column cell. The following parameters are supported:

content

A required string parameter which specifies content for this column cell.

link (opt)

An optional string parameter which specifies a URL link for this column cell. If no link is applicable, set this to none.

sty (opt)

An optional string parameter that specifies a style for this column cell.

Throws: ECSystemException
Related concepts

Dynamic lists

Related tasks

Add a dynamic list

Related reference

Dynamic list JavaScript functions
Dynamic list definition

+
Search Tips | Advanced Search

Java Method	Description
public static void addControlPanel(String xmlfile, int totalpage, int totalitem, Locale loc) Deprecated	Note: This method is deprecated and is listed here for reference only. See the following equivalent JavaScript function: parent.set_t_page_item(totalitem,listsize); Adds the control panel to the scroll control frame. The following parameters are supported: xmlfile A required string parameter which is an XML file that defines the page. totalpage A required integer parameter corresponding to the total number of pages for the list. totalitem A required integer parameter corresponding to the total number of entries in the list. loc A required locale parameter corresponding to the national language in which the page is displayed. Throws: ECSystemException
public static void startDlistTable(String tableid, int width)	This method begins the table definition. It is equivalent to the following HTML code: <table cellpadding="1" cellspacing="0" border="0" width="100%" bgcolor="#6D6D7C"> <tr><td> <table id="tableid" class="list" border="0" cellpadding="0" cellspacing="0" width="width"> The following parameters are supported: tableid A required string parameter specifying the ID for the table. width An optional integer parameter specifying the width for the table. Throws: ECSystemException
public static void endDlistTable()	This method ends the table definition. It is equivalent to the following HTML code: </table> </td></tr> </table>
public static void startDlistRowHeading()	This method begins a heading row definition. It is equivalent to the following HTML code: <tr>
public static void endDlistRowHeading()	This method ends a heading row definition. It is equivalent to the following HTML code: </tr>
public static void addDlistColumnHeading(String hvalue, Boolean wrap, int width, String svalue, Boolean sort, String fnc)	This method inserts a column into a row. The following parameters are supported: hvalue A required string parameter which specifies a heading name for this column. The value should be a key in a resource bundle file. wrap (opt) An optional Boolean parameter which determines if the text in this column will wrap. width (opt) An optional string parameter which specifies the width of this column, represented by a percentage. If this is not required, set this value to null. svalue (opt) An optional string parameter that specifies the value sent back to the databean for sorting purposes. If you do not intend to make the column sortable, set this to null. sort (opt) An optional Boolean parameter that determines if this column requires sorting. fnc (opt) An optional string parameter that specifies the JavaScript function to be executed when a user clicks this column header. Throws: ECSystemException
public static void addDlistCheckHeading(Boolean check, String checkfnc)	This method adds a Select All or Deselect All check box. The following parameters are supported: check A required Boolean parameter which determines whether the Select All check box is included. checkfnc An optional string parameter which sets a user defined function. The default value is null.
public static void endDlistRow()	End row definition, equivalent to HTML code: </TR>
public static void startDlistRow(int row)	This method begins a row definition. The following parameters are supported: row A required integer parameter which determines the row style. This parameter accepts the following values, 1 (color 1) or 2 (color 2). These should be alternated to improve table readability. These colors are specified in a cascading style sheet specified in the panel's JSP page.
public static void addDlistCheck(String name, String fnc, String value)	This method adds a check box column so that list entries are selectable. The following parameters are supported: name A required string parameter, which specifies a name for the check box. This name should be unique. fnc A required string parameter that specifies a user defined function for this check box. If no function is defined, set this to none. value An optional string parameter that specifies a value for the check box. The default value is null. Throws: ECSystemException
public static void addDlistColumn(String content, String link, String sty)	This method adds a column cell. The following parameters are supported: content A required string parameter which specifies content for this column cell. link (opt) An optional string parameter which specifies a URL link for this column cell. If no link is applicable, set this to none. sty (opt) An optional string parameter that specifies a style for this column cell. Throws: ECSystemException