Remove Table Tag for ListBoxes in Read Mode for all instances in one go

Language

Java

Tags

Author

Martin Rolph

Submitted on

July 22, 2013 at 4:31 AM

Rating

Downloads

Notes

By default the read mode display of a ListBox value will be surrounded by new Table element, like so;

Test

This can cause undesired results with with your css.

To automatically output read only values as they are, without the parent table, for all ListBoxs in your application you can use the following Custom Renderer and Theme settings.

1) Create a Java Class for a new Renderer, overriding the existing ListBox one...

2) Include a reference to this renderer in your faces-config, linking it to the SelectOne control family

3) Add a computed property to your theme to apply this automatically to all ListBoxes

NB: All the documentation I could find suggested that the control name above should be ListBox but that didn’t work for me. I took a guess at ComboBox and that works.

Here's my blog article about other things you can do with Renders...
http://www.ovalbusinesssolutions.co.uk/blogs/xpages-customising-renderers/

1)
package com.uk.oval;

import java.io.IOException;
import java.io.Writer;
import javax.faces.component.UIComponent;
import com.ibm.xsp.component.xp.XspSelectOneMenu;
import javax.faces.context.FacesContext;
import com.ibm.xsp.renderkit.html_basic.MenuRenderer;

public class SelectOneRenderer extends MenuRenderer {

	public void encodeEnd(FacesContext context, UIComponent component)
			throws IOException {
		Writer writer = context.getResponseWriter();
		XspSelectOneMenu obj = (XspSelectOneMenu) component;
		//if in read mode just print out the value
		if (obj.isReadonly()) {
			writer.write(obj.getValue().toString());
		} else {
			//if in edit mode then call the parent method to output as normal
			super.encodeEnd(context, component);
		}
	}
}


2)
 <render-kit>
    <renderer>
      <component-family>javax.faces.SelectOne</component-family>
      <renderer-type>com.uk.oval.type.SelectOneRenderer</renderer-type>
      <renderer-class>com.uk.oval.SelectOneRenderer</renderer-class>
    </renderer>
    </render-kit>

3)
<control>
		<name>ComboBox</name>
		<property>
			<name>rendererType</name>
			<value>com.uk.oval.type.SelectOneRenderer</value>
		</property>
	</control>

All code submitted to OpenNTF XSnippets, whether submitted as a "Snippet" or in the body of a Comment, is provided under the Apache License Version 2.0. See Terms of Use for full details.

1 comment(s)Login first to comment...

Oliver Busse

(at 12:35 on 27.08.2013)

This is awesome - BUT: for me this results in a disabled select control instead of a plain text value in read mode. Environment: Domino 9, Web client as well as XPiNC. Any hints to achieve a plain text display here?