jakarta.faces.component.html.HtmlOutputFormat Maven / Gradle / Ivy
Show all versions of jakarta.faces Show documentation
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997, 2020 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 jakarta.faces.component.html;
import static jakarta.faces.component.html.HtmlComponentUtils.handleAttribute;
import jakarta.faces.component.UIOutput;
/**
*
* 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 "jakarta.faces.Format". This value can
* be changed by calling the setRendererType() method.
*
*/
public class HtmlOutputFormat extends UIOutput {
public HtmlOutputFormat() {
super();
setRendererType("jakarta.faces.Format");
}
/**
*
* The standard component type for this component.
*
*/
public static final String COMPONENT_TYPE = "jakarta.faces.HtmlOutputFormat";
/**
* The property keys.
*/
protected enum PropertyKeys {
dir, escape, lang, role, style, styleClass, title,;
String toString;
PropertyKeys(String toString) {
this.toString = toString;
}
PropertyKeys() {
}
@Override
public String toString() {
return toString != null ? toString : super.toString();
}
}
/**
*
* Return the value of the dir property.
*
*
* @return the property value
*
* 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.
*
*
* @param dir the new property value
*/
public void setDir(java.lang.String dir) {
getStateHelper().put(PropertyKeys.dir, dir);
handleAttribute(this, "dir", dir);
}
/**
*
* Return the value of the escape property.
*
*
* @return the property value
*
* 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.
*
*
* @param escape the new property value
*/
public void setEscape(boolean escape) {
getStateHelper().put(PropertyKeys.escape, escape);
}
/**
*
* Return the value of the lang property.
*
*
* @return the property value
*
* 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.
*
*
* @param lang the new property value
*/
public void setLang(java.lang.String lang) {
getStateHelper().put(PropertyKeys.lang, lang);
handleAttribute(this, "lang", lang);
}
/**
*
* Return the value of the role property.
*
*
* @return the property value
*
* 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.
*
*
* @param role the new property value
*/
public void setRole(java.lang.String role) {
getStateHelper().put(PropertyKeys.role, role);
handleAttribute(this, "role", role);
}
/**
*
* Return the value of the style property.
*
*
* @return the property value
*
* 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.
*
*
* @param style the new property value
*/
public void setStyle(java.lang.String style) {
getStateHelper().put(PropertyKeys.style, style);
handleAttribute(this, "style", style);
}
/**
*
* Return the value of the styleClass property.
*
*
* @return the property value
*
* 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.
*
*
* @param styleClass the new property value
*/
public void setStyleClass(java.lang.String styleClass) {
getStateHelper().put(PropertyKeys.styleClass, styleClass);
}
/**
*
* Return the value of the title property.
*
*
* @return the property value
*
* 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.
*
*
* @param title the new property value
*/
public void setTitle(java.lang.String title) {
getStateHelper().put(PropertyKeys.title, title);
handleAttribute(this, "title", title);
}
}