com.sun.faces.renderkit.html_basic.LabelRenderer Maven / Gradle / Ivy
Show all versions of javax.faces Show documentation
/*
* 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.dev.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.
*/
// LabelRenderer.java
package com.sun.faces.renderkit.html_basic;
import java.io.IOException;
import java.util.logging.Level;
import javax.faces.component.NamingContainer;
import javax.faces.component.UIComponent;
import javax.faces.component.UINamingContainer;
import javax.faces.context.FacesContext;
import javax.faces.context.ResponseWriter;
import com.sun.faces.renderkit.Attribute;
import com.sun.faces.renderkit.AttributeManager;
import com.sun.faces.renderkit.RenderKitUtils;
/** LabelRenderer renders Label element.
. */
public class LabelRenderer extends HtmlBasicInputRenderer {
private static final Attribute[] ATTRIBUTES =
AttributeManager.getAttributes(AttributeManager.Key.OUTPUTLABEL);
private static final String RENDER_END_ELEMENT =
"com.sun.faces.RENDER_END_ELEMENT";
// ---------------------------------------------------------- Public Methods
@Override
public void encodeBegin(FacesContext context, UIComponent component)
throws IOException {
rendererParamsNotNull(context, component);
if (!shouldEncode(component)) {
return;
}
ResponseWriter writer = context.getResponseWriter();
assert(writer != null);
String forClientId = null;
String forValue = (String) component.getAttributes().get("for");
if (forValue != null) {
forValue = augmentIdReference(forValue, component);
UIComponent forComponent = getForComponent(context, forValue, component);
if (forComponent == null) {
// it could that the component hasn't been created yet. So
// construct the clientId for component.
forClientId = getForComponentClientId(component, context,
forValue);
} else {
forClientId = forComponent.getClientId(context);
}
}
// set a temporary attribute on the component to indicate that
// label end element needs to be rendered.
component.getAttributes().put(RENDER_END_ELEMENT, "yes");
writer.startElement("label", component);
writeIdAttributeIfNecessary(context, writer, component);
if (forClientId != null) {
writer.writeAttribute("for", forClientId, "for");
}
RenderKitUtils.renderPassThruAttributes(context,
writer,
component,
ATTRIBUTES);
String styleClass = (String)
component.getAttributes().get("styleClass");
if (null != styleClass) {
writer.writeAttribute("class", styleClass, "styleClass");
}
// render the curentValue as label text if specified.
String value = getCurrentValue(context, component);
if (logger.isLoggable(Level.FINE)) {
logger.fine("Value to be rendered " + value);
}
if (value != null && value.length() != 0) {
Object val = component.getAttributes().get("escape");
boolean escape = (val != null) && Boolean.valueOf(val.toString());
if (escape) {
writer.writeText(value, component, "value");
} else {
writer.write(value);
}
}
writer.flush();
}
@Override
public void encodeEnd(FacesContext context, UIComponent component)
throws IOException {
rendererParamsNotNull(context, component);
if (!shouldEncode(component)) {
return;
}
// render label end element if RENDER_END_ELEMENT is set.
String render = (String) component.getAttributes().get(
RENDER_END_ELEMENT);
if ("yes".equals(render)) {
component.getAttributes().remove(RENDER_END_ELEMENT);
ResponseWriter writer = context.getResponseWriter();
assert(writer != null);
writer.endElement("label");
}
}
// ------------------------------------------------------- Private Methods
/**
* Builds and returns the clientId of the component that is
* represented by the forValue. Since the component has not been created
* yet, invoking getClientId(context) is not possible.
*
* @param component UIComponent that represents the label
* @param context FacesContext for this request
* @param forValue String representing the "id" of the component
* that this label represents.
*
* @return String clientId of the component represented by the forValue.
*/
protected String getForComponentClientId(UIComponent component,
FacesContext context,
String forValue) {
String result = null;
// ASSUMPTION: The component for which this acts as the label
// as well ths label component are part of the same form.
// locate the nearest NamingContainer and get its clientId.
UIComponent parent = component.getParent();
while (parent != null) {
if (parent instanceof NamingContainer) {
break;
}
parent = parent.getParent();
}
if (parent == null) {
return result;
}
String parentClientId = parent.getClientId(context);
// prepend the clientId of the nearest container to the forValue.
result = parentClientId + UINamingContainer.getSeparatorChar(context) + forValue;
return result;
}
// The testcase for this class is TestRenderResponsePhase.java
} // end of class LabelRenderer