jakarta.faces.view.AttachedObjectHandler 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

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;

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

/**
 * The abstract base interface for a handler representing an attached object in a PDL page. Subinterfaces are
 * provided for the common attached objects that expose {@link jakarta.faces.convert.Converter Converter},
 * {@link jakarta.faces.validator.Validator Validator}, {@link jakarta.faces.event.ValueChangeEvent ValueChangeEvent},
 * and {@link jakarta.faces.event.ActionListener ActionListener} for use by page authors.
 * 
 * @since 2.0
 */
public interface AttachedObjectHandler
{
    /**
     * Take the argument parent and apply this attached object to it. The action taken varies
     * with class that implements one of the subinterfaces of this interface.
     * 
     * @param context
     *            The FacesContext for this request
     * @param parent
     *            The UIComponent to which this particular attached object must be applied.
     */
    public void applyAttachedObject(FacesContext context, UIComponent parent);

    /**
     * Return the value of the "for" attribute specified by the page author on the tag for this
     * AttachedObjectHandler.
     * 
     * @return the value of the "for" attribute specified by the page author on the tag for this
     *         AttachedObjectHandler.
     */
    public String getFor();
}