Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.apache.click.extras.control
Class IntegerField

java.lang.Object
  extended by org.apache.click.control.AbstractControl
      extended by org.apache.click.control.Field
          extended by org.apache.click.control.TextField
              extended by org.apache.click.extras.control.NumberField
                  extended by org.apache.click.extras.control.IntegerField
All Implemented Interfaces:
Serializable, Control, Stateful
public class IntegerField
extends NumberField

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

Integer Field
IntegerField will validate the number when the control is processed and invoke the control listener if defined.

The IntegerField uses a JavaScript onkeypress() integerFilter() method to prevent users from entering invalid characters. To enable number key filtering reference the variables $jsElements and $headElements in your page template. For example: 

 <html>
 <head>
 $headElements
 </head>
 <body>

 $form

 $jsElements
 </body>
 </html>
The IntegerField has left justified horizontal text alignment, Field.setTextAlign(String).

See also W3C HTML reference INPUT

See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.apache.click.extras.control.NumberField
maxvalue, minvalue, numberFormat, pattern, VALIDATE_NUMBER_FIELD_FUNCTION
 
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
IntegerField()
          Create a IntegerField with no name defined.
IntegerField(String name)
          Construct a IntegerField field with the given name.
IntegerField(String name, boolean required)
          Construct a IntegerField field with the given name and required status.
IntegerField(String name, String label)
          Construct a IntegerField field with the given name and label.
IntegerField(String name, String label, boolean required)
          Construct a IntegerField field with the given name, label and required status.
IntegerField(String name, String label, int size)
          Construct the IntegerField with the given name, label and size.
IntegerField(String name, String label, int size, boolean required)
          Construct the IntegerField with the given name, label, size and required status.
 
Method Summary
 Integer getInteger()
          Return the field Integer value, or null if value was empty or a parsing error occurred.
 Long getLong()
          Return the field Long value, or null if value was empty or a parsing error occurred.
 Object getValueObject()
          Return the field Integer value, or null if value was empty or a parsing error occurred.
 void setInteger(Integer integerValue)
          Set the Integer value of the field.
 void setValueObject(Object object)
          Set the integer value of the field using the given object.
 void validate()
          Validate the IntegerField request submission.
 
Methods inherited from class org.apache.click.extras.control.NumberField
getHeadElements, getMaxValue, getMinValue, getNumber, getNumberFormat, getPattern, getValidationJavaScript, setMaxValue, setMinValue, setNumber, setNumberFormat, setPattern
 
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, 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, 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
 

Constructor Detail

IntegerField

public IntegerField(String name)
Construct a IntegerField field with the given name.

Parameters:
name - the name of the field

IntegerField

public IntegerField(String name,
                    boolean required)
Construct a IntegerField field with the given name and required status.

Parameters:
name - the name of the field
required - the field required status

IntegerField

public IntegerField(String name,
                    String label)
Construct a IntegerField field with the given name and label.

Parameters:
name - the name of the field
label - the label of the field

IntegerField

public IntegerField(String name,
                    String label,
                    boolean required)
Construct a IntegerField field with the given name, label and required status.

Parameters:
name - the name of the field
label - the label of the field
required - the field required status

IntegerField

public IntegerField(String name,
                    String label,
                    int size)
Construct the IntegerField 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

IntegerField

public IntegerField(String name,
                    String label,
                    int size,
                    boolean required)
Construct the IntegerField 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

IntegerField

public IntegerField()
Create a IntegerField with no name defined.

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

Method Detail

getInteger

public Integer getInteger()
Return the field Integer value, or null if value was empty or a parsing error occurred.

Returns:
the field Integer value

setInteger

public void setInteger(Integer integerValue)
Set the Integer value of the field.

Parameters:
integerValue - the field integer value to set

getLong

public Long getLong()
Return the field Long value, or null if value was empty or a parsing error occurred.

Returns:
the field Long value

getValueObject

public Object getValueObject()
Return the field Integer value, or null if value was empty or a parsing error occurred.

Overrides:
getValueObject in class NumberField
Returns:
the Integer object representation of the Field value
See Also:
Field.getValueObject()

setValueObject

public void setValueObject(Object object)
Set the integer value of the field using the given object.

Overrides:
setValueObject in class NumberField
Parameters:
object - the object value to set
See Also:
Field.setValueObject(Object)

validate

public void validate()
Validate the IntegerField 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-required-error
    • number-format-error
    • number-maxvalue-error
    • number-minvalue-error

Overrides:
validate in class NumberField
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD