static void permite_exportacion_excel_plano(
)
|
|
static mixed recuperar_clave_fila(
integer
$cuadro, integer
$clave
)
|
|
Recupera de la sesion el mapeo original de las claves del cuadro
Parámetros:
|
integer |
$cuadro: |
Id del componente |
|
integer |
$clave: |
Id de la fila a recuperar |
static void set_vista_excel_sin_cortes(
boolean
$valor
)
|
|
Esta función debe ser utilizada desde los archivos de customización
para mostrar la vista de excel sin cortes de control
Parámetros:
void agregar_columnas(
array
$columnas
)
|
|
Agrega nuevas definiciones de columnas al cuadro
Parámetros:
|
array |
$columnas: |
componentes obligatoras: clave, titulo |
void agregar_corte_control(
$corte
)
|
|
Parámetros:
boolean datos_cargados(
)
|
|
El cuadro posee datos?
void debe_colapsar_cortes(
)
|
|
void debe_mostrar_total_registros(
)
|
|
void desactivar_modo_clave_segura(
)
|
|
Deja al cuadro sin selección alguna de fila
void deshabilitar_corte_control(
$corte
)
|
|
Parámetros:
void disparar_eventos_multiples(
)
|
|
void disparar_eventos_simples(
$evento
)
|
|
Parámetros:
void eliminar_columnas(
$columnas, array
$columnas.
)
|
|
Elimina columnas del cuadro
Parámetros:
|
array |
$columnas.: |
Ids de las columnas a eliminar |
|
|
$columnas: |
|
void eliminar_corte_control(
$corte
)
|
|
Parámetros:
void es_asociacion_de_vinculo(
$id_evento
)
|
|
Parámetros:
es_clave_fila_seleccionada(
$clave_fila
)
|
|
Indica si la clave que se pasa por parametro es igual a la fila actualmente seleccionada.
Parámetros:
void existen_columnas(
$columnas, array
$columnas.
)
|
|
Chequea si un conjunto de columnas existen en la definicion del cuadro.
Parámetros:
|
array |
$columnas.: |
Ids de las columnas. |
|
|
$columnas: |
|
boolean existen_cortes_control(
)
|
|
Indica la existencia o no de cortes de control en el cuadro.
void existe_columna(
$columna.
$columna
)
|
|
Chequea si una columna existe en la definicion del cuadro.
Parámetros:
|
$columna. |
$columna: |
Id de la columna. |
boolean existe_paginado(
)
|
|
Retorna verdadero si el cuadro se pagina en caso de superar una cantidad dada de registros
void finalizar_ids_seguros(
)
|
|
void generar_fin_zona_colapsable(
)
|
|
Dispara la generacion de la salida HTML del cuadro
void generar_inicio_zona_colapsable(
$id_unico,
$estilo
)
|
|
Parámetros:
void generar_salida(
string
$tipo, [
$objeto_toba_salida = null]
)
|
|
Wrapper que genera los distintos tipos de salida necesario de acuerdo al parametro especificado
Parámetros:
|
string |
$tipo: |
|
|
|
$objeto_toba_salida: |
|
void get_acumulador_usuario(
)
|
|
void get_cantidad_columnas(
)
|
|
void get_cantidad_columnas_total(
)
|
|
integer get_cantidad_paginas(
)
|
|
Devuelve la cantidad de paginas que posee el cuadro de acuerdo a la los datos y el tamaño de pagina
|
Deprecated: | Desde 0.8.3. Usar get_clave_seleccionada |
string get_clave_fila(
integer
$fila, [boolean
$forzar_claves_reales = false]
)
|
|
Retorna la clave serializada de una fila dada
Parámetros:
|
integer |
$fila: |
Numero de fila |
|
boolean |
$forzar_claves_reales: |
Obliga a devolver los valores reales de las claves, aun cuando se encuentre en modo seguro. |
|
Return: | Clave serializada |
array get_clave_fila_array(
integer
$fila
)
|
|
Retorna un arreglo con las claves de la fila dada
Parámetros:
|
integer |
$fila: |
Numero de fila |
|
Return: | Arreglo columna=>valor |
array get_clave_seleccionada(
)
|
|
En caso de existir una fila seleccionada, retorna su clave
|
Return: | Arreglo asociativo id_clave => valor_clave |
Retorna la definición de las columnas actuales del cuadro
void get_cortes_control(
)
|
|
Retorna el conjunto de datos que actualmente posee el cuadro
void get_descripcion_resp_popup(
$fila
)
|
|
Parámetros:
void get_etiqueta_cantidad_filas(
)
|
|
void get_eventos_multiples(
)
|
|
array(id get_eventos_sobre_fila(
)
|
|
Retorna la lista de eventos que fueron definidos a nivel de fila
|
Return: | => toba_evento_usuario) |
Redefinición de:
- toba_ei::get_eventos_sobre_fila()
- Retorna la lista de eventos que fueron definidos a nivel de fila
array get_filas_disponibles_selector(
)
|
|
Obtiene las filas que estaran disponibles para ordenar.
void get_ids_evento_aplicacion_multiple(
)
|
|
Retorna el primer evento del tipo seleccion multiple. Si no existe retorna null
void get_indice_cortes(
)
|
|
void get_nombres_eventos_multiples(
)
|
|
integer get_pagina_actual(
)
|
|
Retorna la página actualmente seleccionada por el usuario, si existe el paginado
integer get_tamanio_pagina(
)
|
|
Retorna el tamaño de página actual en el paginado (si está presente el paginado)
void get_tipo_paginado(
)
|
|
Devuelve el tipo de paginado que esta usando el cuadro
void habilitar_corte_control(
$corte
)
|
|
Parámetros:
void hay_eventos_multiples(
)
|
|
boolean hay_ordenamiento(
)
|
|
Retorna verdadero si el cuadro actualmente se encuentra ordenado por alguna columna por parte del usuario
void hay_ordenamiento_multiple(
)
|
|
Retorna verdadero si existe alguna fila seleccionada
void inicializar_ids_seguros(
)
|
|
void instanciar_manejador_tipo_salida(
$tipo
)
|
|
Parámetros:
Elimina todas las columnas actualmente definidas en el cuadro
mixed ordenamiento_decimal(
string
$columna
)
|
|
Método estandar de ordenamiento de decimales
Heredar en caso de querer cambiar el mecanismo de ordenamiento
Parámetros:
|
string |
$columna: |
Nombre de la columna |
mixed ordenamiento_default(
string
$columna
)
|
|
Método estandar de ordenamiento de los datos, utilizando array_multisort
Heredar en caso de querer cambiar el mecanismo de ordenamiento
Parámetros:
|
string |
$columna: |
Nombre de la columna |
mixed ordenamiento_fecha(
string
$columna
)
|
|
Método estandar de ordenamiento de fechas
Heredar en caso de querer cambiar el mecanismo de ordenamiento
Parámetros:
|
string |
$columna: |
Nombre de la columna |
mixed ordenamiento_fecha_hora(
string
$columna
)
|
|
Método estandar de ordenamiento de timestamps (fecha, hora)
Heredar en caso de querer cambiar el mecanismo de ordenamiento
Parámetros:
|
string |
$columna: |
Nombre de la columna |
mixed ordenamiento_mayusculas(
string
$columna
)
|
|
Método estandar de ordenamiento de caracteres en mayusculas
Heredar en caso de querer cambiar el mecanismo de ordenamiento
Parámetros:
|
string |
$columna: |
Nombre de la columna |
mixed ordenamiento_may_ind(
string
$columna
)
|
|
Método estandar de ordenamiento de caracteres
Heredar en caso de querer cambiar el mecanismo de ordenamiento
Parámetros:
|
string |
$columna: |
Nombre de la columna |
mixed ordenamiento_millares(
string
$columna
)
|
|
Método estandar de ordenamiento de numeros
Heredar en caso de querer cambiar el mecanismo de ordenamiento
Parámetros:
|
string |
$columna: |
Nombre de la columna |
mixed ordenamiento_moneda(
string
$columna
)
|
|
Método estandar de ordenamiento de monedas
Heredar en caso de querer cambiar el mecanismo de ordenamiento
Parámetros:
|
string |
$columna: |
Nombre de la columna |
mixed ordenamiento_porcentaje(
string
$columna
)
|
|
Método estandar de ordenamiento de porcentajes
Heredar en caso de querer cambiar el mecanismo de ordenamiento
Parámetros:
|
string |
$columna: |
Nombre de la columna |
mixed ordenamiento_superficie(
string
$columna
)
|
|
Método estandar de ordenamiento de superficie
Heredar en caso de querer cambiar el mecanismo de ordenamiento
Parámetros:
|
string |
$columna: |
Nombre de la columna |
mixed ordenamiento_tiempo(
string
$columna
)
|
|
Método estandar de ordenamiento de tiempo expresado en numeros
Heredar en caso de querer cambiar el mecanismo de ordenamiento
Parámetros:
|
string |
$columna: |
Nombre de la columna |
Método estandar de ordenamiento de los datos, decide el metodo de ordenamiento en base
al tipo de formateo de la columna, sino utiliza ordenamiento por default
void quita_acentos(
$cadena
)
|
|
Parámetros:
void seleccionar(
array
$clave
)
|
|
Indica al cuadro cual es la clave seleccionada.
A la hora de mostrar la grilla se crea un feedback gráfico sobre la fila que posea esta clave
Parámetros:
|
array |
$clave: |
Arreglo asociativo id_clave => valor_clave |
void set_cortes_colapsados(
[boolean
$colapsado = true]
)
|
|
Fuerza a que los cortes de control se inicien de manera colapsada. Por defecto true
Parámetros:
void set_datos(
array
$datos
)
|
|
Carga el cuadro con un conjunto de datos
Parámetros:
|
array |
$datos: |
Arreglo en formato RecordSet |
void set_eof_mensaje(
string
$mensaje
)
|
|
Cambia el mensaje a mostrar cuando el cuadro no tiene datos
Parámetros:
void set_eof_mostrar(
[boolean
$mostrar = true]
)
|
|
Habilita o deshabilita el mensaje a mostrar cuando el cuadro no tiene datos que mostrar
Parámetros:
void set_etiqueta_cantidad_filas(
$etiqueta
)
|
|
Parámetros:
void set_excel_usar_formulas(
boolean
$usar_formulas
)
|
|
Define si la exportacion a excel utilizara formulas o no
Parámetros:
void set_formateo_columna(
string
$id_columna, string
$funcion, [string
$clase = null]
)
|
|
Cambia la forma en que se le da formato a una columna
Parámetros:
|
string |
$id_columna: |
|
|
string |
$funcion: |
Nombre de la función de formateo, sin el prefijo 'formato_' |
|
string |
$clase: |
Nombre de la clase que contiene la funcion, por defecto toba_formateo |
void set_grupo_columnas(
string
$nombre_grupo, array
$columnas
)
|
|
Agrupa columnas adyacentes bajo una etiqueta común
Parámetros:
|
string |
$nombre_grupo: |
Etiqueta que toma el grupo |
|
array |
$columnas: |
Id. de las columnas a agrupar, deben ser adyacentes |
void set_layout_cant_filas(
$cant_filas, integer
$cant_columnas
)
|
|
Grafica el cuadro agrupando las filas en N-columnas
Parámetros:
|
integer |
$cant_columnas: |
|
|
|
$cant_filas: |
|
void set_manejador_salida(
string
$tipo_salida, string
$clase
)
|
|
Permite configurar una clase especifica para atender la generacion de un tipo de salida particular
Parámetros:
|
string |
$tipo_salida: |
Alguno de los tipos de salida estandar que genera el cuadro |
|
string |
$clase: |
Nombre de clase que implementa dicha salida, la misma debe incluirse en el esquema de autoload |
void set_mostrar_titulo_antes_cc(
[boolean
$unico = true]
)
|
|
El cuadro muestra su título una única vez antes de los cortes de control
Parámetros:
void set_pagina_actual(
integer
$pag
)
|
|
Fuerza al cuadro a mostrar una página específica
Parámetros:
void set_tamanio_pagina(
[
$tamanio = null], integer
$tam
)
|
|
Cambia el tamaño de página a usar en el paginado
Parámetros:
void set_titulo_columna(
string
$id_columna, string
$titulo
)
|
|
Cambia el título o descripción de una columna dada del cuadro
Parámetros:
|
string |
$id_columna: |
Id de la columna a cambiar |
|
string |
$titulo: |
|
void set_total_registros(
integer
$cant
)
|
|
Informa al cuadro la cantidad total de registros que posee el set de datos
Este método se utiliza cuando el paginado no lo hace el propio cuadro, en este caso es necesario informarle la cantidad total de registros así puede armar la barra de paginado
Parámetros:
void set_usar_ordenamiento_con_cortes(
[boolean
$usar = true]
)
|
|
Define si los cortes de control seran considerados al ordenar los datos del cuadro
Parámetros:
string vista_xml(
[boolean
$inicial = false], [string
$xmlns = null]
)
|
|
Genera el xml del componente
Parámetros:
|
boolean |
$inicial: |
Si es el primer elemento llamado desde vista_xml |
|
string |
$xmlns: |
Namespace para el componente |
|
Return: | XML del componente |
