jakarta.faces.component.html.HtmlCommandButton 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 java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import jakarta.faces.component.UICommand;
import jakarta.faces.component.behavior.ClientBehaviorHolder;
/**
*
* Represents an HTML input element for a button of type submit or reset. The
* label text is specified by the component value.
*
*
* By default, the rendererType property must be set to "jakarta.faces.Button". This value can
* be changed by calling the setRendererType() method.
*
*/
public class HtmlCommandButton extends UICommand implements ClientBehaviorHolder {
public HtmlCommandButton() {
super();
setRendererType("jakarta.faces.Button");
}
/**
*
* The standard component type for this component.
*
*/
public static final String COMPONENT_TYPE = "jakarta.faces.HtmlCommandButton";
/**
* Properties used by this component
*
*/
protected enum PropertyKeys {
accesskey, alt, dir, disabled, image, label, lang, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onmousedown,
onmousemove, onmouseout, onmouseover, onmouseup, onselect, readonly, role, style, styleClass, tabindex, title, type,;
String toString;
PropertyKeys(String toString) {
this.toString = toString;
}
PropertyKeys() {
}
@Override
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 String getAccesskey() {
return (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(this, "accesskey", accesskey);
}
/**
*
* Return the value of the alt property.
* This attribute is ignored when the image attribute is not specified.
*
*
* @return the property value
*
* Contents: Alternate textual description of the element rendered by this component.
*/
public java.lang.String getAlt() {
return (java.lang.String) getStateHelper().eval(PropertyKeys.alt);
}
/**
*
* Set the value of the alt property.
*
*
* @param alt the new property value
*/
public void setAlt(java.lang.String alt) {
getStateHelper().put(PropertyKeys.alt, alt);
handleAttribute(this, "alt", alt);
}
/**
*
* 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 String getDir() {
return (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 disabled property.
*
*
* @return the property value
*
* Contents: Flag indicating that this element must never receive focus or be included in a subsequent submit. A value
* of false causes no attribute to be rendered, while a value of true causes the attribute to be rendered as
* disabled="disabled".
*/
public boolean isDisabled() {
return (java.lang.Boolean) getStateHelper().eval(PropertyKeys.disabled, false);
}
/**
*
* Set the value of the disabled property.
*
*
* @param disabled the new property value
*/
public void setDisabled(boolean disabled) {
getStateHelper().put(PropertyKeys.disabled, disabled);
}
/**
*
* Return the value of the image property.
*
*
* @return the property value
*
* Contents:
*
* Absolute or relative URL of the image to be displayed for this button. If specified, this "input" element will be of
* type "image". Otherwise, it will be of the type specified by the "type" property with a label specified by the
* "value" property. Note that if the value of this attribute starts with "/", the
* rendered value for this attribute will be prefixed with the context-root for this application.
*
*/
public java.lang.String getImage() {
return (java.lang.String) getStateHelper().eval(PropertyKeys.image);
}
/**
*
* Set the value of the image property.
*
*
* @param image the new property value
*/
public void setImage(java.lang.String image) {
getStateHelper().put(PropertyKeys.image, image);
}
/**
*
* Return the value of the label property.
*
*
* @return the property value
*
* Contents: A localized user presentable name for this component.
*/
public java.lang.String getLabel() {
return (java.lang.String) getStateHelper().eval(PropertyKeys.label);
}
/**
*
* Set the value of the label property.
*
*
* @param label the new property value
*/
public void setLabel(java.lang.String label) {
getStateHelper().put(PropertyKeys.label, label);
}
/**
*
* 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 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(this, "onblur", onblur);
}
/**
*
* Return the value of the onchange property.
*
*
* @return the property value
*
* Contents: Javascript code executed when this element loses focus and its value has been modified since gaining focus.
*/
public java.lang.String getOnchange() {
return (java.lang.String) getStateHelper().eval(PropertyKeys.onchange);
}
/**
*
* Set the value of the onchange property.
*
*
* @param onchange the new property value
*/
public void setOnchange(java.lang.String onchange) {
getStateHelper().put(PropertyKeys.onchange, onchange);
handleAttribute(this, "onchange", onchange);
}
/**
*
* 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(this, "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(this, "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(this, "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(this, "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(this, "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(this, "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(this, "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(this, "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(this, "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(this, "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(this, "onmouseup", onmouseup);
}
/**
*
* Return the value of the onselect property.
*
*
* @return the property value
*
* Contents: Javascript code executed when text within this element is selected by the user.
*/
public java.lang.String getOnselect() {
return (java.lang.String) getStateHelper().eval(PropertyKeys.onselect);
}
/**
*
* Set the value of the onselect property.
*
*
* @param onselect the new property value
*/
public void setOnselect(java.lang.String onselect) {
getStateHelper().put(PropertyKeys.onselect, onselect);
handleAttribute(this, "onselect", onselect);
}
/**
*
* Return the value of the readonly property.
*
*
* @return the property value
*
* Contents: Flag indicating that this component will prohibit changes by the user. The element may receive focus unless
* it has also been disabled. A value of false causes no attribute to be rendered, while a value of true causes the
* attribute to be rendered as readonly="readonly".
*/
public boolean isReadonly() {
return (java.lang.Boolean) getStateHelper().eval(PropertyKeys.readonly, false);
}
/**
*
* Set the value of the readonly property.
*
*
* @param readonly the new property value
*/
public void setReadonly(boolean readonly) {
getStateHelper().put(PropertyKeys.readonly, readonly);
}
/**
*
* 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 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(this, "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(this, "title", title);
}
/**
*
* Return the value of the type property.
*
*
* @return the property value
*
* Contents: Type of button to create. Valid values are "submit", "button", and "reset". If not specified, or not a
* valid value, the default value is "submit".
*/
public java.lang.String getType() {
return (java.lang.String) getStateHelper().eval(PropertyKeys.type, "submit");
}
/**
*
* Set the value of the type property.
*
*
* @param type the new property value
*/
public void setType(java.lang.String type) {
getStateHelper().put(PropertyKeys.type, type);
}
private static final Collection EVENT_NAMES = Collections.unmodifiableCollection(Arrays.asList("blur", "change", "click", "action", "dblclick",
"focus", "keydown", "keypress", "keyup", "mousedown", "mousemove", "mouseout", "mouseover", "mouseup", "select"));
@Override
public Collection getEventNames() {
return EVENT_NAMES;
}
@Override
public String getDefaultEventName() {
return "action";
}
}