javax.faces.component.html.HtmlOutputLabel Maven / Gradle / Ivy
Show all versions of jboss-jsf-api_2.3_spec Show documentation
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997, 2018 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 javax.faces.component.html;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import javax.faces.component.behavior.ClientBehaviorHolder;
import javax.el.ValueExpression;
import javax.faces.component.UIOutput;
/**
* Represents an HTML label element, used to define
* an accessible label for a corresponding input element.
* By default, the rendererType property must be set to "javax.faces.Label".
* This value can be changed by calling the setRendererType() method.
*/
public class HtmlOutputLabel extends UIOutput implements ClientBehaviorHolder {
private static final String OPTIMIZED_PACKAGE = "javax.faces.component.";
public HtmlOutputLabel() {
super();
setRendererType("javax.faces.Label");
}
/**
* The standard component type for this component.
*/
public static final String COMPONENT_TYPE = "javax.faces.HtmlOutputLabel";
protected enum PropertyKeys {
accesskey,
dir,
escape,
forVal("for"),
lang,
onblur,
onclick,
ondblclick,
onfocus,
onkeydown,
onkeypress,
onkeyup,
onmousedown,
onmousemove,
onmouseout,
onmouseover,
onmouseup,
role,
style,
styleClass,
tabindex,
title,
;
String toString;
PropertyKeys(String toString) { this.toString = toString; }
PropertyKeys() { }
public String toString() {
return ((toString != null) ? toString : super.toString());
}
}
/**
* Return the value of the accesskey property.
* @return the property value
* Contents: Access key that, when pressed, transfers focus
* to this element.
*/
public java.lang.String getAccesskey() {
return (java.lang.String) getStateHelper().eval(PropertyKeys.accesskey);
}
/**
*
Set the value of the accesskey property.
* @param accesskey the new property value
*/
public void setAccesskey(java.lang.String accesskey) {
getStateHelper().put(PropertyKeys.accesskey, accesskey);
handleAttribute("accesskey", accesskey);
}
/**
* 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("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. If omitted, this
* flag is assumed to be "true".
*/
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 for property.
* @return the property value
* Contents:
Search expression to the component
* for which this element is a label.
*/
public java.lang.String getFor() {
return (java.lang.String) getStateHelper().eval(PropertyKeys.forVal);
}
/**
* Set the value of the for property.
* @param _for the new property value
*/
public void setFor(java.lang.String _for) {
getStateHelper().put(PropertyKeys.forVal, _for);
}
/**
* 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("lang", lang);
}
/**
* Return the value of the onblur property.
* @return the property value
* Contents: Javascript code executed when this element loses focus.
*/
public java.lang.String getOnblur() {
return (java.lang.String) getStateHelper().eval(PropertyKeys.onblur);
}
/**
*
Set the value of the onblur property.
* @param onblur the new property value
*/
public void setOnblur(java.lang.String onblur) {
getStateHelper().put(PropertyKeys.onblur, onblur);
handleAttribute("onblur", onblur);
}
/**
* Return the value of the onclick property.
* @return the property value
* Contents: Javascript code executed when a pointer button is
* clicked over this element.
*/
public java.lang.String getOnclick() {
return (java.lang.String) getStateHelper().eval(PropertyKeys.onclick);
}
/**
*
Set the value of the onclick property.
* @param onclick the new property value
*/
public void setOnclick(java.lang.String onclick) {
getStateHelper().put(PropertyKeys.onclick, onclick);
handleAttribute("onclick", onclick);
}
/**
* Return the value of the ondblclick property.
* @return the property value
* Contents: Javascript code executed when a pointer button is
* double clicked over this element.
*/
public java.lang.String getOndblclick() {
return (java.lang.String) getStateHelper().eval(PropertyKeys.ondblclick);
}
/**
*
Set the value of the ondblclick property.
* @param ondblclick the new property value
*/
public void setOndblclick(java.lang.String ondblclick) {
getStateHelper().put(PropertyKeys.ondblclick, ondblclick);
handleAttribute("ondblclick", ondblclick);
}
/**
* Return the value of the onfocus property.
* @return the property value
* Contents: Javascript code executed when this element receives focus.
*/
public java.lang.String getOnfocus() {
return (java.lang.String) getStateHelper().eval(PropertyKeys.onfocus);
}
/**
*
Set the value of the onfocus property.
* @param onfocus the new property value
*/
public void setOnfocus(java.lang.String onfocus) {
getStateHelper().put(PropertyKeys.onfocus, onfocus);
handleAttribute("onfocus", onfocus);
}
/**
* Return the value of the onkeydown property.
* @return the property value
* Contents: Javascript code executed when a key is
* pressed down over this element.
*/
public java.lang.String getOnkeydown() {
return (java.lang.String) getStateHelper().eval(PropertyKeys.onkeydown);
}
/**
*
Set the value of the onkeydown property.
* @param onkeydown the new property value
*/
public void setOnkeydown(java.lang.String onkeydown) {
getStateHelper().put(PropertyKeys.onkeydown, onkeydown);
handleAttribute("onkeydown", onkeydown);
}
/**
* Return the value of the onkeypress property.
* @return the property value
* Contents: Javascript code executed when a key is
* pressed and released over this element.
*/
public java.lang.String getOnkeypress() {
return (java.lang.String) getStateHelper().eval(PropertyKeys.onkeypress);
}
/**
*
Set the value of the onkeypress property.
* @param onkeypress the new property value
*/
public void setOnkeypress(java.lang.String onkeypress) {
getStateHelper().put(PropertyKeys.onkeypress, onkeypress);
handleAttribute("onkeypress", onkeypress);
}
/**
* Return the value of the onkeyup property.
* @return the property value
* Contents: Javascript code executed when a key is
* released over this element.
*/
public java.lang.String getOnkeyup() {
return (java.lang.String) getStateHelper().eval(PropertyKeys.onkeyup);
}
/**
*
Set the value of the onkeyup property.
* @param onkeyup the new property value
*/
public void setOnkeyup(java.lang.String onkeyup) {
getStateHelper().put(PropertyKeys.onkeyup, onkeyup);
handleAttribute("onkeyup", onkeyup);
}
/**
* Return the value of the onmousedown property.
* @return the property value
* Contents: Javascript code executed when a pointer button is
* pressed down over this element.
*/
public java.lang.String getOnmousedown() {
return (java.lang.String) getStateHelper().eval(PropertyKeys.onmousedown);
}
/**
*
Set the value of the onmousedown property.
* @param onmousedown the new property value
*/
public void setOnmousedown(java.lang.String onmousedown) {
getStateHelper().put(PropertyKeys.onmousedown, onmousedown);
handleAttribute("onmousedown", onmousedown);
}
/**
* Return the value of the onmousemove property.
* @return the property value
* Contents: Javascript code executed when a pointer button is
* moved within this element.
*/
public java.lang.String getOnmousemove() {
return (java.lang.String) getStateHelper().eval(PropertyKeys.onmousemove);
}
/**
*
Set the value of the onmousemove property.
* @param onmousemove the new property value
*/
public void setOnmousemove(java.lang.String onmousemove) {
getStateHelper().put(PropertyKeys.onmousemove, onmousemove);
handleAttribute("onmousemove", onmousemove);
}
/**
* Return the value of the onmouseout property.
* @return the property value
* Contents: Javascript code executed when a pointer button is
* moved away from this element.
*/
public java.lang.String getOnmouseout() {
return (java.lang.String) getStateHelper().eval(PropertyKeys.onmouseout);
}
/**
*
Set the value of the onmouseout property.
* @param onmouseout the new property value
*/
public void setOnmouseout(java.lang.String onmouseout) {
getStateHelper().put(PropertyKeys.onmouseout, onmouseout);
handleAttribute("onmouseout", onmouseout);
}
/**
* Return the value of the onmouseover property.
* @return the property value
* Contents: Javascript code executed when a pointer button is
* moved onto this element.
*/
public java.lang.String getOnmouseover() {
return (java.lang.String) getStateHelper().eval(PropertyKeys.onmouseover);
}
/**
*
Set the value of the onmouseover property.
* @param onmouseover the new property value
*/
public void setOnmouseover(java.lang.String onmouseover) {
getStateHelper().put(PropertyKeys.onmouseover, onmouseover);
handleAttribute("onmouseover", onmouseover);
}
/**
* Return the value of the onmouseup property.
* @return the property value
* Contents: Javascript code executed when a pointer button is
* released over this element.
*/
public java.lang.String getOnmouseup() {
return (java.lang.String) getStateHelper().eval(PropertyKeys.onmouseup);
}
/**
*
Set the value of the onmouseup property.
* @param onmouseup the new property value
*/
public void setOnmouseup(java.lang.String onmouseup) {
getStateHelper().put(PropertyKeys.onmouseup, onmouseup);
handleAttribute("onmouseup", onmouseup);
}
/**
* 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("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("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 tabindex property.
* @return the property value
* Contents: Position of this element in the tabbing order
* for the current document. This value must be
* an integer between 0 and 32767.
*/
public java.lang.String getTabindex() {
return (java.lang.String) getStateHelper().eval(PropertyKeys.tabindex);
}
/**
*
Set the value of the tabindex property.
* @param tabindex the new property value
*/
public void setTabindex(java.lang.String tabindex) {
getStateHelper().put(PropertyKeys.tabindex, tabindex);
handleAttribute("tabindex", tabindex);
}
/**
* 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("title", title);
}
private static final Collection EVENT_NAMES = Collections.unmodifiableCollection(Arrays.asList("blur","click","dblclick","focus","keydown","keypress","keyup","mousedown","mousemove","mouseout","mouseover","mouseup"));
public Collection getEventNames() {
return EVENT_NAMES; }
public String getDefaultEventName() {
return null; }
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);
}
}
}
}