|
Framework JavaScript ACube V2.10.0 | ||||||||
CLASSE PRECEDENTE CLASSE SUIVANTE | CADRES SANS CADRES | ||||||||
SOMMAIRE: ATTR | CONSTR | METH | DETAIL: ATTR | CONSTR | METH |
Object | +--NumberFormat
La classe «NumberFormat» est la classe permettant de manipuler les nombres et leurs différentes formes possibles.
Date: 14/11/2006
Version: 2.4
Definie dans technique/fw_format.js
Sommaire des Attributs | |
<private> <final> String |
COMMA
Virgule |
<private> <final> String |
DASH
Tiret |
<private> boolean |
hasSeparators
Variable mise à jour lors des initialisations de séparateurs. |
<private> <final> number |
LEFT_DASH
Indice 0 |
<private> <final> number |
LEFT_INSIDE
Indice de position 1 |
<private> <final> number |
LEFT_OUTSIDE
Indice de position 0 |
<private> <final> String |
LEFT_PAREN
Parenthèse gauche |
<private> <final> number |
NO_ROUNDING
Indice -1 |
<private> <final> number |
PARENTHESIS
Indice 2 |
<private> <final> String |
PERIOD
Séparateur de milliers (point) |
<private> <final> number |
RIGHT_DASH
Indice 1 |
<private> <final> number |
RIGHT_INSIDE
Indice de position 2 |
<private> <final> number |
RIGHT_OUTSIDE
Indice de position 3 |
<private> <final> String |
RIGHT_PAREN
Parenthèse droite |
<final> String |
VERSION
Numéro de version de la classe |
Sommaire des Constructeurs | |
NumberFormat
(<String_Obligatoire> num, <String_Facultatif> inputDecimal)
Crée une nouvelle instance «NumberFormat». Le constructeur de «NumberFormat» crée une instance de la classe , utile pour appeler soit les méthodes publiques associées à cette dernière soit pour interroger ses propriétés publiques. |
Sommaire des Méthodes | |
String
|
addSeparators(<String_Facultatif> nStr, <String_Facultatif> inD, <String_Facultatif> outD, <String_Facultatif> sep)
Le framework ergonomique fw_format.js propose la méthode «addSeparators»; elle permet d'ajouter des séparateurs dans un nombre nStr donné. |
String
|
dateFormat( <String_Obligatoire> maDate, <String_Obligatoire> formatCible, <String_Facultatif> formatSource)
Le framework technique fw_format.js propose la fonction technique globale de mise en forme «dateFormat( maDate, formatCible, formatSource)»; elle permet de vérifier si «maDate» est une date et de retourner cette même date dans un autre format. |
Object
|
entierFormat( <String_Obligatoire> monChiffre)
Le framework technique fw_format.js propose la fonction technique globale de mise en forme «entierFormat( monChiffre)»; elle permet de retourne «monChiffre» dans un autre format entier. |
<private> number
|
expandExponential(<String_Obligatoire> origVal)
Le framework ergonomique fw_format.js propose la méthode «expandExponential»; elle permet de décaler la virgule d'un nombre |
number
|
getOriginal()
Le framework ergonomique fw_format.js propose la fonction «getOriginal»; elle permet d'accéder à l'attribut de sauvegarde numOriginal de l'objet NumberFormat. |
number
|
getRounded(<float_Facultatif> val)
Le framework ergonomique fw_format.js propose la fonction globale «getRounded»; elle permet d'arrondir le nombre val à n(=attribut places de l'objet NumberFormat) chiffres après la virgule. La valeur sera arrondie par défaut si l'attribut truncate est "true", sinon, elle sera arrondie au plus proche. |
<private> String
|
getZeros(<String_Obligatoire> places)
Le framework ergonomique fw_format.js propose la méthode «getZeros»; elle permet de créer un nombre contenant des zéros. |
<private> String
|
justNumber(<String_Obligatoire> val)
Le framework ergonomique fw_format.js propose la fonction globale «justNumber»; elle permet de formater un nombre : remplace un pourcentage nn% par 0.nn, enlève les espaces ou parenthèses ou caractères spéciaux enlève les "traits" pour ajouter un signe "-" devant les nombres négatifs. |
String
|
monnaieFormat( <String_Obligatoire> monChiffre, <String_Obligatoire> devise)
Le framework technique fw_format.js propose la fonction technique globale de mise en forme «monnaieFormat( monChiffre, devise)»; elle permet de retourner «monChiffre» dans un autre format monétaire. |
<private> number
|
moveDecimal(<String_Facultatif> val, <boolean_Facultatif> left, <String_Optionnel> places)
Le framework ergonomique fw_format.js propose la fonction globale «moveDecimal»; elle permet de décaler le caractère décimal (.) d'un nombre de places vers la gauche ou vers la droite dans un nombre val. |
<private> String
|
moveDecimalAsString(<String_Facultatif> val, <boolean_Facultatif> left, <String_Optionnel> places)
Le framework ergonomique fw_format.js propose la fonction globale «moveDecimalAsString»; elle permet de décaler le caractère décimal (.) d'un nombre de places vers la gauche ou vers la droite dans un nombre val. |
number
|
moveDecimalLeft(<String_Facultatif> val, <String_Optionnel> places)
Le framework ergonomique fw_format.js propose la fonction globale «moveDecimalLeft»; elle permet de décaler le caractère décimal (.) d'un nombre de places vers la gauche dans un nombre val. |
number
|
moveDecimalRight(<String_Facultatif> val, <String_Optionnel> places)
Le framework ergonomique fw_format.js propose la fonction globale «moveDecimalRight»; elle permet de décaler le caractère décimal (.) d'un nombre de places vers la droite dans un nombre val. |
String
|
numberFormat( <String_Obligatoire> monChiffre, <String_Obligatoire> formatCible)
Le framework technique fw_format.js propose la fonction technique globale de mise en forme «numberFormat( monChiffre, formatCible)»; elle permet de vérifier si «monChiffre» est un nombre et de retourner ce même nombre dans un autre formet. |
<private> String
|
preserveZeros(<String_Obligatoire> val)
Le framework ergonomique fw_format.js propose la fonction globale «preserveZeros»; elle permet de compléter un nombre décimal par autant de zéros que nécessaire pour être au centième, millième ... |
void
|
setCommas(<boolean_Obligatoire> isC)
Le framework ergonomique fw_format.js propose la méthode «setCommas»; elle permet de réinitialiser à leurs valeurs par défaut le séparateur de nombre (separatorValue) et le séparateur décimal (decimalValue) de l'objet NumberFormat. Elle met également à jour l'attribut hasSeparators à partir de la variable isC passée en argument. |
void
|
setCurrency(<boolean_Obligatoire> isC)
Le framework ergonomique fw_format.js propose la méthode «setCurrency»; elle permet de réinitialiser l'attribut hasCurrency de l'objet NumberFormat par une variable passée en paramètre. |
void
|
setCurrencyPosition(<String_Obligatoire> cp)
Le framework ergonomique fw_format.js propose la méthode «setCurrencyPosition»; elle permet de réinitialiser l'attribut currencyPosition de l'objet NumberFormat par une valeur passée en paramètre. |
void
|
setCurrencyPrefix(<String_Obligatoire> cp)
Le framework ergonomique fw_format.js propose la fonction globale «setCurrencyPrefix»; elle permet de réinitialiser la valeur courante (currencyValue) et la position courante (currencyPosition) de l'objet NumberFormat. La position courante sera initialisée par défaut (à LEFT_OUTSIDE), tandis que la valeur correspondra au paramètre de la fonction. |
void
|
setCurrencyValue(<String_Obligatoire> val)
Le framework ergonomique fw_format.js propose la méthode «setCurrencyValue»; elle permet de réinitialiser l'attribut currencyValue de l'objet NumberFormat par une valeur passée en paramètre. |
void
|
setInputDecimal(<String_Obligatoire> val)
Le framework ergonomique fw_format.js propose la méthode «setInputDecimal»; elle permet d'initialiser l'attribut inputDecimalValue de l'objet NumberFormat. |
void
|
setNegativeFormat(<String_Obligatoire> format)
Le framework ergonomique fw_format.js propose la méthode «setNegativeFormat»; elle permet de réinitialiser l'attribut negativeFormat de l'objet NumberFormat par un argument en paramètre. |
void
|
setNegativeRed(<String_Obligatoire> isRed)
Le framework ergonomique fw_format.js propose la méthode «setNegativeRed»; elle permet de réinitialiser l'attribut negativeRed de l'objet NumberFormat par un argument en paramètre. |
void
|
setNumber(<String_Obligatoire> num, <String_Optionnel> inputDecimal)
Le framework ergonomique fw_format.js propose la méthode «setNumber»; elle permet de réinitialiser l'attribut num par un nombre formaté, de sauvegarder sa valeur initiale, et de réinitialiser en même temps l'attribut inputDecimalValue. |
void
|
setPlaces(<String_Obligatoire> p, <boolean_Facultatif> tr)
Le framework ergonomique fw_format.js propose la fonction globale «setPlaces»; elle permet de réinitialiser les variables roundToPlaces, truncate et places de l'objet NumberFormat. |
void
|
setSeparators(<boolean_Obligatoire> isC, <String_Facultatif> separator, <String_Facultatif> decimal)
Le framework ergonomique fw_format.js propose la méthode «setSeparators»; elle permet de réinitialiser les attributs decimalValue et separatorValue de l'objet NumberFormat par des arguments en paramètre Elle réinitialise également le booléen hasSeparators avec isC. |
<private> String
|
toFormatted()
Le framework ergonomique fw_format.js propose la méthode «toFormatted»; elle permet de changer le format d'un nombre (parenthèses, signe) |
String
|
toPercentage()
Le framework ergonomique fw_format.js propose la fonction globale «toPercentage»; elle permet de convertir le nombre num associé à l'objet NumberFormat en pourcentage, tout en l'arrondissant. |
number
|
toUnformatted()
Le framework ergonomique fw_format.js propose la fonction globale «toUnformatted»; elle permet d'accéder à l'attribut num de l'objet NumberFormat. |
Détail des Attributs |
<private> <final> String COMMA
<private> <final> String DASH
<private> boolean hasSeparators
<private> <final> number LEFT_DASH
<private> <final> number LEFT_INSIDE
<private> <final> number LEFT_OUTSIDE
<private> <final> String LEFT_PAREN
<private> <final> number NO_ROUNDING
<private> <final> number PARENTHESIS
<private> <final> String PERIOD
<private> <final> number RIGHT_DASH
<private> <final> number RIGHT_INSIDE
<private> <final> number RIGHT_OUTSIDE
<private> <final> String RIGHT_PAREN
<final> String VERSION
Détail des Constructeurs |
NumberFormat(<String_Obligatoire> num, <String_Facultatif> inputDecimal)
num - String_Obligatoire
nombre principal manipulé dans la classe
inputDecimal - String_Facultatif
caractère qui caractérisera un nobre décimal (par défaut this.PERIOD)
Détail des Méthodes |
String addSeparators(<String_Facultatif> nStr, <String_Facultatif> inD, <String_Facultatif> outD, <String_Facultatif> sep)
nStr - String_Facultatif
Nombre sur lequel la fonction travaille
inD - String_Facultatif
caractère qui sera recherché dans nStr pour ajout d'un séparateur outD
outD - String_Facultatif
caractère qui sera ajouté aprés la première occurence de inD
sep - String_Facultatif
séparateur de milliers dans un nombre (avec sep="." : xx.xxx.xxx)
String dateFormat( <String_Obligatoire> maDate, <String_Obligatoire> formatCible, <String_Facultatif> formatSource)
maDate - String_Obligatoire
Chaîne de caractères contenant la date.
formatCible - String_Obligatoire
Chaîne de caractères contenant le format cible.
formatSource - String_Facultatif
Chaîne de caractères contenant le format d'origine.
Object entierFormat( <String_Obligatoire> monChiffre)
monChiffre - String_Obligatoire
Chaîne de caractères contenant le nombre.
<private> number expandExponential(<String_Obligatoire> origVal)
origVal - String_Obligatoire
Nombre sur lequel on travaille
number getOriginal()
Aucun -
number getRounded(<float_Facultatif> val)
val - float_Facultatif
valeur à arrondir à "places" chiffres après la virgule
<private> String getZeros(<String_Obligatoire> places)
places - String_Obligatoire
nombre de zéros souhaités
<private> String justNumber(<String_Obligatoire> val)
val - String_Obligatoire
String : Nombre à reformater
String monnaieFormat( <String_Obligatoire> monChiffre, <String_Obligatoire> devise)
monChiffre - String_Obligatoire
Chaîne de caractères contenant le nombre.
devise - String_Obligatoire
Chaîne de caractères contenant le symbole de la devise.
<private> number moveDecimal(<String_Facultatif> val, <boolean_Facultatif> left, <String_Optionnel> places)
val - String_Facultatif
Nombre sur lequel on travaille
left - boolean_Facultatif
indique dans quel sens on décale la virgule (true : vers la gauche, false vers la droite)
places - String_Optionnel
nombre de chiffres à décaler
<private> String moveDecimalAsString(<String_Facultatif> val, <boolean_Facultatif> left, <String_Optionnel> places)
val - String_Facultatif
Nombre sur lequel on travaille
left - boolean_Facultatif
indique dans quel sens on décale la virgule (true : vers la gauche, false vers la droite)
places - String_Optionnel
nombre de chiffres à décaler
number moveDecimalLeft(<String_Facultatif> val, <String_Optionnel> places)
val - String_Facultatif
Nombre sur lequel on travaille
places - String_Optionnel
nombre de chiffres à décaler
number moveDecimalRight(<String_Facultatif> val, <String_Optionnel> places)
val - String_Facultatif
Nombre sur lequel on travaille
places - String_Optionnel
nombre de chiffres à décaler
String numberFormat( <String_Obligatoire> monChiffre, <String_Obligatoire> formatCible)
monChiffre - String_Obligatoire
Chaîne de caractères contenant le nombre.
formatCible - String_Obligatoire
Chaîne de caractères contenant le format cible.
<private> String preserveZeros(<String_Obligatoire> val)
val - String_Obligatoire
nombre sur lequel on travaille
void setCommas(<boolean_Obligatoire> isC)
isC - boolean_Obligatoire
booléen pour réinitialiser l'attribut hasSeparators
void setCurrency(<boolean_Obligatoire> isC)
isC - boolean_Obligatoire
booléen pour réinitialiser l'attribut hasCurrency
void setCurrencyPosition(<String_Obligatoire> cp)
cp - String_Obligatoire
variable pour réinitialiser l'attribut currencyPosition
void setCurrencyPrefix(<String_Obligatoire> cp)
cp - String_Obligatoire
valeur pour réinitialiser l'attribut currencyValue
void setCurrencyValue(<String_Obligatoire> val)
val - String_Obligatoire
valeur pour réinitialiser l'attribut currencyValue
void setInputDecimal(<String_Obligatoire> val)
val - String_Obligatoire
Nombre décimal
void setNegativeFormat(<String_Obligatoire> format)
format - String_Obligatoire
String correspondant à la nouvelle valeur de l'attribut negativeFormat
void setNegativeRed(<String_Obligatoire> isRed)
isRed - String_Obligatoire
String correspondant à la nouvelle valeur de l'attribut negativeRed
void setNumber(<String_Obligatoire> num, <String_Optionnel> inputDecimal)
num - String_Obligatoire
Nombre à formater pour réinitialisation de l'attribut num
inputDecimal - String_Optionnel
Decimal pour réinitialisation de inputDecimalValue
void setPlaces(<String_Obligatoire> p, <boolean_Facultatif> tr)
p - String_Obligatoire
nombre
tr - boolean_Facultatif
booléen
void setSeparators(<boolean_Obligatoire> isC, <String_Facultatif> separator, <String_Facultatif> decimal)
isC - boolean_Obligatoire
Booléen pour réinitialiser l'attribut hasSeparators
separator - String_Facultatif
String pour réinitialiser l'attribut separator
decimal - String_Facultatif
String pour réinitialiser l'attribut decimalValue
<private> String toFormatted()
Aucun -
String toPercentage()
Aucun -
number toUnformatted()
Aucun -
|
Framework JavaScript ACube V2.10.0 | ||||||||
CLASSE PRECEDENTE CLASSE SUIVANTE | CADRES SANS CADRES | ||||||||
SOMMAIRE: ATTR | CONSTR | METH | DETAIL: ATTR | CONSTR | METH |