Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * 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;
 

This component is responsible for displaying messages for a specific UIComponent, identified by a clientId or component id relative to the closest ancestor NamingContainer. The component obtains the messages from the javax.faces.context.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;
         }
 
         PropertyKeys() {
         }
 
         public String toString() {
             return ((this. != null) ? this. : super.toString());
         }
 
     }
    // ------------------------------------------------------------ Constructors


    

Create a new UIMessage instance with default property values.

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


    

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 UIComponent.findComponent(java.lang.String) for more information.

    public String getFor() {
        return (StringgetStateHelper().eval(.);
    }


    

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.

Parameters:
newFor The new client id
    public void setFor(String newFor) {
        getStateHelper().put(.newFor);
    }


    

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

    public boolean isShowDetail() {
        return (BooleangetStateHelper().eval(.true);
    }


    

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

Parameters:
showDetail The new flag
    public void setShowDetail(boolean showDetail) {
        getStateHelper().put(.showDetail);
    }


    

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

    public boolean isShowSummary() {
        return (BooleangetStateHelper().eval(.false);
    }


    

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

Parameters:
showSummary The new flag value
    public void setShowSummary(boolean showSummary) {
        getStateHelper().put(.showSummary);
    }


    

Returns:
true if this UIMessage instance should redisplay javax.faces.application.FacesMessages that have already been handled, otherwise returns false. By default this method will always return true if setRedisplay(boolean) has not been called.
Since:
2.0
    public boolean isRedisplay() {
        return (BooleangetStateHelper().eval(.true);
    }


    

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

Parameters:
redisplay flag indicating whether previously handled messages are redisplayed or not
Since:
2.0
    public void setRedisplay(boolean redisplay) {
        getStateHelper().put(.redisplay);
    }
New to GrepCode? Check out our FAQ X