/*
* Copyright 2005 Joe Walker
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package jsx3.gui;
import org.directwebremoting.ScriptBuffer;
import org.directwebremoting.ScriptSessions;
import org.directwebremoting.io.Context;
/**
* 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
*/
public class Form extends jsx3.lang.Object
{
/**
* All reverse ajax proxies need context to work from
* @param context The script that got us to where we are now
*/
public Form(Context context, String extension)
{
super(context, extension);
}
/**
* #a8a8b5 (default)
*/
public static final String DEFAULTDISABLEDCOLOR = "#a8a8b5";
/**
* #d8d8e5 (default)
*/
public static final String DEFAULTDISABLEDBACKGROUNDCOLOR = "#d8d8e5";
/**
* Value for the validation state field indicating that the value of the form field is invalid.
*/
public static final int STATEINVALID = 0;
/**
* Value for the validation state field indicating that the value of the form field is valid.
*/
public static final int STATEVALID = 1;
/**
* Value for the enabled field indicating that the form field is disabled.
*/
public static final int STATEDISABLED = 0;
/**
* Value for the enabled field indicating that the form field is enabled.
*/
public static final int STATEENABLED = 1;
/**
* Value for the required field indicating that the form field is optional.
*/
public static final int OPTIONAL = 0;
/**
* Value for the required field indicating that the form field is required.
*/
public static final int REQUIRED = 1;
/**
* 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.
* @param fctCallback JavaScript function to execute when the given sequence is keyed by the user.
* @param strKeys a plus-delimited ('+') key sequence such as <code>ctrl+s</code> or
<code>ctrl+shift+alt+h</code> or <code>shift+a</code>, etc. Any combination of shift, ctrl, and alt are
supported, including none. Also supported as the final token are <code>enter</code>, <code>esc</code>,
<code>tab</code>, <code>del</code>, and <code>space</code>. To specify the final token as a key code, the
last token can be the key code contained in brackets, <code>[13]</code>.
* @return the registered hot key.
*/
public jsx3.gui.HotKey doKeyBinding(org.directwebremoting.ui.CodeBlock fctCallback, String strKeys)
{
String extension = "doKeyBinding(\"" + fctCallback + "\", \"" + strKeys + "\").";
try
{
java.lang.reflect.Constructor<jsx3.gui.HotKey> ctor = jsx3.gui.HotKey.class.getConstructor(Context.class, String.class);
return ctor.newInstance(this, extension);
}
catch (Exception ex)
{
throw new IllegalArgumentException("Unsupported type: " + jsx3.gui.HotKey.class.getName());
}
}
/**
* Returns the key binding that when keyed will fire the execute event for this control.
* @param callback plus-delimited (e.g.,'+') key sequence such as ctrl+s or ctrl+shift+alt+h or shift+a, etc
*/
public void getKeyBinding(org.directwebremoting.ui.Callback<String> callback)
{
ScriptBuffer script = new ScriptBuffer();
String callbackPrefix = "";
if (callback != null)
{
callbackPrefix = "var reply = ";
}
script.appendCall(callbackPrefix + getContextPath() + "getKeyBinding");
if (callback != null)
{
String key = org.directwebremoting.extend.CallbackHelperFactory.get().saveCallback(callback, String.class);
script.appendCall("__System.activateCallback", key, "reply");
}
ScriptSessions.addScript(script);
}
/**
* Sets the key binding that when keyed will fire the bound execute (jsx3.gui.Interactive.EXECUTE)
event for this control.
* @param strSequence plus-delimited (e.g.,'+') key sequence such as ctrl+s or ctrl+shift+alt+h or shift+a, etc
* @return this object.
*/
public jsx3.gui.Form setKeyBinding(String strSequence)
{
ScriptBuffer script = new ScriptBuffer();
script.appendCall(getContextPath() + "setKeyBinding", strSequence);
ScriptSessions.addScript(script);
return this;
}
/**
* Returns the background color of this control when it is disabled.
* @param callback valid CSS property value, (i.e., red, #ff0000)
*/
public void getDisabledBackgroundColor(org.directwebremoting.ui.Callback<String> callback)
{
ScriptBuffer script = new ScriptBuffer();
String callbackPrefix = "";
if (callback != null)
{
callbackPrefix = "var reply = ";
}
script.appendCall(callbackPrefix + getContextPath() + "getDisabledBackgroundColor");
if (callback != null)
{
String key = org.directwebremoting.extend.CallbackHelperFactory.get().saveCallback(callback, String.class);
script.appendCall("__System.activateCallback", key, "reply");
}
ScriptSessions.addScript(script);
}
/**
* Sets the background color of this form control when it is disabled.
* @param strColor valid CSS property value, (i.e., red, #ff0000)
* @return this object.
*/
public jsx3.gui.Form setDisabledBackgroundColor(String strColor)
{
ScriptBuffer script = new ScriptBuffer();
script.appendCall(getContextPath() + "setDisabledBackgroundColor", strColor);
ScriptSessions.addScript(script);
return this;
}
/**
* Returns the font color to use when this control is disabled.
* @param callback valid CSS property value, (i.e., red, #ff0000)
*/
public void getDisabledColor(org.directwebremoting.ui.Callback<String> callback)
{
ScriptBuffer script = new ScriptBuffer();
String callbackPrefix = "";
if (callback != null)
{
callbackPrefix = "var reply = ";
}
script.appendCall(callbackPrefix + getContextPath() + "getDisabledColor");
if (callback != null)
{
String key = org.directwebremoting.extend.CallbackHelperFactory.get().saveCallback(callback, String.class);
script.appendCall("__System.activateCallback", key, "reply");
}
ScriptSessions.addScript(script);
}
/**
* Sets the font color to use when this control is disabled.
* @param strColor valid CSS property value, (i.e., red, #ff0000)
* @return this object.
*/
public jsx3.gui.Form setDisabledColor(String strColor)
{
ScriptBuffer script = new ScriptBuffer();
script.appendCall(getContextPath() + "setDisabledColor", strColor);
ScriptSessions.addScript(script);
return this;
}
/**
* Returns the state for the form field control. If no enabled state is set, this method returns
STATEENABLED.
* @param callback <code>STATEDISABLED</code> or <code>STATEENABLED</code>.
*/
public void getEnabled(org.directwebremoting.ui.Callback<Integer> callback)
{
ScriptBuffer script = new ScriptBuffer();
String callbackPrefix = "";
if (callback != null)
{
callbackPrefix = "var reply = ";
}
script.appendCall(callbackPrefix + getContextPath() + "getEnabled");
if (callback != null)
{
String key = org.directwebremoting.extend.CallbackHelperFactory.get().saveCallback(callback, Integer.class);
script.appendCall("__System.activateCallback", key, "reply");
}
ScriptSessions.addScript(script);
}
/**
* Returns the value of this control.
*/
public void getValue(org.directwebremoting.ui.Callback<Integer> callback)
{
ScriptBuffer script = new ScriptBuffer();
String callbackPrefix = "";
if (callback != null)
{
callbackPrefix = "var reply = ";
}
script.appendCall(callbackPrefix + getContextPath() + "getValue");
if (callback != null)
{
String key = org.directwebremoting.extend.CallbackHelperFactory.get().saveCallback(callback, Integer.class);
script.appendCall("__System.activateCallback", key, "reply");
}
ScriptSessions.addScript(script);
}
/**
* Sets the value of this control.
* @param vntValue string/int value for the component
* @return this object.
*/
public jsx3.gui.Form setValue(String vntValue)
{
ScriptBuffer script = new ScriptBuffer();
script.appendCall(getContextPath() + "setValue", vntValue);
ScriptSessions.addScript(script);
return this;
}
/**
* Sets the value of this control.
* @param vntValue string/int value for the component
* @return this object.
*/
public jsx3.gui.Form setValue(Integer vntValue)
{
ScriptBuffer script = new ScriptBuffer();
script.appendCall(getContextPath() + "setValue", vntValue);
ScriptSessions.addScript(script);
return this;
}
/**
* Sets whether this control is enabled. Disabled controls do not respond to user interaction.
* @param intEnabled <code>STATEDISABLED</code> or <code>STATEENABLED</code>. <code>null</code> is
equivalent to <code>STATEENABLED</code>.
* @param bRepaint if <code>true</code> this control is immediately repainted to reflect the new setting.
*/
public void setEnabled(int intEnabled, boolean bRepaint)
{
ScriptBuffer script = new ScriptBuffer();
script.appendCall(getContextPath() + "setEnabled", intEnabled, bRepaint);
ScriptSessions.addScript(script);
}
/**
* Returns whether or not this control is required. If the required property has never been set, this method returns
OPTIONAL.
* @param callback <code>REQUIRED</code> or <code>OPTIONAL</code>.
*/
public void getRequired(org.directwebremoting.ui.Callback<Integer> callback)
{
ScriptBuffer script = new ScriptBuffer();
String callbackPrefix = "";
if (callback != null)
{
callbackPrefix = "var reply = ";
}
script.appendCall(callbackPrefix + getContextPath() + "getRequired");
if (callback != null)
{
String key = org.directwebremoting.extend.CallbackHelperFactory.get().saveCallback(callback, Integer.class);
script.appendCall("__System.activateCallback", key, "reply");
}
ScriptSessions.addScript(script);
}
/**
* Sets whether or not this control is required.
* @param required {int} <code>REQUIRED</code> or <code>OPTIONAL</code>.
* @return this object.
*/
public jsx3.gui.Form setRequired(int required)
{
ScriptBuffer script = new ScriptBuffer();
script.appendCall(getContextPath() + "setRequired", required);
ScriptSessions.addScript(script);
return this;
}
/**
* Returns the validation state of this control. If the validationState property has never been set, this method returns
STATEVALID.
* @param callback <code>STATEINVALID</code> or <code>STATEVALID</code>.
*/
public void getValidationState(org.directwebremoting.ui.Callback<Integer> callback)
{
ScriptBuffer script = new ScriptBuffer();
String callbackPrefix = "";
if (callback != null)
{
callbackPrefix = "var reply = ";
}
script.appendCall(callbackPrefix + getContextPath() + "getValidationState");
if (callback != null)
{
String key = org.directwebremoting.extend.CallbackHelperFactory.get().saveCallback(callback, Integer.class);
script.appendCall("__System.activateCallback", key, "reply");
}
ScriptSessions.addScript(script);
}
/**
* Sets the validation state of this control. The validation state of a control is not serialized.
* @param intState <code>STATEINVALID</code> or <code>STATEVALID</code>.
* @return this object.
*/
public jsx3.gui.Form setValidationState(int intState)
{
ScriptBuffer script = new ScriptBuffer();
script.appendCall(getContextPath() + "setValidationState", intState);
ScriptSessions.addScript(script);
return this;
}
/**
* Abstract method that must be implemented by any class that implements the Form interface.
* @param callback <code>STATEINVALID</code> or <code>STATEVALID</code>.
*/
public void doValidate(org.directwebremoting.ui.Callback<Integer> callback)
{
ScriptBuffer script = new ScriptBuffer();
String callbackPrefix = "";
if (callback != null)
{
callbackPrefix = "var reply = ";
}
script.appendCall(callbackPrefix + getContextPath() + "doValidate");
if (callback != null)
{
String key = org.directwebremoting.extend.CallbackHelperFactory.get().saveCallback(callback, Integer.class);
script.appendCall("__System.activateCallback", key, "reply");
}
ScriptSessions.addScript(script);
}
/**
* Resets the validation state of this control.
* @return this object.
*/
public jsx3.gui.Form doReset()
{
String extension = "doReset().";
try
{
java.lang.reflect.Constructor<jsx3.gui.Form> ctor = jsx3.gui.Form.class.getConstructor(Context.class, String.class);
return ctor.newInstance(this, extension);
}
catch (Exception ex)
{
throw new IllegalArgumentException("Unsupported type: " + jsx3.gui.Form.class.getName());
}
}
/**
* Resets the validation state of this control.
* @param returnType The expected return type
* @return this object.
*/
public <T> T doReset(Class<T> returnType)
{
String extension = "doReset().";
try
{
java.lang.reflect.Constructor<T> ctor = returnType.getConstructor(Context.class, String.class);
return ctor.newInstance(this, extension);
}
catch (Exception ex)
{
throw new IllegalArgumentException("Unsupported return type: " + returnType.getName());
}
}
/**
* 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.
* @param 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)
* @param 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
* @param callback <code>STATEINVALID</code> or <code>STATEVALID</code>.
*/
public void validate(jsx3.app.Model objJSXContainer, org.directwebremoting.ui.CodeBlock objHandler, org.directwebremoting.ui.Callback<Integer> callback)
{
ScriptBuffer script = new ScriptBuffer();
String callbackPrefix = "";
if (callback != null)
{
callbackPrefix = "var reply = ";
}
script.appendCall(callbackPrefix + getContextPath() + "validate", objJSXContainer, objHandler);
if (callback != null)
{
String key = org.directwebremoting.extend.CallbackHelperFactory.get().saveCallback(callback, Integer.class);
script.appendCall("__System.activateCallback", key, "reply");
}
ScriptSessions.addScript(script);
}
/**
* Traverses the DOM branch starting at objJSXContainer and calls doReset() on all nodes
of type jsx3.gui.Form.
* @param 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)
*/
public void reset(jsx3.app.Model objJSXContainer)
{
ScriptBuffer script = new ScriptBuffer();
script.appendCall(getContextPath() + "reset", objJSXContainer);
ScriptSessions.addScript(script);
}
}