org.jowidgets.tools.widgets.wrapper

Class InputControlWrapper<VALUE_TYPE>

java.lang.Object

org.jowidgets.tools.widgets.wrapper.WidgetWrapper

org.jowidgets.tools.widgets.wrapper.ComponentWrapper

org.jowidgets.tools.widgets.wrapper.ControlWrapper

org.jowidgets.tools.widgets.wrapper.InputControlWrapper<VALUE_TYPE>

All Implemented Interfaces:

IDisposeObservable, IParentObservable<IContainer>, IShowingStateObservable, IInputValueAccessor<VALUE_TYPE>, IComponent, IControl, IInputComponent<VALUE_TYPE>, IInputControl<VALUE_TYPE>, IWidget, IComponentObservable, IFocusObservable, IInputObservable, IKeyObservable, IMouseMotionObservable, IMouseObservable, IPopupDetectionObservable, IComponentCommon, IControlCommon, IInputComponentCommon, IWidgetCommon, IValidateable

Direct Known Subclasses:

CheckBoxWrapper, ComboBoxWrapper

public class InputControlWrapper<VALUE_TYPE>
extends ControlWrapper
implements IInputControl<VALUE_TYPE>

Constructor Summary

Constructors

Constructor and Description
InputControlWrapper(IInputControl<VALUE_TYPE> widget)

Method Summary

Methods

Modifier and Type	Method and Description
void	addInputListener(IInputListener listener) Adds an input listener
void	addValidationConditionListener(IValidationConditionListener listener) Adds a validation condition listener
void	addValidator(IValidator<VALUE_TYPE> validator) Adds a validator to the input component
VALUE_TYPE	getValue() Gets the value
protected IInputControl<VALUE_TYPE>	getWidget()
boolean	hasModifications() Determines if modifications has been occurred since object creation or the last invocation of resetModificationState().
boolean	isEditable() Gets the editable state
void	removeInputListener(IInputListener listener) Removes an input listener
void	removeValidationConditionListener(IValidationConditionListener listener) Removes a validation condition listener
void	resetModificationState() Resets the modification state.
void	setEditable(boolean editable) Sets the editable state of the input component.
void	setValue(VALUE_TYPE value) Sets the value
IValidationResult	validate() Does the validation

Methods inherited from class org.jowidgets.tools.widgets.wrapper.ControlWrapper

addParentListener, getDragSource, getDropTarget, getLayoutConstraints, getMaxSize, getMinSize, getParent, getPreferredSize, getRoot, removeParentListener, setLayoutConstraints, setMaxSize, setMinSize, setParent, setPreferredSize, setToolTipText

Methods inherited from class org.jowidgets.tools.widgets.wrapper.ComponentWrapper

addComponentListener, addFocusListener, addKeyListener, addMouseListener, addMouseMotionListener, addPopupDetectionListener, addShowingStateListener, createPopupMenu, fromComponent, getBackgroundColor, getBounds, getForegroundColor, getPosition, getSize, hasFocus, isReparentable, isShowing, isVisible, redraw, removeComponentListener, removeFocusListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removePopupDetectionListener, removeShowingStateListener, requestFocus, setBackgroundColor, setBounds, setCursor, setForegroundColor, setPopupMenu, setPosition, setPosition, setRedrawEnabled, setSize, setSize, setVisible, toComponent, toLocal, toScreen

Methods inherited from class org.jowidgets.tools.widgets.wrapper.WidgetWrapper

addDisposeListener, dispose, getUiReference, isDisposed, isEnabled, removeDisposeListener, setEnabled

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jowidgets.api.widgets.IControl

getDragSource, getDropTarget, getParent, getRoot, setMaxSize, setMinSize, setParent, setPreferredSize

Methods inherited from interface org.jowidgets.common.widgets.IControlCommon

getLayoutConstraints, getMaxSize, getMinSize, getPreferredSize, setLayoutConstraints, setToolTipText

Methods inherited from interface org.jowidgets.api.controller.IParentObservable

addParentListener, removeParentListener

Methods inherited from interface org.jowidgets.api.widgets.IComponent

createPopupMenu, fromComponent, getBounds, hasFocus, isReparentable, isShowing, setBounds, setPopupMenu, setPosition, setSize, toComponent, toLocal, toScreen

Methods inherited from interface org.jowidgets.api.widgets.IWidget

dispose, isDisposed

Methods inherited from interface org.jowidgets.api.controller.IDisposeObservable

addDisposeListener, removeDisposeListener

Methods inherited from interface org.jowidgets.api.controller.IShowingStateObservable

addShowingStateListener, removeShowingStateListener

Methods inherited from interface org.jowidgets.common.widgets.IComponentCommon

getBackgroundColor, getForegroundColor, getPosition, getSize, isVisible, redraw, requestFocus, setBackgroundColor, setCursor, setForegroundColor, setPosition, setRedrawEnabled, setSize, setVisible

