Deprecated: Assigning the return value of new by reference is deprecated in /nfs/c01/h14/mnt/37629/domains/ on line 36

Deprecated: Assigning the return value of new by reference is deprecated in /nfs/c01/h14/mnt/37629/domains/ on line 21

Deprecated: Assigning the return value of new by reference is deprecated in /nfs/c01/h14/mnt/37629/domains/ on line 540
Evolutionary Dawn » Custom JSF Component 1.2

Evolutionary Dawn

June 11, 2009

Custom JSF Component 1.2

Filed under: Uncategorized — admin @ 12:25 pm

Since I had a hard time finding a complete solution anywhere online I decided that I would post a simple how-to for a JSF Custom component.

The problem that this component seeks to address is that the <f:verbatim> tag does not work properly in a <ui:repeat> tag.

This presented a issue to me because I have RAW HTML stored in my data model to be used in my simple blog application.

1. The most confusing thing about JSF Custom components.  YOU NEED 3 SEPERATE CLASSES TO IMPLEMENT A CUSTOM COMPONENT.

Alot of other tutorials will teach you there is a method in which you can use only two classes to accomplish the task, although this is true the most straight forward approach is to use 3 classes to implement your component.

The are as follows:

  1.  The component class (For this tutorial: HTMLVerbatimComponent) This class is technically where the “DATA” resisdes
  2. The tag class (For this tutorial: HTMLVerbatimTag) This class is the ADAPTER piece between the “JSF Page” and the DATA Model “Your component”
  3. The renderer class (For this tutorial: HTMLVerbatimRenderer) This class is response for the actual rendering of the HTML or OUTPUT.

The component class:

