All Downloads are FREE. Search and download functionalities are using the official Maven repository.

javax.faces.component.html.HtmlOutputFormat Maven / Gradle / Ivy

Go to download

This is the master POM file for Oracle's Implementation of the JSF 2.2 Specification.

There is a newer version: 2.4.0
Show newest version
/*
 * 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.
 */
package javax.faces.component.html;

import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

import javax.faces.context.FacesContext;
import javax.el.MethodExpression;
import javax.el.ValueExpression;


/*
 * ******* GENERATED CODE - DO NOT EDIT *******
 */


/**
 * 

Represents a component that looks up a localized message in a * resource bundle, optionally uses it as a * MessageFormat pattern string and substitutes in * parameter values from nested UIParameter components, and * renders the result. If the "dir" or "lang" attributes are * present, render a span element and pass them through * as attributes on the span.

*

By default, the rendererType property must be set to "javax.faces.Format". * This value can be changed by calling the setRendererType() method.

*/ public class HtmlOutputFormat extends javax.faces.component.UIOutput { private static final String OPTIMIZED_PACKAGE = "javax.faces.component."; public HtmlOutputFormat() { super(); setRendererType("javax.faces.Format"); } /** *

The standard component type for this component.

*/ public static final String COMPONENT_TYPE = "javax.faces.HtmlOutputFormat"; protected enum PropertyKeys { dir, escape, lang, role, style, styleClass, title, ; String toString; PropertyKeys(String toString) { this.toString = toString; } PropertyKeys() { } public String toString() { return ((toString != null) ? toString : super.toString()); } } /** *

Return the value of the dir property.

*

Contents: Direction indication for text that does not inherit directionality. * Valid values are "LTR" (left-to-right) and "RTL" (right-to-left). * These attributes are case sensitive when rendering to XHTML, so * care must be taken to have the correct case. */ public java.lang.String getDir() { return (java.lang.String) getStateHelper().eval(PropertyKeys.dir); } /** *

Set the value of the dir property.

*/ public void setDir(java.lang.String dir) { getStateHelper().put(PropertyKeys.dir, dir); handleAttribute("dir", dir); } /** *

Return the value of the escape property.

*

Contents: Flag indicating that characters that are sensitive * in HTML and XML markup must be escaped. This flag * is set to "true" by default. */ public boolean isEscape() { return (java.lang.Boolean) getStateHelper().eval(PropertyKeys.escape, true); } /** *

Set the value of the escape property.

*/ public void setEscape(boolean escape) { getStateHelper().put(PropertyKeys.escape, escape); } /** *

Return the value of the lang property.

*

Contents: Code describing the language used in the generated markup * for this component. */ public java.lang.String getLang() { return (java.lang.String) getStateHelper().eval(PropertyKeys.lang); } /** *

Set the value of the lang property.

*/ public void setLang(java.lang.String lang) { getStateHelper().put(PropertyKeys.lang, lang); handleAttribute("lang", lang); } /** *

Return the value of the role property.

*

Contents:

Per the WAI-ARIA spec and its * relationship to HTML5 (Section title ARIA Role Attriubute), * every HTML element may have a "role" attribute whose value * must be passed through unmodified on the element on which it * is declared in the final rendered markup. The attribute, if * specified, must have a value that is a string literal that is, * or an EL Expression that evaluates to, a set of * space-separated tokens representing the various WAI-ARIA roles * that the element belongs to. *

* *

It is the page author's * responsibility to ensure that the user agent is capable of * correctly interpreting the value of this attribute.

*/ public java.lang.String getRole() { return (java.lang.String) getStateHelper().eval(PropertyKeys.role); } /** *

Set the value of the role property.

*/ public void setRole(java.lang.String role) { getStateHelper().put(PropertyKeys.role, role); handleAttribute("role", role); } /** *

Return the value of the style property.

*

Contents: CSS style(s) to be applied when this component is rendered. */ public java.lang.String getStyle() { return (java.lang.String) getStateHelper().eval(PropertyKeys.style); } /** *

Set the value of the style property.

*/ public void setStyle(java.lang.String style) { getStateHelper().put(PropertyKeys.style, style); handleAttribute("style", style); } /** *

Return the value of the styleClass property.

*

Contents: Space-separated list of CSS style class(es) to be applied when * this element is rendered. This value must be passed through * as the "class" attribute on generated markup. */ public java.lang.String getStyleClass() { return (java.lang.String) getStateHelper().eval(PropertyKeys.styleClass); } /** *

Set the value of the styleClass property.

*/ public void setStyleClass(java.lang.String styleClass) { getStateHelper().put(PropertyKeys.styleClass, styleClass); } /** *

Return the value of the title property.

*

Contents: Advisory title information about markup elements generated * for this component. */ public java.lang.String getTitle() { return (java.lang.String) getStateHelper().eval(PropertyKeys.title); } /** *

Set the value of the title property.

*/ public void setTitle(java.lang.String title) { getStateHelper().put(PropertyKeys.title, title); handleAttribute("title", title); } private void handleAttribute(String name, Object value) { List setAttributes = (List) this.getAttributes().get("javax.faces.component.UIComponentBase.attributesThatAreSet"); if (setAttributes == null) { String cname = this.getClass().getName(); if (cname != null && cname.startsWith(OPTIMIZED_PACKAGE)) { setAttributes = new ArrayList(6); this.getAttributes().put("javax.faces.component.UIComponentBase.attributesThatAreSet", setAttributes); } } if (setAttributes != null) { if (value == null) { ValueExpression ve = getValueExpression(name); if (ve == null) { setAttributes.remove(name); } } else if (!setAttributes.contains(name)) { setAttributes.add(name); } } } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy