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 * This tag associates a single SelectItem with the nearest 26 * parent UIComponent. The item represents a single option 27 * for a component such as an h:selectBooleanCheckbox or h:selectOneMenu. 28 * See also component selectItems. 29 * <p> 30 * Unless otherwise specified, all attributes accept static values 31 * or EL expressions. 32 * </p> 33 * <p> 34 * UISelectItem should be nestetd inside a UISelectMany or UISelectOne component, 35 * and results in the addition of a SelectItem instance to the list of available options 36 * for the parent component 37 * </p> 38 */ 39 @JSFComponent 40 (clazz = "javax.faces.component.UISelectItem",template=true, 41 name = "f:selectItem", 42 tagClass = "org.apache.myfaces.taglib.core.SelectItemTag", 43 bodyContent = "empty") 44 abstract class _UISelectItem extends UIComponentBase 45 { 46 47 static public final String COMPONENT_FAMILY = 48 "javax.faces.SelectItem"; 49 static public final String COMPONENT_TYPE = 50 "javax.faces.SelectItem"; 51 52 /** 53 * Disable this property; although this class extends a base-class that 54 * defines a read/write rendered property, this particular subclass 55 * does not support setting it. Yes, this is broken OO design: direct 56 * all complaints to the JSF spec group. 57 */ 58 @JSFProperty(tagExcluded=true) 59 public void setRendered(boolean state) { 60 super.setRendered(state); 61 //call parent method due TCK problems 62 //throw new UnsupportedOperationException(); 63 } 64 65 /** 66 * The initial value of this component. 67 * 68 * @return the new value value 69 */ 70 @JSFProperty 71 public abstract Object getValue(); 72 73 /** 74 * Determine whether this item can be chosen by the user. 75 * When true, this item cannot be chosen by the user. If this method is 76 * ever called, then any EL-binding for the disabled property will be ignored. 77 * 78 * @return the new itemDisabled value 79 */ 80 @JSFProperty(defaultValue="false") 81 public abstract boolean isItemDisabled(); 82 83 /** 84 * The escape setting for the label of this selection item. 85 * 86 * @return the new itemEscaped value 87 */ 88 @JSFProperty(defaultValue="false", jspName="escape") 89 public abstract boolean isItemEscaped(); 90 91 /** 92 * For use in development tools. 93 * 94 * @return the new itemDescription value 95 */ 96 @JSFProperty 97 public abstract String getItemDescription(); 98 99 /** 100 * The string which will be presented to the user for this option. 101 * 102 * @return the new itemLabel value 103 */ 104 @JSFProperty 105 public abstract String getItemLabel(); 106 107 /** 108 * The value for this Item. 109 * 110 * @return the new itemValue value 111 */ 112 @JSFProperty 113 public abstract Object getItemValue(); 114 115 }