package com.mdb.web.jsf.component;
import javax.faces.component.UIComponentBase;
import javax.faces.context.FacesContext;
import javax.el.ValueExpression;
public class HTMLVerbatimComponent extends UIComponentBase {
    public HTMLVerbatimComponent() { }
    //Properties you want exposed as tag values must be exposed using getters/setters
    private String value;
    public String getValue() {
        if(value != null)
            return value;
        //If the value has not already been set interpret the Expression language and get resulting object
        Object value = this.getValueExpressionValue("value");
        return value != null ? (String)value : null;
    public void setValue(String value) { this.value = value;}
    //Honestly I am not sure what this method does besides link the component to the config files
    public String getFamily() {
        return "com.mdb.web.jsf.component.HTMLVerbatim";
    //Method allows component state to be stored
    public Object saveState(FacesContext context) {
        return new Object[] { super.saveState(context), value};
    //Method allows component state to be restored
    public void restoreState(FacesContext context, Object object) {
        Object state[] = (Object[]) object;
        super.restoreState(context, state[0]);
        value = (String)state[1];
    //Helper method to simplify getters/setters
    //This helps the JSF Component use Expression Language
    private Object getValueExpressionValue(String name) {
        ValueExpression ve = super.getValueExpression(name);
        return ve.getValue(FacesContext.getCurrentInstance().getELContext());

The tag class:

package com.mdb.web.jsf.component;
import javax.faces.webapp.UIComponentELTag;
import javax.faces.component.UIComponent;
import javax.el.ValueExpression;
public class HTMLVerbatimTag extends UIComponentELTag {
    //Temporary holder property hence if I put
    //&lt;tag:htmlVerbatim value="#{SomeBackingBean.htmlText}"/&gt;
    //information is stored in this object until the data is pushed into the component in setProperties method
    private ValueExpression value = null;
    public HTMLVerbatimTag() {}
    public ValueExpression getValue() { return this.value;}
    public void setValue(ValueExpression value) { this.value = value;}
    //This is where the action happens
    //Data is taken from the tag on the JSF Page and placed into the Component
    protected void setProperties(UIComponent component) {
        HTMLVerbatimComponent verbatimComponent = (HTMLVerbatimComponent)component;
        if(value != null) {
            verbatimComponent.setValueExpression("value", value);
    //Method links this tag object to the component in config files
    public String getComponentType() { return "com.mdb.web.jsf.component.HTMLVerbatim"; }
    //Method links this tag object to the renderer in config files
    public String getRendererType() { return "com.mdb.web.jsf.component.HTMLVerbatim";}

The renderer class:

package com.mdb.web.jsf.component;import javax.faces.render.Renderer;
import javax.faces.component.UIComponent;
import javax.faces.context.FacesContext;
import javax.faces.context.ResponseWriter;
public class HTMLVerbatimRenderer extends Renderer {public HTMLVerbatimRenderer() {}
    //Render your HTML HERE
    public void encodeBegin(FacesContext context, UIComponent component) throws IOException {
        HTMLVerbatimComponent verbatimComponent = (HTMLVerbatimComponent)component;
        ResponseWriter writer = context.getResponseWriter();

Now you must make some changes to your configuration files and I make the big assumption you are using Facelets.

Create a file in your WEB-INF directory called: custom.taglib.xml

Add the following content (Edit accordingly for your own component and domain):

  "-//Sun Microsystems, Inc.//DTD Facelet Taglib 1.0//EN"

Edit your faces-config.xml and add the following content(Edit accordingly for your own component and domain):

<faces-config version="1.2">

Edit your web.xml and add the following content:


Now you should be able to use your new component/tag simply by adding a namespace to your JSF Page as such:


then using the tag as such:

<custom:htmlverbatim value="#{SomeBackingBean.htmlText}">

No Comments »

No comments yet.

RSS feed for comments on this post. TrackBack URL

Leave a comment

You must be logged in to post a comment.

Powered by WordPress

  • animacje na telefon download za free
  • anti mosquito free download nokia 5800
  • audio boost sgs 2 download
  • aurelio dicionario portugues download gratis
  • blacks ops soundtrack download
  • brother mfc 9850 driver download
  • astral projection burning up download
  • adobe reader xp pro download
  • bradshaw on the family download
  • a nausea livro download
  • anahi de las misiones download
  • blue best in me download free mp3
  • 4shared download for kindle fire
  • ar rahman hits download rar
  • b.a.p power mv 1080p download
  • canon mp830 firmware download
  • adobe ps 6 beta download
  • bauch strings mp3 download
  • cisco quickvpn client download windows 7
  • canon mp610 software download windows 7
  • cisco nac agent download windows
  • blessed hellride mp3 download
  • brooklyn tabernacle choir download free
  • cisa exam prep download
  • asereje song mp3 download
  • chasing the sun download video
  • baseball superstars 2012 download
  • action movie fx 1.1 ipa download
  • asus k8v mx manual download
  • aperte o play 2 download gratis
  • baseband lg optimus 2x download
  • broadband speed test 1 download
  • cd sergio lopes 2011 download
  • alba dei morti dementi download
  • brothers karamazov movie download free
  • anatomie de l'enfer movie download
  • asus gamerosd download win 7
  • anthrax spreading the disease download blogspot
  • 24 bit download music
  • 3 movie songs download sensongs
  • close to heaven rls download mp3
  • beyond ynth hd download apk
  • besplatan download e knjige
  • alenka v AAA?i divA? download cz dabing
  • alice maciel download discografia
  • black thought 2 download
  • adobe download manager cos A?
  • centigradz nil sanda madala mp3 download
  • clube da insA?nia livro download
  • amma thale mp3 download
  • bracia nad przepaAciA download djoles
  • alessio nero argento album download
  • allods online download not working
  • big smo song download
  • andala rakshasi 320kbps download
  • beatport sync download for windows
  • 3d filme download bei usenext
  • ale lewa lewa mp3 download
  • angel in disguise download corrinne may
  • can no longer download youtube videos safari
  • bhajan mp3 download
  • band baaja barat download film
  • canon mx870 driver download for mac
  • clannad download game pc
  • chilman uthegi nahin mp3 download
  • asa sunt eu mp3 download
  • borknagar for the elements download
  • biggie smalls respect download
  • battle at kruger video download free
  • brindavanam songs download southmp3
  • augusto canario e amigos download 2010
  • aleksandra radovic cuvam te download free
  • cd snj para download
  • canon mp640 manual download
  • 6.60 me 1.6 lite download
  • christina grimmie titanium download free
  • bully download jogo pc
  • beastie boys live download