The online documentation is produced by a web publishing technology created by us to read the documents origins in OpenOffice Writer (ODT) and Microsoft Word (docx) formats and produces native web and PDF versions. In this way we maintain Louder project documentation update and in sync on each of its formats.
En este capítulo se describen clases y funciones en JavaScript que proporciona el framework al desarrollador para agilizar el proceso de creación de capturas y presentación de datos e información al usuario final.
Clase Format
Esta clase permite darle formato a los diferentes tipos de datos que pueden ser incluidos dentro de una captura de datos o una vista tal. Está enteramente codificada en javascript usando el framework Prototype. Tiene licencia de uso y modifcación totalmente abierta y hace parte del proyecto de Herramientas JavaScript de uso común en Aplicaciones Web.
Instanciando la clase
Para iniciar el uso de esta herramienta es necesario crear un objeto que definirá las propiedades que se usarán para darle formato a los datos. Esto se logra de la siguiente manera:
Puede notar que no todas estas propiedades deben ser definidas, todas poseen valores por defecto que serán usados en principio para el formato. Estas propiedades son determinadas por el tipo, con lo cual se usa la notación type: 'nombre_tipo', properties: {propiedades}.
Los tipos de datos soportados por el Format son: numeric, que define las propiedades para los valores que serán numéricos, tanto enteros como punto flotante; percent, para los valores que tienen un formato de porcentaje; money en el cual se establecen los atributos para los datos tipo moneda.
Opciones del constructor de Format:
Tabla: Parámetros que recibe el helper javascript Format
Nombre
Valor por Defecto
Aplicable a
Descripción
decimals
0
todas
Establece el número de decimales.
puntoDec
','
todas
Carácter para el punto decimal.
sepMiles
'.'
todas
Carácter para el separador de Miles.
simbPer
'%'
percent
Símbolo de porcentaje.
simbMon
'$'
money
Símbolo de moneda.
letNegative
true
todas
Establece si permite negativos o no.
blankToZero
true
todas
Define si un valor vacío es puesto como cero.
leftZeros
0
todas
Número de ceros que serán añadidos a la izquierda del dato.
complete
0
todas
Tamaño obligatorio que deben tener los datos en su parte entera.
completeCaracter
'0'
todas
Carácter que se usará para completar los datos.
onCompleteTruncate
true
todas
Define si se truncará un dato si este supera el tamaño definido en complete. No aplica si complete es cero.
Nótese que una vez que ha sido creado el objeto format lo único que debe hacerse es usarlo para dar formato a los datos que se tengan, asimismo es posible deshacer dicho formato haciendo uso de la función deFormat. También es importante observar que todos los llamados son dinámicos y debe usarse un objeto definido para ello es decir, antes de usar cualquier función es necesario crear un objeto como se indica en el apartado Instanciando la clase, y una vez hecho esto todas las funciones se deben invocar con variable.función(parámetros).
Funciones de Format
numeric(number) Formatea un número que es ingresado como parámetro usando las propiedades definidas para los tipo numeric al instanciar la clase o que hayan sido establecidas con el método changeProperties. Retorna una cadena de caracteres que posee el formato adecuado.
money(number) Formatea un número que es ingresado como parámetro usando las propiedades definidas para los tipo money al instanciar la clase o que hayan sido establecidas con el método changeProperties. Retorna una cadena de caracteres que posee el formato adecuado, agregando el símbolo de pesos requerido.
percent(number) Formatea un número que es ingresado como parámetro usando las propiedades definidas para los tipo percent al instanciar la clase o que hayan sido establecidas con el método changeProperties. Retorna una cadena de caracteres que posee el formato adecuado, agregando el símbolo porcentual definido.
changeProperties() Cambia las propiedades del tipo especificado. Las propiedades que no sean incluidas conservan su valor anterior.
deFormat(str,type) Deformatea una cadena de caracteres. Recibe como parámetros "str" que representa la cadena de texto a procesar; "type" que debe ser el tipo de formato al que fue sometida dicha cadena.
Clase Validator
Esta clase permite realizar validaciones a los diferentes datos que pueden ser incluidos dentro de una captura de datos o una vista tal. Está enteramente codificada en javascript usando el framework Prototype. Tiene licencia de uso y modifcación totalmente abierta y hace parte del proyecto de Herramientas JavaScript de uso común en aplicaciones Web.
Instanciando la clase
Antes de hacer uso de esta clase debe instanciarse un objeto que contendrá las propiedades para las validaciones que se requieran. El constructor del objeto acepta tipos predefinidos y otros personalizados que se definen dinámicamente.
Tipos de dato predefinidos en Validator:
Tabla: Tipos de datos que recibe el helper Javascript Validator
Nombre
Descripción
text
Tipo que representa valores textuales.
number
Se asocia a los números enteros.
decimal
Se asocia a los números decimales.
date
Tipo definido para las fechas.
select
Este tipo de dato es usado en los combos de selección.
email
Tipo que se usa para los campos que deben contener un email.
format_number
Se usa para definir los formatos numéricos estableciendo una asociación con algún objeto del tipo format que será aplicado sobre ese campo.
format_decimal
Relaciona una variable de la clase Format con un campo que contendrá valores decimales.
format_money
Relaciona una variable de la clase Format con un campo que contendrá valores de moneda.
format_percent
Relaciona una variable de la clase Format con un campo que contendrá valores porcentaje.
<script type="text/javascript">
var val = new Validator();
</script>