API Documentation

static method permite_exportacion_excel_plano [línea 2398]

static  permite_exportacion_excel_plano(
            )

static method recuperar_clave_fila [línea 562]

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:
integer	$clave:

static method set_vista_excel_sin_cortes [línea 2393]

static  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:

boolean

$valor:

__construct [línea 90]

 __construct(
                                    
                
                $id                                    )

Parámetros:

$id:

actualizar_acumulador_general [línea 1151]

 actualizar_acumulador_general(
                                    
                
                $dato                                    )

Parámetros:

$dato:

agregar_columnas [línea 345]

 agregar_columnas(
                                    
                array
                $columnas                                    )

Agrega nuevas definiciones de columnas al cuadro

Parámetros:

array

$columnas:

agregar_corte_control [línea 970]

 agregar_corte_control(
                                    
                
                $corte                                    )

Parámetros:

$corte:

datos_cargados [línea 603]

boolean datos_cargados(
        )

El cuadro posee datos?

debe_colapsar_cortes [línea 2340]

 debe_colapsar_cortes(
        )

debe_mostrar_total_registros [línea 690]

 debe_mostrar_total_registros(
        )

desactivar_modo_clave_segura [línea 546]

 desactivar_modo_clave_segura(
        )

deseleccionar [línea 811]

 deseleccionar(
        )

Deja al cuadro sin selección alguna de fila

deshabilitar_corte_control [línea 1025]

 deshabilitar_corte_control(
                                    
                
                $corte                                    )

Parámetros:

$corte:

destruir [línea 110]

 destruir(
        )

Destructor del componente

disparar_eventos_multiples [línea 1905]

 disparar_eventos_multiples(
        )

disparar_eventos_simples [línea 1916]

 disparar_eventos_simples(
                                    
                
                $evento                                    )

Parámetros:

$evento:

eliminar_columnas [línea 296]

 eliminar_columnas(
                                    
                
                $columnas                                    )

Elimina columnas del cuadro

Parámetros:

$columnas:

eliminar_corte_control [línea 1014]

 eliminar_corte_control(
                                    
                
                $corte                                    )

Parámetros:

$corte:

es_asociacion_de_vinculo [línea 1816]

 es_asociacion_de_vinculo(
                                    
                
                $id_evento                                    )

Parámetros:

$id_evento:

es_clave_fila_seleccionada [línea 897]

\ es_clave_fila_seleccionada(
                                    
                \
                $clave_fila                                    )

Indica si la clave que se pasa por parametro es igual a la fila actualmente seleccionada.

Parámetros:

$clave_fila:

existe_columna [línea 309]

 existe_columna(
                                    
                
                $columna                                    )

Chequea si una columna existe en la definicion del cuadro.

Parámetros:

$columna:

existe_paginado [línea 1236]

boolean existe_paginado(
        )

Retorna verdadero si el cuadro se pagina en caso de superar una cantidad dada de registros

existen_columnas [línea 319]

 existen_columnas(
                                    
                
                $columnas                                    )

Chequea si un conjunto de columnas existen en la definicion del cuadro.

Parámetros:

$columnas:

existen_cortes_control [línea 945]

boolean existen_cortes_control(
        )

Indica la existencia o no de cortes de control en el cuadro.

finalizar_ids_seguros [línea 742]

 finalizar_ids_seguros(
        )

generar_fin_zona_colapsable [línea 2305]

 generar_fin_zona_colapsable(
        )

generar_html [línea 2073]

 generar_html(
        )

Dispara la generacion de la salida HTML del cuadro

generar_inicio_zona_colapsable [línea 2293]

 generar_inicio_zona_colapsable(
                                    
                
                $id_unico                ,                             
                
                $estilo                                    )

Parámetros:

	$id_unico:
	$estilo:

generar_salida [línea 2082]

 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:

get_acumulador_usuario [línea 1170]

 get_acumulador_usuario(
        )

get_cantidad_columnas [línea 2163]

 get_cantidad_columnas(
        )

get_cantidad_columnas_total [línea 2158]

 get_cantidad_columnas_total(
        )

get_cantidad_paginas [línea 1336]

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

get_clave [línea 877]

 get_clave(
        )

get_clave_fila [línea 842]

