Controls Documentation

Controls  Complex Types  Show Hierarchies  Show Full Hierarchies 

Control: xp:form

Description

A control that groups data that should be submitted together. This control is added to pages automatically.

Properties

• <xp:form
• accessibility
• title
• basics
• accept
• acceptcharset
• autocomplete
• binding
• dir
• enctype
• id
• lang
• loaded
• nestedForm
• rendered
• rendererType
• target
• dojo
• dojoAttributes
• dojoType
• events
• onclick
• ondblclick
• onkeydown
• onkeypress
• onkeyup
• onmousedown
• onmousemove
• onmouseout
• onmouseover
• onmouseup
• onreset
• onsubmit
• styling
• disableTheme
• style
• styleClass
• themeId
• />

Java

Java Class: com.ibm.xsp.component.xp.XspForm

accessibility

title, string Advisory Title Provides title information for controls. Required Attribute false Localizable true Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

basics

binding, object - javax.faces.component.UIComponent  [Inherited] Control Binding Specifies an expression that binds the control to a particular control property. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding false

loaded, boolean  [Inherited] Loaded Specifies whether or not the control should be created when the page is loaded. Value defaults to 'true'. Required Attribute false Localizable false Allow Runtime Binding false Allow Load Time Binding true Allow Non Binding true

id, string  [Inherited] Control Identifier Specifies the name identifier for the control. No two controls can have the same name identifier in a single page. Required Attribute false Localizable false Allow Runtime Binding false Allow Load Time Binding true Allow Non Binding true

rendered, boolean  [Inherited] Rendered Flag Indicates whether or not the control should be displayed or processed on any subsequent form submission. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

rendererType, string  [Inherited] Renderer Type Identifies (with the "family" defined by the control) an appropriate renderer to encode and decode this control Required Attribute false Localizable false Allow Runtime Binding false Allow Load Time Binding true Allow Non Binding true

autocomplete, string  [Inherited] Automatically Complete Disables the browser automatically complete feature for this control when set to "off" Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

enctype, string  [Inherited] Encoding Type Content type used to submit the form to the server. If not specified, the default value is "application/x-www-form-urlencoded". Required Attribute false Localizable false Allow Runtime Binding false Allow Load Time Binding true Allow Non Binding true

nestedForm, boolean  [Inherited] Allow this form as a nested form This property should be used when nested forms should be created. Else, the form tag will either remove the form auto-generated by the view, or throw an exception. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

dir, string Direction Specifies the direction for text that does not inherit a direction. Valid values are 'LTR' (left to right) and 'RTL' (right to left). Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

lang, string Language Code Describes the language used in the generated markup of the control. Required Attribute false Localizable true Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

accept, string Content Type List of content types that a server processing this form will handle correctly Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

acceptcharset, string Character Set List of character encodings for input data that are accepted by the server processing this form. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

target, string Target Frame Name of a frame where the response retrieved after this form submit is to be displayed Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

dojo

dojoType, string  [Inherited] Dojo Type Sets the default Dojo Type used to create this control in the browser. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

dojoAttributes, Collection of xp:dojoAttribute - com.ibm.xsp.dojo.DojoAttribute  [Inherited] Dojo Attributes Specifies a list of Dojo attributes. Required Attribute false

events

onclick, string Click Script JavaScript code executed when a pointer control is clicked over this control Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

ondblclick, string Double Click Script JavaScript code executed when a pointer control is double clicked over this control Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onmousedown, string Mouse Down Script JavaScript code executed when a pointer control is pressed down over this control Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onmouseup, string Mouse Up Script JavaScript code executed when a pointer control is released over this control Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onmouseover, string Mouse Over Script JavaScript code executed when a pointer control is moved onto this control Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onmousemove, string Mouse Move Script JavaScript code executed when a pointer control is moved within this control Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onmouseout, string Mouse Out Script JavaScript code executed when a pointer control is moved away from this control Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onkeypress, string Key Press Script JavaScript code executed when a key is pressed and released over this control. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onkeydown, string Key Down Script JavaScript code executed when a key is pressed down over this control Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onkeyup, string Key Up Script JavaScript code executed when a key is released over this control Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onreset, string Form Reset Script JavaScript code executed when this form is reset Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onsubmit, string Form Submit Script JavaScript code executed when this form is submitted Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

styling

disableTheme, boolean  [Inherited] Disable Theme A flag used to determine if the theme should be applied to this control. Required Attribute false Localizable false Allow Runtime Binding false Allow Load Time Binding true Allow Non Binding true

themeId, string  [Inherited] Theme Id The theme id that should be used to set the component properties when a theme is applied Required Attribute false Localizable false Allow Runtime Binding false Allow Load Time Binding true Allow Non Binding true

style, string CSS Styles Specifies CSS style(s) to be applied when this control is rendered. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

styleClass, string CSS Style Classes Specifies the space-separated list of CSS style class(es) to be applied when this control is rendered. This value must be passed through as the "class" attribute on generated markup. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true