jakarta.faces.component.html.HtmlForm Maven / Gradle / Ivy
Show all versions of jakarta.faces-api 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.UIForm;
import jakarta.faces.component.behavior.ClientBehaviorHolder;
/**
*
* Represents an HTML form element. Child input components will be submitted unless they have been
* disabled.
*
*
* By default, the rendererType property must be set to "jakarta.faces.Form". This value can
* be changed by calling the setRendererType() method.
*
*/
public class HtmlForm extends UIForm implements ClientBehaviorHolder {
public HtmlForm() {
super();
setRendererType("jakarta.faces.Form");
handleAttribute(this, "enctype", "application/x-www-form-urlencoded");
}
/**
*
* The standard component type for this component.
*
*/
public static final String COMPONENT_TYPE = "jakarta.faces.HtmlForm";
/**
* Properties used by this component
*
*/
protected enum PropertyKeys {
accept, acceptcharset, dir, enctype, lang, onclick, ondblclick, onkeydown, onkeypress, onkeyup, onmousedown, onmousemove, onmouseout, onmouseover,
onmouseup, onreset, onsubmit, role, style, styleClass, target, 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 accept property.
*
*
* @return the property value
*
* Contents: List of content types that a server processing this form will handle correctly
*/
public java.lang.String getAccept() {
return (java.lang.String) getStateHelper().eval(PropertyKeys.accept);
}
/**
*
* Set the value of the accept property.
*
*
* @param accept the new property value
*/
public void setAccept(java.lang.String accept) {
getStateHelper().put(PropertyKeys.accept, accept);
handleAttribute(this, "accept", accept);
}
/**
*
* Return the value of the acceptcharset property.
*
*
* @return the property value
*
* Contents: List of character encodings for input data that are accepted by the server processing this form.
*/
public java.lang.String getAcceptcharset() {
return (java.lang.String) getStateHelper().eval(PropertyKeys.acceptcharset);
}
/**
*
* Set the value of the acceptcharset property.
*
*
* @param acceptcharset the new property value
*/
public void setAcceptcharset(java.lang.String acceptcharset) {
getStateHelper().put(PropertyKeys.acceptcharset, acceptcharset);
}
/**
*
* 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 enctype property.
*
*
* @return the property value
*
* Contents: Content type used to submit the form to the server. If not specified, the default value is
* "application/x-www-form-urlencoded".
*/
public java.lang.String getEnctype() {
return (java.lang.String) getStateHelper().eval(PropertyKeys.enctype, "application/x-www-form-urlencoded");
}
/**
*
* Set the value of the enctype property.
*
*
* @param enctype the new property value
*/
public void setEnctype(java.lang.String enctype) {
getStateHelper().put(PropertyKeys.enctype, enctype);
}
/**
*
* 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 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 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 onreset property.
*
*
* @return the property value
*
* Contents: Javascript code executed when this form is reset.
*/
public java.lang.String getOnreset() {
return (java.lang.String) getStateHelper().eval(PropertyKeys.onreset);
}
/**
*
* Set the value of the onreset property.
*
*
* @param onreset the new property value
*/
public void setOnreset(java.lang.String onreset) {
getStateHelper().put(PropertyKeys.onreset, onreset);
handleAttribute(this, "onreset", onreset);
}
/**
*
* Return the value of the onsubmit property.
*
*
* @return the property value
*
* Contents: Javascript code executed when this form is submitted.
*/
public java.lang.String getOnsubmit() {
return (java.lang.String) getStateHelper().eval(PropertyKeys.onsubmit);
}
/**
*
* Set the value of the onsubmit property.
*
*
* @param onsubmit the new property value
*/
public void setOnsubmit(java.lang.String onsubmit) {
getStateHelper().put(PropertyKeys.onsubmit, onsubmit);
handleAttribute(this, "onsubmit", onsubmit);
}
/**
*
* 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 target property.
*
*
* @return the property value
*
* Contents: Name of a frame where the response retrieved after this form submit is to be displayed.
*/
public java.lang.String getTarget() {
return (java.lang.String) getStateHelper().eval(PropertyKeys.target);
}
/**
*
* Set the value of the target property.
*
*
* @param target the new property value
*/
public void setTarget(java.lang.String target) {
getStateHelper().put(PropertyKeys.target, target);
handleAttribute(this, "target", target);
}
/**
*
* 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);
}
private static final Collection EVENT_NAMES = Collections.unmodifiableCollection(
Arrays.asList("click", "dblclick", "keydown", "keypress", "keyup", "mousedown", "mousemove", "mouseout", "mouseover", "mouseup"));
@Override
public Collection getEventNames() {
return EVENT_NAMES;
}
@Override
public String getDefaultEventName() {
return null;
}
}