All Downloads are FREE. Search and download functionalities are using the official Maven repository.

javax.faces.component.UIMessage Maven / Gradle / Ivy

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2010 Oracle and/or its affiliates. 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_1_1.html
 * or packager/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 packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [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;


/**
 * 

This component is * responsible for displaying messages for a specific {@link * UIComponent}, identified by a clientId or component id relative to the * closest ancestor NamingContainer. 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"; enum PropertyKeys { forValue("for"), showDetail, showSummary, redisplay; String toString; PropertyKeys(String toString) { this.toString = toString; } PropertyKeys() { } public String toString() { return ((this.toString != null) ? this.toString : super.toString()); } } // ------------------------------------------------------------ Constructors /** *

Create a new {@link UIMessage} instance with default property * values.

*/ public UIMessage() { super(); setRendererType("javax.faces.Message"); } // -------------------------------------------------------------- Properties public String getFamily() { return (COMPONENT_FAMILY); } /** *

Return the Identifier * of the component for which to render error messages. If this * component is within the same NamingContainer as the target * component, this must be the component identifier. Otherwise, it * must be an absolute component identifier (starting with ":"). See * the {@link UIComponent#findComponent} for more * information.

*/ public String getFor() { return (String) getStateHelper().eval(PropertyKeys.forValue); } /** *

Set the * 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) { getStateHelper().put(PropertyKeys.forValue, newFor); } /** *

Return the flag indicating whether the detail * property of the associated message(s) should be displayed. * Defaults to true.

*/ public boolean isShowDetail() { return (Boolean) getStateHelper().eval(PropertyKeys.showDetail, true); } /** *

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) { getStateHelper().put(PropertyKeys.showDetail, showDetail); } /** *

Return the flag indicating whether the summary * property of the associated message(s) should be displayed. * Defaults to false.

*/ public boolean isShowSummary() { return (Boolean) getStateHelper().eval(PropertyKeys.showSummary, false); } /** *

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) { getStateHelper().put(PropertyKeys.showSummary, showSummary); } /** * @return true if this UIMessage instance should * redisplay {@link javax.faces.application.FacesMessage}s that have already been handled, * otherwise returns false. By default this method will * always return true if {@link #setRedisplay(boolean)} has * not been called. * * @since 2.0 */ public boolean isRedisplay() { return (Boolean) getStateHelper().eval(PropertyKeys.redisplay, true); } /** *

Set the flag indicating whether the detail property * of the associated message(s) should be displayed.

* * @param redisplay flag indicating whether previously handled messages * are redisplayed or not * * @since 2.0 */ public void setRedisplay(boolean redisplay) { getStateHelper().put(PropertyKeys.redisplay, redisplay); } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy