ef

Clase base de los elementos de formulario.

Object
   |
   +--ef

Ubicada en ef.js

Documentación WIKI
Clase PHP equivalente: toba_ef

Subclases directas

ef_multi_seleccion, ef_checkbox, ef_upload, ef_radio, ef_popup, ef_editable, ef_cuit, ef_combo_editable, ef_html, ef_fijo, ef_combo

Métodos

void	activar()	Permite que el usuario pueda modificar el estado del elemento
boolean	activo()	Retorna verdadero si el elemento esta disponible para edicion por parte del usuario
void	borrar_opciones()	Elimina las opciones seleccionables del elemento Solo se aplica si el elemento maneja una serie de opciones desde donde se elige su estado
void	cambiar_expansion(expandir)	Invierte la expansión actual del elemento Si actualmente esta colapsado lo expande y viceversa
void	cambiar_valor(nuevo)
void	cuando_cambia_valor(<string> callback)	Agrega una funcion o callback que será invocada cuando el elemento cambie su estado
void	desactivar()	Impide que el usuario pueda modificar el estado del elemento
Object	es_oculto()	El ef esta oculto?
string	formatear_valor(valor)	Formatea un valor segun el tipo de elemento y lo retorna
element	get_contenedor()	Retorna el TAG HTML que contiene al elemento en el documento
Object	get_error()	Retorna la descripción del último error detectado por este ef
string	get_estado()	Retorna el estado o valor actual del elemento.
string	get_estado_con_formato()	Retorna el estado o valor actual del elemento en un formato legible al usuario
int	get_fila_actual()	Cuando el elemento es parte de un formulario_ml este método retorna la fila a la que actualmente se hace referencia
string	get_id()	Retorna el id de este elemento definido en el editor
int	get_tab_index()	Retorna el tabIndex actual del elemento.
element	input()	Retorna el input HTML asociado a este elemento
ef	ir_a_fila(fila)	Cuando el elemento es parte de un formulario_ml este método permite cambiar la fila/linea a la que se referencia
void	mostrar(mostrar, resetear)	Muestra el elemento previamente ocultado
void	no_resaltar()	Elimina el icono visual incluido por el metodo resaltar()
element	nodo()	Retorna el TAG HTML que contiene tanto la etiqueta como el elemento en el documento
void	ocultar(resetear)	Oculta temporalmente el elemento y su etiqueta
void	resaltar(<String> texto, <int> izq)	Muestra un icono de error a la izquierda del elemento conteniendo un mensaje
void	resaltar_cambio(hay_cambio)
void	resetear_error()	Deja sin efecto la ultima validación
void	resetear_estado()	Borra el estado actual del elemento, el nuevo estado depende de cada ef, generalmente equivale a un string vacio
boolean	seleccionar()	Intenta forzar el foco visual al elemento, esto generalmente pone el cursor y la atención visual en el elemento
void	set_error(error)	Fuerza un mensaje particular de error al elemento.
void	set_estado(nuevo)	Cambia el valor o estado actual del elemento
void	set_obligatorio(<boolean> es_obligatorio)	Modifica la obligatoriedad actual del ef
void	set_opciones(opciones)	Cambia las opciones disponibles de selección Solo se aplica si el elemento maneja una serie de opciones desde donde se elige su estado
void	set_solo_lectura(<boolean> solo_lectura)	Cambia la capacidad de edición sobre el elemento
void	set_tab_index(<int> tab_index)	Cambia el tabIndex actual del elemento.
ef	sin_fila()	Cuando el elemento es parte de un formulario_ml este método fuerza a que el elemento no referencie a ninguna fila particular
boolean	tiene_estado()	Retorna verdadero si el ef tiene algún valor cargado
boolean	validar()	Valida el estado actual del ef
Object	valor()

ef (id_form, etiqueta, obligatorio, colapsable)

activar

void activar ()

Permite que el usuario pueda modificar el estado del elemento

activo

boolean activo ()

Retorna verdadero si el elemento esta disponible para edicion por parte del usuario

borrar_opciones

void borrar_opciones ()

Elimina las opciones seleccionables del elemento Solo se aplica si el elemento maneja una serie de opciones desde donde se elige su estado

cambiar_expansion

void cambiar_expansion (expandir)

Invierte la expansión actual del elemento Si actualmente esta colapsado lo expande y viceversa

cambiar_valor

void cambiar_valor (nuevo)

See:

set_estado()

Deprecated

Desde la versión 1.0 usar set_estado()

cuando_cambia_valor

void cuando_cambia_valor (<string> callback)

Agrega una funcion o callback que será invocada cuando el elemento cambie su estado

Parámetros:

callback

Codigo de la funcion a disparar

desactivar

void desactivar ()

