to.etc.domui.dom.html

Interface IControl<T>

All Superinterfaces:

IActionControl, IHasChangeListener, INodeErrorDelegate

All Known Subinterfaces:

IDisplayControl<T>

All Known Implementing Classes:

AbstractDivControl, Checkbox, CheckboxSetInput, CheckboxSetInputBase, CKEditor, ColorPickerButton, ColorPickerInput, ComboBoxBase, ComboComponentBase, ComboComponentBase2, ComboFixed, ComboFixed2, ComboFixedClientFilter, ComboLookup, ComboLookup2, DateInput, DisplayCheckbox, DisplayHtml, DisplayImage, DisplaySpan, DisplayValue, DropDownPicker, EditableDropDownPicker, FileUpload, HiddenText, HtmlEditor, ImageSelectControl, LabelSelector, LookupInput, LookupInput2, LookupInputBase, LookupInputBase2, MultipleLookupInput, RelationLookupDisplayInput, SelectFixed, Text, TextArea, TextDisplayArea, TextStr

public interface IControl<T>
extends IActionControl, IHasChangeListener, INodeErrorDelegate

Something to control a control: some input or control comnponent in a generic way. This interface is allowed to be implemented on non-nodebase object.

Author:

Frits Jalvingh Created on Dec 6, 2009

Method Summary

Modifier and Type	Method and Description
String	getErrorLocation() When set this contains a user-understandable tekst indicating which control has the error.
T	getValue() Returns the current value of this input component.
T	getValueSafe() Like getValue() this returns the value of the component, but this returns null if the value was invalid.
boolean	hasError() Returns T if this control is currently in error state, meaning it's input is in some way invalid.
boolean	isDisabled() Returns T if the control is currently in disabled.
boolean	isMandatory() Returns T if this control is a mandatory input.
boolean	isReadOnly() Returns T if the control is currently in readonly mode.
void	setErrorLocation(String errorLocation) When set this contains a user-understandable tekst indicating which control has the error.
void	setMandatory(boolean ro) Make the control mandatory.
void	setReadOnly(boolean ro) Sets the input to readonly-mode.
void	setValue(T v) Set a new value into this control.

Methods inherited from interface to.etc.domui.dom.html.IActionControl

setDisabled, setTestID

Methods inherited from interface to.etc.domui.dom.html.IHasChangeListener

getOnValueChanged, setOnValueChanged

Methods inherited from interface to.etc.domui.dom.errors.INodeErrorDelegate

clearMessage, getMessage, setMessage

Method Detail

setValue

void setValue(@Nullable
              T v)

Set a new value into this control. Setting a value to null means the control holds no value. This value is converted to a presentable form using any (implicitly) defined converters; it will not be validated though! This means that if you set an invalid value for a validator this will not be seen until the value is gotten from the control again.

Parameters:

v -

getValue

@Nullable
T getValue()

Returns the current value of this input component. If the component contains no value this returns null. All text input components will return null when their value is the empty string! If the component, during conversion or validation of the input value, discovers that the input is invalid it will set itself in "error" mode, post an error message up the form, and throw a ValidationException. This means that this call either delivers correct input (as defined by it's converter and validators), null (when empty) or throws an exception. When a ValidationException occurs the framework mostly ignores it - it does not produce a stacktrace or error in the client. Instead the resulting error as posted by the error handling framework gets displayed on the form when the request completes.

To get the value of a component while ignoring exceptions call getValueSafe().

Returns:

getValueSafe

T getValueSafe()

Like getValue() this returns the value of the component, but this returns null if the value was invalid. For this method NULL either means the value was invalid OR it's content was empty. To distinguish between the two call hasError() or use getValue() instead of this call.

Returns:

hasError

boolean hasError()

Returns T if this control is currently in error state, meaning it's input is in some way invalid. This call internally calls getValue() to ensure it's error state is valid for the current data held.

Returns:

isReadOnly

boolean isReadOnly()

Returns T if the control is currently in readonly mode. Controls that do not have a readonly ability (comboboxes) will use disabled as the readonly state. For those controls the readonly state mirrors the disabled state.

Returns:

setReadOnly

void setReadOnly(boolean ro)

Sets the input to readonly-mode. Components that do not implement readonly mode (comboboxes) will usually set themselves to disabled which works much the same.

Parameters:

ro -

isDisabled

boolean isDisabled()

Returns T if the control is currently in disabled. Controls that do not have a readonly ability (comboboxes) will use disabled as the readonly state. For those controls the readonly state mirrors the disabled state.

Returns:

isMandatory

boolean isMandatory()

Returns T if this control is a mandatory input.

Returns:

setMandatory

void setMandatory(boolean ro)

Make the control mandatory.

Parameters:

ro -

setErrorLocation

void setErrorLocation(@Nullable
                      String errorLocation)

When set this contains a user-understandable tekst indicating which control has the error. It usually contains the "label" associated with the control, and is set automatically by form builders if possible.

Parameters:

errorLocation -

getErrorLocation

@Nullable
String getErrorLocation()

When set this contains a user-understandable tekst indicating which control has the error. It usually contains the "label" associated with the control, and is set automatically by form builders if possible.

Returns: