com.xalys.xgl.forms

Class Field<H extends HTMLElement<H>,W extends Field<H,W,V>,V>

java.lang.Object

com.xalys.xgl.Widget<H,W>

com.xalys.xgl.FocusableWidget<H,W>

com.xalys.xgl.forms.Field<H,W,V>

All Implemented Interfaces:

EventTarget<W>, HasFieldChangeHandlers<W,V>, HasActionHandlers<W>, HasAnimationEndHandlers<W>, HasAnimationIterationHandlers<W>, HasAnimationStartHandlers<W>, HasAttachHandlers<W>, HasBlurHandlers<W>, HasClickHandlers<W>, HasContextMenuHandlers<W>, HasDetachHandlers<W>, HasDoubleActionHandlers<W>, HasDoubleClickHandlers<W>, HasDoubleTapHandlers<W>, HasFocusHandlers<W>, HasHandlers, HasKeyDownHandlers<W>, HasKeyHandlers<W>, HasKeyPressHandlers<W>, HasKeyUpHandlers<W>, HasMouseDownHandlers<W>, HasMouseHandlers<W>, HasMouseMoveHandlers<W>, HasMouseOutHandlers<W>, HasMouseOverHandlers<W>, HasMouseUpHandlers<W>, HasResizeHandlers<W>, HasScrollHandlers<W>, HasTapHandlers<W>, HasTouchCancelHandlers<W>, HasTouchEndHandlers<W>, HasTouchForceChangeHandlers<W>, HasTouchHandlers<W>, HasTouchHoldHandlers<W>, HasTouchMoveHandlers<W>, HasTouchStartHandlers<W>, HasTransitionEndHandlers<W>, HasWheelHandlers<W>, IsFocusable<H,W>, ReflowScheduler<W>

Direct Known Subclasses:

AbstractSliderField, CheckBoxField, ValueField

public abstract class Field<H extends HTMLElement<H>,W extends Field<H,W,V>,V>
extends FocusableWidget<H,W>
implements IsFocusable<H,W>, HasFieldChangeHandlers<W,V>

Since:

1.0

Version:

1.0

Author:

Paul Sitarz

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	readOnly
protected boolean	valid
protected V	value

Fields inherited from class com.xalys.xgl.Widget

contextMenu, contextMenuHandlerRegistration, currentHeight, currentWidth, enabled, NATIVE_CONTEXT_MENU_HANDLER

Constructor Summary

Constructors

Constructor and Description
Field(H element)

Method Summary

Modifier and Type	Method and Description
HandlerRegistration	addFieldChangeHandler(FieldChangeHandler<W,V> fieldChangeHandler)
W	addValidator(Validator<V> validator) Add a new validator.
protected void	fireFieldChangeEvent(V previousValue) Fire the field change event.
List<Validator<V>>	getValidators() Returns an unmodifiable list of the field's validators.
V	getValue()
boolean	isReadOnly() Returns the read only status of this field
boolean	isValid() Returns whether the field is currently marked as valid or not.
W	removeValidator(Validator<V> validator) Remove a validator.
abstract W	reset()
abstract W	setReadOnly(boolean readOnly) Sets the read only status, should be overridden by a child classes to set the readonly flag on input fields as needed
abstract W	setValue(V value)
protected W	setValue(V value, boolean validate, boolean fireEvents)
boolean	validate()
boolean	validate(boolean silently) Validate the field value.

Methods inherited from class com.xalys.xgl.FocusableWidget

focusNext, focusPrevious

Methods inherited from class com.xalys.xgl.Widget

add, addActionHandler, addClassName, addDoubleActionHandler, addDoubleTapHandler, addDropTarget, addEventHandler, addEventHandler, addResizeHandler, addStyleName, addTapHandler, addTouchHoldHandler, canDropTargetAccept, cast, clear, clearBackgroundColor, clearDropTargets, clearTextColor, ensureHandlers, fireEvent, fireEvent, fireResizeEvent, getAbsoluteLeft, getAbsoluteTop, getAncestor, getChildren, getChildrenCount, getComputedStyle, getContextMenu, getContextMenuHandler, getDeepestWidget, getDragSource, getDropTargetList, getElement, getFirstChild, getId, getLastChild, getNextSibling, getNextSibling, getOffsetHeight, getOffsetWidth, getParent, getScrollLeft, getScrollTop, getStyle, hasClassName, hasFocus, insert, isAttached, isDropTarget, isEnabled, isInEventThread, onAttach, onDetach, remove, removeClassName, removeDropTarget, removeStyleName, setBackgroundColor, setClassName, setContextMenu, setDragSource, setDropTarget, setEnabled, setHeight, setHeight, setHeight, setId, setLeft, setLeftAndTop, setMaxHeight, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setMinWidth, setParent, setPixelSize, setScrollLeft, setScrollTop, setSize, setTextAlign, setTextColor, setTop, setWidth, setWidth, setWidth

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.xalys.xgl.IsFocusable

blur, click, focus, getElement

Methods inherited from interface com.xalys.xgl.events.HasBlurHandlers

addBlurHandler, addBlurHandler

Methods inherited from interface com.xalys.xgl.events.HasFocusHandlers

addFocusHandler, addFocusHandler

Methods inherited from interface com.xalys.xgl.events.HasHandlers

addEventHandler, addEventHandler

Methods inherited from interface com.xalys.xgl.presto.ReflowScheduler

cancelMeasure, cancelMutation, measureAsSoonAsPossible, mutateAsSoonAsPossible, mutateAsSoonAsPossible, scheduleMeasure, scheduleMutation

Methods inherited from interface com.xalys.xgl.events.HasAttachHandlers

addAttachHandler

Methods inherited from interface com.xalys.xgl.events.HasDetachHandlers

addDetachHandler

Methods inherited from interface com.xalys.xgl.events.HasTransitionEndHandlers

addTransitionEndHandler, addTransitionEndHandler

Methods inherited from interface com.xalys.xgl.events.HasMouseDownHandlers

addMouseDownHandler, addMouseDownHandler

Methods inherited from interface com.xalys.xgl.events.HasMouseMoveHandlers

addMouseMoveHandler, addMouseMoveHandler

Methods inherited from interface com.xalys.xgl.events.HasMouseOutHandlers

addMouseOutHandler, addMouseOutHandler

Methods inherited from interface com.xalys.xgl.events.HasMouseOverHandlers

addMouseOverHandler, addMouseOverHandler

Methods inherited from interface com.xalys.xgl.events.HasMouseUpHandlers

addMouseUpHandler, addMouseUpHandler

Methods inherited from interface com.xalys.xgl.events.HasWheelHandlers

addWheelHandler, addWheelHandler

Methods inherited from interface com.xalys.xgl.events.HasClickHandlers

addClickHandler, addClickHandler

Methods inherited from interface com.xalys.xgl.events.HasDoubleClickHandlers

addDoubleClickHandler, addDoubleClickHandler

Methods inherited from interface com.xalys.xgl.events.HasContextMenuHandlers

addContextMenuHandler, addContextMenuHandler

Methods inherited from interface com.xalys.xgl.events.HasTouchStartHandlers

addTouchStartHandler, addTouchStartHandler

Methods inherited from interface com.xalys.xgl.events.HasTouchMoveHandlers

addTouchMoveHandler, addTouchMoveHandler

Methods inherited from interface com.xalys.xgl.events.HasTouchForceChangeHandlers

addTouchForceChangeHandler, addTouchForceChangeHandler

Methods inherited from interface com.xalys.xgl.events.HasTouchEndHandlers

addTouchEndHandler, addTouchEndHandler

Methods inherited from interface com.xalys.xgl.events.HasTouchCancelHandlers

addTouchCancelHandler, addTouchCancelHandler

Methods inherited from interface com.xalys.xgl.events.HasTouchHoldHandlers

addTouchHoldHandler

Methods inherited from interface com.xalys.xgl.events.HasTapHandlers

addTapHandler

Methods inherited from interface com.xalys.xgl.events.HasDoubleTapHandlers

addDoubleTapHandler

Methods inherited from interface com.xalys.xgl.events.HasKeyDownHandlers

addKeyDownHandler, addKeyDownHandler

Methods inherited from interface com.xalys.xgl.events.HasKeyUpHandlers

addKeyUpHandler, addKeyUpHandler

Methods inherited from interface com.xalys.xgl.events.HasKeyPressHandlers

addKeyPressHandler, addKeyPressHandler

Methods inherited from interface com.xalys.xgl.events.HasScrollHandlers

addScrollHandler, addScrollHandler

Methods inherited from interface com.xalys.xgl.events.HasAnimationStartHandlers

addAnimationStartHandler, addAnimationStartHandler

Methods inherited from interface com.xalys.xgl.events.HasAnimationIterationHandlers

addAnimationIterationHandler, addAnimationIterationHandler

Methods inherited from interface com.xalys.xgl.events.HasAnimationEndHandlers

addAnimationEndHandler, addAnimationEndHandler

Methods inherited from interface com.xalys.xgl.events.HasActionHandlers

addActionHandler

Methods inherited from interface com.xalys.xgl.events.HasDoubleActionHandlers

addDoubleActionHandler

Field Detail

value

protected V value

valid

protected boolean valid

readOnly

protected boolean readOnly

Constructor Detail

Field

public Field(H element)

Parameters:

element - the html element representing this field

Method Detail

addValidator

public W addValidator(Validator<V> validator)

Add a new validator. The validators are called in the order they are added.

Parameters:

validator -

Returns:

the field (for daisy chaining)

removeValidator

public W removeValidator(Validator<V> validator)

Remove a validator.

Parameters:

validator -

Returns:

the field (for daisy chaining)

getValidators

public List<Validator<V>> getValidators()

Returns an unmodifiable list of the field's validators.

Returns:

the validators

getValue

public V getValue()

Returns:

the value of the field

setValue

public abstract W setValue(V value)

Parameters:

value -

Returns:

setValue

protected W setValue(V value,
                     boolean validate,
                     boolean fireEvents)

Parameters:

value -

Returns:

validate

public boolean validate()

validate

public boolean validate(boolean silently)

Validate the field value.

Parameters:

silently - if true, it will not mark the field as valid or invalid, and it will not fire any invalid event

isValid

public boolean isValid()

Returns whether the field is currently marked as valid or not. It does not validate the field. To validate the field, use instead validate.

Returns:

true if the field is valid, false otherwise.

addFieldChangeHandler

public HandlerRegistration addFieldChangeHandler(FieldChangeHandler<W,V> fieldChangeHandler)

Specified by:

addFieldChangeHandler in interface HasFieldChangeHandlers<W extends Field<H,W,V>,V>

See Also:

HasFieldChangeHandlers.addFieldChangeHandler(com.xalys.xgl.events.forms.FieldChangeHandler)

reset

public abstract W reset()

Returns:

fireFieldChangeEvent

protected void fireFieldChangeEvent(V previousValue)

Fire the field change event. The new value should be set before calling this method. The previous value have to be provided.

Parameters:

previousValue - the previous value

isReadOnly

public boolean isReadOnly()

Returns the read only status of this field

Returns:

true if the field is readable only

setReadOnly

public abstract W setReadOnly(boolean readOnly)

Sets the read only status, should be overridden by a child classes to set the readonly flag on input fields as needed

Parameters:

readOnly - the read only status to set

Returns:

this field (for daisy chaining)