to.etc.domui.component.input

Class Text<T>

java.lang.Object

to.etc.domui.dom.css.CssBase

to.etc.domui.dom.html.NodeBase

to.etc.domui.dom.html.Input

to.etc.domui.component.input.Text<T>

All Implemented Interfaces:

ITypedControl<T>, IConvertable<T>, INodeErrorDelegate, IActionControl, IControl<T>, IHasChangeListener, IHasModifiedIndication, IHtmlInput, INativeChangeListener

Direct Known Subclasses:

DateInput, HiddenText, TextStr

public class Text<T>
extends Input
implements IControl<T>, IHasModifiedIndication, IConvertable<T>, ITypedControl<T>

A single-line input box. This extends the "input" tag with validation ability and methods to handle conversions and labels.

Author:

Frits Jalvingh Created on Jun 11, 2008

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Text.NumberMode

Constructor Summary

Constructors

Constructor and Description
Text(Class<T> inputClass)

Method Summary

Modifier and Type	Method and Description
boolean	acceptRequestParameter(String[] values) Handle the input from the request for this component.
void	addValidator(Class<? extends IValueValidator<T>> clz)
void	addValidator(Class<? extends IValueValidator<T>> clz, String[] parameters)
void	addValidator(IValueValidator<?> v)
void	addValidator(PropertyMetaValidator v)
static void	assignPrecisionValidator(Text<?> control, int precision, int scale) This adds a validator for the maximal and minimal value for a numeric input, depending on the precision and scale.
static void	assignPrecisionValidator(Text<?> control, PropertyMetaModel<?> pmm) This adds a validator for the maximal and minimal value for an input, gotten from the property metamodel.
void	clearMessage() Clear message and reset validated flag, so next getValue would result with new validation check.
static void	configureNumericInput(Text<?> txt, PropertyMetaModel<?> pmm, boolean editable)
static Text<BigDecimal>	createBDMoneyInput(Class<?> clz, String property, boolean editable)
static Text<BigDecimal>	createBDMoneyInput(PropertyMetaModel<BigDecimal> pmm, boolean editable)
static Text<BigDecimal>	createBigDecimalInput(Class<?> clz, String property, boolean editable)
void	createContent()
static Text<Double>	createDoubleInput(Class<?> clz, String property, boolean editable)
static Text<Double>	createDoubleMoneyInput(Class<?> clz, String property, boolean editable) Create a control to input a monetary value proper for the specified property.
static Text<Double>	createDoubleMoneyInput(PropertyMetaModel<Double> pmm, boolean editable)
static Text<Integer>	createIntInput(Class<?> clz, String property, boolean editable) Create an int input control, properly configured for the specified property.
static Text<Long>	createLongInput(Class<?> clz, String property, boolean editable)
static <T extends Number> Text<T>	createNumericInput(PropertyMetaModel<T> pmm, boolean editable)
static <T> Text<?>	createText(Class<?> clz, String property, boolean editable)
static <T> Text<T>	createText(Class<T> iclz, PropertyMetaModel<T> pmm, boolean editable)
static <T> Text<T>	createText(Class<T> iclz, PropertyMetaModel<T> pmm, boolean editable, boolean setDefaultErrorLocation)
Class<T>	getActualType() Returns the datatype of the value of this control, as passed in the constructor.
T	getBindValue() Bind-capable version of getValue().
IConverter<T>	getConverter() See IConvertable.getConverter().
String	getEmptyMarker() Returns assigned empty marker.
String	getMarkerImage() Returns assigned empty marker.
Text.NumberMode	getNumberMode() Returns the current numeric mode in effect.
String	getRegexpUserString()
String	getValidationRegexp()
T	getValue() Returns the current value of this input component.
T	getValueSafe() Like IControl.getValue() this returns the value of the component, but this returns null if the value was invalid.
boolean	hasError() Return T if this node currently has an error associated with it.
boolean	isMandatory() Returns T if this control is mandatory.
boolean	isModified() Returns the modified-by-user flag.
boolean	isUntrimmed() Returns T if the input is to be left untrimmed.
static void	main(String[] args)
void	setBindValue(T value)
void	setConverter(IConverter<T> converter) See IConvertable.setConverter(IConverter).
void	setMandatory(boolean mandatory) Set the control as mandatory.
void	setMarker() Method can be used to show default marker icon (THEME/icon-search.png) with magnifier image in background of input.
void	setMarker(String iconUrl) Method can be used to show custom marker icon as image in background of input.
void	setMarker(String iconUrl, String caption) Method can be used to show custom marker icon and custom label as image in background of input.
void	setMarkerImage(String emptyMarker) This sets a marker image to be used as the background image for an empty text box.
void	setMarkerText(String caption) Method can be used to show default marker icon (THEME/icon-search.png) with magnifier and custom label as image in background of input.
void	setModified(boolean as) Set or clear the modified by user flag.
void	setNumberMode(Text.NumberMode numberMode) Sets the current numeric mode in effect.
void	setRegexpUserString(String regexpUserString)
void	setUntrimmed(boolean untrimmed) Specify whether the input is to be space-trimmed before being used.
void	setValidationRegexp(String validationRegexp)
void	setValue(T value) Set a new value in this component.

