com.sun.webui.jsf.component.Form 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.data.provider.RowKey;
import com.sun.faces.annotation.Component;
import com.sun.faces.annotation.Property;
import com.sun.webui.jsf.util.MessageUtil;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import java.util.StringTokenizer;
import javax.el.ValueExpression;
import javax.faces.component.EditableValueHolder;
import javax.faces.component.NamingContainer;
import javax.faces.component.UIComponent;
import javax.faces.component.UIData;
import javax.faces.component.UIForm;
import javax.faces.context.FacesContext;
import javax.faces.event.FacesEvent;
import javax.faces.event.ActionEvent;
/**
* The Form component is used to create a form element.
*/
@Component(type = "com.sun.webui.jsf.Form", family = "com.sun.webui.jsf.Form",
displayName = "Form", tagName = "form",
helpKey = "projrave_ui_elements_palette_wdstk-jsf1.2_form",
propertiesHelpKey = "projrave_ui_elements_palette_wdstk-jsf1.2_propsheets_form_props")
public class Form extends UIForm {
private VirtualFormDescriptor submittedVirtualForm; //the virtual form that was submitted
private static final String VF_DELIM_1 = ","; //NOI18N
private static final String VF_DELIM_2 = "|"; //NOI18N
private static final String ID_SEP = String.valueOf(NamingContainer.SEPARATOR_CHAR);
public static final char ID_WILD_CHAR = '*';
private static final String ID_WILD = String.valueOf(ID_WILD_CHAR);
private transient Map erasedMap = new HashMap(); //has an EditableValueHolder as the key, and an Object[] value pair or a TableValues as the value
private transient Set nonDefaultRetainStatusEvhs = new HashSet(); //contains EditableValueHolders with a retain status different from the default
private static final boolean DEFAULT_RETAIN_STATUS = true; //default for whether non-participating submitted values are retained
/**
* Default constructor.
*/
public Form() {
super();
setRendererType("com.sun.webui.jsf.Form");
}
/**
* Return the family for this component.
*/
@Override
public String getFamily() {
return "com.sun.webui.jsf.Form";
}
/**
* Override UIForm.processDecodes(FacesContext) to ensure
* correct virtual form processing.
*
* @param context FacesContext for the current request
*
* @exception NullPointerException Thrown when context is null
*/
@Override
public void processDecodes(FacesContext context) {
if (context == null) {
throw new NullPointerException();
}
submittedVirtualForm = null;
erasedMap.clear();
//clearing out nonDefaultRetainStatusEvhs occurs in restoreNonParticipatingSubmittedValues
//(which is called during renderering)
//so that application code can muck with the retain statuses in preprocess
// Process this component itself
decode(context); //may set submittedVirtualForm
// if we're not the submitted form, don't process children.
if (!isSubmitted()) {
return;
}
// Process all facets and children of this component
Iterator kids = getFacetsAndChildren();
while (kids.hasNext()) {
UIComponent kid = (UIComponent) kids.next();
kid.processDecodes(context);
}
if (submittedVirtualForm != null) {
//if the children of the Form are known to participate in submittedVirtualForm,
//then don't bother erasing
if (!childrenAreKnownToParticipate(this, submittedVirtualForm)) {
eraseVirtualFormNonParticipants(this, null, null);
}
}
}
@Override
public void queueEvent(FacesEvent event) {
FacesEvent relevantEvent = event;
if (event instanceof WrapperEvent) {
WrapperEvent wrapperEvent = (WrapperEvent) event;
relevantEvent = wrapperEvent.getFacesEvent();
}
if (relevantEvent instanceof ActionEvent && submittedVirtualForm == null) {
UIComponent sourceComp = relevantEvent.getComponent();
VirtualFormDescriptor virtualFormComponentSubmits = getVirtualFormComponentSubmits(sourceComp);
if (virtualFormComponentSubmits != null) { //if the source component does in fact submit a virtual form
submittedVirtualForm = virtualFormComponentSubmits; //then set that virtual form as having been submitted
}
}
super.queueEvent(event);
}
public void setSubmittedVirtualForm(VirtualFormDescriptor vfd) {
if (submittedVirtualForm == null && vfd != null) {
submittedVirtualForm = vfd;
}
}
public void setVirtualForms(VirtualFormDescriptor[] vfds) {
setVirtualForms(vfds, true);
}
private void setVirtualForms(VirtualFormDescriptor[] vfds, boolean sync) {
_setVirtualForms(vfds);
if (sync) {
String configStr = generateVirtualFormsConfig(vfds);
setVirtualFormsConfig(configStr, false);
}
}
public void setVirtualFormsConfig(String configStr) {
setVirtualFormsConfig(configStr, true);
}
private void setVirtualFormsConfig(String configStr, boolean sync) {
_setVirtualFormsConfig(configStr);
if (sync) {
VirtualFormDescriptor[] vfds = generateVirtualForms(configStr);
setVirtualForms(vfds, false);
}
}
private VirtualFormDescriptor getVirtualFormComponentSubmitsByFullyQualifiedId(String fqId) {
if (!isValidFullyQualifiedId(fqId)) {
return null;
}
//first try regular configuration
VirtualFormDescriptor vfd = getVirtualFormComponentSubmitsByFullyQualifiedId(fqId, getVirtualForms());
if (vfd != null) {
return vfd;
}
//try internal configuration
vfd = getVirtualFormComponentSubmitsByFullyQualifiedId(fqId, getInternalVirtualForms());
return vfd;
}
private VirtualFormDescriptor getVirtualFormComponentSubmitsByFullyQualifiedId(String fqId, VirtualFormDescriptor[] vfds) {
if (vfds == null || vfds.length < 1) {
return null;
}
//look for matches of fqId against all of vfds's submitters--without any trailing wilds.
//if no match found, try the parent fqId.
//this technique ensures that the most appropriate submitter is found first and its vf is returned
String currentFqId = fqId;
while (currentFqId.length() > 0) {
for (int v = 0; v < vfds.length; v++) {
VirtualFormDescriptor vfd = vfds[v];
String[] submitters = vfd.getSubmittingIds();
for (int s = 0; submitters != null && s < submitters.length; s++) {
String submitter = submitters[s];
if (submitter == null) {
continue;
}
String wildSuffix = ID_SEP + ID_WILD;
if (submitter.endsWith(wildSuffix)) {
submitter = submitter.substring(0, submitter.length() - wildSuffix.length());
}
if (submitter.length() < 1) {
continue;
}
boolean fqIdMatches = fullyQualifiedIdMatchesPattern(currentFqId, submitter);
if (fqIdMatches) {
return vfd;
}
}
}
int lastIndexOfSep = currentFqId.lastIndexOf(ID_SEP);
currentFqId = currentFqId.substring(0, lastIndexOfSep);
}
return null;
}
private int getVirtualFormCount() {
VirtualFormDescriptor[] vfds = getVirtualForms();
VirtualFormDescriptor[] ivfds = getInternalVirtualForms();
return (vfds == null ? 0 : vfds.length) + (ivfds == null ? 0 : ivfds.length);
}
private VirtualFormDescriptor getVirtualFormComponentSubmits(UIComponent component) {
if (getVirtualFormCount() < 1) {
return null;
}
String fqId = getFullyQualifiedId(component);
VirtualFormDescriptor vfd = getVirtualFormComponentSubmitsByFullyQualifiedId(fqId);
return vfd;
}
/** Get the virtual form submitted by the component whose id is provided or null if the component does not submit a virtual form. */
public VirtualFormDescriptor getVirtualFormComponentSubmits(String id) {
if (getVirtualFormCount() < 1) {
return null;
}
if (isValidFullyQualifiedId(id)) {
return getVirtualFormComponentSubmitsByFullyQualifiedId(id);
}
UIComponent component = findComponentById(id);
return getVirtualFormComponentSubmits(component);
}
//this method is public for designer's use
/**
* Given a bare, partially qualified, or fully qualified id, find the component.
* Unlike the inherited findComponent method, this method does recursively
* search NamingContainers.
*/
public UIComponent findComponentById(String id) {
if (id == null) {
return null;
}
if (id.length() == 0 || id.endsWith(ID_WILD) || (!id.equals(ID_SEP) && id.endsWith(ID_SEP))) {
return null;
}
//see if id indicates the Form itself
String fqId = getFullyQualifiedId(this);
if (fullyQualifiedIdMatchesPattern(fqId, id)) {
return this;
}
return searchKidsRecursivelyForId(this, id);
}
private UIComponent searchKidsRecursivelyForId(UIComponent parent, String id) {
Iterator kids = parent.getFacetsAndChildren();
while (kids.hasNext()) {
UIComponent kid = (UIComponent) kids.next();
String fqId = getFullyQualifiedId(kid);
//see if id indicates kid
boolean fqIdMatches = fullyQualifiedIdMatchesPattern(fqId, id);
if (fqIdMatches) {
return kid;
}
UIComponent match = searchKidsRecursivelyForId(kid, id);
if (match != null) {
return match;
}
}
return null;
}
//return true if a virtual form has been submitted and this component participates in that virtual form
private boolean participatesInSubmittedVirtualForm(UIComponent component) {
if (submittedVirtualForm == null) {
return false;
}
String fqId = getFullyQualifiedId(component);
return submittedVirtualForm.hasParticipant(fqId);
}
/**
* Generate an
* array of VirtualFormDescriptors based on a virtual form
* configuration String.
*/
/*
* Be sure to keep this method in sync with the version in
* javax.faces.component.html.HtmlFormDesignInfo
* (in jsfcl).
*/
public static VirtualFormDescriptor[] generateVirtualForms(String configStr) {
//formname1|pid1 pid2 pid3|sid1 sid2 sid3, formname2|pid4 pid5 pid6|sid4 sid5 sid6
if (configStr == null) {
return null;
}
configStr = configStr.trim();
if (configStr.length() < 1) {
return new VirtualFormDescriptor[0];
}
//configStr now can't be null, blank, or just ws
StringTokenizer st = new StringTokenizer(configStr, VF_DELIM_1);
List vfs = new ArrayList(); //list of marshalled vfs
while (st.hasMoreTokens()) {
String vf = st.nextToken(); //not null, but could be just whitespace or blank
vf = vf.trim();
//vf could be a blank string
if (vf.length() > 0) {
vfs.add(vf);
}
}
List descriptors = new ArrayList(); //a list of VirtualFormDescriptors
for (int i = 0; i < vfs.size(); i++) { //go through each marshalled vf
String vf = (String) vfs.get(i); //get the marshalled vf. not mere ws, blank, or null.
st = new StringTokenizer(vf, VF_DELIM_2);
String[] parts = new String[3]; //part1 is vf name, part2 is participating ids, part3 is submitting ids
int partIndex = 0;
while (partIndex < parts.length && st.hasMoreTokens()) {
String part = st.nextToken(); //not null, but could be whitespace or blank
part = part.trim(); //now can't be whitespace, but could be blank
if (part.length() > 0) {
//part is not null, whitespace, or blank
parts[partIndex] = part;
}
partIndex++;
}
VirtualFormDescriptor vfd;
if (parts[0] != null) {
vfd = new VirtualFormDescriptor();
vfd.setName(parts[0]); //won't be null, blank, or just ws
descriptors.add(vfd);
} else {
continue; //this marshalled vf has no name. can't create a descriptor for it. go to next marshalled vf
}
if (parts[1] != null) {
String pidString = parts[1]; //not null, blank, or just ws
st = new StringTokenizer(pidString);
List pidList = new ArrayList();
while (st.hasMoreTokens()) {
String pid = st.nextToken();
pidList.add(pid.trim());
}
String[] pids = (String[]) pidList.toArray(new String[pidList.size()]); //size guaranteed to be at least 1
vfd.setParticipatingIds(pids);
}
if (parts[2] != null) {
String sidString = parts[2]; //not null, blank, or just ws
st = new StringTokenizer(sidString);
List sidList = new ArrayList();
while (st.hasMoreTokens()) {
String sid = st.nextToken();
sidList.add(sid.trim());
}
String[] sids = (String[]) sidList.toArray(new String[sidList.size()]); //size guaranteed to be at least 1
vfd.setSubmittingIds(sids);
}
}
return (VirtualFormDescriptor[]) descriptors.toArray(new VirtualFormDescriptor[descriptors.size()]); //might be of size 0, but won't be null
}
/**
* Generate a virtual form
* configuration String based on an
* array of VirtualFormDescriptors.
*/
/*
* Be sure to keep this method in sync with the version in
* javax.faces.component.html.HtmlFormDesignInfo
* (in jsfcl).
*/
public static String generateVirtualFormsConfig(VirtualFormDescriptor[] descriptors) {
if (descriptors == null) {
return null;
}
StringBuffer sb = new StringBuffer();
for (int i = 0; i < descriptors.length; i++) {
if (descriptors[i] != null) {
String vf = descriptors[i].toString();
if (vf.length() > 0) {
if (sb.length() > 0) {
sb.append(" , ");
}
sb.append(vf);
}
}
}
return sb.toString();
}
/**
* Obtain the virtual form compatible fully-qualified id for the supplied component.
* A fully-qualified id begins with the NamingContainer.SEPARATOR_CHAR
* (representing the Form itself), contains component ids of the
* component's ancestors separated by NamingContainer.SEPARATOR_CHAR,
* and ends with the component's id.
*/
/*
* Be sure to keep this method in sync with the versions in
* javax.faces.component.html.HtmlFormDesignInfo
* (in jsfcl) and
* com.sun.webui.jsf.component.FormDesignInfo
* (in webui).
*/
public static String getFullyQualifiedId(UIComponent component) {
if (component == null) {
return null;
}
if (component instanceof Form) {
return ID_SEP;
}
String compId = component.getId();
if (compId == null) {
return null;
}
StringBuffer sb = new StringBuffer(compId);
UIComponent currentComp = component.getParent();
boolean formEncountered = false;
while (currentComp != null) {
sb.insert(0, ID_SEP);
if (currentComp instanceof Form) {
formEncountered = true;
break;
} else {
String currentCompId = currentComp.getId();
if (currentCompId == null) {
return null;
}
sb.insert(0, currentCompId);
}
currentComp = currentComp.getParent();
}
if (formEncountered) {
return sb.toString();
} else {
return null;
}
}
/**
* Determine if the id provided is non-null and exhibits the traits of a
* fully qualified id. This includes beginning with
* NamingContainer.SEPARATOR_CHAR, not ending with that
* character unless it is the only character, not ending in
* Form.ID_WILD_CHAR, and not containing spaces.
*/
/*
* Be sure to keep this method in sync with the version in
* javax.faces.component.html.HtmlFormDesignInfo
* (in jsfcl).
*/
public static boolean isValidFullyQualifiedId(String id) {
return id != null &&
id.startsWith(ID_SEP) &&
(id.length() == 1 || !id.endsWith(ID_SEP)) &&
!id.endsWith(ID_WILD) &&
id.indexOf(' ') == -1;
}
/**
* Determine if the fully qualified id provided matches the supplied pattern.
* The pattern may be a bare, partially qualified, or fully qualified id.
* The pattern may also end with the
* NamingContainer.SEPARATOR_CHAR followed by the
* Form.ID_WILD_CHAR, in which case the children of the component
* indicated by the pattern will be considered a match.
*/
/*
* Be sure to keep this method in sync with the version in
* javax.faces.component.html.HtmlFormDesignInfo
* (in jsfcl).
*/
public static boolean fullyQualifiedIdMatchesPattern(String fqId, String pattern) {
if (!isValidFullyQualifiedId(fqId)) {
return false;
}
if (pattern == null || pattern.length() < 1 || pattern.indexOf(' ') != -1) {
return false;
}
//unless pattern is ":", it should not end with ":"
if (pattern.endsWith(ID_SEP) && !pattern.equals(ID_SEP)) {
return false;
}
String wildSuffix = ID_SEP + ID_WILD;
//if ID_WILD appears in pattern, it must be the last character, and preceded by ID_SEP
int indexOfWildInPattern = pattern.indexOf(ID_WILD);
if (indexOfWildInPattern != -1) {
if (indexOfWildInPattern != pattern.length() - 1) {
return false;
}
if (!pattern.endsWith(wildSuffix)) {
return false;
}
}
if (pattern.equals(wildSuffix)) {
//if pattern was ":*", then any valid fqId is a match
return true;
} else if (pattern.endsWith(wildSuffix)) {
String patternPrefix = pattern.substring(0, pattern.length() - wildSuffix.length());
if (patternPrefix.startsWith(ID_SEP)) {
return fqId.equals(patternPrefix) || fqId.startsWith(patternPrefix + ID_SEP);
} else {
return fqId.endsWith(ID_SEP + patternPrefix) || fqId.indexOf(ID_SEP + patternPrefix + ID_SEP) > -1;
}
} else {
if (pattern.startsWith(ID_SEP)) {
return fqId.equals(pattern);
} else {
return fqId.endsWith(ID_SEP + pattern);
}
}
}
/**
* Add a VirtualFormDescriptor to the internal virtual forms.
* If an existing VirtualFormDescriptor object is found with the same name,
* the object is replaced.
*
* @param descriptor The VirtualFormDescriptor to add.
*/
public void addInternalVirtualForm(VirtualFormDescriptor descriptor) {
if (descriptor == null) {
return;
}
// Get current descriptors.
VirtualFormDescriptor[] oldDescriptors = getInternalVirtualForms();
// Iterate over each VirtualFormDescriptor object and check for a match.
if (oldDescriptors != null) {
for (int i = 0; i < oldDescriptors.length; i++) {
if (oldDescriptors[i] == null) {
continue;
}
String name = oldDescriptors[i].getName();
if (name != null && name.equals(descriptor.getName())) {
oldDescriptors[i] = descriptor;
return; // No further processing is required.
}
}
}
// Create array to hold new descriptors.
int oldLength = (oldDescriptors != null) ? oldDescriptors.length : 0;
VirtualFormDescriptor[] newDescriptors = new VirtualFormDescriptor[oldLength + 1];
for (int i = 0; i < oldLength; i++) {
newDescriptors[i] = oldDescriptors[i];
}
// Add new VirtualFormDescriptor object.
newDescriptors[oldLength] = descriptor;
setInternalVirtualForms(newDescriptors);
}
/*
* Be sure to keep this class in sync with the version in
* javax.faces.component.html.HtmlFormDesignInfo
* (in jsfcl).
*/
public static class VirtualFormDescriptor implements Serializable {
private static final long serialVersionUID = 7348674581125090187L;
private String name; //name of the virtual form
private String[] participatingIds; //ids of components that participate
private String[] submittingIds; //ids of components that submit
public VirtualFormDescriptor() {
}
public VirtualFormDescriptor(String name) {
setName(name);
}
public String getName() {
return name;
}
public void setName(String name) {
if (name == null) {
throw new IllegalArgumentException(
getMessage("nullVfName", null) //NOI18N
);
}
name = name.trim();
if (name.length() < 1) {
throw new IllegalArgumentException(
getMessage("vfNameWhitespaceOnly", null) //NOI18N
);
}
this.name = name;
}
public String[] getParticipatingIds() {
return participatingIds;
}
public void setParticipatingIds(java.lang.String[] participatingIds) {
for (int i = 0; participatingIds != null && i < participatingIds.length; i++) {
if (participatingIds[i] == null) {
throw new IllegalArgumentException(
getMessage("nullParticipatingIdAtIndex", new Object[]{new Integer(i)}) //NOI18N
);
}
participatingIds[i] = participatingIds[i].trim();
if (participatingIds[i].length() < 1) {
throw new IllegalArgumentException(
getMessage("whitespaceOnlyParticipatingIdAtIndex", new Object[]{new Integer(i)}) //NOI18N
);
}
}
this.participatingIds = participatingIds;
}
public String[] getSubmittingIds() {
return submittingIds;
}
public void setSubmittingIds(java.lang.String[] submittingIds) {
for (int i = 0; submittingIds != null && i < submittingIds.length; i++) {
if (submittingIds[i] == null) {
throw new IllegalArgumentException(
getMessage("nullSubmittingIdAtIndex", new Object[]{new Integer(i)}) //NOI18N
);
}
submittingIds[i] = submittingIds[i].trim();
if (submittingIds[i].length() < 1) {
throw new IllegalArgumentException(
getMessage("whitespaceOnlySubmittingIdAtIndex", new Object[]{new Integer(i)}) //NOI18N
);
}
}
this.submittingIds = submittingIds;
}
//return true if the component id provided submits this virtual form
public boolean isSubmittedBy(String fqId) {
if (!isValidFullyQualifiedId(fqId)) {
return false;
}
for (int i = 0; submittingIds != null && i < submittingIds.length; i++) {
if (Form.fullyQualifiedIdMatchesPattern(fqId, submittingIds[i])) {
return true;
}
}
return false;
}
//return true if the component id provided participates in this virtual form
public boolean hasParticipant(String fqId) {
if (!isValidFullyQualifiedId(fqId)) {
return false;
}
for (int i = 0; participatingIds != null && i < participatingIds.length; i++) {
if (Form.fullyQualifiedIdMatchesPattern(fqId, participatingIds[i])) {
return true;
}
}
return false;
}
@Override
public String toString() {
if (name == null) {
return "";
} //NOI18N
StringBuffer sb = new StringBuffer();
sb.append(name);
sb.append(" | "); //NOI18N
for (int i = 0; participatingIds != null && i < participatingIds.length; i++) {
sb.append(participatingIds[i]);
sb.append(' ');
}
sb.append("| "); //NOI18N
for (int i = 0; submittingIds != null && i < submittingIds.length; i++) {
sb.append(submittingIds[i]);
sb.append(' ');
}
return sb.toString().trim();
}
}
//Examine the participating ids that end in ID_WILD. If any of them match
//the component's fully qualified id, then the component's children are known
//to participate in vfd.
private static boolean childrenAreKnownToParticipate(UIComponent component, VirtualFormDescriptor vfd) {
if (vfd == null) {
return false;
}
String fqId = getFullyQualifiedId(component);
if (fqId == null) {
return false;
}
String[] participants = vfd.getParticipatingIds();
for (int i = 0; participants != null && i < participants.length; i++) {
String participant = participants[i];
String wildSuffix = ID_SEP + ID_WILD;
if (participant == null || !participant.endsWith(wildSuffix)) {
continue;
}
if (fullyQualifiedIdMatchesPattern(fqId, participant)) {
return true;
}
}
return false;
}
/**
* Recursively erase virtual form non-participants by setting their
* submitted values to null. This method caches the submitted
* values in the erasedMap before actually erasing.
* If the parent is embedded in one or more tables,
* the contextualTables and contextualRows
* are used to record the table- and row-based context of the
* submitted value, so that such context can be stored in the
* erasedMap.
* Note: Restoring of submitted values works for
* the braveheart table but not the standard jsf table. However, submitted
* values inside a standard jsf table are still cached and an attempt is
* made to restore them, in case a third-party component extends
* UIData and, unlike UIData, does not discard
* its saved state during rendering.
* @param parent A parent component whose children will be examined and
* possibly erased
* @param contextualTables an array of UIData or TableRowGroup components
* in the parent's ancestry (with the most distant ancestor as the first
* member of the array), or null if the parent is not embedded
* within any tables
* @param contextualRows a parallel array of Integer or
* RowKey objects representing a row in the corresponding
* contextual table, or null if the parent is not embedded
* within any tables
*/
private void eraseVirtualFormNonParticipants(UIComponent parent, Object[] contextualTables, Object[] contextualRows) {
// Process all facets and children of this component
//FIXME check the synchronization issue here
synchronized (erasedMap) { //prevent multiple threads from the same session simultaneously accessing erasedMap, nonDefaultRetainStatusEvhs
Iterator kids = parent.getFacetsAndChildren();
while (kids.hasNext()) {
UIComponent kid = (UIComponent) kids.next();
//if this kid is an EditableValueHolder, and it does not participate, set submitted value to null
if (kid instanceof EditableValueHolder && !participatesInSubmittedVirtualForm(kid)) {
EditableValueHolder kidEvh = (EditableValueHolder) kid;
//cache the submitted value to be erased in eraseMap
Object submittedValueToErase = kidEvh.getSubmittedValue();
if (contextualTables == null) {
erasedMap.put(kidEvh, submittedValueToErase);
} else {
addTableValuesEntry(erasedMap, kidEvh, 0, contextualTables, contextualRows, submittedValueToErase);
}
kidEvh.setSubmittedValue(null);
}
//if children of kid are known to participate in submittedVirtualForm,
//then no need to recurse on kid
if (childrenAreKnownToParticipate(kid, submittedVirtualForm)) {
continue; //continue to next kid
}
//recurse. if kid is a UIData or TableRowGroup, perform a recursive call once per row.
//if kid is not a UIData or TableRowGroup, simply perform a recursive call once.
if (kid instanceof UIData) {
UIData kidTable = (UIData) kid;
int originalRowIndex = kidTable.getRowIndex();
int rowIndex = 0;
kidTable.setRowIndex(rowIndex);
while (kidTable.isRowAvailable()) {
Object[] localContextualTables = appendToArray(contextualTables, kidTable);
Object[] localContextualRows = appendToArray(contextualRows, new Integer(rowIndex));
eraseVirtualFormNonParticipants(kidTable, localContextualTables, localContextualRows);
kidTable.setRowIndex(++rowIndex);
}
kidTable.setRowIndex(originalRowIndex);
} else if (kid instanceof TableRowGroup) {
TableRowGroup group = (TableRowGroup) kid;
RowKey[] rowKeys = group.getRowKeys();
RowKey oldRowKey = group.getRowKey(); // Save RowKey.
// Check for null TableDataProvider.
if (rowKeys != null) {
for (int i = 0; i < rowKeys.length; i++) {
group.setRowKey(rowKeys[i]);
if (!group.isRowAvailable()) {
continue;
}
Object[] localContextualTables = appendToArray(contextualTables, group);
Object[] localContextualRows = appendToArray(contextualRows, rowKeys[i]);
eraseVirtualFormNonParticipants(group, localContextualTables, localContextualRows);
}
}
group.setRowKey(oldRowKey); // Restore RowKey.
} else {
eraseVirtualFormNonParticipants(kid, contextualTables, contextualRows);
}
}
}
}
/** Recursively add an entry to erasedMap, whose value is a
* TableValues (and whose key is an
* EditableValueHolder).
*/
private void addTableValuesEntry(Map map, Object mapKey, int c, Object[] contextualTables, Object[] contextualRows, Object submittedValueToErase) {
//use the map and mapKey to get a TableValues, using contextualTables[c] to create tsv if necessary
TableValues tv = (TableValues) map.get(mapKey);
if (tv == null) {
tv = new TableValues(contextualTables[c]);
map.put(mapKey, tv);
}
//ensure an entry is populated in tv.values with contextualRows[c] as the key
Map values = tv.getValues();
if (c == contextualTables.length - 1) { //if last index in contextualTables
values.put(contextualRows[c], submittedValueToErase);
} else {
addTableValuesEntry(values, contextualRows[c], c + 1, contextualTables, contextualRows, submittedValueToErase);
}
}
private static Object[] appendToArray(Object[] array, Object item) {
Object[] result;
if (array == null) {
result = new Object[]{item};
} else {
result = new Object[array.length + 1];
System.arraycopy(array, 0, result, 0, array.length);
result[array.length] = item;
}
return result;
}
/**
* Restore the submitted values erased by the virtual form mechanism
* where appropriate.
* This method is called in FormRenderer.renderStart. It should
* not be called by developer code.
* Note: Restoring of submitted values works on
* TableRowGroup components, but does not work on the
* standard faces data table component. This is because in
* UIData.encodeBegin, the table's per-row saved state is
* typically discarded. The result is that upon
* exiting FormRenderer.renderStart, the submitted values will
* be restored; however, they will subsequently be discarded.
* Nonetheless, we still cache and restore those submitted values, in case
* a third-party component extends
* UIData and, unlike UIData, does not discard
* its saved state during rendering.
*/
public void restoreNonParticipatingSubmittedValues() {
//FIXME check the synchronization issue here
synchronized (erasedMap) { //prevent multiple threads from the same session simultaneously accessing erasedMap, nonDefaultRetainStatusEvhs
for (Iterator iter = erasedMap.entrySet().iterator(); iter.hasNext();) {
Map.Entry entry = (Map.Entry) iter.next();
EditableValueHolder evh = (EditableValueHolder) entry.getKey();
//if evh is designated as discarding submitted values, do not restore
//if DEFAULT_RETAIN_STATUS==true (retain by default), then nonDefaultRetainStatusEvhs contains evhs that discard
//if DEFAULT_RETAIN_STATUS==false (discard by default), then nonDefaultRetainStatusEvhs contains evhs that retain
boolean evhAppearsInSet = nonDefaultRetainStatusEvhs.contains(evh);
boolean discards = DEFAULT_RETAIN_STATUS ? evhAppearsInSet : !evhAppearsInSet;
if (discards) {
continue;
}
//restore
Object erasedMapValue = entry.getValue();
if (erasedMapValue instanceof TableValues) {
TableValues tv = (TableValues) erasedMapValue;
restoreTableValues(tv, evh);
} else {
evh.setSubmittedValue(erasedMapValue);
}
}
nonDefaultRetainStatusEvhs.clear(); //after restoring, clear out the retain status data
}
}
/**
* Helper method to restore submitted values for an
* EditableValueHolder component from a
* TableValues object, which contains a value for
* each row of each table in the EditableValueHolder's
* ancestry.
*/
private void restoreTableValues(TableValues tv, EditableValueHolder evh) {
//capture the old row of the tv and
//iterate through the tv rows
Object oldRow; //an Integer or RowKey
Iterator rowIterator;
Object table = tv.getTable();
Map values = tv.getValues();
if (table instanceof UIData) {
//capture the old row
UIData uidata = (UIData) table;
int iOldRow = uidata.getRowIndex();
oldRow = new Integer(iOldRow);
//get rowIterator
List rowList = new ArrayList();
rowList.addAll(values.keySet()); //add Set of Integers to List
Collections.sort(rowList);
rowIterator = rowList.iterator();
} else {
//capture the old row
TableRowGroup rowGroup = (TableRowGroup) table;
oldRow = rowGroup.getRowKey();
//get rowIterator
rowIterator = values.keySet().iterator();
}
while (rowIterator.hasNext()) {
Object row = rowIterator.next(); //row is an Integer or RowKey
//set the table to that row
if (table instanceof UIData) {
UIData uidata = (UIData) table;
Integer rowInt = (Integer) row;
int iRow = rowInt.intValue();
uidata.setRowIndex(iRow);
} else {
TableRowGroup rowGroup = (TableRowGroup) table;
RowKey rowKey = (RowKey) row;
rowGroup.setRowKey(rowKey);
}
//get the rowValue for that row, which can be an Object or a TableValues
//and restore that rowValue
Object rowValue = values.get(row);
if (rowValue instanceof TableValues) {
TableValues rowValueTv = (TableValues) rowValue;
restoreTableValues(rowValueTv, evh);
} else {
evh.setSubmittedValue(rowValue);
}
}
//set table back to old row
if (table instanceof UIData) {
UIData uidata = (UIData) table;
Integer oldRowInt = (Integer) oldRow;
int iOldRow = oldRowInt.intValue();
uidata.setRowIndex(iOldRow);
} else {
TableRowGroup rowGroup = (TableRowGroup) table;
RowKey oldRowKey = (RowKey) oldRow;
rowGroup.setRowKey(oldRowKey);
}
}
/** Structure that stores a component's submitted value
* for each row of a table (UIData or
* TableRowGroup), either as an
* Object or as a
* nested TableValues. This permits storing of all the
* submitted values for a component in the case where that component has
* more than one table in its ancestry.
*/
private class TableValues {
private Object table; //store a UIData or TableRowGroup
private Map values; //has a RowKey or Integer as the key, and a submitted value Object or a TableValues as the value
public TableValues(Object table) {
this.table = table;
values = new HashMap();
}
/** Get the UIData or TableRowGroup
* for this instance.
*/
public Object getTable() {
return this.table;
}
/** Get a Map of the values for each row
* of the table in question, where the key is an Integer or
* RowKey, and the value is a submitted value
* Object or a
* TableValues instance.
*/
public Map getValues() {
return this.values;
}
}
/**
* Ensure that the supplied EditableValueHolder component
* will discard (rather than retain) its submitted value when a virtual
* form is submitted in which the component does not participate.
* @param inputField An EditableValueHolder component that is
* not a participant in the virtual form that was submitted
* on this request.
* @throws IllegalArgumentException if inputField is null.
* @throws IllegalArgumentException if a virtual form has been
* submitted and the supplied inputField participates in it.
*/
public void discardSubmittedValue(EditableValueHolder inputField) {
if (inputField == null) {
throw new IllegalArgumentException(
getMessage("nullInputField", null) //NOI18N
);
}
if (inputField instanceof UIComponent) { //just defensive
UIComponent uicInputField = (UIComponent) inputField;
if (participatesInSubmittedVirtualForm(uicInputField)) {
throw new IllegalArgumentException(
getMessage("supplyNonParticipatingInputField", new Object[]{uicInputField.getId(), "discardSubmittedValue"}) //NOI18N
);
}
}
List evhCollection = new ArrayList();
evhCollection.add(inputField);
setRetainWhenNonParticipating(evhCollection, false);
}
/**
* Ensure that the participants in the supplied virtual form
* will discard (rather than retain) their submitted values when a
* different virtual form is submitted.
* @param virtualFormName The name of a virtual form on this page which
* has not been submitted.
* @throws IllegalArgumentException if no virtual form exists with the
* supplied name.
* @throws IllegalArgumentException if the supplied virtual form has been
* submitted on this request.
*/
public void discardSubmittedValues(String virtualFormName) {
VirtualFormDescriptor vfd = getVirtualFormByName(virtualFormName);
if (vfd == null) {
throw new IllegalArgumentException(
getMessage("unrecognizedVfName", new Object[]{virtualFormName}) //NOI18N
);
}
if (vfd == submittedVirtualForm) {
throw new IllegalArgumentException(
getMessage("supplyUnsubmittedVirtualForm", new Object[]{virtualFormName, "discardSubmittedValues"}) //NOI18N
);
}
setRetainWhenNonParticipating(vfd, false);
}
private void setRetainWhenNonParticipating(VirtualFormDescriptor vfd, boolean retain) {
String[] pids = vfd.getParticipatingIds();
if (pids == null || pids.length < 1) {
return;
}
List evhList = new ArrayList();
for (int i = 0; i < pids.length; i++) {
UIComponent uic = findComponentById(pids[i]);
if (uic instanceof EditableValueHolder) {
evhList.add(uic);
}
}
setRetainWhenNonParticipating(evhList, retain);
}
private void setRetainWhenNonParticipating(Collection evhs, boolean retain) {
if (evhs == null || evhs.size() < 1) {
return;
}
//FIXME check the synchronization issue here
synchronized (erasedMap) { //prevent multiple threads from the same session simultaneously accessing erasedMap, nonDefaultRetainStatusEvhs
//if we retain by default, then nonDefaultRetainStatusEvhs should contain evhs only if we want evhs to discard
//if we discard by default, then nonDefaultRetainStatusEvhs should contain evhs only if we want evhs to retain
boolean shouldContain = DEFAULT_RETAIN_STATUS ? !retain : retain;
if (shouldContain) {
nonDefaultRetainStatusEvhs.addAll(evhs);
} else {
nonDefaultRetainStatusEvhs.removeAll(evhs);
}
}
}
private VirtualFormDescriptor getVirtualFormByName(String virtualFormName) {
if (virtualFormName == null) {
return null;
}
VirtualFormDescriptor[] vfds = getVirtualForms();
for (int i = 0; vfds != null && i < vfds.length; i++) {
if (virtualFormName.equals(vfds[i].getName())) {
return vfds[i];
}
}
return null;
}
private static String getMessage(String key, Object[] args) {
String baseName = Form.class.getPackage().getName() + ".Bundle";
return MessageUtil.getMessage(FacesContext.getCurrentInstance(), baseName, key, args);
}
public String getEnctype() {
String encType = _getEnctype();
if (encType == null || encType.length() == 0) {
encType = "application/x-www-form-urlencoded"; //NOI18N
setEnctype(encType);
}
return encType;
}
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Tag attribute methods
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/**
* The component identifier for this component. This value must be unique
* within the closest parent component that is a naming container.
*/
@Property(name = "id")
@Override
public void setId(String id) {
super.setId(id);
}
/**
* Use the rendered attribute to indicate whether the HTML code for the
* component should be included in the rendered HTML page. If set to false,
* the rendered HTML page does not include the HTML for the component. If
* the component is not rendered, it is also not processed on any subsequent
* form submission.
*/
@Property(name = "rendered")
@Override
public void setRendered(boolean rendered) {
super.setRendered(rendered);
}
/**
* Use this non-XHTML compliant boolean attribute to turn off autocompletion
* feature of Internet Explorer and Firefox browsers. Set to "false" to
* turn off completion. The default is "true".
*/
@Property(name = "autoComplete", displayName = "Auto Complete", category = "Behavior")
private boolean autoComplete = false;
private boolean autoComplete_set = false;
public boolean isAutoComplete() {
if (this.autoComplete_set) {
return this.autoComplete;
}
ValueExpression _vb = getValueExpression("autoComplete");
if (_vb != null) {
Object _result = _vb.getValue(getFacesContext().getELContext());
if (_result == null) {
return false;
} else {
return ((Boolean) _result).booleanValue();
}
}
return true;
}
/**
* Use this non-XHTML compliant boolean attribute to turn off autocompletion
* feature of Internet Explorer and Firefox browsers. Set to "false" to
* turn off completion. The default is "true".
* @see #isAutoComplete()
*/
public void setAutoComplete(boolean autoComplete) {
this.autoComplete = autoComplete;
this.autoComplete_set = true;
}
/**
* Use this attribute to set the content-type of the HTTP request
* generated by this form. You do not normally need to set this
* attribute. Its default value is
* application/x-www-form-urlencoded. If there is an upload tag
* inside the form, the upload tag will modify the form's enctype
* attribute to multipart/form-data.
*/
@Property(name = "enctype", displayName = "Content Type of the Request", category = "Advanced")
private String enctype = null;
private String _getEnctype() {
if (this.enctype != null) {
return this.enctype;
}
ValueExpression _vb = getValueExpression("enctype");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return "application/x-www-form-urlencoded";
}
/**
* Use this attribute to set the content-type of the HTTP request
* generated by this form. You do not normally need to set this
* attribute. Its default value is
* application/x-www-form-urlencoded. If there is an upload tag
* inside the form, the upload tag will modify the form's enctype
* attribute to multipart/form-data.
* @see #getEnctype()
*/
public void setEnctype(String enctype) {
this.enctype = enctype;
}
/**
* The virtual forms used "internally" by components (such as Table).
* Component authors can manipulate this set of virtual forms independent
* of the set exposed to developers. This set is only consulted after the
* set exposed to developers is consulted. A participating or submitting id
* can end in ":*" to indicate descendants. For example, table1:* can be
* used as a participating or submitting id to indicate all the descendants
* of table1.
*/
@Property(name = "internalVirtualForms", displayName = "Internal Virtual Form Descriptors",
category = "Advanced", isHidden = false, isAttribute = false)
private com.sun.webui.jsf.component.Form.VirtualFormDescriptor[] internalVirtualForms = null;
public com.sun.webui.jsf.component.Form.VirtualFormDescriptor[] getInternalVirtualForms() {
if (this.internalVirtualForms != null) {
return this.internalVirtualForms;
}
ValueExpression _vb = getValueExpression("internalVirtualForms");
if (_vb != null) {
return (com.sun.webui.jsf.component.Form.VirtualFormDescriptor[]) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* The virtual forms used "internally" by components (such as Table).
* Component authors can manipulate this set of virtual forms independent
* of the set exposed to developers. This set is only consulted after the
* set exposed to developers is consulted. A participating or submitting id
* can end in ":*" to indicate descendants. For example, table1:* can be
* used as a participating or submitting id to indicate all the descendants
* of table1.
* @see #getInternalVirtualForms()
*/
public void setInternalVirtualForms(com.sun.webui.jsf.component.Form.VirtualFormDescriptor[] internalVirtualForms) {
this.internalVirtualForms = internalVirtualForms;
}
/**
* Scripting code executed when a mouse click
* occurs over this component.
*/
@Property(name = "onClick", displayName = "Click Script", category = "Javascript",
editorClassName = "com.sun.rave.propertyeditors.JavaScriptPropertyEditor")
private String onClick = null;
public String getOnClick() {
if (this.onClick != null) {
return this.onClick;
}
ValueExpression _vb = getValueExpression("onClick");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* Scripting code executed when a mouse click
* occurs over this component.
* @see #getOnClick()
*/
public void setOnClick(String onClick) {
this.onClick = onClick;
}
/**
* Scripting code executed when a mouse double click
* occurs over this component.
*/
@Property(name = "onDblClick", displayName = "Double Click Script", category = "Javascript",
editorClassName = "com.sun.rave.propertyeditors.JavaScriptPropertyEditor")
private String onDblClick = null;
public String getOnDblClick() {
if (this.onDblClick != null) {
return this.onDblClick;
}
ValueExpression _vb = getValueExpression("onDblClick");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* Scripting code executed when a mouse double click
* occurs over this component.
* @see #getOnDblClick()
*/
public void setOnDblClick(String onDblClick) {
this.onDblClick = onDblClick;
}
/**
* Scripting code executed when the user presses down on a key while the
* component has focus.
*/
@Property(name = "onKeyDown", displayName = "Key Down Script", category = "Javascript",
editorClassName = "com.sun.rave.propertyeditors.JavaScriptPropertyEditor")
private String onKeyDown = null;
public String getOnKeyDown() {
if (this.onKeyDown != null) {
return this.onKeyDown;
}
ValueExpression _vb = getValueExpression("onKeyDown");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* Scripting code executed when the user presses down on a key while the
* component has focus.
* @see #getOnKeyDown()
*/
public void setOnKeyDown(String onKeyDown) {
this.onKeyDown = onKeyDown;
}
/**
* Scripting code executed when the user presses and releases a key while
* the component has focus.
*/
@Property(name = "onKeyPress", displayName = "Key Press Script", category = "Javascript",
editorClassName = "com.sun.rave.propertyeditors.JavaScriptPropertyEditor")
private String onKeyPress = null;
public String getOnKeyPress() {
if (this.onKeyPress != null) {
return this.onKeyPress;
}
ValueExpression _vb = getValueExpression("onKeyPress");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* Scripting code executed when the user presses and releases a key while
* the component has focus.
* @see #getOnKeyPress()
*/
public void setOnKeyPress(String onKeyPress) {
this.onKeyPress = onKeyPress;
}
/**
* Scripting code executed when the user releases a key while the
* component has focus.
*/
@Property(name = "onKeyUp", displayName = "Key Up Script", category = "Javascript",
editorClassName = "com.sun.rave.propertyeditors.JavaScriptPropertyEditor")
private String onKeyUp = null;
public String getOnKeyUp() {
if (this.onKeyUp != null) {
return this.onKeyUp;
}
ValueExpression _vb = getValueExpression("onKeyUp");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* Scripting code executed when the user releases a key while the
* component has focus.
* @see #getOnKeyUp()
*/
public void setOnKeyUp(String onKeyUp) {
this.onKeyUp = onKeyUp;
}
/**
* Scripting code executed when the user presses a mouse button while the
* mouse pointer is on the component.
*/
@Property(name = "onMouseDown", displayName = "Mouse Down Script", category = "Javascript",
editorClassName = "com.sun.rave.propertyeditors.JavaScriptPropertyEditor")
private String onMouseDown = null;
public String getOnMouseDown() {
if (this.onMouseDown != null) {
return this.onMouseDown;
}
ValueExpression _vb = getValueExpression("onMouseDown");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* Scripting code executed when the user presses a mouse button while the
* mouse pointer is on the component.
* @see #getOnMouseDown()
*/
public void setOnMouseDown(String onMouseDown) {
this.onMouseDown = onMouseDown;
}
/**
* Scripting code executed when the user moves the mouse pointer while
* over the component.
*/
@Property(name = "onMouseMove", displayName = "Mouse Move Script", category = "Javascript",
editorClassName = "com.sun.rave.propertyeditors.JavaScriptPropertyEditor")
private String onMouseMove = null;
public String getOnMouseMove() {
if (this.onMouseMove != null) {
return this.onMouseMove;
}
ValueExpression _vb = getValueExpression("onMouseMove");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* Scripting code executed when the user moves the mouse pointer while
* over the component.
* @see #getOnMouseMove()
*/
public void setOnMouseMove(String onMouseMove) {
this.onMouseMove = onMouseMove;
}
/**
* Scripting code executed when a mouse out movement
* occurs over this component.
*/
@Property(name = "onMouseOut", displayName = "Mouse Out Script", category = "Javascript",
editorClassName = "com.sun.rave.propertyeditors.JavaScriptPropertyEditor")
private String onMouseOut = null;
public String getOnMouseOut() {
if (this.onMouseOut != null) {
return this.onMouseOut;
}
ValueExpression _vb = getValueExpression("onMouseOut");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* Scripting code executed when a mouse out movement
* occurs over this component.
* @see #getOnMouseOut()
*/
public void setOnMouseOut(String onMouseOut) {
this.onMouseOut = onMouseOut;
}
/**
* Scripting code executed when the user moves the mouse pointer into
* the boundary of this component.
*/
@Property(name = "onMouseOver", displayName = "Mouse In Script", category = "Javascript",
editorClassName = "com.sun.rave.propertyeditors.JavaScriptPropertyEditor")
private String onMouseOver = null;
public String getOnMouseOver() {
if (this.onMouseOver != null) {
return this.onMouseOver;
}
ValueExpression _vb = getValueExpression("onMouseOver");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* Scripting code executed when the user moves the mouse pointer into
* the boundary of this component.
* @see #getOnMouseOver()
*/
public void setOnMouseOver(String onMouseOver) {
this.onMouseOver = onMouseOver;
}
/**
* Scripting code executed when the user releases a mouse button while
* the mouse pointer is on the component.
*/
@Property(name = "onMouseUp", displayName = "Mouse Up Script", category = "Javascript",
editorClassName = "com.sun.rave.propertyeditors.JavaScriptPropertyEditor")
private String onMouseUp = null;
public String getOnMouseUp() {
if (this.onMouseUp != null) {
return this.onMouseUp;
}
ValueExpression _vb = getValueExpression("onMouseUp");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* Scripting code executed when the user releases a mouse button while
* the mouse pointer is on the component.
* @see #getOnMouseUp()
*/
public void setOnMouseUp(String onMouseUp) {
this.onMouseUp = onMouseUp;
}
/**
* Scripting code executed when this form is reset.
*/
@Property(name = "onReset", displayName = "Form Reset Script", category = "Javascript",
editorClassName = "com.sun.rave.propertyeditors.JavaScriptPropertyEditor")
private String onReset = null;
public String getOnReset() {
if (this.onReset != null) {
return this.onReset;
}
ValueExpression _vb = getValueExpression("onReset");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* Scripting code executed when this form is reset.
* @see #getOnReset()
*/
public void setOnReset(String onReset) {
this.onReset = onReset;
}
/**
* Scripting code executed when this form is submitted.
*/
@Property(name = "onSubmit", displayName = "Form Submit Script", category = "Javascript",
editorClassName = "com.sun.rave.propertyeditors.JavaScriptPropertyEditor")
private String onSubmit = null;
public String getOnSubmit() {
if (this.onSubmit != null) {
return this.onSubmit;
}
ValueExpression _vb = getValueExpression("onSubmit");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* Scripting code executed when this form is submitted.
* @see #getOnSubmit()
*/
public void setOnSubmit(String onSubmit) {
this.onSubmit = onSubmit;
}
/**
* CSS style(s) to be applied to the outermost HTML element when this
* component is rendered.
*/
@Property(name = "style", displayName = "CSS Style(s)", category = "Appearance",
editorClassName = "com.sun.jsfcl.std.css.CssStylePropertyEditor")
private String style = null;
public String getStyle() {
if (this.style != null) {
return this.style;
}
ValueExpression _vb = getValueExpression("style");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* CSS style(s) to be applied to the outermost HTML element when this
* component is rendered.
* @see #getStyle()
*/
public void setStyle(String style) {
this.style = style;
}
/**
* CSS style class(es) to be applied to the outermost HTML element when this
* component is rendered.
*/
@Property(name = "styleClass", displayName = "CSS Style Class(es)", category = "Appearance",
editorClassName = "com.sun.rave.propertyeditors.StyleClassPropertyEditor")
private String styleClass = null;
public String getStyleClass() {
if (this.styleClass != null) {
return this.styleClass;
}
ValueExpression _vb = getValueExpression("styleClass");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* CSS style class(es) to be applied to the outermost HTML element when this
* component is rendered.
* @see #getStyleClass()
*/
public void setStyleClass(String styleClass) {
this.styleClass = styleClass;
}
/**
* Use this attribute to set the target of the XHTML form tag.
*/
@Property(name = "target", displayName = "Target", category = "Behavior",
editorClassName = "com.sun.webui.jsf.component.propertyeditors.FrameTargetsEditor")
private String target = null;
public String getTarget() {
if (this.target != null) {
return this.target;
}
ValueExpression _vb = getValueExpression("target");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* Use this attribute to set the target of the XHTML form tag.
* @see #getTarget()
*/
public void setTarget(String target) {
this.target = target;
}
/**
* The virtual forms within this literal form, represented as an
* array of Form.VirtualFormDescriptor objects. This property
* and the "virtualFormsConfig" property are automatically kept
* in-sync.
*/
@Property(name = "virtualForms", displayName = "Virtual Form Descriptors", category = "Advanced",
isHidden = true, isAttribute = false)
private com.sun.webui.jsf.component.Form.VirtualFormDescriptor[] virtualForms = null;
public com.sun.webui.jsf.component.Form.VirtualFormDescriptor[] getVirtualForms() {
if (this.virtualForms != null) {
return this.virtualForms;
}
ValueExpression _vb = getValueExpression("virtualForms");
if (_vb != null) {
return (com.sun.webui.jsf.component.Form.VirtualFormDescriptor[]) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* The virtual forms within this literal form, represented as an
* array of Form.VirtualFormDescriptor objects. This property
* and the "virtualFormsConfig" property are automatically kept
* in-sync.
* @see #getVirtualForms()
*/
private void _setVirtualForms(com.sun.webui.jsf.component.Form.VirtualFormDescriptor[] virtualForms) {
this.virtualForms = virtualForms;
}
/**
* The configuration of the virtual forms within this literal form, represented as a String.
* Each virtual form is described by three parts, separated with pipe ("|") characters:
* the virtual form name, a space-separated list of component ids that participate in the
* virtual form, and a space-separated list of component ids that submit the virtual form.
* Multiple such virtual form "descriptors" are separated by commas. The component ids may
* be qualified (for instance, "table1:tableRowGroup1:tableColumn1:textField1").
*/
@Property(name = "virtualFormsConfig", displayName = "Virtual Forms Configuration",
category = "Advanced", editorClassName = "com.sun.rave.propertyeditors.StringPropertyEditor")
private String virtualFormsConfig = null;
public String getVirtualFormsConfig() {
if (this.virtualFormsConfig != null) {
return this.virtualFormsConfig;
}
ValueExpression _vb = getValueExpression("virtualFormsConfig");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* The configuration of the virtual forms within this literal form, represented as a String.
* Each virtual form is described by three parts, separated with pipe ("|") characters:
* the virtual form name, a space-separated list of component ids that participate in the
* virtual form, and a space-separated list of component ids that submit the virtual form.
* Multiple such virtual form "descriptors" are separated by commas. The component ids may
* be qualified (for instance, "table1:tableRowGroup1:tableColumn1:textField1").
* @see #getVirtualFormsConfig()
*/
private void _setVirtualFormsConfig(String virtualFormsConfig) {
this.virtualFormsConfig = virtualFormsConfig;
}
/**
* Use the visible attribute to indicate whether the component should be
* viewable by the user in the rendered HTML page.
*/
@Property(name = "visible", displayName = "Visible", category = "Behavior")
private boolean visible = false;
private boolean visible_set = false;
public boolean isVisible() {
if (this.visible_set) {
return this.visible;
}
ValueExpression _vb = getValueExpression("visible");
if (_vb != null) {
Object _result = _vb.getValue(getFacesContext().getELContext());
if (_result == null) {
return false;
} else {
return ((Boolean) _result).booleanValue();
}
}
return true;
}
/**
* Use the visible attribute to indicate whether the component should be
* viewable by the user in the rendered HTML page.
* @see #isVisible()
*/
public void setVisible(boolean visible) {
this.visible = visible;
this.visible_set = true;
}
/**
* Restore the state of this component.
*/
@Override
public void restoreState(FacesContext _context, Object _state) {
Object _values[] = (Object[]) _state;
super.restoreState(_context, _values[0]);
this.autoComplete = ((Boolean) _values[1]).booleanValue();
this.autoComplete_set = ((Boolean) _values[2]).booleanValue();
this.enctype = (String) _values[3];
this.internalVirtualForms = (com.sun.webui.jsf.component.Form.VirtualFormDescriptor[]) _values[4];
this.onClick = (String) _values[5];
this.onDblClick = (String) _values[6];
this.onKeyDown = (String) _values[7];
this.onKeyPress = (String) _values[8];
this.onKeyUp = (String) _values[9];
this.onMouseDown = (String) _values[10];
this.onMouseMove = (String) _values[11];
this.onMouseOut = (String) _values[12];
this.onMouseOver = (String) _values[13];
this.onMouseUp = (String) _values[14];
this.onReset = (String) _values[15];
this.onSubmit = (String) _values[16];
this.style = (String) _values[17];
this.styleClass = (String) _values[18];
this.target = (String) _values[19];
this.virtualForms = (com.sun.webui.jsf.component.Form.VirtualFormDescriptor[]) _values[20];
this.virtualFormsConfig = (String) _values[21];
this.visible = ((Boolean) _values[22]).booleanValue();
this.visible_set = ((Boolean) _values[23]).booleanValue();
}
/**
* Save the state of this component.
*/
@Override
public Object saveState(FacesContext _context) {
Object _values[] = new Object[24];
_values[0] = super.saveState(_context);
_values[1] = this.autoComplete ? Boolean.TRUE : Boolean.FALSE;
_values[2] = this.autoComplete_set ? Boolean.TRUE : Boolean.FALSE;
_values[3] = this.enctype;
_values[4] = this.internalVirtualForms;
_values[5] = this.onClick;
_values[6] = this.onDblClick;
_values[7] = this.onKeyDown;
_values[8] = this.onKeyPress;
_values[9] = this.onKeyUp;
_values[10] = this.onMouseDown;
_values[11] = this.onMouseMove;
_values[12] = this.onMouseOut;
_values[13] = this.onMouseOver;
_values[14] = this.onMouseUp;
_values[15] = this.onReset;
_values[16] = this.onSubmit;
_values[17] = this.style;
_values[18] = this.styleClass;
_values[19] = this.target;
_values[20] = this.virtualForms;
_values[21] = this.virtualFormsConfig;
_values[22] = this.visible ? Boolean.TRUE : Boolean.FALSE;
_values[23] = this.visible_set ? Boolean.TRUE : Boolean.FALSE;
return _values;
}
}