Portlet Factory, Version 6.1.2

 

List builder inputs

This topic describes the inputs for the List builder.

 

General inputs

Table 1. General inputs
Input Name Description
Name Name for this builder call. The WebSphere Portlet Factory Designer displays this name in the builder call list.
Page Location Page or pages on which this builder call acts.

Alternatively, you can type in the page location syntax directly.

Orientation Choose between positioning the two list boxes horizontally (side by side) or vertically (one above the other).
Source List Title Enter a title for the source list or an indirect reference to the title. For example, ${Variables/SourceTitle}

where SourceTitle is the name of the variable of type String that stores the title of the source list.

Source List Options Specify data returned from a function, method, service call, or variable. The List builder also accepts a reference to an object that implements java.util.Collection or an iterator for a Java collection. You can also enter a comma-delimited list.

Here are some examples:

For a database query

${Variables/ResultSetXml/RowSet}

For a service call

${Variables/MyServiceCall_reply/Order/Items}

For a Variable containing XML

${Variables/Products}

For a comma-delimited list

ListItem1,ListItem2,ListItem3

For a collection

${Java/webAppAccess.getRequestInputs().getInputValues("myInput")}

In each of these cases (except for the comma-delimited list and collection), the last item in the path should be the XML tag that contains the elements to display as options in the List box.

Note: You do not have to specify these paths manually; you can use the reference chooser located to the left of the field.

 

XML Datasource Elements for Source List

Table 2. XML Datasource Elements for Source List inputs
Input Name Description
Source Value Element If you entered an indirect reference in the Source List Option input to a source list defined in XML hierarchy, specify which element is used for the values. If you did not enter an indirect reference in the Source List Option input, any value entered in the Source Value Element input is ignored.

Do one of the following:

  • Enter a name for the tag.

  • Enter an indirect references for the tag. The value would be stored in a variable of type String.
Source Label Element If you entered an indirect reference in the Source List Option input to a source list defined in XML hierarchy, specify which element is used for the label. Values assigned to this element appear in the source list. If you did not enter an indirect reference in the Source List Option input, any value entered here is ignored.

Do one of the following:

  • Enter a name for the source label element.

  • Enter an indirect references for the source label element. The value would be stored in a variable of type String.
Target List Title Type a title for the target list or an indirect reference to the title. For example, ${Variables/TargetTitle}

where TargetTitle is the name of the variable of type String that stores the title of the target list.

Target List Options To pre-populate the target list with options, specify data returned from a function, method, service call, or variable. This data will be in XML. You can also specify a comma-delimited list.

After the user has made initial selections, the target list contains this input when it is subsequently displayed.

 

XML Datasource Elements for Target List

Table 3. XML Datasource Elements for Target List inputs
Input Name Description
Target Value Element If you entered an indirect reference in the Target List Option input to a target list defined in XML hierarchy, specify which element is used for the values.

Do one of the following:

  • Enter a name for the tag.

  • Enter an indirect references for the tag. The value would be stored in a variable of type String.
Target Label Element If you entered an indirect reference in the Target List Option input to a target list defined in XML hierarchy, specify which element is used for the label. Values assigned to this element appear in the source list. If you did not enter an indirect reference in the Target List Options input, any value entered here is ignored.

Do one of the following:

  • Enter a name for the target label element.

  • Enter an indirect references for the target label element. The value would be stored in a variable of type String.

 

User Interface Overrides

Table 4. User Interface Overrides inputs
Input Name Description
Base Page URL Use this input to substitute custom HTML for the basic structure of the list.

The Base Page URL input indicates an HTML file that the builder imports at regeneration time and inserts at the specified page location to provide the structure and layout of the user interface (UI) generated by the builder.

This HTML is modified by the List builder after being inserted into the target page to hook the UI elements to their behavior (for example, filling the lists with data, creating onclick event handlers on the Add and Remove buttons to do the adding and removing, and so on.)

By default, if no value is given for this input, the builder uses the HTML in either /factory/pages/list_builder_horizontal.html or /factory/pages/list_builder_vertical.html, depending on the selected orientation.

"Add" Button Text Actual, or indirect reference to, text to be used for this button.
"Remove" Button Text Actual, or indirect reference to, text to be used for this button.
"Add All" Button Text Actual, or indirect reference to, text to be used for this button.
"Remove All Button Text Actual, or indirect reference to, text to be used for this button.

Parent topic: List builder

Library | Support |