Methods inherited from class to.etc.domui.dom.html.Input

componentHandleWebAction, getDisabledBecause, getInputType, getMaxLength, getOnKeyPressJS, getOnLookupTyping, getOnValueChanged, getRawValue, getSize, isDisabled, isReadOnly, setDisabled, setDisabledBecause, setMaxLength, setOnKeyPressJS, setOnLookupTyping, setOnValueChanged, setRawValue, setReadOnly, setSize, visit

Methods inherited from class to.etc.domui.dom.html.NodeBase

$, addBinding, addCssClass, addGlobalMessage, addNotificationListener, afterCreateContent, alignToLeft, alignToLeft, alignToMiddle, alignToMiddle, alignTopToBottom, alignTopToBottom, alignToRight, alignToRight, alignToTop, alignToTop, appendAfterMe, appendBeforeMe, appendCreateJS, appendJavascript, appendJQuerySelector, appendJsCustomUpdatesContributor, appendShowOverflowTextAsTitleJs, appendStatement, appendTreeErrors, beforeCreateContent, bind, bind, bindErrors, build, calcTestID, changed, changedJavascriptState, clearFocusRequested, clearGlobalMessage, clearGlobalMessage, clearGlobalMessage, clearValidationFailure, componentHandleWebDataRequest, createStatement, findComponentBundle, findParent, forceRebuild, getActualID, getAllocationTracepoint, getBindingErrors, getBindingList, getBrowserWindowSize, getCalculatedTestID, getClicked, getClientBounds, getComponentBundle, getComponentDataURL, getComponentDataURL, getComponentInfo, getComponentJSONURL, getCreateJS, getCssClass, getErrorList, getErrorLocation, getFocusID, getMessage, getOnClickJS, getOnMouseDownJS, getOnSizeAndPositionChange, getPage, getParent, getParent, getParent, getParentOfTypes, getSharedContext, getSharedContextFactory, getSpecialAttribute, getSpecialAttributeList, getTag, getTestID, getTestRepeatId, getThemedResourceRURL, getTitle, getUserObject, handleDrop, hasCssClass, hasParent, internalClearDelta, internalClearDeltaFully, internalCreateFrame, internalGetNodeCount, internalGetOldParent, internalGetParent, internalHasChangedAttributes, internalNeedClickHandler, internalOnBeforeRender, internalOnClicked, internalOnValueChanged, internalRenderJavascriptDelta, internalRenderJavascriptState, internalSetHasChangedAttributes, internalSetHasChangedAttributes, internalSetLogAllocations, internalSetTag, internalShelve, internalUnshelve, isAttached, isBuilt, isFocusable, isFocusRequested, isRendersOwnClose, isStretchHeight, lc, notify, notifyParentOrOpenerPage, onAddedToPage, onBeforeFullRender, onBeforeRender, onForceRebuild, onHeaderContributors, onRefresh, onRemoveFromPage, onShelve, onUnshelve, refresh, remove, removeBinding, removeCssClass, renderJavascriptDelta, renderJavascriptState, renderJavascriptState, replaceWith, setBrowserWindowSize, setCalculcatedId, setCalculcatedId, setClicked, setClientBounds, setComponentBundle, setCssClass, setErrorLocation, setFocus, setMessage, setOnClickJS, setOnMouseDownJS, setOnSizeAndPositionChange, setOverrideTitle, setSpecialAttribute, setStretchHeight, setTestID, setTestRepeatID, setTitle, setUserObject, toString

