javax.faces.component.UISelectItem Maven / Gradle / Ivy
Go to download
This is the master POM file for Oracle's Implementation of the JSF 2.1 Specification.
/*
* $Id: UISelectItem.java,v 1.39 2006/06/05 21:14:26 rlubke Exp $
*/
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the License). You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the License at
* https://javaserverfaces.dev.java.net/CDDL.html or
* legal/CDDLv1.0.txt.
* See the License for the specific language governing
* permission and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at legal/CDDLv1.0.txt.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* your own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* [Name of File] [ver.__] [Date]
*
* Copyright 2005 Sun Microsystems Inc. All Rights Reserved
*/
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 = false;
private boolean itemDisabledSet = false;
private boolean itemEscaped = true;
private boolean itemEscapedSet = false;
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.itemDisabledSet) {
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 (this.itemDisabled);
}
}
/**
* Set the disabled value for this selection item.
*
* @param itemDisabled The new disabled flag
*/
public void setItemDisabled(boolean itemDisabled) {
this.itemDisabled = itemDisabled;
this.itemDisabledSet = true;
}
/**
* Return the escape setting for the label of this selection item.
*/
public boolean isItemEscaped() {
if (this.itemEscapedSet) {
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 (this.itemEscaped);
}
}
/**
* 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;
this.itemEscapedSet = true;
}
/**
* 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[9];
}
values[0] = super.saveState(context);
values[1] = itemDescription;
values[2] = itemDisabled ? Boolean.TRUE : Boolean.FALSE;
values[3] = itemDisabledSet ? Boolean.TRUE : Boolean.FALSE;
values[4] = itemEscaped ? Boolean.TRUE : Boolean.FALSE;
values[5] = itemEscapedSet ? Boolean.TRUE : Boolean.FALSE;
values[6] = itemLabel;
values[7] = itemValue;
values[8] = 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]).booleanValue();
itemDisabledSet = ((Boolean) values[3]).booleanValue();
itemEscaped = ((Boolean) values[4]).booleanValue();
itemEscapedSet = ((Boolean) values[5]).booleanValue();
itemLabel = (String) values[6];
itemValue = values[7];
value = values[8];
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy