jakarta.faces.view.facelets.Facelet Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of myfaces-api Show documentation
Show all versions of myfaces-api Show documentation
The public API classes of the Apache MyFaces CORE JSF-2.2 project
The newest version!
/*
* 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 jakarta.faces.view.facelets;
import java.io.IOException;
import jakarta.faces.component.UIComponent;
import jakarta.faces.context.FacesContext;
/**
* The parent or root object in a FaceletHandler composition. The Facelet will take care of populating the passed
* UIComponent parent in relation to the create/restore lifecycle of Faces.
*/
public abstract class Facelet
{
/**
*
* The passed UIComponent parent will be
* populated/restored in accordance with the
* Facelets chapter in the spec prose document
* with only the meta data as per the f:metadata
tag.
*
*
* @param facesContext The current FacesContext (Should be the same as FacesContext.getInstance())
* @param parent The UIComponent to populate in a compositional fashion. In most cases a Facelet will be base a
* UIViewRoot.
*
* @throws IOException if unable to load a file necessary to apply this {@code Facelet}
* @throws FaceletException if unable to parse the markup loaded in applying this {@code Facelet}
* @throws jakarta.faces.FacesException if unable to create child UIComponent
instances
* @throws jakarta.el.ELException if any of the expressions in the markup loaded during the apply fail
*
*/
public void applyMetadata(FacesContext facesContext, UIComponent parent) throws IOException
{
// By default, do nothing
}
/**
*
* The passed UIComponent parent will be
* populated/restored in accordance with the
* Facelets chapter in the spec prose document.
*
*
* @param facesContext The current FacesContext (Should be the same as FacesContext.getInstance())
* @param parent The UIComponent to populate in a compositional fashion. In most cases a Facelet will be base a
* UIViewRoot.
*
* @throws IOException if unable to load a file necessary to apply this {@code Facelet}
* @throws FaceletException if unable to parse the markup loaded in applying this {@code Facelet}
* @throws jakarta.faces.FacesException if unable to create child UIComponent
instances
* @throws jakarta.el.ELException if any of the expressions in the markup loaded during the apply fail
*
*/
public abstract void apply(FacesContext facesContext, UIComponent parent) throws IOException;
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy