com.sun.webui.jsf.component.HiddenField Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2007-2018 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://oss.oracle.com/licenses/CDDL+GPL-1.1
* or 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 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 com.sun.webui.jsf.component;
import com.sun.faces.annotation.Component;
import com.sun.faces.annotation.Property;
import com.sun.webui.jsf.util.ConversionUtilities;
import javax.el.ValueExpression;
import javax.faces.context.FacesContext;
/**
* The HiddenField component is used to create a hidden input field.
*/
@Component(type = "com.sun.webui.jsf.HiddenField", family = "com.sun.webui.jsf.HiddenField",
displayName = "Hidden Field", tagName = "hiddenField",
helpKey = "projrave_ui_elements_palette_wdstk-jsf1.2_hidden_field",
propertiesHelpKey = "projrave_ui_elements_palette_wdstk-jsf1.2_propsheets_hidden_field_props")
public class HiddenField extends WebuiInput {
private final static boolean DEBUG = false;
/** Creates a new instance of HiddenField */
public HiddenField() {
super();
setRendererType("com.sun.webui.jsf.HiddenField");
}
/**
* Return the family for this component.
*/
@Override
public String getFamily() {
return "com.sun.webui.jsf.HiddenField";
}
/**
* Return the value to be rendered as a string when the
* component is readOnly. The default behaviour is to
* invoke getValueAsString(). Override this method in case
* a component needs specialized behaviour.
* @param context FacesContext for the current request
* @return A String value of the component
*/
public String getReadOnlyValueString(FacesContext context) {
return getValueAsString(context);
}
/**
* Return the value to be rendered, as a String (converted
* if necessary), or null if the value is null.
* @param context FacesContext for the current request
* @return A String value of the component
*/
public String getValueAsString(FacesContext context) {
if (DEBUG) {
log("getValueAsString()");
}
// This is done in case the RENDER_RESPONSE is occuring
// prematurely due to some error or an immediate condition
// on a button. submittedValue is set to null when the
// component has been validated.
// If the component has not passed through the PROCESS_VALIDATORS
// phase then submittedValue will be non null if a value
// was submitted for this component.
//
Object submittedValue = getSubmittedValue();
if (submittedValue != null) {
if (DEBUG) {
log("Submitted value is not null " + submittedValue.toString()); //NOI18N
}
return (String) submittedValue;
}
String value = ConversionUtilities.convertValueToString(this, getText());
if (value == null) {
value = new String();
}
if (DEBUG) {
log("Component value is " + value);
}
return value;
}
/**
* Return the converted value of newValue.
* If newValue is null, return null.
* If newValue is "", check the rendered value. If the
* the value that was rendered was null, return null
* else continue to convert.
*/
@Override
protected Object getConvertedValue(FacesContext context,
Object newValue)
throws javax.faces.convert.ConverterException {
if (DEBUG) {
log("getConvertedValue()");
}
Object value = ConversionUtilities.convertRenderedValue(context,
newValue, this);
if (DEBUG) {
log("\tComponent is valid " + String.valueOf(isValid()));
}
if (DEBUG) {
log("\tValue is " + String.valueOf(value));
}
return value;
}
protected void log(String s) {
System.out.println(this.getClass().getName() + "::" + s);
}
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Tag attribute methods
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/**
* Return the ValueExpression stored for the
* specified name (if any), respecting any property aliases.
*
* @param name Name of value binding expression to retrieve
*/
@Override
public ValueExpression getValueExpression(String name) {
if (name.equals("text")) {
return super.getValueExpression("value");
}
return super.getValueExpression(name);
}
/**
* Set the ValueExpression stored for the
* specified name (if any), respecting any property
* aliases.
*
* @param name Name of value binding to set
* @param binding ValueExpression to set, or null to remove
*/
@Override
public void setValueExpression(String name, ValueExpression binding) {
if (name.equals("text")) {
super.setValueExpression("value", binding);
return;
}
super.setValueExpression(name, binding);
}
// Hide required
@Property(name = "required", isHidden = true, isAttribute = false)
@Override
public boolean isRequired() {
return super.isRequired();
}
// Hide value as property
@Property(name = "value", isHidden = true, isAttribute = false)
@Override
public Object getValue() {
return super.getValue();
}
/**
* Flag indicating that the hidden field should not send its value to the
* server.
*/
@Property(name = "disabled", displayName = "Disabled", category = "Behavior")
private boolean disabled = false;
private boolean disabled_set = false;
public boolean isDisabled() {
if (this.disabled_set) {
return this.disabled;
}
ValueExpression _vb = getValueExpression("disabled");
if (_vb != null) {
Object _result = _vb.getValue(getFacesContext().getELContext());
if (_result == null) {
return false;
} else {
return ((Boolean) _result).booleanValue();
}
}
return false;
}
/**
* Flag indicating that the hidden field should not send its value to the
* server.
* @see #isDisabled()
*/
public void setDisabled(boolean disabled) {
this.disabled = disabled;
this.disabled_set = true;
}
/**
* Literal value to be rendered in this hidden field.
* If this property is specified by a value binding
* expression, the corresponding value will be updated
* if validation succeeds.
*/
@Property(name = "text", displayName = "Text", category = "Data", isDefault = true,
editorClassName = "com.sun.rave.propertyeditors.StringPropertyEditor")
public Object getText() {
return getValue();
}
/**
* Literal value to be rendered in this hidden field.
* If this property is specified by a value binding
* expression, the corresponding value will be updated
* if validation succeeds.
* @see #getText()
*/
public void setText(Object text) {
setValue(text);
}
/**
* Restore the state of this component.
*/
@Override
public void restoreState(FacesContext _context, Object _state) {
Object _values[] = (Object[]) _state;
super.restoreState(_context, _values[0]);
this.disabled = ((Boolean) _values[1]).booleanValue();
this.disabled_set = ((Boolean) _values[2]).booleanValue();
}
/**
* Save the state of this component.
*/
@Override
public Object saveState(FacesContext _context) {
Object _values[] = new Object[3];
_values[0] = super.saveState(_context);
_values[1] = this.disabled ? Boolean.TRUE : Boolean.FALSE;
_values[2] = this.disabled_set ? Boolean.TRUE : Boolean.FALSE;
return _values;
}
}