public abstract class InputElement extends XulElement implements Constrainted, Readonly, Disable
Events: onChange, onChanging, onFocus, onBlur, onSelection.
HtmlBasedComponent.ExtraCtrl
AbstractComponent.Children
Modifier and Type | Field and Description |
---|---|
protected java.lang.Object |
_value
The value.
|
_zclass
APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE
AFTER_CHILD_ADDED, AFTER_CHILD_REMOVED, AFTER_PAGE_ATTACHED, AFTER_PAGE_DETACHED, CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE
Constructor and Description |
---|
InputElement() |
Modifier and Type | Method and Description |
---|---|
protected void |
checkUserError()
Checks whether user entered a wrong value (and not correct it yet).
|
void |
clearErrorMessage()
Clears the error message.
|
void |
clearErrorMessage(boolean revalidateRequired)
Clears the error message.
|
java.lang.Object |
clone()
Clones the component.
|
protected abstract java.lang.Object |
coerceFromString(java.lang.String value)
Coerces the value passed to
setText(java.lang.String) . |
protected abstract java.lang.String |
coerceToString(java.lang.Object value)
Coerces the value passed to
setText(java.lang.String) . |
int |
getCols()
Returns the cols.
|
Constraint |
getConstraint()
Returns the constraint, or null if no constraint at all.
|
java.lang.String |
getErrorboxIconSclass()
Returns the class name of the custom style applied to the errorbox icon of this component.
|
java.lang.String |
getErrorboxSclass()
Returns the class name of the custom style applied to the errorbox of this component.
|
java.lang.String |
getErrorMessage()
Returns the error message that is caused when user entered
invalid value, or null if no error at all.
|
boolean |
getInstant()
Returns true if onChange event is sent as soon as user types in the input
component.
|
int |
getMaxlength()
Returns the maxlength.
|
java.lang.String |
getName()
Returns the name of this component.
|
java.lang.String |
getPlaceholder()
Returns the placeholder text
|
PropertyAccess |
getPropertyAccess(java.lang.String prop)
Returns the corresponding property access object from the given property
name, if any.
|
java.lang.String |
getRawText()
Returns the text directly without checking whether any error
message not yet fixed.
|
java.lang.Object |
getRawValue()
Returns the raw value directly with checking whether any
error message not yet fixed.
|
protected java.lang.Object |
getTargetValue()
Returns the value in the targeting type.
|
java.lang.String |
getText()
Returns the value in the String format.
|
java.lang.String |
getType()
Returns the type.
|
protected boolean |
isChildable()
Not childable.
|
boolean |
isDisabled()
Returns whether it is disabled.
|
boolean |
isInplace()
Returns whether enable the inplace-editing.
|
boolean |
isInstant()
Returns true if onChange event is sent as soon as user types in the input
component.
|
boolean |
isMultiline()
Returns whether it is multiline.
|
boolean |
isReadonly()
Returns whether it is readonly.
|
boolean |
isValid()
Returns the current content of this input is correct.
|
protected java.lang.Object |
marshall(java.lang.Object value)
Marshall value to be sent to the client if needed.
|
WrongValueException |
onWrongValue(WrongValueException ex)
Notifies that an
WrongValueException instance is thrown,
and WrongValueException.getComponent() is this component. |
protected void |
renderProperties(ContentRenderer renderer)
Renders the content of this component, excluding the enclosing
tags and children.
|
void |
select()
Selects the whole text in this input.
|
void |
service(AuRequest request,
boolean everError)
Processes an AU request.
|
void |
setCols(int cols)
Sets the cols.
|
void |
setConstraint(Constraint constr)
Sets the constraint.
|
void |
setConstraint(java.lang.String constr) |
void |
setDisabled(boolean disabled)
Sets whether it is disabled.
|
void |
setErrorboxIconSclass(java.lang.String iconSclass)
Sets the class name of the custom style to be applied to the errorbox icon of this component.
|
void |
setErrorboxSclass(java.lang.String sclass)
Sets the class name of the custom style to be applied to the errorbox of this component.
|
void |
setErrorMessage(java.lang.String errmsg)
Associates an error message to this input.
|
void |
setInplace(boolean inplace)
Sets to enable the inplace-editing function that the look and feel is
like a label.
|
void |
setInsertedText(java.lang.String text)
Inserts the text at the current cursor position.
|
void |
setInstant(boolean instant)
Sets the instant attribute.
|
void |
setMaxlength(int maxlength)
Sets the maxlength.
|
void |
setName(java.lang.String name)
Sets the name of this component.
|
void |
setPlaceholder(java.lang.String placeholder)
Sets the placeholder text that is displayed when input is empty.
|
void |
setRawValue(java.lang.Object value)
Sets the raw value directly.
|
void |
setReadonly(boolean readonly)
Sets whether it is readonly.
|
void |
setSelectedText(int start,
int end,
java.lang.String newtxt,
boolean isHighLight)
Sets the text of this InputElement to the specified text which is
beginning with the new start point and ending with the new end point.
|
void |
setSelectionRange(int start,
int end)
Sets the selection end to the specified position and the selection start
to the specified position.
|
void |
setText(java.lang.String value)
Sets the value in the String format.
|
protected void |
setValueDirectly(java.lang.Object value)
Sets the value directly.
|
protected WrongValueException |
showCustomError(WrongValueException ex)
Shows the error message in the custom way by calling
(
CustomConstraint.showCustomError(org.zkoss.zk.ui.Component, org.zkoss.zk.ui.WrongValueException) , if the constraint
implements CustomConstraint . |
protected java.lang.Object |
unmarshall(java.lang.Object value)
Unmarshall value returned from client if needed.
|
protected void |
validate(java.lang.Object value)
Validates the value returned by
coerceFromString(java.lang.String) . |
getContext, getCtrlKeys, getPopup, getTooltip, setContext, setContext, setContextAttributes, setCtrlKeys, setPopup, setPopup, setPopupAttributes, setTooltip, setTooltip, setTooltipAttributes
focus, getAction, getDraggable, getDroppable, getExtraCtrl, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTabindex, getTabindexInteger, getTooltiptext, getTop, getVflex, getWidth, getZclass, getZindex, getZIndex, setAction, setClass, setDraggable, setDroppable, setFocus, setHeight, setHeight0, setHeightDirectly, setHflex, setHflex0, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, setSclass, setStyle, setTabindex, setTabindex, setTooltiptext, setTop, setTopDirectly, setVflex, setVflex0, setVflexDirectly, setWidth, setWidth0, setWidthDirectly, setZclass, setZindex, setZIndex, setZIndexDirectly
addAnnotation, addAnnotation, addCallback, addClientEvent, addEventHandler, addEventListener, addEventListener, addForward, addForward, addForward, addForward, addMoved, addRedrawCallback, addScopeListener, addShadowRoot, addShadowRootBefore, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildAdded, beforeChildRemoved, beforeParentChanged, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableBindingAnnotation, disableClientUpdate, enableBindingAnnotation, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getCallback, getChildren, getClientAttribute, getClientDataAttribute, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getEventListenerMap, getEventListeners, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRedrawCallback, getRoot, getShadowFellowIfAny, getShadowRoots, getShadowVariable, getShadowVariable, getShadowVariable0, getSpaceOwner, getSpecialRendererOutput, getStubonly, getSubBindingAnnotationCount, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasBindingAnnotation, hasFellow, hasFellow, hasSubBindingAnnotation, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onChildRemoved, onPageAttached, onPageDetached, query, queryAll, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeCallback, removeChild, removeEventListener, removeForward, removeForward, removeRedrawCallback, removeScopeListener, removeShadowRoot, render, render, render, replace, response, response, response, service, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setAutag, setClientAttribute, setClientDataAttribute, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setStubonly, setSubBindingAnnotationCount, setTemplate, setVisible, setVisibleDirectly, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, updateByClient, updateSubBindingAnnotationCount, willPassivate, willPassivate, willSerialize, willSerialize
public java.lang.String getPlaceholder()
public void setPlaceholder(java.lang.String placeholder)
public void setInplace(boolean inplace)
public boolean isInplace()
default: false.
public boolean isDisabled()
Default: false.
isDisabled
in interface Disable
public void setDisabled(boolean disabled)
setDisabled
in interface Disable
public boolean isReadonly()
Default: false.
isReadonly
in interface Readonly
public void setReadonly(boolean readonly)
setReadonly
in interface Readonly
public java.lang.String getName()
Default: null.
Don't use this method if your application is purely based on ZK's event-driven model.
The name is used only to work with "legacy" Web application that handles user's request by servlets. It works only with HTTP/HTML-based browsers. It doesn't work with other kind of clients.
public void setName(java.lang.String name)
Don't use this method if your application is purely based on ZK's event-driven model.
The name is used only to work with "legacy" Web application that handles user's request by servlets. It works only with HTTP/HTML-based browsers. It doesn't work with other kind of clients.
name
- the name of this component.public java.lang.String getErrorMessage()
The error message is set when user has entered a wrong value, or setValue is called with a wrong value. It is cleared once a correct value is assigned.
If the error message is set, we say this input is in the error mode.
Any following invocation to getText()
or getValue will throw
any exception.
Example, Textbox.getValue()
and
Intbox.getValue()
.
public void setErrorMessage(java.lang.String errmsg)
Notice that the application rarely invokes this method. Rather,
throw WrongValueException
instead.
Notice it does not invoke CustomConstraint.showCustomError(org.zkoss.zk.ui.Component, org.zkoss.zk.ui.WrongValueException)
even if getConstraint()
implements CustomConstraint
.
public void clearErrorMessage(boolean revalidateRequired)
The error message is cleared automatically, so you rarely need to call this method. However, if a constraint depends on multiple input fields and the error can be corrected by changing one of these fields, then you may have to clear the error message manually by invoking this method.
For example, assume you have two Intbox
and want the value of the first one to be smaller than that of the
second one. Then, you have to call this method for the second intbox
once the validation of the first intbox succeeds, and vice versa.
Otherwise, the error message for the second intbox remains if
the user fixed the error by lowering down the value of the first one
Why? The second intbox got no idea to clear the error message
(since its content doesn't change).
revalidateRequired
- whether to re-validate the current value
when getText()
or others (such as Intbox.getValue()
)
is called.
If false, the current value is assumed to be correct and
the following invocation to getText()
or others (such as Intbox.getValue()
)
won't check the value again.
Note: when an input element is constructed, the initial value
is assumed to be "not-validated-yet".public void clearErrorMessage()
getText()
or others (such as Intbox.getValue()
)
won't re-validate it again.
The error message is cleared automatically, so you rarely need to call this method.
clearErrorMessage(boolean)
public java.lang.String getText() throws WrongValueException
Textbox.getValue()
and
Intbox.getValue()
.
It invokes checkUserError()
to ensure no user error.
It invokes coerceToString(java.lang.Object)
to convert the stored value
into a string.
WrongValueException
- if user entered a wrong valuepublic void setText(java.lang.String value) throws WrongValueException
Textbox.setValue(java.lang.String)
and
Intbox.setValue(java.lang.Integer)
.
It invokes coerceFromString(java.lang.String)
first and then validate(java.lang.Object)
.
Derives might override them for type conversion and special
validation.
value
- the value; If null, it is considered as empty.WrongValueException
protected abstract java.lang.Object coerceFromString(java.lang.String value) throws WrongValueException
setText(java.lang.String)
.
Deriving note:
If you want to store the value in other type, say BigDecimal,
you have to override coerceToString(java.lang.Object)
and coerceFromString(java.lang.String)
to convert between a string and your targeting type.
Moreover, when Textbox
is called, it calls this method
with value = null. Derives shall handle this case properly.
WrongValueException
protected abstract java.lang.String coerceToString(java.lang.Object value)
setText(java.lang.String)
.
Default: convert null to an empty string.
Deriving note:
If you want to store the value in other type, say BigDecimal,
you have to override coerceToString(java.lang.Object)
and coerceFromString(java.lang.String)
to convert between a string and your targeting type.
protected void validate(java.lang.Object value) throws WrongValueException
coerceFromString(java.lang.String)
.
Default: use getConstraint()
's Constraint.validate(org.zkoss.zk.ui.Component, java.lang.Object)
,
if not null.
You rarely need to override this method.
WrongValueException
protected WrongValueException showCustomError(WrongValueException ex)
CustomConstraint.showCustomError(org.zkoss.zk.ui.Component, org.zkoss.zk.ui.WrongValueException)
, if the constraint
implements CustomConstraint
.
Derived class shall call this method before throwing
WrongValueException
, such that the constraint,
if any, has a chance to show the error message in a custom way.
ex
- the exception, or null to clean up the error.public int getMaxlength()
Default: 0 (non-positive means unlimited).
public void setMaxlength(int maxlength)
The length includes the format, if specified.
public int getCols()
Default: 0 (non-positive means the same as browser's default).
public void setCols(int cols) throws WrongValueException
WrongValueException
public boolean getInstant()
Default: false
public boolean isInstant()
Default: false
public void setInstant(boolean instant)
public boolean isMultiline()
Default: false.
public java.lang.String getType()
Default: text.
public void select()
public void setConstraint(java.lang.String constr)
public void setConstraint(Constraint constr)
Constrainted
Default: null (means no constraint all all).
setConstraint
in interface Constrainted
public Constraint getConstraint()
Constrainted
getConstraint
in interface Constrainted
protected java.lang.Object getTargetValue() throws WrongValueException
Intbox.getValue()
is the same
as this method except with a different signature.
It invokes checkUserError()
to ensure no user error.
WrongValueException
- if the user entered a wrong valuegetText()
public java.lang.Object getRawValue()
checkUserError()
.
Note: if the user entered an incorrect value (i.e., caused
WrongValueException
), the incorrect value doesn't
be stored so this method returned the last correct value.
getRawText()
,
getText()
,
setRawValue(java.lang.Object)
public java.lang.String getRawText()
checkUserError()
.
Note: if the user entered an incorrect value (i.e., caused
WrongValueException
), the incorrect value doesn't
be stored so this method returned the last correct value.
getRawValue()
,
getText()
public void setRawValue(java.lang.Object value)
If you feel confusing with setValue, such as Textbox.setValue(java.lang.String)
,
it is usually better to use setValue instead. This method
is reserved for developer that really want to set an 'illegal'
value (such as an empty string to a textbox with no-empty constraint).
Note: since 3.0.1, the value will be re-validate again if
getText()
or others (such as Intbox.getValue()
)
is called. In other words, it is assumed that the specified value
is not validated yet -- the same state when this component is
created. If you want to avoid the re-validation, you have to invoke
clearErrorMessage()
.
Like setValue, the result is returned back to the server
by calling getText()
.
getRawValue()
protected void setValueDirectly(java.lang.Object value)
setRawValue(java.lang.Object)
(nor setValue), this method
assigns the value directly without clearing error message or
synchronizing with the client.
It is usually used only the constructor.
Though it is also OK to use setRawValue(java.lang.Object)
in the constructor,
this method has better performance.
public boolean isValid()
public void setSelectedText(int start, int end, java.lang.String newtxt, boolean isHighLight)
start
- the start position of the text (included)end
- the end position of the text (excluded)newtxt
- the new text to be set.isHighLight
- Sets whether it will represent highlight style or cursor
style.If the start point same with the end point always
represent cursor style.public void setSelectionRange(int start, int end)
Set both arguments to the same value to move the cursor to the corresponding position without selecting text.
start
- the start position of the text (included)end
- the end position of the text (excluded)public void setInsertedText(java.lang.String text)
text
- the text to be insertedprotected void checkUserError() throws WrongValueException
getText()
or getTargetValue()
is
called.
Derives rarely need to access this method if they use only
getText()
and getTargetValue()
.
WrongValueException
public java.lang.String getErrorboxSclass()
public void setErrorboxSclass(java.lang.String sclass)
sclass
- public java.lang.String getErrorboxIconSclass()
public void setErrorboxIconSclass(java.lang.String iconSclass)
iconSclass
- protected boolean isChildable()
isChildable
in class AbstractComponent
public WrongValueException onWrongValue(WrongValueException ex)
AbstractComponent
WrongValueException
instance is thrown,
and WrongValueException.getComponent()
is this component.
It is a callback and the component can store the error message,
show up the custom information, or even 'eat' the exception.
Default: does nothing but returns ex.
onWrongValue
in interface ComponentCtrl
onWrongValue
in class AbstractComponent
ex
- the exception being thrown (never null)protected java.lang.Object marshall(java.lang.Object value)
Overrides it if the value to be sent to the client is not JSON Compatible.
value
- the value to be sent to the clientprotected java.lang.Object unmarshall(java.lang.Object value)
Overrides it if the value returned is not JSON Compatible.
value
- the value returned from clientpublic void service(AuRequest request, boolean everError)
Default: in addition to what are handled by HtmlBasedComponent.service(org.zkoss.zk.au.AuRequest, boolean)
,
it also handles onChange, onChanging and onError.
service
in interface ComponentCtrl
service
in class HtmlBasedComponent
everError
- whether any error ever occurred before
processing this request.AbstractComponent.setAuService(org.zkoss.zk.au.AuService)
protected void renderProperties(ContentRenderer renderer) throws java.io.IOException
HtmlBasedComponent
renderProperties
in class XulElement
java.io.IOException
public PropertyAccess getPropertyAccess(java.lang.String prop)
ComponentCtrl
getPropertyAccess
in interface ComponentCtrl
getPropertyAccess
in class XulElement
prop
- the name of the propertypublic java.lang.Object clone()
Component
clone
in interface Component
clone
in class XulElement
Copyright © 2005-2018 Potix Corporation. All Rights Reserved.