| java.lang.Object
 org.directwebremoting.proxy.io.Context
jsx3.lang.Object
jsx3.gui.Form
| Form | | public class Form extends jsx3.lang.Object (Code) | | Mixin interface. Contains methods and constants encapsulating the functionality of an HTML form control.
author:
Joe Walker [joe at getahead dot org]
author:
DRAPGEN - Dwr Reverse Ajax Proxy GENerator |
| Field Summary | |
| final public static String | DEFAULTDISABLEDBACKGROUNDCOLOR
| | final public static String | DEFAULTDISABLEDCOLOR
| | final public static int | OPTIONAL
Value for the required field indicating that the form field is optional. | | final public static int | REQUIRED
Value for the required field indicating that the form field is required. | | final public static int | STATEDISABLED
Value for the enabled field indicating that the form field is disabled. | | final public static int | STATEENABLED
Value for the enabled field indicating that the form field is enabled. | | final public static int | STATEINVALID
Value for the validation state field indicating that the value of the form field is invalid. | | final public static int | STATEVALID
Value for the validation state field indicating that the value of the form field is valid. |
| DEFAULTDISABLEDBACKGROUNDCOLOR | | final public static String DEFAULTDISABLEDBACKGROUNDCOLOR(Code) | | #d8d8e5 (default)
|
| DEFAULTDISABLEDCOLOR | | final public static String DEFAULTDISABLEDCOLOR(Code) | | #a8a8b5 (default)
|
| OPTIONAL | | final public static int OPTIONAL(Code) | | Value for the required field indicating that the form field is optional.
|
| REQUIRED | | final public static int REQUIRED(Code) | | Value for the required field indicating that the form field is required.
|
| STATEDISABLED | | final public static int STATEDISABLED(Code) | | Value for the enabled field indicating that the form field is disabled.
|
| STATEENABLED | | final public static int STATEENABLED(Code) | | Value for the enabled field indicating that the form field is enabled.
|
| STATEINVALID | | final public static int STATEINVALID(Code) | | Value for the validation state field indicating that the value of the form field is invalid.
|
| STATEVALID | | final public static int STATEVALID(Code) | | Value for the validation state field indicating that the value of the form field is valid.
|
| Form | | public Form(Context context, String extension, ScriptProxy scriptProxy)(Code) | | All reverse ajax proxies need context to work from
Parameters:
scriptProxy - The place we are writing scripts to
Parameters:
context - The script that got us to where we are now |
| doKeyBinding | | public jsx3.gui.HotKey doKeyBinding(org.directwebremoting.proxy.CodeBlock fctCallback, String strKeys)(Code) | | Binds the given key sequence to a callback function. Any object that has a key binding (specified with
setKeyBinding()) will call this method when painted to register the key sequence with an appropriate
ancestor of this form control. Any key down event that bubbles up to the ancestor without being intercepted
and matches the given key sequence will invoke the given callback function.
As of 3.2: The hot key will be registered with the first ancestor found that is either a
jsx3.gui.Window, a jsx3.gui.Dialog, or the root block of a jsx3.app.Server.
Parameters:
fctCallback - JavaScript function to execute when the given sequence is keyed by the user.
Parameters:
strKeys - a plus-delimited ('+') key sequence such as ctrl+s orctrl+shift+alt+h or shift+a, etc. Any combination of shift, ctrl, and alt aresupported, including none. Also supported as the final token are enter, esc,tab, del, and space. To specify the final token as a key code, thelast token can be the key code contained in brackets, [13]. the registered hot key. |
| doReset | | public jsx3.gui.Form doReset()(Code) | | Resets the validation state of this control.
this object. |
| doReset | | public T doReset(Class<T> returnType)(Code) | | Resets the validation state of this control.
Parameters:
returnType - The expected return type this object. |
| getDisabledBackgroundColor | | public void getDisabledBackgroundColor(org.directwebremoting.proxy.Callback<String> callback)(Code) | | Returns the background color of this control when it is disabled.
Parameters:
callback - valid CSS property value, (i.e., red, #ff0000) |
| getEnabled | | public void getEnabled(org.directwebremoting.proxy.Callback<Integer> callback)(Code) | | Returns the state for the form field control. If no enabled state is set, this method returns
STATEENABLED.
Parameters:
callback - STATEDISABLED or STATEENABLED. |
| getKeyBinding | | public void getKeyBinding(org.directwebremoting.proxy.Callback<String> callback)(Code) | | Returns the key binding that when keyed will fire the execute event for this control.
Parameters:
callback - plus-delimited (e.g.,'+') key sequence such as ctrl+s or ctrl+shift+alt+h or shift+a, etc |
| getRequired | | public void getRequired(org.directwebremoting.proxy.Callback<Integer> callback)(Code) | | Returns whether or not this control is required. If the required property has never been set, this method returns
OPTIONAL.
Parameters:
callback - REQUIRED or OPTIONAL. |
| getValidationState | | public void getValidationState(org.directwebremoting.proxy.Callback<Integer> callback)(Code) | | Returns the validation state of this control. If the validationState property has never been set, this method returns
STATEVALID.
Parameters:
callback - STATEINVALID or STATEVALID. |
| reset | | public void reset(jsx3.app.Model objJSXContainer)(Code) | | Traverses the DOM branch starting at objJSXContainer and calls doReset() on all nodes
of type jsx3.gui.Form.
Parameters:
objJSXContainer - JSX GUI object containing all form fields that need to be reset (the 'reset' process will start with this item and be applied to all descendants, not just direct children) |
| setDisabledBackgroundColor | | public jsx3.gui.Form setDisabledBackgroundColor(String strColor)(Code) | | Sets the background color of this form control when it is disabled.
Parameters:
strColor - valid CSS property value, (i.e., red, #ff0000) this object. |
| setDisabledColor | | public jsx3.gui.Form setDisabledColor(String strColor)(Code) | | Sets the font color to use when this control is disabled.
Parameters:
strColor - valid CSS property value, (i.e., red, #ff0000) this object. |
| setEnabled | | public void setEnabled(int intEnabled, boolean bRepaint)(Code) | | Sets whether this control is enabled. Disabled controls do not respond to user interaction.
Parameters:
intEnabled - STATEDISABLED or STATEENABLED. null isequivalent to STATEENABLED.
Parameters:
bRepaint - if true this control is immediately repainted to reflect the new setting. |
| setKeyBinding | | public jsx3.gui.Form setKeyBinding(String strSequence)(Code) | | Sets the key binding that when keyed will fire the bound execute (jsx3.gui.Interactive.EXECUTE)
event for this control.
Parameters:
strSequence - plus-delimited (e.g.,'+') key sequence such as ctrl+s or ctrl+shift+alt+h or shift+a, etc this object. |
| setRequired | | public jsx3.gui.Form setRequired(int required)(Code) | | Sets whether or not this control is required.
Parameters:
required - {int} REQUIRED or OPTIONAL. this object. |
| setValidationState | | public jsx3.gui.Form setValidationState(int intState)(Code) | | Sets the validation state of this control. The validation state of a control is not serialized.
Parameters:
intState - STATEINVALID or STATEVALID. this object. |
| setValue | | public jsx3.gui.Form setValue(String vntValue)(Code) | | Sets the value of this control.
Parameters:
vntValue - string/int value for the component this object. |
| setValue | | public jsx3.gui.Form setValue(Integer vntValue)(Code) | | Sets the value of this control.
Parameters:
vntValue - string/int value for the component this object. |
| validate | | public void validate(jsx3.app.Model objJSXContainer, org.directwebremoting.proxy.CodeBlock objHandler, org.directwebremoting.proxy.Callback<Integer> callback)(Code) | | Traverses the DOM branch starting at objJSXContainer and calls doValidate() on all nodes
of type jsx3.gui.Form. A custom function handler, objHandler, can be passed that will
be called once for each encountered form control.
Parameters:
objJSXContainer - JSX GUI object containing all form fields that need to be validated (recursive validation will start with this item and be applied to all descendants, not just direct children)
Parameters:
objHandler - a JavaScript function (as object). This function will be passed two parameters: the object reference to the JSX Form object (textbox, selectbox, checkbox, etc) being validated as well as a constant denoting whether or not it validated (0 or 1)—1 meaning true
Parameters:
callback - STATEINVALID or STATEVALID. |
| Methods inherited from jsx3.lang.Object | public void ignoreReturn()(Code)(Java Doc)
|
|
|