string get_clave_fila(
                                    
                integer
                $fila                ,                             
                [boolean
                $forzar_claves_reales = false ]                                    )

Retorna la clave serializada de una fila dada

Parámetros:

integer	$fila:
boolean	$forzar_claves_reales:

get_clave_fila_array [línea 864]

array get_clave_fila_array(
                                    
                integer
                $fila                                    )

Retorna un arreglo con las claves de la fila dada

Parámetros:

integer

$fila:

get_clave_seleccionada [línea 887]

array get_clave_seleccionada(
        )

En caso de existir una fila seleccionada, retorna su clave

get_columnas [línea 398]

array get_columnas(
        )

Retorna la definición de las columnas actuales del cuadro

get_cortes_control [línea 1223]

 get_cortes_control(
        )

get_cortes_modo [línea 1213]

 get_cortes_modo(
        )

get_datos [línea 516]

array get_datos(
        )

Retorna el conjunto de datos que actualmente posee el cuadro

get_descripcion_resp_popup [línea 655]

 get_descripcion_resp_popup(
                                    
                
                $fila                                    )

Parámetros:

$fila:

get_etiqueta_cantidad_filas [línea 2443]

 get_etiqueta_cantidad_filas(
        )

get_eventos [línea 1953]

 get_eventos(
        )

get_eventos_multiples [línea 1948]

 get_eventos_multiples(
        )

get_eventos_sobre_fila [línea 1803]

