1 /* 2 * Licensed to the Apache Software Foundation (ASF) under one 3 * or more contributor license agreements. See the NOTICE file 4 * distributed with this work for additional information 5 * regarding copyright ownership. The ASF licenses this file 6 * to you under the Apache License, Version 2.0 (the 7 * "License"); you may not use this file except in compliance 8 * with the License. You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, 13 * software distributed under the License is distributed on an 14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 * KIND, either express or implied. See the License for the 16 * specific language governing permissions and limitations 17 * under the License. 18 */ 19 package javax.faces.component; 20 21 import org.apache.myfaces.buildtools.maven2.plugin.builder.annotation.JSFComponent; 22 import org.apache.myfaces.buildtools.maven2.plugin.builder.annotation.JSFProperty; 23 24 /** 25 * 26 * UIMessage is the base component class for components 27 * that display a single message on behalf of a component. 28 */ 29 @JSFComponent 30 (clazz = "javax.faces.component.UIMessage",template=true, 31 defaultRendererType = "javax.faces.Message" 32 ) 33 abstract class _UIMessage extends UIComponentBase 34 { 35 36 static public final String COMPONENT_FAMILY = 37 "javax.faces.Message"; 38 static public final String COMPONENT_TYPE = 39 "javax.faces.Message"; 40 41 /** 42 * The ID of the component whose attached FacesMessage object (if present) 43 * should be diplayed by this component. 44 * <p> 45 * This is a required property on the component. 46 * </p> 47 * 48 * @return the new for value 49 */ 50 @JSFProperty 51 (required = true) 52 public abstract String getFor(); 53 54 /** 55 * Specifies whether the detailed information from the message should be shown. 56 * Default to true. 57 * 58 * @return the new showDetail value 59 */ 60 @JSFProperty 61 (defaultValue = "true") 62 public abstract boolean isShowDetail(); 63 64 /** 65 * Specifies whether the summary information from the message should be shown. 66 * Defaults to false. 67 * 68 * @return the new showSummary value 69 */ 70 @JSFProperty 71 (defaultValue = "false") 72 public abstract boolean isShowSummary(); 73 74 }