Impide que el usuario pueda modificar el estado del elemento

es_oculto

Object es_oculto ()

El ef esta oculto?

Retorna:

boolean

formatear_valor

string formatear_valor (valor)

Formatea un valor segun el tipo de elemento y lo retorna

get_contenedor

element get_contenedor ()

Retorna el TAG HTML que contiene al elemento en el documento

See:

nodo()

get_error

Object get_error ()

Retorna la descripción del último error detectado por este ef

Retorna:

string

get_estado

string get_estado ()

Retorna el estado o valor actual del elemento. Generalmente es el value del input HTML

get_estado_con_formato

string get_estado_con_formato ()

Retorna el estado o valor actual del elemento en un formato legible al usuario

get_fila_actual

int get_fila_actual ()

Cuando el elemento es parte de un formulario_ml este método retorna la fila a la que actualmente se hace referencia

See:

ir_a_fila()

get_id

string get_id ()

Retorna el id de este elemento definido en el editor

get_tab_index

int get_tab_index ()

Retorna el tabIndex actual del elemento. Este número es utilizado para ciclar por los distintos elementos usando la tecla TAB

Retorna:

string

input

element input ()

Retorna el input HTML asociado a este elemento

ir_a_fila

ef ir_a_fila (fila)

this.ef('nombre').ir_a_fila(5).set_estado('Nuevo nombre');

Retorna:

Una referencia a este ef

See:

sin_fila()

mostrar

void mostrar (mostrar, resetear)

Muestra el elemento previamente ocultado

Parámetros:

resetar

Además de ocultar el elemento borra su estado o valor actual

See:

ocultar()

no_resaltar

void no_resaltar ()

Elimina el icono visual incluido por el metodo resaltar()

See:

resaltar()

nodo

element nodo ()

Retorna el TAG HTML que contiene tanto la etiqueta como el elemento en el documento

ocultar

void ocultar (resetear)

Oculta temporalmente el elemento y su etiqueta

Parámetros:

resetar

Además de ocultar el elemento borra su estado o valor actual, por defecto false

See:

mostrar()

resaltar

void resaltar (<String> texto, <int> izq)

Muestra un icono de error a la izquierda del elemento conteniendo un mensaje

Parámetros:

texto	Mensaje a mostrar
izq	Opcional, cantidad de pixeles a izq. donde se ubica el icono

See:

no_resaltar()

resaltar_cambio

void resaltar_cambio (hay_cambio)

resetear_error

void resetear_error ()

Deja sin efecto la ultima validación

resetear_estado

void resetear_estado ()

Borra el estado actual del elemento, el nuevo estado depende de cada ef, generalmente equivale a un string vacio

seleccionar

boolean seleccionar ()

Intenta forzar el foco visual al elemento, esto generalmente pone el cursor y la atención visual en el elemento

Retorna:

Verdadero si se pudo seleccionar/dar foco, falso en caso contrario

set_error

void set_error (error)

Fuerza un mensaje particular de error al elemento. Generalmente se usa cuando se quiere ampliar la validación predeterminada del formulario

set_estado

void set_estado (nuevo)

Cambia el valor o estado actual del elemento

set_obligatorio

void set_obligatorio (<boolean> es_obligatorio)

Modifica la obligatoriedad actual del ef

Parámetros:

es_obligatorio

Nuevo valor Requiere tildar cascada relajada en el editor

set_opciones

void set_opciones (opciones)

Cambia las opciones disponibles de selección Solo se aplica si el elemento maneja una serie de opciones desde donde se elige su estado

set_solo_lectura

void set_solo_lectura (<boolean> solo_lectura)

Cambia la capacidad de edición sobre el elemento

Parámetros:

solo_lectura

Desactiva (true) o activa (false) el elemento

See:

activar()

desactivar()

set_tab_index

void set_tab_index (<int> tab_index)

Cambia el tabIndex actual del elemento. Este número es utilizado para ciclar por los distintos elementos usando la tecla TAB

Parámetros:

tab_index

Nuevo orden

sin_fila

ef sin_fila ()

Cuando el elemento es parte de un formulario_ml este método fuerza a que el elemento no referencie a ninguna fila particular

Retorna:

Una referencia a este ef

See:

ir_a_fila()

tiene_estado

boolean tiene_estado ()

Retorna verdadero si el ef tiene algún valor cargado

validar

boolean validar ()

Valida el estado actual del ef

Retorna:

Verdadero si el estado actual del ef es válido, falso en caso contrario

See:

Usar get_error para ver el mensaje de error en caso de no validar

valor

Object valor ()

See:

get_estado()

Deprecated

Desde la version 1.0 usar get_estado()

Desarrollado por SIU.
Documentación generada con JSDoc