javax.faces.view.AttachedObjectHandler Maven / Gradle / Ivy
Show all versions of jboss-jsf-api_2.3_spec Show documentation
/*
* Copyright (c) 1997, 2018 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 javax.faces.view;
import javax.faces.component.UIComponent;
import javax.faces.context.FacesContext;
/**
* The
* abstract base interface for a
* handler representing an attached object in a VDL page.
* Subinterfaces are provided for the common attached objects that
* expose {@link javax.faces.component.behavior.Behavior}, {@link
* javax.faces.convert.Converter}s, {@link
* javax.faces.validator.Validator}s, {@link
* javax.faces.event.ValueChangeListener}s, and {@link
* javax.faces.event.ActionListener}s 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 for this attached object
*/
public String getFor();
}