Framework JavaScript ACube V2.10.0
 

Classe NumberFormat

Object
   |
   +--NumberFormat

class 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

COMMA

<private> <final> String COMMA

DASH

<private> <final> String DASH

hasSeparators

<private> boolean hasSeparators

LEFT_DASH

<private> <final> number LEFT_DASH

LEFT_INSIDE

<private> <final> number LEFT_INSIDE

LEFT_OUTSIDE

<private> <final> number LEFT_OUTSIDE

LEFT_PAREN

<private> <final> String LEFT_PAREN

NO_ROUNDING

<private> <final> number NO_ROUNDING

PARENTHESIS

<private> <final> number PARENTHESIS

PERIOD

<private> <final> String PERIOD

RIGHT_DASH

<private> <final> number RIGHT_DASH

RIGHT_INSIDE

<private> <final> number RIGHT_INSIDE

RIGHT_OUTSIDE

<private> <final> number RIGHT_OUTSIDE

RIGHT_PAREN

<private> <final> String RIGHT_PAREN

VERSION

<final> String VERSION

Détail des Constructeurs

NumberFormat

NumberFormat(<String_Obligatoire> num, <String_Facultatif> inputDecimal)

Détail des Méthodes

addSeparators

String addSeparators(<String_Facultatif> nStr, <String_Facultatif> inD, <String_Facultatif> outD, <String_Facultatif> sep)

dateFormat

String dateFormat( <String_Obligatoire> maDate, <String_Obligatoire> formatCible, <String_Facultatif> formatSource)

entierFormat

Object entierFormat( <String_Obligatoire> monChiffre)

expandExponential

 <private> number expandExponential(<String_Obligatoire> origVal)

getOriginal

number getOriginal()

getRounded

number getRounded(<float_Facultatif> val)

getZeros

 <private> String getZeros(<String_Obligatoire> places)

justNumber

 <private> String justNumber(<String_Obligatoire> val)

monnaieFormat

String monnaieFormat( <String_Obligatoire> monChiffre, <String_Obligatoire> devise)

moveDecimal

 <private> number moveDecimal(<String_Facultatif> val, <boolean_Facultatif> left, <String_Optionnel> places)

moveDecimalAsString

 <private> String moveDecimalAsString(<String_Facultatif> val, <boolean_Facultatif> left, <String_Optionnel> places)

moveDecimalLeft

number moveDecimalLeft(<String_Facultatif> val, <String_Optionnel> places)

moveDecimalRight

number moveDecimalRight(<String_Facultatif> val, <String_Optionnel> places)

numberFormat

String numberFormat( <String_Obligatoire> monChiffre, <String_Obligatoire> formatCible)

preserveZeros

 <private> String preserveZeros(<String_Obligatoire> val)

setCommas

void setCommas(<boolean_Obligatoire> isC)

setCurrency

void setCurrency(<boolean_Obligatoire> isC)

setCurrencyPosition

void setCurrencyPosition(<String_Obligatoire> cp)

setCurrencyPrefix

void setCurrencyPrefix(<String_Obligatoire> cp)

setCurrencyValue

void setCurrencyValue(<String_Obligatoire> val)

setInputDecimal

void setInputDecimal(<String_Obligatoire> val)

setNegativeFormat

void setNegativeFormat(<String_Obligatoire> format)

setNegativeRed

void setNegativeRed(<String_Obligatoire> isRed)

setNumber

void setNumber(<String_Obligatoire> num, <String_Optionnel> inputDecimal)

setPlaces

void setPlaces(<String_Obligatoire> p, <boolean_Facultatif> tr)

setSeparators

void setSeparators(<boolean_Obligatoire> isC, <String_Facultatif> separator, <String_Facultatif> decimal)

toFormatted

 <private> String toFormatted()

toPercentage

String toPercentage()

toUnformatted

number toUnformatted()

Framework JavaScript ACube V2.10.0
 

Version 2.10.0, / Etat : Validé
Cette création est mise à disposition selon le Contrat Paternité - Pas d'Utilisation Commerciale - Partage des Conditions Initiales à l'Identique disponible en ligne http://creativecommons.org/licenses/by-nc-sa/2.0/fr/ ou par courrier postal à Creative Commons, 559 Nathan Abbott Way, Stanford,California 94305, USA.


Documentation generated by JSDoc on Wed Jan 6 17:05:02 2010