javax.faces.view.facelets.FaceletHandler Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jakarta.faces Show documentation

EE4J Compatible Implementation for Jakarta Faces API

There is a newer version: 4.1.1

/*
 * Copyright (c) 1997, 2018 Oracle and/or its affiliates. All rights reserved.
 * Copyright 2005-2007 The Apache Software Foundation
 *
 * Licensed 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 javax.faces.view.facelets;

import java.io.IOException;
import javax.faces.component.UIComponent;

/**
 * This is the root class for markup
 * elements in Facelets VDL.  Facelets is XHTML, and XHTML is XML, and
 * the root unit of abstraction in XML is the element.  A
 * FaceletHandler instance represents an XML element at
 * runtime.  Two direct implementations exist to embody the contract for
 * more specific behavior.
 *
 * 

 * 

 * {@link CompositeFaceletHandler}

 * A container for other FaceletHandlers

 * {@link TagHandler}

 * The foundation class for FaceletHandlers associated
 * with markup in a Facelet document.

 * 

 * 

 * @since 2.0
 */
public interface FaceletHandler {

    /**
     * Process changes on a particular
     * UIComponent
     * 
     * @param ctx the current FaceletContext instance for this execution
     * @param parent the parent UIComponent to operate upon

     * @throws IOException if unable to load relativePath

     * @throws FaceletException if unable to parse the markup loaded from relativePath

     * @throws javax.faces.FacesException if unable to create child UIComponent instances

     * @throws javax.el.ELException if any of the expressions in the markup
     * loaded from relativePath fail

     * @since 2.0

     */
    public void apply(FaceletContext ctx, UIComponent parent)
    throws IOException;
}