javax.faces.component.UIMessages Maven / Gradle / Ivy
Show all versions of jsf-api Show documentation
/*
* $Id: UIMessages.java,v 1.18.4.1 2007/10/18 16:57:29 rlubke Exp $
*/
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can obtain
* a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
* or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [year]
* [name of copyright owner]"
*
* Contributor(s):
*
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.faces.component;
import javax.faces.context.FacesContext;
import javax.faces.FacesException;
import javax.el.ELException;
import javax.el.ValueExpression;
/**
* The renderer for this component is responsible for obtaining the
* messages from the {@link FacesContext} and displaying them to the
* user.
*
* This component supports the Messages renderer-type.
*
* By default, the rendererType property must be set to
* "javax.faces.Messages". This value can be changed by
* calling the setRendererType() method.
*
*
*/
public class UIMessages extends UIComponentBase {
// ------------------------------------------------------ Manifest Constants
/**
* The standard component type for this component.
*/
public static final String COMPONENT_TYPE = "javax.faces.Messages";
/**
* The standard component family for this component.
*/
public static final String COMPONENT_FAMILY = "javax.faces.Messages";
// ------------------------------------------------------------ Constructors
/**
* Create a new {@link UIMessages} instance with default property
* values.
*/
public UIMessages() {
super();
setRendererType("javax.faces.Messages");
}
// ------------------------------------------------------ Instance Variables
private Boolean globalOnly;
private Boolean showDetail;
private Boolean showSummary;
// -------------------------------------------------------------- Properties
public String getFamily() {
return (COMPONENT_FAMILY);
}
/**
* Return the flag indicating whether only global messages (that
* is, messages with no associated client identifier) should be
* rendered. Defaults to false.
*/
public boolean isGlobalOnly() {
if (this.globalOnly != null) {
return (this.globalOnly);
}
ValueExpression ve = getValueExpression("globalOnly");
if (ve != null) {
try {
return (Boolean.TRUE.equals(ve.getValue(getFacesContext().getELContext())));
}
catch (ELException e) {
throw new FacesException(e);
}
} else {
return (false);
}
}
/**
* Set the flag indicating whether only global messages (that is,
* messages with no associated client identifier) should be rendered.
*
* @param globalOnly The new flag value
*/
public void setGlobalOnly(boolean globalOnly) {
this.globalOnly = globalOnly;
}
/**
* Return the flag indicating whether the detail
* property of the associated message(s) should be displayed.
* Defaults to false.
*/
public boolean isShowDetail() {
if (this.showDetail != null){
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 (false);
}
}
/**
* 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;
}
/**
* Return the flag indicating whether the summary
* property of the associated message(s) should be displayed.
* Defaults to true.
*/
public boolean isShowSummary() {
if (this.showSummary != null) {
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 (true);
}
}
/**
* 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;
}
// ----------------------------------------------------- StateHolder Methods
private Object[] values;
public Object saveState(FacesContext context) {
if (values == null) {
values = new Object[4];
}
values[0] = super.saveState(context);
values[1] = this.globalOnly;
values[2] = this.showDetail;
values[3] = this.showSummary;
return (values);
}
public void restoreState(FacesContext context, Object state) {
values = (Object[]) state;
super.restoreState(context, values[0]);
globalOnly = (Boolean) values[1];
showDetail = (Boolean) values[2];
showSummary = (Boolean) values[3];
}
}