This topic describes the inputs for the Paging Assistant builder.
- General Inputs
- Source Data Filter
- Refresh Location
Table 1. General Inputs
|Name||Enter a name for this builder call. The WebSphere® Portlet Factory Designer displays this name in the builder call list.|
|Source Data Type||Enable the radio button that represents the type of data source to be used. |
Specify the name of a valid JNDI DataSource.Service Call
Specify the name of the service call that returns the data to display.Variable
Specify the name of the variable that contains the data to display.Reference
Use the reference chooser to specify a method or Java expression that returns the data to display.Custom
Specify the name of an LJO whose Java class implements the com.bowstreet.builders.webapp.methods.DataRetriever interface. Use the Custom option when you want to perform your own data retrieval.
|Source Data||Use the select box to choose one of the available options. The select box contains all the available options of the type you specify for the Source Data Type input. For example, if the Source Data Type input is set to Variable, the select options only include variables of the XML Data type.|
|Page Size||Specify the number of records to fetch per page. |
Note: If you are using the Paging Assistant in conjunction with a Dynamic Table builder call, be sure that the Paging Assistant Page Size input value and the Dynamic Table Row Count input value are the same. Otherwise, the Paging Buttons or Paging Links do not correctly indicate the row numbers being displayed.
|Check for New Data||Enable to force a check for changes in the data prior to each data re-fetch from the data variable.|
If the data has changed, the data variable is refreshed with new data.
|Preserve Location||Enable to maintain page context when data changes. When enabled, builder retains the current page setting rather than reset the page to 0.|
Source Data Filter
Use the inputs in this group to repeat over elements that have no container element.
If you use both a Paging Assistant builder and a Repeated Region builder in the same model, and need to set either of the inputs in this group, set them in the Paging Assistant builder and not in the Repeated Region builder.
Use these inputs only on data that is locally paged. If you use alternate paging tools (for example, SQL), these inputs are ignored and generate warning messages.
Table 2. Source Data Filter inputs
|(Optional) Skip this many elements||Enter the number of items to be omitted (from the beginning of the list) in the repeated region. |
Note: Item numbering starts with zero.
|Use elements named||Specify the element names corresponding to the values to be viewed. The builder filters out the remaining elements.|
For example, assume you have XML in a variable that contains the following types of elements.
To display only the values assigned to the City element, enter City.
Table 3. Refresh Location input
|Refresh Location||Specify the area on the page that this builder call updates when the current page changes. Associated builders use this information to perform partial page refresh or to transition animations. If this input is not specified, the related Paging Buttons or Paging Links builder cannot do partial page refresh. |
Table 4. Advanced inputs
|Auto-initialize data||If true, the data source will be asked to fetch the initial data; if false, the data variable is assumed to have been already populated.|
|Variable Schema||Specify a data type or schema path to the schema type to be used for creating the Data variable.|
Note: This input is only necessary when the Data Source specified is an LJO that implements the DataRetriever.
Parent topic: Paging Assistant builder: wpf7