Methods inherited from interface org.jowidgets.common.widgets.IWidgetCommon

getUiReference, isEnabled, setEnabled

Methods inherited from interface org.jowidgets.common.widgets.controller.IComponentObservable

addComponentListener, removeComponentListener

Methods inherited from interface org.jowidgets.common.widgets.controller.IFocusObservable

addFocusListener, removeFocusListener

Methods inherited from interface org.jowidgets.common.widgets.controller.IKeyObservable

addKeyListener, removeKeyListener

Methods inherited from interface org.jowidgets.common.widgets.controller.IMouseObservable

addMouseListener, removeMouseListener

Methods inherited from interface org.jowidgets.common.widgets.controller.IMouseMotionObservable

addMouseMotionListener, removeMouseMotionListener

Methods inherited from interface org.jowidgets.common.widgets.controller.IPopupDetectionObservable

addPopupDetectionListener, removePopupDetectionListener

Constructor Detail

InputControlWrapper

public InputControlWrapper(IInputControl<VALUE_TYPE> widget)

Method Detail

getWidget

protected IInputControl<VALUE_TYPE> getWidget()

Overrides:

getWidget in class ControlWrapper

addValidator

public void addValidator(IValidator<VALUE_TYPE> validator)

Description copied from interface: IInputComponent

Adds a validator to the input component

Specified by:

addValidator in interface IInputComponent<VALUE_TYPE>

Parameters:

validator - The validator to add, must not be null

hasModifications

public boolean hasModifications()

Description copied from interface: IInputComponent

Determines if modifications has been occurred since object creation or the last invocation of resetModificationState(). Remark: The component may have modifications even if the public value not differs from its original value, Example: The user enters a date in an IInputField, composed from an single ITextField. The current input (e.g. '12-11-') is incomplete so it can not be converted to a valid date, which leads to a value of 'null'. The IInputComponent.resetModificationState() method will be invoked, so the method IInputComponent.hasModifications() returns false. After pressing the '2' key, the method IInputComponent.hasModifications() returns true, but the value is still null. After pressing the keys '0', '1' , '1', the method IInputComponent.hasModifications() returns still true and the value is a Date object representing "12-11-2011". If the user presses the backspace key 4 times, the value is 'null' and the method IInputComponent.hasModifications() returns false again, which indicates that the field is in it's original state.

Specified by:

hasModifications in interface IInputComponent<VALUE_TYPE>

Returns:

True if the component has modifications, false otherwise

See Also:

IInputComponent.hasModifications()

resetModificationState

public void resetModificationState()

Description copied from interface: IInputComponent

Resets the modification state. After that, the IInputComponent.hasModifications() method must return false, until modification was made by the user or programmatically. Remark: This method invocation must not reset the modifications. Only the modification state (modified or not) will be reseted.

Specified by:

resetModificationState in interface IInputComponent<VALUE_TYPE>

setValue

public void setValue(VALUE_TYPE value)

Description copied from interface: IInputValueAccessor

Sets the value

Specified by:

setValue in interface IInputValueAccessor<VALUE_TYPE>

Parameters:

value - The value, may be null

getValue

public VALUE_TYPE getValue()

Description copied from interface: IInputValueAccessor

Gets the value

Specified by:

getValue in interface IInputValueAccessor<VALUE_TYPE>

Returns:

The value, may be null

validate

public IValidationResult validate()

Description copied from interface: IValidateable

Does the validation

Specified by:

validate in interface IValidateable

Returns:

The validation result, must not be null

addValidationConditionListener

public void addValidationConditionListener(IValidationConditionListener listener)

Description copied from interface: IValidateable

Adds a validation condition listener

Specified by:

addValidationConditionListener in interface IValidateable

Parameters:

listener - The listener to add

removeValidationConditionListener

public void removeValidationConditionListener(IValidationConditionListener listener)

Description copied from interface: IValidateable

Removes a validation condition listener

Specified by:

removeValidationConditionListener in interface IValidateable

Parameters:

listener - The listener to remove

setEditable

public void setEditable(boolean editable)

Description copied from interface: IInputComponentCommon

Sets the editable state of the input component. A input component that is not editable can not be changed by the user

Specified by:

setEditable in interface IInputComponentCommon

Parameters:

editable - The editable state to set

addInputListener

public void addInputListener(IInputListener listener)

Description copied from interface: IInputObservable

Adds an input listener

Specified by:

addInputListener in interface IInputObservable

Parameters:

listener - The listener to add

removeInputListener

public void removeInputListener(IInputListener listener)

Description copied from interface: IInputObservable

Removes an input listener

Specified by:

removeInputListener in interface IInputObservable

Parameters:

listener - The listener to remove

isEditable

public boolean isEditable()

Description copied from interface: IInputComponent

Gets the editable state

Specified by:

isEditable in interface IInputComponent<VALUE_TYPE>

Returns:

True if the component is editable, false otherwise