Skip to main content

Rows per page selection: Part 1

I was asked to create a control that would allow users to select the number of rows per page in a view/repeat control (the application uses both). It seemed simple at first, but I ran into a few issues that I thought I'd share the solutions to.

First, lets start at the beginning. I went through the relevant design elements and set row="#{viewScope.tableRows}", and I created an xp:comboBox with value="#{viewScope.tableRows}" and added items for 20, 30, 50, and 100, and I assigned it an onChange event handler that did a partial execution and partial refresh of a div containing the combo box, pager and the table. Then I started fixing all the problems.

Problem 1: The combobox value was a string, but the rows parameter requires an integer. This was causing IllegalArgumentException / java.lang.String incompatible with java.lang.Integer.

I added a NumberConverter, but this only slightly changed the exception message to java.lang.Long incompatible with java.lang.Integer. So I created a very simple custom converter:
public class IntegerConverter implements Converter {

public Object getAsObject(final FacesContext facesContext, final UIComponent component, final String valueString) {
Integer i = null;
try {
i = Integer.parseInt(valueString);
} catch (Exception e) {
// error handling
}
return i;
}

public Object getAsString(final FacesContext facesContext, final UIComponent component, final Object valueObj) {
String s = null;
try {
i = String.valueOf(valueObj);
} catch (Exception e) {
// error handling
}
return s;
}
We then add this converter to faces-config.xml
<converter>
<converter-id>org.common.xsp.IntegerConverter</converter-id>
<converter-class>org.package.name.IntetgerConverter<converter-class>
</converter>
And finally we add the converter to the comboBox
<xp:this.converter>
<xp:converter converterId="org.common.xsp.IntegerConverter" />
</xp:this.converter>
Success!! Although I did get some warnings about maybe I should calculate the selectItem values, which I ignored until...

Problem 2: When the page refreshed, the combobox value always reverted back to the default

It turns out that the Integer value stored in the viewScope doesn't get run through the converter back to a string before being compared to options. Solution in Part 2. (Hint: It's my old friend, the GetMap.)

Comments

Popular posts from this blog

Pass data between XPages and existing LS scripts

I'm working on modernizing a fairly hefty application with a lot of existing script libraries which we want to leverage within the XPages environment. Here is a technique that works very well. First, create an in-memory document in SSJS. We can set any input values needed for the back end. Then we pass that document to a LS Agent which can work it's magic using the values set in SSJS and use the same document to return values back to the XPage. Here is how it works in detail:

Quick tip: Convert a number to String in EL

I just had a need to do this and a Google search didn't immediately turn up a solution. So I thought for a couple of minutes and came up with this: value="0#{numberVar}" This takes advantage of the way Java auto-converts objects to strings when doing a concatenation. So if your number is 13, Java EL turns this into new String("0"+13), which becomes "013". You can then strip off the leading zero or just parse the string back into a number.

Project in Review - Part 3: What didn't work

Of course, not everything was an unmitigated success. I tried many things that didn't work out. Much of which I've removed and forgotten about, but a few things remain - either scarred into my psyche or woven too deeply to fix. What didn't work Storing my entire configuration in application.properties Using properties files is great. It let me get configuration out of a profile document and into something much easier to edit - particularly configuration that users will never see or maintain (and thus there is no need for an interface for). But I took it too far. The paths to the other databases are there, and that's good. But view aliases are also there, and that was a mistake. I already have a ViewDefinition enum that describes each view and all the information I need to know about it. I could have set view names there, but instead I'm reading them from the application config. I can change where a view is pointing without having to go into my code. Except of co