public class HtmlCommandScript extends UICommand
Represents an HTML script element for a function that acts like an ajax form submit. This component must
be placed inside a form, and requires JavaScript to be enabled in the client.
By default, the rendererType property must be set to "jakarta.faces.Script". This value can
be changed by calling the setRendererType() method.
| Modifier and Type | Class and Description |
|---|---|
protected static class |
HtmlCommandScript.PropertyKeys
The property keys.
|
| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
COMPONENT_TYPE
The standard component type for this component.
|
COMPONENT_FAMILYATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEY| Constructor and Description |
|---|
HtmlCommandScript() |
| Modifier and Type | Method and Description |
|---|---|
java.lang.String |
getExecute()
Return the value of the
execute property. |
java.lang.String |
getName()
Return the value of the
name property. |
java.lang.String |
getOnerror()
Return the value of the
onerror property. |
java.lang.String |
getOnevent()
Return the value of the
onevent property. |
java.lang.String |
getRender()
Return the value of the
render property. |
java.lang.Boolean |
getResetValues()
Return the value of the
resetValues property. |
boolean |
isAutorun()
Return the value of the
autorun property. |
void |
setAutorun(boolean autorun)
Set the value of the
autorun property. |
void |
setExecute(java.lang.String execute)
Set the value of the
execute property. |
void |
setName(java.lang.String name)
Set the value of the
name property. |
void |
setOnerror(java.lang.String onerror)
Set the value of the
onerror property. |
void |
setOnevent(java.lang.String onevent)
Set the value of the
onevent property. |
void |
setRender(java.lang.String render)
Set the value of the
render property. |
void |
setResetValues(java.lang.Boolean resetValues)
Set the value of the
resetValues property. |
addActionListener, broadcast, getActionExpression, getActionListeners, getFamily, getValue, isImmediate, queueEvent, removeActionListener, setActionExpression, setImmediate, setValueaddClientBehavior, addFacesListener, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, subscribeToEvent, unsubscribeFromEventencodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTreepublic static final java.lang.String COMPONENT_TYPE
The standard component type for this component.
public boolean isAutorun()
Return the value of the autorun property.
Contents: Whether to execute declared JavaScript function during load event of the window.
Defaults to false.
public void setAutorun(boolean autorun)
Set the value of the autorun property.
autorun - the new property valuepublic java.lang.String getExecute()
Return the value of the execute property.
Contents: This is a space separated list of client identifiers of components that will participate in the "execute"
portion of the Request Processing Lifecycle. If a literal is specified the identifiers must be space delimited. Any
of the keywords "@this", "@form", "@all", "@none" may be specified in the identifier list. If not specified, the
default value of "@this" is assumed. For example, @this clientIdOne clientIdTwo.
public void setExecute(java.lang.String execute)
Set the value of the execute property.
execute - the new property valuepublic java.lang.String getName()
Return the value of the name property.
Contents: Name of JavaScript function to be declared, e.g. name="functionName". This can be a namespaced
function name, e.g. name="ez.functionName".
public void setName(java.lang.String name)
Set the value of the name property.
name - the new property valuepublic java.lang.String getOnerror()
Return the value of the onerror property.
Contents: The name of the JavaScript function that will handle errors.
public void setOnerror(java.lang.String onerror)
Set the value of the onerror property.
onerror - the new property valuepublic java.lang.String getOnevent()
Return the value of the onevent property.
Contents: The name of the JavaScript function that will handle UI events.
public void setOnevent(java.lang.String onevent)
Set the value of the onevent property.
onevent - the new property valuepublic java.lang.String getRender()
Return the value of the render property.
Contents: This is a space separated list of client identifiers of components that will participate in the "render"
portion of the Request Processing Lifecycle. If a literal is specified the identifiers must be space delimited. Any
of the keywords "@this", "@form", "@all", "@none" may be specified in the identifier list. If not specified, the
default value of "@none" is assumed. For example, @this clientIdOne clientIdTwo.
public void setRender(java.lang.String render)
Set the value of the render property.
render - the new property valuepublic java.lang.Boolean getResetValues()
Return the value of the resetValues property.
Contents: Reset specific input values. Interpret the value of the render attribute as a space separated
list of client identifiers suitable for passing directly to UIViewRoot.resetValues(). The implementation
must cause an ActionListener to be attached to the ActionSource component in which this tag
is nested that calls UIViewRoot.resetValues() passing the value of the render attribute as
the argument.
public void setResetValues(java.lang.Boolean resetValues)
Set the value of the resetValues property.
resetValues - the new property value