javax.faces.component.UISelectItem Maven / Gradle / Ivy
/*
* $Id: UISelectItem.java,v 1.40.4.1 2007/10/18 16:57:28 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.el.ELException;
import javax.el.ValueExpression;
import javax.faces.FacesException;
import javax.faces.context.FacesContext;
import javax.faces.model.SelectItem;
/**
* UISelectItem is a component that may be nested
* inside a {@link UISelectMany} or {@link UISelectOne} component, and
* causes the addition of a {@link SelectItem} instance to the list of
* available options for the parent component. The contents of the
* {@link SelectItem} can be specified in one of the following ways:
*
* - The
value attribute's value is an instance of
* {@link SelectItem}.
* - The associated {@link javax.el.ValueExpression} points at a model data
* item of type {@link SelectItem}.
* - A new {@link SelectItem} instance is synthesized from the values
* of the
itemDescription, itemDisabled,
* itemLabel, and itemValue attributes.
*
*/
public class UISelectItem extends UIComponentBase {
// ------------------------------------------------------ Manifest Constants
/**
* The standard component type for this component.
*/
public static final String COMPONENT_TYPE = "javax.faces.SelectItem";
/**
* The standard component family for this component.
*/
public static final String COMPONENT_FAMILY = "javax.faces.SelectItem";
// ------------------------------------------------------------ Constructors
/**
* Create a new {@link UISelectItem} instance with default property
* values.
*/
public UISelectItem() {
super();
setRendererType(null);
}
// ------------------------------------------------------ Instance Variables
private String itemDescription = null;
private Boolean itemDisabled;
private Boolean itemEscaped;
private String itemLabel = null;
private Object itemValue = null;
private Object value = null;
// -------------------------------------------------------------- Properties
public String getFamily() {
return (COMPONENT_FAMILY);
}
/**
* Return the description for this selection item.
*/
public String getItemDescription() {
if (this.itemDescription != null) {
return (this.itemDescription);
}
ValueExpression ve = getValueExpression("itemDescription");
if (ve != null) {
try {
return ((String) ve.getValue(getFacesContext().getELContext()));
}
catch (ELException e) {
throw new FacesException(e);
}
} else {
return (null);
}
}
/**
* Set the description for this selection item.
*
* @param itemDescription The new description
*/
public void setItemDescription(String itemDescription) {
this.itemDescription = itemDescription;
}
/**
* Return the disabled setting for this selection item.
*/
public boolean isItemDisabled() {
if (this.itemDisabled != null) {
return (this.itemDisabled);
}
ValueExpression ve = getValueExpression("itemDisabled");
if (ve != null) {
try {
return (Boolean.TRUE.equals(ve.getValue(getFacesContext().getELContext())));
}
catch (ELException e) {
throw new FacesException(e);
}
} else {
return (false);
}
}
/**
* Set the disabled value for this selection item.
*
* @param itemDisabled The new disabled flag
*/
public void setItemDisabled(boolean itemDisabled) {
this.itemDisabled = itemDisabled;
}
/**
* Return the escape setting for the label of this selection item.
*/
public boolean isItemEscaped() {
if (this.itemEscaped != null) {
return (this.itemEscaped);
}
ValueExpression ve = getValueExpression("itemEscaped");
if (ve != null) {
try {
return (Boolean.TRUE.equals(ve.getValue(getFacesContext().getELContext())));
}
catch (ELException e) {
throw new FacesException(e);
}
} else {
return (true);
}
}
/**
* Set the escape value for the label of this selection item.
*
* @param itemEscaped The new disabled flag
*/
public void setItemEscaped(boolean itemEscaped) {
this.itemEscaped = itemEscaped;
}
/**
* Return the localized label for this selection item.
*/
public String getItemLabel() {
if (this.itemLabel != null) {
return (this.itemLabel);
}
ValueExpression ve = getValueExpression("itemLabel");
if (ve != null) {
try {
return ((String) ve.getValue(getFacesContext().getELContext()));
}
catch (ELException e) {
throw new FacesException(e);
}
} else {
return (null);
}
}
/**
* Set the localized label for this selection item.
*
* @param itemLabel The new localized label
*/
public void setItemLabel(String itemLabel) {
this.itemLabel = itemLabel;
}
/**
* Return the server value for this selection item.
*/
public Object getItemValue() {
if (this.itemValue != null) {
return (this.itemValue);
}
ValueExpression ve = getValueExpression("itemValue");
if (ve != null) {
try {
return ve.getValue(getFacesContext().getELContext());
}
catch (ELException e) {
throw new FacesException(e);
}
} else {
return (null);
}
}
/**
* Set the server value for this selection item.
*
* @param itemValue The new server value
*/
public void setItemValue(Object itemValue) {
this.itemValue = itemValue;
}
/**
* Returns the value property of the
* UISelectItem.
*/
public Object getValue() {
if (this.value != null) {
return (this.value);
}
ValueExpression ve = getValueExpression("value");
if (ve != null) {
try {
return (ve.getValue(getFacesContext().getELContext()));
}
catch (ELException e) {
throw new FacesException(e);
}
} else {
return (null);
}
}
/**
* Sets the value property of the
* UISelectItem.
*
* @param value the new value
*/
public void setValue(Object value) {
this.value = value;
}
// ----------------------------------------------------- StateHolder Methods
private Object[] values;
public Object saveState(FacesContext context) {
if (values == null) {
values = new Object[7];
}
values[0] = super.saveState(context);
values[1] = itemDescription;
values[2] = itemDisabled;
values[3] = itemEscaped;
values[4] = itemLabel;
values[5] = itemValue;
values[6] = value;
return (values);
}
public void restoreState(FacesContext context, Object state) {
values = (Object[]) state;
super.restoreState(context, values[0]);
itemDescription = (String) values[1];
itemDisabled = (Boolean) values[2];
itemEscaped = (Boolean) values[3];
itemLabel = (String) values[4];
itemValue = values[5];
value = values[6];
}
}