javax.faces.render.FacesRenderer Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.faces.render;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.lang.annotation.Inherited;
/**
* The presence of this annotation on a
* class automatically registers the class with the runtime as a {@link
* Renderer}. The value of the {@link #renderKitId} attribute is taken
* to be the render-kit-id to which an instance of this
* Renderer is to be added. There must be a public
* zero-argument constructor on any class where this annotation appears.
* The implementation must indicate a fatal error if such a constructor
* does not exist and the application must not be placed in service.
* Within that {@link RenderKit}, The value of the {@link #rendererType}
* attribute is taken to be the renderer-type, and the value of
* the {@link #componentFamily} attribute is to be taken as the
* component-family. The implementation must guarantee that
* for each class annotated with FacesRenderer, found with
* the algorithm in section JSF.11.5,
* the following actions are taken.
*
*
* Obtain a reference to the {@link RenderKitFactory} for
* this application.
See if a RenderKit exists for
render-kit-id. If so, let that instance be
renderKit for discussion. If not, the implementation
must indicate a fatal error if such a RenderKit
does not exist and the application must not be placed in
service.
Create an instance of this class using the public
zero-argument constructor.
Call {@link RenderKit#addRenderer} on
renderKit, passing component-family as the
first argument, renderer-type as the second, and the
newly instantiated RenderKit instance as the
third argument.
*
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Inherited
public @interface FacesRenderer {
/**
* The value of this annotation
* attribute is taken to be the render-kit-id in which an
* instance of this class of Renderer must be
* installed.
*
* @return the render-kit-id
*/
String renderKitId() default RenderKitFactory.HTML_BASIC_RENDER_KIT;
/**
* The value of this annotation
* attribute is taken to be the renderer-type which, in
* combination with {@link #componentFamily} can be used to obtain a
* reference to an instance of this {@link Renderer} by calling
* {@link javax.faces.render.RenderKit#getRenderer(java.lang.String,
* java.lang.String)}.
*
* @return the renderer-type
*/
String rendererType();
/**
* The value of this annotation
* attribute is taken to be the component-family which, in
* combination with {@link #rendererType} can be used to obtain a
* reference to an instance of this {@link Renderer} by calling
* {@link javax.faces.render.RenderKit#getRenderer(java.lang.String,
* java.lang.String)}.
*
* @return the component-family
*/
String componentFamily();
}