javax.faces.component.html.HtmlCommandButton Maven / Gradle / Ivy
Show all versions of jsf-api 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.
*/
package javax.faces.component.html;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import javax.faces.context.FacesContext;
import javax.faces.component.behavior.ClientBehaviorHolder;
import javax.el.MethodExpression;
import javax.el.ValueExpression;
/*
* ******* GENERATED CODE - DO NOT EDIT *******
*/
/**
* 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 "javax.faces.Button".
* This value can be changed by calling the setRendererType() method.
*/
public class HtmlCommandButton extends javax.faces.component.UICommand implements ClientBehaviorHolder {
private static final String OPTIMIZED_PACKAGE = "javax.faces.component.";
public HtmlCommandButton() {
super();
setRendererType("javax.faces.Button");
}
/**
* The standard component type for this component.
*/
public static final String COMPONENT_TYPE = "javax.faces.HtmlCommandButton";
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,
style,
styleClass,
tabindex,
title,
type,
;
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.
* 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.
*/
public void setAccesskey(java.lang.String accesskey) {
getStateHelper().put(PropertyKeys.accesskey, accesskey);
handleAttribute("accesskey", accesskey);
}
/**
* Return the value of the alt property.
* 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.
*/
public void setAlt(java.lang.String alt) {
getStateHelper().put(PropertyKeys.alt, alt);
handleAttribute("alt", alt);
}
/**
* 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).
*/
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 disabled property.
* 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.
*/
public void setDisabled(boolean disabled) {
getStateHelper().put(PropertyKeys.disabled, disabled);
}
/**
* Return the value of the image property.
* 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.
*/
public void setImage(java.lang.String image) {
getStateHelper().put(PropertyKeys.image, image);
}
/**
* Return the value of the label property.
* 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.
*/
public void setLabel(java.lang.String label) {
getStateHelper().put(PropertyKeys.label, label);
}
/**
* 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 onblur property.
* 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.
*/
public void setOnblur(java.lang.String onblur) {
getStateHelper().put(PropertyKeys.onblur, onblur);
handleAttribute("onblur", onblur);
}
/**
* Return the value of the onchange property.
* 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.
*/
public void setOnchange(java.lang.String onchange) {
getStateHelper().put(PropertyKeys.onchange, onchange);
handleAttribute("onchange", onchange);
}
/**
* Return the value of the onclick property.
* 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.
*/
public void setOnclick(java.lang.String onclick) {
getStateHelper().put(PropertyKeys.onclick, onclick);
handleAttribute("onclick", onclick);
}
/**
* Return the value of the ondblclick property.
* 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.
*/
public void setOndblclick(java.lang.String ondblclick) {
getStateHelper().put(PropertyKeys.ondblclick, ondblclick);
handleAttribute("ondblclick", ondblclick);
}
/**
* Return the value of the onfocus property.
* 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.
*/
public void setOnfocus(java.lang.String onfocus) {
getStateHelper().put(PropertyKeys.onfocus, onfocus);
handleAttribute("onfocus", onfocus);
}
/**
* Return the value of the onkeydown property.
* 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.
*/
public void setOnkeydown(java.lang.String onkeydown) {
getStateHelper().put(PropertyKeys.onkeydown, onkeydown);
handleAttribute("onkeydown", onkeydown);
}
/**
* Return the value of the onkeypress property.
* 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.
*/
public void setOnkeypress(java.lang.String onkeypress) {
getStateHelper().put(PropertyKeys.onkeypress, onkeypress);
handleAttribute("onkeypress", onkeypress);
}
/**
* Return the value of the onkeyup property.
* 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.
*/
public void setOnkeyup(java.lang.String onkeyup) {
getStateHelper().put(PropertyKeys.onkeyup, onkeyup);
handleAttribute("onkeyup", onkeyup);
}
/**
* Return the value of the onmousedown property.
* 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.
*/
public void setOnmousedown(java.lang.String onmousedown) {
getStateHelper().put(PropertyKeys.onmousedown, onmousedown);
handleAttribute("onmousedown", onmousedown);
}
/**
* Return the value of the onmousemove property.
* 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.
*/
public void setOnmousemove(java.lang.String onmousemove) {
getStateHelper().put(PropertyKeys.onmousemove, onmousemove);
handleAttribute("onmousemove", onmousemove);
}
/**
* Return the value of the onmouseout property.
* 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.
*/
public void setOnmouseout(java.lang.String onmouseout) {
getStateHelper().put(PropertyKeys.onmouseout, onmouseout);
handleAttribute("onmouseout", onmouseout);
}
/**
* Return the value of the onmouseover property.
* 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.
*/
public void setOnmouseover(java.lang.String onmouseover) {
getStateHelper().put(PropertyKeys.onmouseover, onmouseover);
handleAttribute("onmouseover", onmouseover);
}
/**
* Return the value of the onmouseup property.
* 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.
*/
public void setOnmouseup(java.lang.String onmouseup) {
getStateHelper().put(PropertyKeys.onmouseup, onmouseup);
handleAttribute("onmouseup", onmouseup);
}
/**
* Return the value of the onselect property.
* 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.
*/
public void setOnselect(java.lang.String onselect) {
getStateHelper().put(PropertyKeys.onselect, onselect);
handleAttribute("onselect", onselect);
}
/**
* Return the value of the readonly property.
* 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.
*/
public void setReadonly(boolean readonly) {
getStateHelper().put(PropertyKeys.readonly, readonly);
}
/**
* 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 tabindex property.
* 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.
*/
public void setTabindex(java.lang.String tabindex) {
getStateHelper().put(PropertyKeys.tabindex, tabindex);
handleAttribute("tabindex", tabindex);
}
/**
* 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);
}
/**
* Return the value of the type property.
* 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.
*/
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"));
public Collection getEventNames() {
return EVENT_NAMES; }
public String getDefaultEventName() {
return "action"; }
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);
}
}
}
}