org.apache.click.extras.control
Class EmailField

java.lang.Object
  org.apache.click.control.AbstractControl
      org.apache.click.control.Field
          org.apache.click.control.TextField
              org.apache.click.extras.control.EmailField

All Implemented Interfaces:

Serializable, Control, Stateful

public class EmailField
extends TextField

Provides a Email Field control: <input type='text'>.

Email Field

EmailField will validate the email when the control is processed and invoke the control listener if defined.

CSS and JavaScript resources

The EmailField control makes use of the following resources (which Click automatically deploys to the application directory, /click):

• click/extras-control.js

To import this EmailField file simply reference the variables $headElements and $jsElements in the page template.

See also W3C HTML reference INPUT

See Also:

Serialized Form

Field Summary

protected static String

VALIDATE_EMAILFIELD_FUNCTION The field validation JavaScript function template.

Fields inherited from class org.apache.click.control.TextField

maxLength, minLength, size, VALIDATE_TEXTFIELD_FUNCTION

Fields inherited from class org.apache.click.control.Field

disabled, error, focus, form, help, label, labelStyle, labelStyleClass, parentStyleClassHint, parentStyleHint, readonly, required, tabindex, title, trim, validate, value

Fields inherited from class org.apache.click.control.AbstractControl

actionListener, attributes, behaviors, headElements, listener, listenerMethod, messages, name, parent, styles

Fields inherited from interface org.apache.click.Control

CONTROL_MESSAGES

Constructor Summary

EmailField()
Create an Email Field with no name defined.

EmailField(String name)
Construct an Email Field with the given name.

EmailField(String name, boolean required)
Construct an Email Field with the given name and required status.

EmailField(String name, String label)
Construct an Email Field with the given name and label.

EmailField(String name, String label, boolean required)
Construct an Email Field with the given name, label and required status.

EmailField(String name, String label, int size)
Construct the Email Field with the given name, label and size.

EmailField(String name, String label, int size, boolean required)
Construct the Email Field with the given name, label, size and required status.

Method Summary

List<Element>	getHeadElements() Returns the EmailField HTML head imports statements for the click/extras-control.js resource.
String	getValidationJavaScript() Return the field JavaScript client side validation function.
void	validate() Process the EmailField request submission.

Methods inherited from class org.apache.click.control.TextField

getControlSizeEst, getMaxLength, getMinLength, getSize, getTag, getType, render, setMaxLength, setMinLength, setSize

Methods inherited from class org.apache.click.control.Field

bindRequestValue, getError, getErrorLabel, getFocus, getFocusJavaScript, getForm, getHelp, getId, getLabel, getLabelStyle, getLabelStyleClass, getParentStyleClassHint, getParentStyleHint, getRequestValue, getState, getTabIndex, getTextAlign, getTitle, getValidate, getValue, getValueObject, getWidth, isDisabled, isHidden, isReadonly, isRequired, isTrim, isValid, onProcess, removeState, renderTagBegin, restoreState, saveState, setDisabled, setError, setErrorMessage, setErrorMessage, setFocus, setForm, setHelp, setLabel, setLabelStyle, setLabelStyleClass, setListener, setParent, setParentStyleClassHint, setParentStyleHint, setReadonly, setRequired, setState, setTabIndex, setTextAlign, setTitle, setTrim, setValidate, setValue, setValueObject, setWidth

Methods inherited from class org.apache.click.control.AbstractControl

addBehavior, addStyleClass, appendAttributes, dispatchActionEvent, getActionListener, getAttribute, getAttributes, getBehaviors, getContext, getHtmlImports, getMessage, getMessage, getMessages, getName, getPage, getParent, getStyle, getStyles, hasAttribute, hasAttributes, hasBehaviors, hasStyles, isAjaxTarget, onDeploy, onDestroy, onInit, onRender, removeBehavior, removeStyleClass, renderTagEnd, setActionListener, setAttribute, setId, setName, setStyle, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

VALIDATE_EMAILFIELD_FUNCTION

protected static final String VALIDATE_EMAILFIELD_FUNCTION

The field validation JavaScript function template. The function template arguments are:

• 0 - is the field id
• 1 - is the Field required status
• 2 - is the minimum length
• 3 - is the maximum length
• 4 - is the localized error message for required validation
• 5 - is the localized error message for minimum length validation
• 6 - is the localized error message for maximum length validation
• 7 - is the localized error message for format validation

See Also:

Constant Field Values

Constructor Detail

EmailField

public EmailField(String name)

Construct an Email Field with the given name. The default email field size is 30 characters.

Parameters:

name - the name of the field

EmailField

public EmailField(String name,
                  String label)

Construct an Email Field with the given name and label. The default email field size is 30 characters.

Parameters:

name - the name of the field

label - the label of the field

EmailField

public EmailField(String name,
                  boolean required)

Construct an Email Field with the given name and required status. The default email field size is 30 characters.

Parameters:

name - the name of the field

required - the field required status

EmailField

public EmailField(String name,
                  String label,
                  boolean required)

Construct an Email Field with the given name, label and required status. The default email field size is 30 characters.

Parameters:

name - the name of the field

label - the label of the field

required - the field required status

EmailField

public EmailField(String name,
                  String label,
                  int size)

Construct the Email Field with the given name, label and size.

Parameters:

name - the name of the field

label - the label of the field

size - the size of the field

EmailField

public EmailField(String name,
                  String label,
                  int size,
                  boolean required)

Construct the Email Field with the given name, label, size and required status.

Parameters:

name - the name of the field

label - the label of the field

size - the size of the field

required - the field required status

EmailField

public EmailField()

Create an Email Field with no name defined.

Please note the control's name must be defined before it is valid.

Method Detail

getHeadElements

public List<Element> getHeadElements()

Returns the EmailField HTML head imports statements for the click/extras-control.js resource.

Specified by:

getHeadElements in interface Control

Overrides:

getHeadElements in class AbstractControl

Returns:

the HTML head import statements for the control

See Also:

Control.getHeadElements()

getValidationJavaScript

public String getValidationJavaScript()

Return the field JavaScript client side validation function.

The function name must follow the format validate_[id], where the id is the DOM element id of the fields focusable HTML element, to ensure the function has a unique name.

Overrides:

getValidationJavaScript in class TextField

Returns:

the field JavaScript client side validation function

validate

public void validate()

Process the EmailField request submission.

A field error message is displayed if a validation error occurs. These messages are defined in the resource bundle:

• /click-control.properties
  • field-maxlength-error
  • field-minlength-error
  • field-required-error
• /org/apache/click/extras/control/EmailField.properties
  • email-format-error

Overrides:

validate in class TextField