Decimalbox"

From Documentation
 
(19 intermediate revisions by 8 users not shown)
Line 3: Line 3:
 
= Decimalbox =
 
= Decimalbox =
  
*Demonstration: [http://www.zkoss.org/zkdemo/userguide/#f2 Decimalbox ]
+
*Demonstration: [http://www.zkoss.org/zkdemo/input/form_sample Decimalbox ]
 
*Java API: <javadoc>org.zkoss.zul.Decimalbox</javadoc>
 
*Java API: <javadoc>org.zkoss.zul.Decimalbox</javadoc>
 
*JavaScript API: <javadoc directory="jsdoc">zul.inp.Decimalbox</javadoc>
 
*JavaScript API: <javadoc directory="jsdoc">zul.inp.Decimalbox</javadoc>
 +
*Style Guide: [[ZK_Style_Guide/XUL_Component_Specification/Decimalbox | Decimalbox]]
  
 
= Employment/Purpose =
 
= Employment/Purpose =
Line 13: Line 14:
 
= Example =
 
= Example =
  
 +
[[Image:ZKComRef_Decimalbox_Examples.PNG]]
  
 +
<source lang="xml" >
 +
<decimalbox value="155"/>
 +
</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>.
  
=Supported events=
+
<source lang="xml" >
 +
<decimalbox format="#,##0.##"/>
 +
</source>
  
{| border="1" | width="100%"
+
{{versionSince| 8.5.2}}
! <center>Name</center>
+
You can provide a locale to format the number by specifying a value starting with "locale:", e.g. [https://en.wikipedia.org/wiki/Indian_numbering_system Indian numbering system]:
! <center>Event Type</center>
+
 
|-
+
<source lang="xml" >
| <center>onBlur</center>
+
<decimalbox format="locale:en-In"/>
| '''Event:'''<javadoc>org.zkoss.zk.ui.even.Event</javadoc>
+
</source>
 +
 
 +
Ref: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat
 +
 
 +
<!-- https://tracker.zkoss.org/browse/ZK-3704 -->
 +
 
 +
== Constraint ==
 +
You could specify what value to accept for input controls by the 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>.
  
Denotes when a component loses the focus.
+
To specify two or more constraints, use comma to separate them as follows.
  
|-
+
<source lang="xml" >
| <center> onChange</center>
+
<decimalbox constraint="no negative,no empty"/>
| '''Event:'''<javadoc>org.zkoss.zk.ui.even.InputEvent</javadoc>
+
</source>
  
An input control notifies the application with the onChange event if its content is changed by the user.
+
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" >
| <center>onChanging</center>
+
<decimalbox constraint="no negative: it shall not be negative"/>
| '''Event:'''<javadoc>org.zkoss.zk.ui.even.InputEvent</javadoc>
+
</source>
  
An input control also notifies the application with the onChanging event, when user is changing the content.
+
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" >
| <center>onFocus</center>
+
<decimalbox constraint="no negative: ${c:l('err.num.negative')}"/>
| '''Event:'''<javadoc>org.zkoss.zk.ui.event.Event</javadoc>
+
</source>
  
Denotes when a component gets the focus.
+
=Inherited Functions=
  
|-
+
Please refer to [[ZK_Component_Reference/Base_Components/NumberInputElement| NumberInputElement]] for inherited functions.
| <center>OnSelection</center>
 
| '''Event:'''<javadoc>org.zkoss.zk.ui.event.SelectionEvent</javadoc>
 
  
Denotes that user is selecting a portion of the text of an input component. You can retrieve the start and end position of the selected text by use of the getStart and getEnd methods.</tt>
+
=Supported Events=
  
 +
{| class='wikitable' | width="100%"
 +
! <center>Name</center>
 +
! <center>Event Type</center>
 +
|-
 +
| None
 +
| None
 
|}
 
|}
 +
*Inherited Supported Events: [[ZK_Component_Reference/Base_Components/NumberInputElement#Supported_Events | NumberInputElement]]
  
 
=Supported Children=
 
=Supported Children=
Line 58: Line 83:
 
  *NONE
 
  *NONE
  
=Use cases=
+
=Use Cases=
  
{| border='1px' | width="100%"
+
{| class='wikitable' | width="100%"
 
! Version !! Description !! Example Location
 
! Version !! Description !! Example Location
 
|-
 
|-
| 5.0+
+
| &nbsp;
 
| &nbsp;
 
| &nbsp;
 
| &nbsp;
 
| &nbsp;
Line 69: Line 94:
  
 
=Version History=
 
=Version History=
 
+
{{LastUpdated}}
{| border='1px' | width="100%"
+
{| class='wikitable' | width="100%"
 
! Version !! Date !! Content
 
! Version !! Date !! Content
 
|-
 
|-
| 5.0.1
+
| &nbsp;
| 4/28/2010
+
| &nbsp;
| Initialization
+
| &nbsp;
 
|}
 
|}
  
 
{{ZKComponentReferencePageFooter}}
 
{{ZKComponentReferencePageFooter}}

Latest revision as of 02:29, 12 May 2022

Decimalbox

Employment/Purpose

An edit box for holding big decimal value .

Example

ZKComRef Decimalbox Examples.PNG

 <decimalbox value="155"/>

Properties

Format

You are able to format the field by providing specifying the attribute with a formatting string. The default value is null.

<decimalbox format="#,##0.##"/>

Since 8.5.2 You can provide a locale to format the number by specifying a value starting with "locale:", e.g. Indian numbering system:

<decimalbox format="locale:en-In"/>

Ref: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat


Constraint

You could specify what value to accept for input controls by the 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.

<decimalbox 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.

<decimalbox 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.
<decimalbox constraint="no negative: ${c:l('err.num.negative')}"/>

Inherited Functions

Please refer to NumberInputElement for inherited functions.

Supported Events

Name
Event Type
None None

Supported Children

*NONE

Use Cases

Version Description Example Location
     

Version History

Last Update : 2022/05/12


Version Date Content
     



Last Update : 2022/05/12

Copyright © Potix Corporation. This article is licensed under GNU Free Documentation License.