Longbox"
From Documentation
m ((via JWB)) |
|||
(15 intermediate revisions by 6 users not shown) | |||
Line 3: | Line 3: | ||
= Longbox = | = Longbox = | ||
− | *Demonstration: [http://www.zkoss.org/zkdemo/ | + | *Demonstration: [http://www.zkoss.org/zkdemo/input/form_sample Longbox] |
*Java API: <javadoc>org.zkoss.zul.Longbox</javadoc> | *Java API: <javadoc>org.zkoss.zul.Longbox</javadoc> | ||
*JavaScript API: <javadoc directory="jsdoc">zul.inp.Longbox</javadoc> | *JavaScript API: <javadoc directory="jsdoc">zul.inp.Longbox</javadoc> | ||
+ | *Style Guide: [[ZK_Style_Guide/XUL_Component_Specification/Longbox | Longbox]] | ||
= Employment/Purpose = | = Employment/Purpose = | ||
+ | A long<code>box</code> is used to let users input long data. | ||
+ | = Example = | ||
− | = | + | [[Image:ZKComRef_longbox.jpg]] |
+ | |||
+ | <source lang="xml" > | ||
+ | <window title="Longbox Demo" border="normal" width="400px"> | ||
+ | long box:<longbox width="250px"/> | ||
+ | </window> | ||
+ | </source> | ||
+ | =Properties= | ||
+ | |||
+ | == Format == | ||
+ | You are able to format the field by providing specifying the attribute with a formatting string. The default value is <code>null</code>. | ||
+ | |||
+ | <source lang="xml" > | ||
+ | <longbox format="#,##0"/> | ||
+ | </source> | ||
+ | |||
+ | Since 8.5.2 | ||
+ | You can provide a locale to format the number by specify the String starts with "locale:" | ||
+ | |||
+ | <source lang="xml" > | ||
+ | <longbox format="locale:zh-TW"/> | ||
+ | </source> | ||
+ | |||
+ | == Constraint == | ||
+ | You could specify what value to accept for input controls by use of the <code>constraint </code>property. | ||
+ | It could be a combination of <code>no positive</code>, <code>no negative</code>, <code>no zero</code>, <code>no empty</code>. | ||
+ | |||
+ | To specify two or more constraints, use comma to separate them as follows. | ||
+ | |||
+ | <source lang="xml" > | ||
+ | <longbox constraint="no negative,no empty"/> | ||
+ | </source> | ||
+ | |||
+ | If you prefer to display different message to the default one, you can append the error message to the constraint with a colon. | ||
+ | |||
+ | <source lang="xml" > | ||
+ | <intbox constraint="no negative: it shall not be negative"/> | ||
+ | </source> | ||
+ | Notes: | ||
+ | * The error message, if specified, must be the last element and start with colon. | ||
+ | * To support multiple languages, you could use the 「l」 function as depicted in the '''Internationalization''' chapter. | ||
+ | <source lang="xml" > | ||
+ | <longbox constraint="no negative: ${c:l('err.num.negative')}"/> | ||
+ | </source> | ||
+ | =Inherited Functions= | ||
+ | Please refer to [[ZK_Component_Reference/Base_Components/NumberInputElement| NumberInputElement]] for inherited functions. | ||
− | =Supported | + | =Supported Events= |
− | {| | + | {| class='wikitable' | width="100%" |
! <center>Name</center> | ! <center>Name</center> | ||
! <center>Event Type</center> | ! <center>Event Type</center> | ||
Line 26: | Line 74: | ||
| None | | None | ||
|} | |} | ||
+ | *Inherited Supported Events: [[ZK_Component_Reference/Base_Components/NumberInputElement#Supported_Events | NumberInputElement]] | ||
=Supported Children= | =Supported Children= | ||
Line 31: | Line 80: | ||
*NONE | *NONE | ||
− | =Use | + | =Use Cases= |
− | {| | + | {| class='wikitable' | width="100%" |
! Version !! Description !! Example Location | ! Version !! Description !! Example Location | ||
|- | |- | ||
− | | | + | | |
| | | | ||
| | | | ||
Line 42: | Line 91: | ||
=Version History= | =Version History= | ||
− | + | {{LastUpdated}} | |
− | {| | + | {| class='wikitable' | width="100%" |
! Version !! Date !! Content | ! Version !! Date !! Content | ||
|- | |- | ||
− | | | + | | |
− | | | + | | |
− | | | + | | |
|} | |} | ||
{{ZKComponentReferencePageFooter}} | {{ZKComponentReferencePageFooter}} |
Latest revision as of 10:42, 12 January 2022
Longbox
Employment/Purpose
A longbox
is used to let users input long data.
Example
<window title="Longbox Demo" border="normal" width="400px">
long box:<longbox width="250px"/>
</window>
Properties
Format
You are able to format the field by providing specifying the attribute with a formatting string. The default value is null
.
<longbox format="#,##0"/>
Since 8.5.2
You can provide a locale to format the number by specify the String starts with "locale:"
<longbox format="locale:zh-TW"/>
Constraint
You could specify what value to accept for input controls by use of the constraint
property.
It could be a combination of no positive
, no negative
, no zero
, no empty
.
To specify two or more constraints, use comma to separate them as follows.
<longbox constraint="no negative,no empty"/>
If you prefer to display different message to the default one, you can append the error message to the constraint with a colon.
<intbox constraint="no negative: it shall not be negative"/>
Notes:
- The error message, if specified, must be the last element and start with colon.
- To support multiple languages, you could use the 「l」 function as depicted in the Internationalization chapter.
<longbox constraint="no negative: ${c:l('err.num.negative')}"/>
Inherited Functions
Please refer to NumberInputElement for inherited functions.
Supported Events
None | None |
- Inherited Supported Events: NumberInputElement
Supported Children
*NONE
Use Cases
Version | Description | Example Location |
---|---|---|
Version History
Version | Date | Content |
---|---|---|