com.icesoft.faces.component.ext.HtmlMessages Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of icefaces-compat Show documentation
${icefaces.product.name} Compat Component Library
There is a newer version: 3.3.0
/*
 * Copyright 2004-2012 ICEsoft Technologies Canada Corp.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the
 * License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an "AS
 * IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language
 * governing permissions and limitations under the License.
 */

package com.icesoft.faces.component.ext;

import com.icesoft.faces.component.CSS_DEFAULT;
import com.icesoft.faces.component.ext.taglib.Util;
import com.icesoft.faces.context.effects.CurrentStyle;
import com.icesoft.faces.context.effects.Effect;
import com.icesoft.faces.context.effects.JavascriptContext;

import javax.faces.context.FacesContext;
import javax.faces.el.ValueBinding;


/**
 * This is an extension of javax.faces.component.html.HtmlMessages, which
 * provides some additional behavior to this component such as:  changes
 * the component's rendered state based on the authentication
 adds
 * effects to the component
 
 */
public class HtmlMessages extends javax.faces.component.html.HtmlMessages {
    public static final String COMPONENT_TYPE =
            "com.icesoft.faces.HtmlMessages";
    public static final String RENDERER_TYPE = "com.icesoft.faces.Messages";
    private static final boolean DEFAULT_VISIBLE = true;
	private static final boolean DEFAULT_ESCAPE = true;
    private String renderedOnUserRole = null;
    private Effect effect;
    private Boolean visible = null;
	private Boolean escape = null;
    private String errorClass = null;
    private String fatalClass = null;
    private String infoClass = null;
    private String warnClass = null;
    private String styleClass = null;
    private CurrentStyle currentStyle;

    public HtmlMessages() {
        super();
        setRendererType(RENDERER_TYPE);
    }

    public void setValueBinding(String s, ValueBinding vb) {
        if (s != null && s.indexOf("effect") != -1) {
            // If this is an effect attribute make sure Ice Extras is included
            JavascriptContext.includeLib(JavascriptContext.ICE_EXTRAS,
                                         getFacesContext());
        }
        super.setValueBinding(s, vb);
    }

    /**
     * Set the value of the effect property.
     */
    public void setEffect(Effect effect) {
        this.effect = effect;
        JavascriptContext
                .includeLib(JavascriptContext.ICE_EXTRAS, getFacesContext());
    }

    /**
     * Return the value of the effect property.
     */
    public Effect getEffect() {
        if (effect != null) {
            return effect;
        }
        ValueBinding vb = getValueBinding("effect");
        return vb != null ? (Effect) vb.getValue(getFacesContext()) : null;
    }

    /**
     * Set the value of the visible property.
     */
    public void setVisible(boolean visible) {
        this.visible = Boolean.valueOf(visible);
    }

    /**
     * Return the value of the visible property.
     */
    public boolean getVisible() {
        if (visible != null) {
            return visible.booleanValue();
        }
        ValueBinding vb = getValueBinding("visible");
        Boolean boolVal =
                vb != null ? (Boolean) vb.getValue(getFacesContext()) : null;
        return boolVal != null ? boolVal.booleanValue() : DEFAULT_VISIBLE;
    }
	
    /**
     * Set the value of the escape property.
     */
    public void setEscape(boolean escape) {
        this.escape = Boolean.valueOf(escape);
    }

    /**
     * Return the value of the escape property.
     */
    public boolean getEscape() {
        if (escape != null) {
            return escape.booleanValue();
        }
        ValueBinding vb = getValueBinding("escape");
        Boolean boolVal =
                vb != null ? (Boolean) vb.getValue(getFacesContext()) : null;
        return boolVal != null ? boolVal.booleanValue() : DEFAULT_ESCAPE;
    }

    /**
     * Set the value of the renderedOnUserRole property.
     */
    public void setRenderedOnUserRole(String renderedOnUserRole) {
        this.renderedOnUserRole = renderedOnUserRole;
    }

    /**
     * Return the value of the renderedOnUserRole property.
     */
    public String getRenderedOnUserRole() {
        if (renderedOnUserRole != null) {
            return renderedOnUserRole;
        }
        ValueBinding vb = getValueBinding("renderedOnUserRole");
        return vb != null ? (String) vb.getValue(getFacesContext()) : null;
    }

    /**
     * Return the value of the rendered property.
     */
    public boolean isRendered() {
        if (!Util.isRenderedOnUserRole(this)) {
            return false;
        }
        return super.isRendered();
    }

    /**
     * Return the value of the currentStyle property.
     */
    public CurrentStyle getCurrentStyle() {
        return currentStyle;
    }

