jakarta.faces.component.UIForm Maven / Gradle / Ivy
Show all versions of jakarta.faces-api Show documentation
/*
* Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package jakarta.faces.component;
import static com.sun.faces.util.Util.coalesce;
import static jakarta.faces.component.UIViewRoot.UNIQUE_ID_PREFIX;
import static jakarta.faces.component.visit.VisitResult.COMPLETE;
import java.util.Collection;
import java.util.Iterator;
import jakarta.faces.FacesException;
import jakarta.faces.application.Application;
import jakarta.faces.component.visit.VisitCallback;
import jakarta.faces.component.visit.VisitContext;
import jakarta.faces.context.FacesContext;
import jakarta.faces.event.PostValidateEvent;
import jakarta.faces.event.PreValidateEvent;
/**
*
* UIForm is a {@link UIComponent} that represents an input form to be
* presented to the user, and whose child components represent (among other things) the input fields to be included when
* the form is submitted.
*
*
*
* By default, the rendererType property must be set to "jakarta.faces.Form". This value can
* be changed by calling the setRendererType() method.
*
*/
public class UIForm extends UIComponentBase implements NamingContainer, UniqueIdVendor {
// ------------------------------------------------------ Manifest Constants
/**
*
* The standard component type for this component.
*
*/
public static final String COMPONENT_TYPE = "jakarta.faces.Form";
/**
*
* The standard component family for this component.
*
*/
public static final String COMPONENT_FAMILY = "jakarta.faces.Form";
/**
* Properties that are tracked by state saving.
*/
enum PropertyKeys {
/**
*
* The prependId flag.
*
*/
prependId,
/**
*
* Last id vended by {@link UIForm#createUniqueId(jakarta.faces.context.FacesContext, String)}.
*
*/
lastId,
submitted,
}
// ------------------------------------------------------------ Constructors
/**
*
* Create a new {@link UIForm} instance with default property values.
*
*/
public UIForm() {
super();
setRendererType("jakarta.faces.Form");
}
// -------------------------------------------------------------- Properties
@Override
public String getFamily() {
return COMPONENT_FAMILY;
}
/**
*
* Returns the current value of the submitted property. The
* default value is false. See {@link #setSubmitted} for details.
*
*
*
* This property must be kept as a transient property using the {@link UIComponent#getTransientStateHelper}.
*
*
* @return true if the form was submitted, false otherwise.
*/
public boolean isSubmitted() {
return (Boolean) getTransientStateHelper().getTransient(PropertyKeys.submitted, false);
}
/**
*
* If this UIForm instance (as opposed to other
* forms in the page) is experiencing a submit during this request processing lifecycle, this method must be called,
* with true as the argument, during the {@link UIComponent#decode} for this UIForm instance.
* If this UIForm instance is not experiencing a submit, this method must
* be called, with false as the argument, during the {@link UIComponent#decode} for this
* UIForm instance.
*
*
*
* The value of a UIForm's submitted property must not be saved as part of its state.
*
*
*
* This property must be kept as a transient property using the {@link UIComponent#getTransientStateHelper}.
*
*
* @param submitted the new value of the submitted flag.
*/
public void setSubmitted(boolean submitted) {
getTransientStateHelper().putTransient(PropertyKeys.submitted, submitted);
}
/**
* Is the id prepended.
*
* @return true if it is, false otherwise.
*/
public boolean isPrependId() {
return (Boolean) getStateHelper().eval(PropertyKeys.prependId, true);
}
/**
* Set whether the id should be prepended.
*
* @param prependId true if it is, false otherwise.
*/
public void setPrependId(boolean prependId) {
getStateHelper().put(PropertyKeys.prependId, prependId);
}
// ----------------------------------------------------- UIComponent Methods
/**
*
* Override {@link UIComponent#processDecodes} to ensure that the form is decoded before its children.
* This is necessary to allow the submitted property to be correctly set.
*
*
* @throws NullPointerException {@inheritDoc}
*/
@Override
public void processDecodes(FacesContext context) {
if (context == null) {
throw new NullPointerException();
}
// Process this component itself
decode(context);
// 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()) {
kids.next().processDecodes(context);
}
}
/**
*
* Override {@link UIComponent#processValidators} to ensure that the children of this UIForm instance are
* only processed if {@link #isSubmitted} returns true.
*
*
* @throws NullPointerException {@inheritDoc}
* @see jakarta.faces.event.PreValidateEvent
* @see jakarta.faces.event.PostValidateEvent
*/
@Override
public void processValidators(FacesContext context) {
if (context == null) {
throw new NullPointerException();
}
if (!isSubmitted()) {
return;
}
pushComponentToEL(context, this);
Application application = context.getApplication();
application.publishEvent(context, PreValidateEvent.class, this);
// Process all the facets and children of this component
Iterator kids = getFacetsAndChildren();
while (kids.hasNext()) {
kids.next().processValidators(context);
}
application.publishEvent(context, PostValidateEvent.class, this);
popComponentFromEL(context);
}
/**
*
* Override {@link UIComponent#processUpdates} to ensure that the children of this UIForm instance are only
* processed if {@link #isSubmitted} returns true.
*
*
* @throws NullPointerException {@inheritDoc}
*/
@Override
public void processUpdates(FacesContext context) {
if (context == null) {
throw new NullPointerException();
}
if (!isSubmitted()) {
return;
}
pushComponentToEL(context, this);
try {
// Process all facets and children of this component
Iterator kids = getFacetsAndChildren();
while (kids.hasNext()) {
kids.next().processUpdates(context);
}
} finally {
popComponentFromEL(context);
}
}
/**
*
* Generate an identifier for a component. The identifier will be prefixed with UNIQUE_ID_PREFIX, and will be unique
* within this component-container. Optionally, a unique seed value can be supplied by component creators which should
* be included in the generated unique id.
*
*
* If the prependId property has the value false, this method must call
* createUniqueId on the next ancestor UniqueIdVendor.
*
*
* @param context FacesContext
* @param seed an optional seed value - e.g. based on the position of the component in the VDL-template
* @return a unique-id in this component-container
*/
@Override
public String createUniqueId(FacesContext context, String seed) {
if (isPrependId()) {
int lastId = coalesce(getLastId(), 0);
setLastId(++lastId);
return UNIQUE_ID_PREFIX + coalesce(seed, lastId);
}
UIComponent ancestorNamingContainer = getParent() == null ? null : getParent().getNamingContainer();
if (ancestorNamingContainer instanceof UniqueIdVendor) {
return ((UniqueIdVendor) ancestorNamingContainer).createUniqueId(context, seed);
}
return context.getViewRoot().createUniqueId(context, seed);
}
/**
*
* Override the {@link UIComponent#getContainerClientId} to allow users to disable this form from prepending its
* clientId to its descendent's clientIds depending on the value of this form's
* {@link #isPrependId} property.
*
*/
@Override
public String getContainerClientId(FacesContext context) {
if (isPrependId()) {
return super.getContainerClientId(context);
}
UIComponent parent = getParent();
while (parent != null) {
if (parent instanceof NamingContainer) {
return parent.getContainerClientId(context);
}
parent = parent.getParent();
}
return null;
}
/**
* @see UIComponent#visitTree
*/
@Override
public boolean visitTree(VisitContext context, VisitCallback callback) {
// NamingContainers can optimize partial tree visits by taking advantage
// of the fact that it is possible to detect whether any ids to visit
// exist underneath the NamingContainer. If no such ids exist, there
// is no need to visit the subtree under the NamingContainer.
// UIForm is a bit different from other NamingContainers. It only acts
// as a NamingContainer when prependId is true. Note that if it
// weren't for this, we could push this implementation up in to
// UIComponent and share it across all NamingContainers. Instead,
// we currently duplicate this implementation in UIForm and
// UINamingContainer, so that we can check isPrependId() here.
if (!isPrependId()) {
return super.visitTree(context, callback);
}
Collection idsToVisit = context.getSubtreeIdsToVisit(this);
// If we have ids to visit, let the superclass implementation
// handle the visit
if (!idsToVisit.isEmpty()) {
return super.visitTree(context, callback);
}
// If we have no child ids to visit, just visit ourselves, if
// we are visitable.
if (isVisitable(context)) {
FacesContext facesContext = context.getFacesContext();
pushComponentToEL(facesContext, null);
try {
return context.invokeVisitCallback(this, callback) == COMPLETE;
} finally {
popComponentFromEL(facesContext);
}
}
// Done visiting this subtree. Return false to allow
// visit to continue.
return false;
}
/**
* @see UIComponent#invokeOnComponent
*/
@Override
public boolean invokeOnComponent(FacesContext context, String clientId, ContextCallback callback) throws FacesException {
// Optimization: In case when invokeOnComponent is used and the form has prependId=true,
// we can early skip the whole component tree if the baseClientId != form clientId.
if (isPrependId()) {
String baseClientId = getClientId(context);
// skip if the component is not a child of the UIForm
if (!clientId.startsWith(baseClientId)) {
return false;
}
}
return super.invokeOnComponent(context, clientId, callback);
}
// ----------------------------------------------------- Private Methods
private Integer getLastId() {
return (Integer) getStateHelper().get(PropertyKeys.lastId);
}
private void setLastId(Integer lastId) {
getStateHelper().put(PropertyKeys.lastId, lastId);
}
}