javax.faces.webapp.UIComponentTagBase 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.webapp;
import javax.el.ELContext;
import javax.faces.component.UIComponent;
import javax.faces.context.FacesContext;
import javax.servlet.jsp.tagext.JspTag;
import java.util.logging.Logger;
/**
* UIComponentTagBase is the base class
* for all JSP tags that correspond to a {@link
* javax.faces.component.UIComponent} instance in the view. This base
* class allows a single view to be described in a JSP page consisting
* of both {@link UIComponentELTag} and {@link UIComponentTag}
* instances.
*/
public abstract class UIComponentTagBase extends Object implements JspTag {
protected static final Logger log = Logger.getLogger("javax.faces.webapp",
"javax.faces.LogStrings");
/**
* Return the {@link FacesContext} instance for the current
* request. This value will be non-null only from the
* beginning of doStartTag() through the end of
* doEndTag() for each tag instance.
*
* @return the {@code FacesContext} for the current request.
*/
protected abstract FacesContext getFacesContext();
/**
* Return the {@link ELContext} for the {@link FacesContext} for
* this request.
*
* This is a convenience for
* getFacesContext().getELContext().
*
* @return the {code ELContext} for this {@code FacesContext}
*/
protected ELContext getELContext() {
FacesContext fc = getFacesContext();
ELContext result = null;
if (null != fc) {
result = fc.getELContext();
}
return result;
}
/**
* Add the component identifier of the specified {@link UIComponent}
* to the list of component identifiers created or located by nested
* {@link UIComponentTag}s processing this request.
*
* @param child New child whose identifier should be added
*/
protected abstract void addChild(UIComponent child);
/**
* Add the facet name of the specified facet to the list of
* facet names created or located by nested {@link UIComponentTag}s
* processing this request.
*
* @param name Facet name to be added
*/
protected abstract void addFacet(String name);
/**
* Set the component identifier for the component corresponding
* to this tag instance. If the argument begins with {@link
* javax.faces.component.UIViewRoot#UNIQUE_ID_PREFIX} throw an
* IllegalArgumentException
*
* @param id The new component identifier. This may not start with
* {@link javax.faces.component.UIViewRoot#UNIQUE_ID_PREFIX}.
*
* @throws IllegalArgumentException if the argument is
* non-null and starts with {@link
* javax.faces.component.UIViewRoot#UNIQUE_ID_PREFIX}.
*/
public abstract void setId(String id);
/**
* Return the component type for the component that is or will be
* bound to this tag. This value can be passed to
* {@link javax.faces.application.Application#createComponent} to create
* the {@link UIComponent} instance for this tag. Subclasses must
* override this method to return the appropriate value.
*
* @return the component type
*/
public abstract String getComponentType();
/**
* Return the rendererType property that selects the
* Renderer to be used for encoding this component, or
* null to ask the component to render itself directly.
* Subclasses must override this method to return the appropriate value.
*
*
* @return the renderer type
*/
public abstract String getRendererType();
/**
* Return the {@link UIComponent} instance that is associated with
* this tag instance. This method is designed to be used by tags nested
* within this tag, and only returns useful results between the
* execution of doStartTag() and doEndTag()
* on this tag instance.
*
* @return the component
*/
public abstract UIComponent getComponentInstance();
/**
* Return true if we dynamically created a new component
* instance during execution of this tag. This method is designed to be
* used by tags nested within this tag, and only returns useful results
* between the execution of doStartTag() and
* doEndTag() on this tag instance.
*
* @return the result as specified above
*/
public abstract boolean getCreated();
/**
* Return the index of the next child to be added as a child of
* this tag. The default implementation maintains a list of created
* components and returns the size of the list.
*
* @return the index
*/
protected abstract int getIndexOfNextChildTag();
}