    /**
     * Set the value of the currentStyle property.
     */
    public void setCurrentStyle(CurrentStyle currentStyle) {
        this.currentStyle = currentStyle;
    }

    /**
     * Gets the state of the instance as a Serializable
     * Object.
     */
    public Object saveState(FacesContext context) {
        Object values[] = new Object[13];
        values[0] = super.saveState(context);
        values[1] = renderedOnUserRole;
        values[2] = effect;
        values[3] = currentStyle;
        values[4] = visible;
        values[5] = dir;
        values[6] = lang;
        values[7] = errorClass ;
        values[8] = fatalClass ;
        values[9] = infoClass ;
        values[10] = warnClass ;
        values[11] = styleClass ;        
		values[12] = escape;
        return ((Object) (values));
    }

    /**
     * Perform any processing required to restore the state from the entries
     * in the state Object.
     */
    public void restoreState(FacesContext context, Object state) {
        Object values[] = (Object[]) state;
        super.restoreState(context, values[0]);
        renderedOnUserRole = (String) values[1];
        effect = (Effect) values[2];
        currentStyle = (CurrentStyle) values[3];
        visible = (Boolean) values[4];
        dir = (String)values[5];
        lang = (String)values[6];
        errorClass = (String)values[7];
        fatalClass = (String)values[8];
        infoClass = (String)values[9];
        warnClass = (String)values[10];
        styleClass = (String)values[11];         
		escape = (Boolean) values[12];
    }

    /**
     * Set the value of the styleClass property.
     */
    public void setStyleClass(String styleClass) {
        this.styleClass = styleClass;
    }

    /**
     * Return the value of the styleClass property.
     */
    public String getStyleClass() {
        return Util.getQualifiedStyleClass(this, 
                styleClass,
                CSS_DEFAULT.MESSAGES_STYLE_CLASS,
                "styleClass");  
    }


    /**
     * Set the value of the errorClass property.
     */
    public void setErrorClass(String errorClass) {
        this.errorClass = errorClass;
    }

    /**
     * Return the value of the errorClass property.
     */
    public String getErrorClass() {
        return Util.getQualifiedStyleClass(this, 
                errorClass,
                CSS_DEFAULT.ERROR_STYLE_CLASS,
                "errorClass");  
    }


    /**
     * Set the value of the fataClass property.
     */
    public void setFatalClass(String fatalClass) {
        this.fatalClass = fatalClass;
    }

    /**
     * Return the value of the fataClass property.
     */
    public String getFatalClass() {
        return Util.getQualifiedStyleClass(this, 
                fatalClass,
                CSS_DEFAULT.FATAL_STYLE_CLASS,
                "fatalClass"); 
    }


    /**
     * Set the value of the infoClass property.
     */
    public void setInfoClass(String infoClass) {
        this.infoClass = infoClass;
    }

    /**
     * Return the value of the infoClass property.
     */
    public String getInfoClass() {
        return Util.getQualifiedStyleClass(this, 
                infoClass,
                CSS_DEFAULT.INFO_STYLE_CLASS,
                "infoClass"); 
    }

    /**
     * Set the value of the warnClass property.
     */
    public void setWarnClass(String warnClass) {
        this.warnClass = warnClass;
    }

    /**
     * Return the value of the warnClass property.
     */
    public String getWarnClass() {
        return Util.getQualifiedStyleClass(this, 
                warnClass,
                CSS_DEFAULT.WARN_STYLE_CLASS,
                "warnClass");  
    }
    
      private java.lang.String dir;

  /**
   * Return the value of the dir property.  Contents:

   * Direction indication for text that does not inherit directionality.
   *           Valid values are "LTR" (left-to-right) and "RTL" (right-to-left).
   * 
   */
  public java.lang.String getDir() {
    if (null != this.dir) {
      return this.dir;
    }
    ValueBinding _vb = getValueBinding("dir");
    if (_vb != null) {
      return (java.lang.String) _vb.getValue(getFacesContext());
    } else {
      return null;
    }
  }

  /**
   * Set the value of the dir property.
   */
  public void setDir(java.lang.String dir) {
    this.dir = dir;
  }
  
    private java.lang.String lang;

  /**
   * Return the value of the lang property.  Contents:

   * Code describing the language used in the generated markup
   *           for this component.
   * 
   */
  public java.lang.String getLang() {
    if (null != this.lang) {
      return this.lang;
    }
    ValueBinding _vb = getValueBinding("lang");
    if (_vb != null) {
      return (java.lang.String) _vb.getValue(getFacesContext());
    } else {
      return null;
    }
  }

  /**
   * Set the value of the lang property.
   */
  public void setLang(java.lang.String lang) {
    this.lang = lang;
  }

}