Methods inherited from class to.etc.domui.dom.css.CssBase

getBackgroundAttachment, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorderBottomColor, getBorderBottomStyle, getBorderBottomWidth, getBorderLeftColor, getBorderLeftStyle, getBorderLeftWidth, getBorderRightColor, getBorderRightStyle, getBorderRightWidth, getBorderTopColor, getBorderTopStyle, getBorderTopWidth, getBottom, getCachedStyle, getClear, getColor, getDisplay, getFloat, getFontFamily, getFontSize, getFontSizeAdjust, getFontStyle, getFontVariant, getFontWeight, getHeight, getLeft, getLineHeight, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOverflow, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getPosition, getRight, getTextAlign, getTop, getTransform, getVerticalAlign, getVisibility, getWidth, getZIndex, internalSetDisplay, setBackgroundAttachment, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBorder, setBorderBottomColor, setBorderBottomStyle, setBorderBottomWidth, setBorderColor, setBorderLeftColor, setBorderLeftStyle, setBorderLeftWidth, setBorderRightColor, setBorderRightStyle, setBorderRightWidth, setBorderStyle, setBorderTopColor, setBorderTopStyle, setBorderTopWidth, setBorderWidth, setBottom, setBottom, setCachedStyle, setClear, setColor, setDisplay, setFloat, setFontFamily, setFontSize, setFontSizeAdjust, setFontStyle, setFontVariant, setFontWeight, setHeight, setLeft, setLeft, setLineHeight, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setOverflow, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop, setPosition, setRight, setRight, setTextAlign, setTop, setTop, setTransform, setVerticalAlign, setVisibility, setWidth, setZIndex

Methods inherited from class java.lang.Object

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

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

getErrorLocation, isDisabled, isReadOnly, setErrorLocation, setReadOnly

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

getMessage, setMessage

Constructor Detail

Text

public Text(@Nonnull
            Class<T> inputClass)

Method Detail

acceptRequestParameter

public boolean acceptRequestParameter(@Nonnull
                                      String[] values)

Handle the input from the request for this component.

Overrides:

acceptRequestParameter in class Input

See Also:

Input.acceptRequestParameter(java.lang.String[])

getActualType

@Nonnull
public Class<T> getActualType()

Returns the datatype of the value of this control, as passed in the constructor.

Specified by:

getActualType in interface ITypedControl<T>

Returns:

getConverter

public IConverter<T> getConverter()

See IConvertable.getConverter(). This returns null if no converter has been set. It also returns null if a default converter is used.

Specified by:

getConverter in interface IConvertable<T>

Returns:

setConverter

public void setConverter(IConverter<T> converter)

See IConvertable.setConverter(IConverter). Sets the Converter to use to convert the string value to a T and vice versa. It is the programmer's responsibility to ensure that the converter actually converts to a T; if not the code will throw ClassCastExceptions.

Specified by:

setConverter in interface IConvertable<T>

Parameters:

converter -

getBindValue

public T getBindValue()

Bind-capable version of getValue(). If called (usually from binding) this will act as follows:

• If this component has an input error: throw the ValidationException for that error
• On no error this returns the value.

