com.ibm.xsp.component.xp
Class XspForm

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIForm
              extended by com.ibm.xsp.component.UIFormEx
                  extended by com.ibm.xsp.component.xp.XspForm
All Implemented Interfaces:
FacesAttrsObject, FacesDojoComponent, ThemeControl, javax.faces.component.NamingContainer, javax.faces.component.StateHolder

public class XspForm
extends UIFormEx

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

XPages Container Controls - Form


Nested Class Summary
 
Nested classes/interfaces inherited from class javax.faces.component.UIComponentBase
javax.faces.component.UIComponentBase.AggregatedIterator, javax.faces.component.UIComponentBase.UnmodifiableIterator
 
Nested classes/interfaces inherited from class javax.faces.component.UIComponent
javax.faces.component.UIComponent.StateMap, javax.faces.component.UIComponent.StateMapEntry
 
Field Summary
static java.lang.String COMPONENT_TYPE
           
static java.lang.String RENDERER_TYPE
           
 
Fields inherited from class javax.faces.component.UIForm
COMPONENT_FAMILY
 
Fields inherited from class javax.faces.component.UIComponentBase
EMPTY_ITERATOR
 
Fields inherited from class javax.faces.component.UIComponent
_xspStateId
 
Fields inherited from interface javax.faces.component.NamingContainer
SEPARATOR_CHAR
 
Constructor Summary
XspForm()
           
 
Method Summary
 java.lang.String getAccept()
           Return the value of the accept property.
 java.lang.String getAcceptcharset()
           Return the value of the acceptcharset property.
 java.lang.String getDir()
           Return the value of the dir property.
 java.lang.String getLang()
           Return the value of the lang property.
 java.lang.String getOnclick()
           Return the value of the onclick property.
 java.lang.String getOndblclick()
           Return the value of the ondblclick property.
 java.lang.String getOnkeydown()
           Return the value of the onkeydown property.
 java.lang.String getOnkeypress()
           Return the value of the onkeypress property.
 java.lang.String getOnkeyup()
           Return the value of the onkeyup property.
 java.lang.String getOnmousedown()
           Return the value of the onmousedown property.
 java.lang.String getOnmousemove()
           Return the value of the onmousemove property.
 java.lang.String getOnmouseout()
           Return the value of the onmouseout property.
 java.lang.String getOnmouseover()
           Return the value of the onmouseover property.
 java.lang.String getOnmouseup()
           Return the value of the onmouseup property.
 java.lang.String getOnreset()
           Return the value of the onreset property.
 java.lang.String getOnsubmit()
           Return the value of the onsubmit property.
 java.lang.String getStyle()
           Return the value of the style property.
 java.lang.String getStyleClass()
           Return the value of the styleClass property.
 java.lang.String getTarget()
           Return the value of the target property.
 java.lang.String getTitle()
           Return the value of the title property.
 void restoreState(javax.faces.context.FacesContext _context, java.lang.Object _state)
           
 java.lang.Object saveState(javax.faces.context.FacesContext _context)
           
 void setAccept(java.lang.String accept)
           Set the value of the accept property.
 void setAcceptcharset(java.lang.String acceptcharset)
           Set the value of the acceptcharset property.
 void setDir(java.lang.String dir)
           Set the value of the dir property.
 void setLang(java.lang.String lang)
           Set the value of the lang property.
 void setOnclick(java.lang.String onclick)
           Set the value of the onclick property.
 void setOndblclick(java.lang.String ondblclick)
           Set the value of the ondblclick property.
 void setOnkeydown(java.lang.String onkeydown)
           Set the value of the onkeydown property.
 void setOnkeypress(java.lang.String onkeypress)
           Set the value of the onkeypress property.
 void setOnkeyup(java.lang.String onkeyup)
           Set the value of the onkeyup property.
 void setOnmousedown(java.lang.String onmousedown)
           Set the value of the onmousedown property.
 void setOnmousemove(java.lang.String onmousemove)
           Set the value of the onmousemove property.
 void setOnmouseout(java.lang.String onmouseout)
           Set the value of the onmouseout property.
 void setOnmouseover(java.lang.String onmouseover)
           Set the value of the onmouseover property.
 void setOnmouseup(java.lang.String onmouseup)
           Set the value of the onmouseup property.
 void setOnreset(java.lang.String onreset)
           Set the value of the onreset property.
 void setOnsubmit(java.lang.String onsubmit)
           Set the value of the onsubmit property.
 void setStyle(java.lang.String style)
           Set the value of the style property.
 void setStyleClass(java.lang.String styleClass)
           Set the value of the styleClass property.
 void setTarget(java.lang.String target)
           Set the value of the target property.
 void setTitle(java.lang.String title)
           Set the value of the title property.
 
Methods inherited from class com.ibm.xsp.component.UIFormEx
addAttr, addDojoAttribute, getAttrs, getAutocomplete, getDojoAttributes, getDojoType, getEnctype, getStyleKitFamily, isAutoForm, isNestedForm, save, save, setAttrs, setAutocomplete, setAutoForm, setDojoAttributes, setDojoType, setEnctype, setNestedForm, setParent
 
Methods inherited from class javax.faces.component.UIForm
getFamily, isSubmitted, processDecodes, processUpdates, processValidators, setSubmitted
 
Methods inherited from class javax.faces.component.UIComponentBase
_xspCleanTransientData, _xspGetReadOnlyObj, _xspGetRendererData, _xspRemoveReadOnlyObj, _xspRemoveRendererData, _xspSetIdUnchecked, _xspSetReadOnlyObj, _xspSetRendererData, addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setRendered, setRendererType, setTransient, setValueBinding
 
Methods inherited from class javax.faces.component.UIComponent
_xspGetStateId, _xspGetStateMap, _xspRestoreAttribute, _xspRestoreState, _xspSaveState, invokeOnComponent, isVisitable, markInitialState, setControlState, visitTree
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE
See Also:
Constant Field Values

RENDERER_TYPE

public static final java.lang.String RENDERER_TYPE
See Also:
Constant Field Values
Constructor Detail

XspForm

public XspForm()
Method Detail

getAccept

public java.lang.String getAccept()

Return the value of the accept property. Contents:

List of content types that a server processing this form will handle correctly


getAcceptcharset

public java.lang.String getAcceptcharset()

Return the value of the acceptcharset property. Contents:

List of character encodings for input data that are accepted by the server processing this form.


getDir

public java.lang.String getDir()

Return the value of the dir property. Contents:

Specifies the direction for text that does not inherit a direction. Valid values are 'LTR' (left to right) and 'RTL' (right to left).

Overrides:
getDir in class UIFormEx

getLang

public java.lang.String getLang()

Return the value of the lang property. Contents:

Describes the language used in the generated markup of the control.


getOnclick

public java.lang.String getOnclick()

Return the value of the onclick property. Contents:

JavaScript code executed when a pointer control is clicked over this control


getOndblclick

public java.lang.String getOndblclick()

Return the value of the ondblclick property. Contents:

JavaScript code executed when a pointer control is double clicked over this control


getOnkeydown

public java.lang.String getOnkeydown()

Return the value of the onkeydown property. Contents:

JavaScript code executed when a key is pressed down over this control


getOnkeypress

public java.lang.String getOnkeypress()

Return the value of the onkeypress property. Contents:

JavaScript code executed when a key is pressed and released over this control.


getOnkeyup

public java.lang.String getOnkeyup()

Return the value of the onkeyup property. Contents:

JavaScript code executed when a key is released over this control


getOnmousedown

public java.lang.String getOnmousedown()

Return the value of the onmousedown property. Contents:

JavaScript code executed when a pointer control is pressed down over this control


getOnmousemove

public java.lang.String getOnmousemove()

Return the value of the onmousemove property. Contents:

JavaScript code executed when a pointer control is moved within this control


getOnmouseout

public java.lang.String getOnmouseout()

Return the value of the onmouseout property. Contents:

JavaScript code executed when a pointer control is moved away from this control


getOnmouseover

public java.lang.String getOnmouseover()

Return the value of the onmouseover property. Contents:

JavaScript code executed when a pointer control is moved onto this control


getOnmouseup

public java.lang.String getOnmouseup()

Return the value of the onmouseup property. Contents:

JavaScript code executed when a pointer control is released over this control


getOnreset

public java.lang.String getOnreset()

Return the value of the onreset property. Contents:

JavaScript code executed when this form is reset


getOnsubmit

public java.lang.String getOnsubmit()

Return the value of the onsubmit property. Contents:

JavaScript code executed when this form is submitted


getStyle

public java.lang.String getStyle()

Return the value of the style property. Contents:

Specifies CSS style(s) to be applied when this control is rendered.

XPages Styling Category - style


getStyleClass

public java.lang.String getStyleClass()

Return the value of the styleClass property. Contents:

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.


getTarget

public java.lang.String getTarget()

Return the value of the target property. Contents:

Name of a frame where the response retrieved after this form submit is to be displayed


getTitle

public java.lang.String getTitle()

Return the value of the title property. Contents:

Provides title information for controls.


restoreState

public void restoreState(javax.faces.context.FacesContext _context,
                         java.lang.Object _state)
Specified by:
restoreState in interface javax.faces.component.StateHolder
Overrides:
restoreState in class UIFormEx

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext _context)
Specified by:
saveState in interface javax.faces.component.StateHolder
Overrides:
saveState in class UIFormEx

setAccept

public void setAccept(java.lang.String accept)

Set the value of the accept property.


setAcceptcharset

public void setAcceptcharset(java.lang.String acceptcharset)

Set the value of the acceptcharset property.


setDir

public void setDir(java.lang.String dir)

Set the value of the dir property.

Overrides:
setDir in class UIFormEx

setLang

public void setLang(java.lang.String lang)

Set the value of the lang property.


setOnclick

public void setOnclick(java.lang.String onclick)

Set the value of the onclick property.


setOndblclick

public void setOndblclick(java.lang.String ondblclick)

Set the value of the ondblclick property.


setOnkeydown

public void setOnkeydown(java.lang.String onkeydown)

Set the value of the onkeydown property.


setOnkeypress

public void setOnkeypress(java.lang.String onkeypress)

Set the value of the onkeypress property.


setOnkeyup

public void setOnkeyup(java.lang.String onkeyup)

Set the value of the onkeyup property.


setOnmousedown

public void setOnmousedown(java.lang.String onmousedown)

Set the value of the onmousedown property.


setOnmousemove

public void setOnmousemove(java.lang.String onmousemove)

Set the value of the onmousemove property.


setOnmouseout

public void setOnmouseout(java.lang.String onmouseout)

Set the value of the onmouseout property.


setOnmouseover

public void setOnmouseover(java.lang.String onmouseover)

Set the value of the onmouseover property.


setOnmouseup

public void setOnmouseup(java.lang.String onmouseup)

Set the value of the onmouseup property.


setOnreset

public void setOnreset(java.lang.String onreset)

Set the value of the onreset property.


setOnsubmit

public void setOnsubmit(java.lang.String onsubmit)

Set the value of the onsubmit property.


setStyle

public void setStyle(java.lang.String style)

Set the value of the style property.


setStyleClass

public void setStyleClass(java.lang.String styleClass)

Set the value of the styleClass property.


setTarget

public void setTarget(java.lang.String target)

Set the value of the target property.


setTitle

public void setTitle(java.lang.String title)

Set the value of the title property.