org.jowidgets.api.widgets

Interface IInputComponent<VALUE_TYPE>

Type Parameters:

VALUE_TYPE - The type of the values the input component can handle with

All Superinterfaces:

IComponent, IComponentCommon, IComponentObservable, IDisposeObservable, IFocusObservable, IInputComponentCommon, IInputObservable, IInputValueAccessor<VALUE_TYPE>, IKeyObservable, IMouseMotionObservable, IMouseObservable, IPopupDetectionObservable, IShowingStateObservable, IValidateable, IWidget, IWidgetCommon

All Known Subinterfaces:

ICheckBox, IComboBox<VALUE_TYPE>, IInputComposite<INPUT_TYPE>, IInputControl<VALUE_TYPE>, IInputDialog<INPUT_TYPE>, IInputField<VALUE_TYPE>, ISlider, ISliderViewer<VALUE_TYPE>, ITextArea, IToggleButton, IUnitValueField<BASE_VALUE_TYPE,UNIT_VALUE_TYPE>

All Known Implementing Classes:

AbstractCompositeInputControl, AbstractInputControl, CheckBoxWrapper, ComboBoxWrapper, InputControlWrapper, InputDialogWrapper, JoCheckBox, JoComboBox, JoComboBoxSelection, JoInputField, JoToggleButton

public interface IInputComponent<VALUE_TYPE>
extends IComponent, IInputValueAccessor<VALUE_TYPE>, IValidateable, IInputComponentCommon

An input provides a user interface (HCI) for a specific VALUE_TYPE. The VALUE_TYPE can be simple (String, Integer, Float, ..) or complex (Person, Company, ...) A input component can validate its own state. Validators can be added to allow custom validation rules.

Method Summary

Methods

Modifier and Type	Method and Description
void	addValidator(IValidator<VALUE_TYPE> validator) Adds a validator to the input component
boolean	hasModifications() Determines if modifications has been occurred since object creation or the last invocation of resetModificationState().
boolean	isEditable() Gets the editable state
void	resetModificationState() Resets the modification state.

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, getParent, getRoot, 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.api.widgets.access.IInputValueAccessor

getValue, setValue

Methods inherited from interface org.jowidgets.validation.IValidateable

addValidationConditionListener, removeValidationConditionListener, validate

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

setEditable

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

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

addInputListener, removeInputListener

Method Detail

addValidator

void addValidator(IValidator<VALUE_TYPE> validator)

Adds a validator to the input component

Parameters:

validator - The validator to add, must not be null

hasModifications

boolean hasModifications()

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 resetModificationState() method will be invoked, so the method hasModifications() returns false. After pressing the '2' key, the method hasModifications() returns true, but the value is still null. After pressing the keys '0', '1' , '1', the method 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 hasModifications() returns false again, which indicates that the field is in it's original state.

Returns:

True if the component has modifications, false otherwise

See Also:

hasModifications()

resetModificationState

void resetModificationState()

Resets the modification state. After that, the 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.

isEditable

boolean isEditable()

Gets the editable state

Returns:

True if the component is editable, false otherwise