Returns:

setBindValue

public void setBindValue(@Nullable
                         T value)

getValue

public T getValue()

Description copied from interface: IControl

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 IControl.getValueSafe().

Specified by:

getValue in interface IControl<T>

Returns:

See Also:

IControl.getValue()

clearMessage

public void clearMessage()

Clear message and reset validated flag, so next getValue would result with new validation check.

Specified by:

clearMessage in interface INodeErrorDelegate

Overrides:

clearMessage in class NodeBase

See Also:

NodeBase.clearMessage()

getValueSafe

public T getValueSafe()

Description copied from interface: IControl

Like IControl.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 IControl.hasError() or use IControl.getValue() instead of this call.

Specified by:

getValueSafe in interface IControl<T>

Returns:

See Also:

IControl.getValueSafe()

hasError

public boolean hasError()

Description copied from class: NodeBase

Return T if this node currently has an error associated with it.

Specified by:

hasError in interface IControl<T>

Overrides:

hasError in class NodeBase

Returns:

See Also:

IControl.hasError()

setValue

public void setValue(@Nullable
                     T value)

Set a new value in this component. The value will be converted to a string representation by any converter set or by one of the default converters. This string value will then be shown to the users.

Specified by:

setValue in interface IControl<T>

See Also:

IControl.setValue(java.lang.Object)

isMandatory

public boolean isMandatory()

Returns T if this control is mandatory.

Specified by:

isMandatory in interface IControl<T>

Returns:

See Also:

IControl.isMandatory()

setMandatory

public void setMandatory(boolean mandatory)

Set the control as mandatory. A mandatory control expects the value filled in to be non-whitespace.

Specified by:

setMandatory in interface IControl<T>

See Also:

IControl.setMandatory(boolean)

isUntrimmed

public boolean isUntrimmed()

Returns T if the input is to be left untrimmed.

Returns:

setUntrimmed

public void setUntrimmed(boolean untrimmed)

Specify whether the input is to be space-trimmed before being used. This defaults to TRUE, causing values to be trimmed before being returned to the converter code.

Parameters:

untrimmed -

getEmptyMarker

public String getEmptyMarker()

Returns assigned empty marker.

See Also:

setEmptyMarker(String)

setMarkerImage

public void setMarkerImage(String emptyMarker)

This sets a marker image to be used as the background image for an empty text box. It should contain the URL to a fully-constructed background image. To create such an image from an icon plus text use one of the setMarkerXxx methods. This method should be used only for manually-constructed images.

Parameters:

emptyMarker -

getMarkerImage

public String getMarkerImage()

Returns assigned empty marker.

See Also:

setMarkerImage(String)

setMarker

public void setMarker()

Method can be used to show default marker icon (THEME/icon-search.png) with magnifier image in background of input. Image is hidden when input have focus or has any content.

setMarker

public void setMarker(String iconUrl)

Method can be used to show custom marker icon as image in background of input. Image is hidden when input have focus or has any content.

Parameters:

iconUrl -

setMarkerText

public void setMarkerText(String caption)

Method can be used to show default marker icon (THEME/icon-search.png) with magnifier and custom label as image in background of input. Image is hidden when input have focus or has any content.

Parameters:

caption -

setMarker

public void setMarker(String iconUrl,
                      String caption)

Method can be used to show custom marker icon and custom label as image in background of input. Image is hidden when input have focus or has any content.

Parameters:

iconUrl -

caption -

getNumberMode

@Nonnull
public Text.NumberMode getNumberMode()

Returns the current numeric mode in effect. This mode prevents letters from being input on the screen.

Returns:

setNumberMode

public void setNumberMode(@Nonnull
                          Text.NumberMode numberMode)

Sets the current numeric mode in effect. This mode prevents letters from being input on the screen.

Parameters:

numberMode -

addValidator

public void addValidator(IValueValidator<?> v)

addValidator

public void addValidator(PropertyMetaValidator v)

addValidator

