javax.faces.component.UIMessage Maven / Gradle / Ivy
/*
* $Id: UIMessage.java,v 1.18 2006/06/05 21:14:25 rlubke Exp $
*/
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the License). You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the License at
* https://javaserverfaces.dev.java.net/CDDL.html or
* legal/CDDLv1.0.txt.
* See the License for the specific language governing
* permission and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at legal/CDDLv1.0.txt.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* your own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* [Name of File] [ver.__] [Date]
*
* Copyright 2005 Sun Microsystems Inc. All Rights Reserved
*/
package javax.faces.component;
import javax.faces.context.FacesContext;
import javax.faces.FacesException;
import javax.el.ELException;
import javax.el.ValueExpression;
/**
* This component is responsible for displaying messages for a specific
* {@link UIComponent}, identified by a clientId. The component
* obtains the messages from the {@link FacesContext}.
*
* By default, the rendererType property must be set to
* "javax.faces.Message". This value can be changed by
* calling the setRendererType() method.
*
*/
public class UIMessage extends UIComponentBase {
// ------------------------------------------------------ Manifest Constants
/**
* The standard component type for this component.
*/
public static final String COMPONENT_TYPE = "javax.faces.Message";
/**
* The standard component family for this component.
*/
public static final String COMPONENT_FAMILY = "javax.faces.Message";
// ------------------------------------------------------------ Constructors
/**
* Create a new {@link UIMessage} instance with default property
* values.
*/
public UIMessage() {
super();
setRendererType("javax.faces.Message");
}
// ------------------------------------------------------ Instance Variables
private String forVal = null;
private boolean showDetail = true;
private boolean showDetailSet = false;
private boolean showSummary = false;
private boolean showSummarySet = false;
// -------------------------------------------------------------- Properties
public String getFamily() {
return (COMPONENT_FAMILY);
}
/**
* Return the client identifier of the component for which
* this component represents associated message(s) (if any).
*/
public String getFor() {
if (this.forVal != null) {
return (this.forVal);
}
ValueExpression ve = getValueExpression("for");
if (ve != null) {
try {
return ((String) ve.getValue(getFacesContext().getELContext()));
}
catch (ELException e) {
throw new FacesException(e);
}
} else {
return (null);
}
}
/**
* Set the client identifier of the component for which this
* component represents associated message(s) (if any). This
* property must be set before the message is displayed.
*
* @param newFor The new client id
*/
public void setFor(String newFor) {
forVal = newFor;
}
/**
* Return the flag indicating whether the detail
* property of the associated message(s) should be displayed.
* Defaults to true.
*/
public boolean isShowDetail() {
if (this.showDetailSet){
return (this.showDetail);
}
ValueExpression ve = getValueExpression("showDetail");
if (ve != null) {
try {
return (Boolean.TRUE.equals(ve.getValue(getFacesContext().getELContext())));
}
catch (ELException e) {
throw new FacesException(e);
}
} else {
return (this.showDetail);
}
}
/**
* Set the flag indicating whether the detail property
* of the associated message(s) should be displayed.
*
* @param showDetail The new flag
*/
public void setShowDetail(boolean showDetail) {
this.showDetail = showDetail;
this.showDetailSet = true;
}
/**
* Return the flag indicating whether the summary
* property of the associated message(s) should be displayed.
* Defaults to false.
*/
public boolean isShowSummary() {
if (this.showSummarySet) {
return (this.showSummary);
}
ValueExpression ve = getValueExpression("showSummary");
if (ve != null) {
try {
return (!Boolean.FALSE.equals(ve.getValue(getFacesContext().getELContext())));
}
catch (ELException e) {
throw new FacesException(e);
}
} else {
return (this.showSummary);
}
}
/**
* Set the flag indicating whether the summary property
* of the associated message(s) should be displayed.
*
* @param showSummary The new flag value
*/
public void setShowSummary(boolean showSummary) {
this.showSummary = showSummary;
this.showSummarySet = true;
}
// ----------------------------------------------------- StateHolder Methods
private Object[] values;
public Object saveState(FacesContext context) {
if (values == null) {
values = new Object[6];
}
values[0] = super.saveState(context);
values[1] = this.forVal;
values[2] = this.showDetail ? Boolean.TRUE : Boolean.FALSE;
values[3] = this.showDetailSet ? Boolean.TRUE : Boolean.FALSE;
values[4] = this.showSummary ? Boolean.TRUE : Boolean.FALSE;
values[5] = this.showSummarySet ? Boolean.TRUE : Boolean.FALSE;
return (values);
}
public void restoreState(FacesContext context, Object state) {
values = (Object[]) state;
super.restoreState(context, values[0]);
forVal = (String) values[1];
showDetail = ((Boolean) values[2]).booleanValue();
showDetailSet = ((Boolean) values[3]).booleanValue();
showSummary = ((Boolean) values[4]).booleanValue();
showSummarySet = ((Boolean) values[5]).booleanValue();
}
}