\array(id get_eventos_sobre_fila(
        )

Retorna la lista de eventos que fueron definidos a nivel de fila

get_filas_disponibles_selector [línea 2407]

array get_filas_disponibles_selector(
        )

Obtiene las filas que estaran disponibles para ordenar.

get_ids_evento_aplicacion_multiple [línea 1828]

 get_ids_evento_aplicacion_multiple(
        )

Retorna el primer evento del tipo seleccion multiple. Si no existe retorna null

get_indice_cortes [línea 1218]

 get_indice_cortes(
        )

get_nombre_evento_multiple [línea 1929]

 get_nombre_evento_multiple(
                                    
                
                $evento                                    )

Parámetros:

$evento:

get_nombres_eventos_multiples [línea 1934]

 get_nombres_eventos_multiples(
        )

get_pagina_actual [línea 1308]

integer get_pagina_actual(
        )

Retorna la página actualmente seleccionada por el usuario, si existe el paginado

get_sentido_ordenamiento [línea 1738]

 get_sentido_ordenamiento(
                                    
                [
                $valor = 'asc' ]                                    )

Parámetros:

$valor:

get_tamanio_pagina [línea 1317]

integer get_tamanio_pagina(
        )

Retorna el tamaño de página actual en el paginado (si está presente el paginado)

get_tipo_paginado [línea 1325]

 get_tipo_paginado(
        )

Devuelve el tipo de paginado que esta usando el cuadro

habilitar_corte_control [línea 1035]

 habilitar_corte_control(
                                    
                
                $corte                                    )

Parámetros:

$corte:

hay_eventos_multiples [línea 1943]

 hay_eventos_multiples(
        )

hay_ordenamiento [línea 1479]

boolean hay_ordenamiento(
        )

Retorna verdadero si el cuadro actualmente se encuentra ordenado por alguna columna por parte del usuario

hay_ordenamiento_multiple [línea 1484]

 hay_ordenamiento_multiple(
        )

hay_seleccion [línea 830]

boolean hay_seleccion(
        )

Retorna verdadero si existe alguna fila seleccionada

inicializar_ids_seguros [línea 734]

 inicializar_ids_seguros(
        )

instanciar_manejador_tipo_salida [línea 2122]

 instanciar_manejador_tipo_salida(
                                    
                
                $tipo                                    )

Parámetros:

$tipo:

limpiar_columnas [línea 334]

 limpiar_columnas(
        )

Elimina todas las columnas actualmente definidas en el cuadro

ordenamiento_decimal [línea 1612]

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:

ordenamiento_default [línea 1679]

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:

ordenamiento_fecha [línea 1568]

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:

ordenamiento_fecha_hora [línea 1579]

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:

ordenamiento_may_ind [línea 1668]

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:

ordenamiento_mayusculas [línea 1657]

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:

ordenamiento_millares [línea 1601]

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:

ordenamiento_moneda [línea 1590]

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:

ordenamiento_porcentaje [línea 1635]

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:

ordenamiento_superficie [línea 1646]

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:

ordenamiento_tiempo [línea 1624]

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:

ordenar [línea 1493]

 ordenar(
        )

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

quita_acentos [línea 1750]

 quita_acentos(
                                    
                
                $cadena                                    )

Parámetros:

$cadena:

seleccionar [línea 821]

 seleccionar(
                                    
                array
                $clave                                    )

Indica al cuadro cual es la clave seleccionada.

Parámetros:

array

$clave:

set_cortes_colapsados [línea 965]

 set_cortes_colapsados(
                                    
                [boolean
                $colapsado = true ]                                    )

Fuerza a que los cortes de control se inicien de manera colapsada. Por defecto true

Parámetros:

boolean

$colapsado:

set_datos [línea 1962]

 set_datos(
                                    
                array
                $datos                                    )

Carga el cuadro con un conjunto de datos

Parámetros:

array

$datos:

set_eof_mensaje [línea 612]

 set_eof_mensaje(
                                    
                string
                $mensaje                                    )

Cambia el mensaje a mostrar cuando el cuadro no tiene datos

Parámetros:

string

$mensaje:

set_eof_mostrar [línea 621]

 set_eof_mostrar(
                                    
                [boolean
                $mostrar = true ]                                    )

Habilita o deshabilita el mensaje a mostrar cuando el cuadro no tiene datos que mostrar

Parámetros:

boolean

$mostrar:

set_etiqueta_cantidad_filas [línea 2438]

 set_etiqueta_cantidad_filas(
                                    
                
                $etiqueta                                    )

Parámetros:

$etiqueta:

set_excel_usar_formulas [línea 640]

 set_excel_usar_formulas(
                                    
                boolean
                $usar_formulas                                    )

Define si la exportacion a excel utilizara formulas o no

Parámetros:

boolean

$usar_formulas:

set_formateo_columna [línea 504]

 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:
string	$clase:

set_grupo_columnas [línea 375]

 set_grupo_columnas(
                                    
                string
                $nombre_grupo                ,                             
                array
                $columnas                                    )

Agrupa columnas adyacentes bajo una etiqueta común

Parámetros:

string	$nombre_grupo:
array	$columnas:

set_layout_cant_filas [línea 669]

 set_layout_cant_filas(
                                    
                integer
                $cant_filas                                    )

Grafica el cuadro agrupando las filas en N-columnas

Parámetros:

integer

$cant_filas:

set_manejador_salida [línea 535]

 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:
string	$clase:

set_mostrar_titulo_antes_cc [línea 631]

 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:

boolean

$unico:

set_pagina_actual [línea 1299]

 set_pagina_actual(
                                    
                integer
                $pag                                    )

Fuerza al cuadro a mostrar una página específica

Parámetros:

integer

$pag:

set_tamanio_pagina [línea 1275]

 set_tamanio_pagina(
                                    
                [
                $tamanio = null ]                                    )

Cambia el tamaño de página a usar en el paginado

Parámetros:

$tamanio:

set_titulo_columna [línea 493]

 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:
string	$titulo:

set_total_registros [línea 1290]

 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:

integer

$cant:

set_usar_ordenamiento_con_cortes [línea 1394]

 set_usar_ordenamiento_con_cortes(
                                    
                [boolean
                $usar = true ]                                    )

Define si los cortes de control seran considerados al ordenar los datos del cuadro

Parámetros:

boolean

$usar:

usa_modo_seguro [línea 551]

 usa_modo_seguro(
        )

validar_y_separar_clave [línea 790]

 validar_y_separar_clave(
                                    
                
                $klave                                    )

Parámetros:

$klave:

vista_xml [línea 2050]

string vista_xml(
                                    
                [boolean
                $inicial = false ]                ,                             
                [string
                $xmlns = null ]                                    )

Genera el xml del componente

Parámetros:

boolean	$inicial:
string	$xmlns:

	Centrales \| Componentes \| consola \| Debug \| Default \| Fuentes \| SalidaGrafica \| Seguridad \| SIUToba \| Varios \| Deprecated

toba_ei_cuadro