public void addValidator(Class<? extends IValueValidator<T>> clz)

addValidator

public void addValidator(Class<? extends IValueValidator<T>> clz,
                         String[] parameters)

getValidationRegexp

public String getValidationRegexp()

setValidationRegexp

public void setValidationRegexp(String validationRegexp)

getRegexpUserString

public String getRegexpUserString()

setRegexpUserString

public void setRegexpUserString(String regexpUserString)

isModified

public boolean isModified()

Returns the modified-by-user flag.

Specified by:

isModified in interface IHasModifiedIndication

See Also:

IHasModifiedIndication.isModified()

setModified

public void setModified(boolean as)

Set or clear the modified by user flag.

Specified by:

setModified in interface IHasModifiedIndication

See Also:

IHasModifiedIndication.setModified(boolean)

assignPrecisionValidator

public static final void assignPrecisionValidator(@Nonnull
                                                  Text<?> control,
                                                  @Nonnull
                                                  PropertyMetaModel<?> pmm)

This adds a validator for the maximal and minimal value for an input, gotten from the property metamodel.

Parameters:

control -

pmm -

assignPrecisionValidator

public static final void assignPrecisionValidator(@Nonnull
                                                  Text<?> control,
                                                  int precision,
                                                  int scale)

This adds a validator for the maximal and minimal value for a numeric input, depending on the precision and scale.

Parameters:

control -

precision -

scale -

createDoubleMoneyInput

@Nonnull
public static Text<Double> createDoubleMoneyInput(@Nonnull
                                                           Class<?> clz,
                                                           @Nonnull
                                                           String property,
                                                           boolean editable)

Create a control to input a monetary value proper for the specified property.

Parameters:

clz -

property -

Returns:

createBDMoneyInput

@Nonnull
public static Text<BigDecimal> createBDMoneyInput(Class<?> clz,
                                                           String property,
                                                           boolean editable)

createBDMoneyInput

@Nonnull
public static Text<BigDecimal> createBDMoneyInput(PropertyMetaModel<BigDecimal> pmm,
                                                           boolean editable)

createDoubleMoneyInput

@Nonnull
public static Text<Double> createDoubleMoneyInput(@Nonnull
                                                           PropertyMetaModel<Double> pmm,
                                                           boolean editable)

configureNumericInput

public static void configureNumericInput(@Nonnull
                                         Text<?> txt,
                                         @Nonnull
                                         PropertyMetaModel<?> pmm,
                                         boolean editable)

createNumericInput

@Nonnull
public static <T extends Number> Text<T> createNumericInput(PropertyMetaModel<T> pmm,
                                                                     boolean editable)

createIntInput

@Nonnull
public static Text<Integer> createIntInput(Class<?> clz,
                                                    String property,
                                                    boolean editable)

Create an int input control, properly configured for the specified property.

Parameters:

clz -

property -

editable -

Returns:

createLongInput

@Nonnull
public static Text<Long> createLongInput(Class<?> clz,
                                                  String property,
                                                  boolean editable)

createDoubleInput

@Nonnull
public static Text<Double> createDoubleInput(Class<?> clz,
                                                      String property,
                                                      boolean editable)

createBigDecimalInput

@Nonnull
public static Text<BigDecimal> createBigDecimalInput(Class<?> clz,
                                                              String property,
                                                              boolean editable)

createText

@Nonnull
public static <T> Text<?> createText(Class<?> clz,
                                              String property,
                                              boolean editable)

createText

@Nonnull
public static <T> Text<T> createText(Class<T> iclz,
                                              PropertyMetaModel<T> pmm,
                                              boolean editable)

createText

@Nonnull
public static <T> Text<T> createText(Class<T> iclz,
                                              PropertyMetaModel<T> pmm,
                                              boolean editable,
                                              boolean setDefaultErrorLocation)

createContent

public void createContent()
                   throws Exception

Overrides:

createContent in class NodeBase

Throws:

Exception

main

public static void main(String[] args)