org.apache.myfaces.trinidad.render.LifecycleRenderer Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of trinidad-api Show documentation

Public API for the Apache MyFaces Trinidad project

There is a newer version: 2.2.1

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.myfaces.trinidad.render;

import javax.faces.component.UIComponent;
import javax.faces.context.FacesContext;

/**
 * LifecycleRenderer can be used to enhance the general component-renderer
 * contract, by letting a renderer take over control of
 * all child component hierarchy lifecycle phases.  In particular,
 * the renderer can take over the implementation of
 * UIComponent.processValidators(), processDecode(), and processUpdates().
 * (This requires that the component be a subclass of UIXComponentBase.)
 *
 */
public interface LifecycleRenderer
{
  /**
   * Decodes a component's children.
   *
   * @param context    the Faces context
   * @param component  the component to render
   * @return whether the lifecycle was processed;  if returns false,
   *   the component should continue default processing of the
   *    Apply Request Values phase.
   */
  public boolean decodeChildren(
    FacesContext context,
    UIComponent  component);

  /**
   * Validates a component's children.
   *
   * @param context    the Faces context
   * @param component  the component to render
   * @return whether the lifecycle was processed;  if returns false,
   *   the component should continue default processing of the
   *    Process Validation phase.
   */
  public boolean validateChildren(
    FacesContext context,
    UIComponent  component);

  /**
   * Updates a component's children.
   *
   * @param context    the Faces context
   * @param component  the component to render
   * @return whether the lifecycle was processed;  if returns false,
   *   the component should continue default processing of the
   *    Update Model phase.
   */
  public boolean updateChildren(
    FacesContext context,
    UIComponent  component);
}