static void set_refresh_ejecuta_eventos(
[
$activado = true]
)
|
|
Hace que los componentes reenvien sus eventos cuando se hace un refresh sobre la pagina
por defecto se encuentra desactivado
Parámetros:
void agregar_evento(
string
$id
)
|
|
Determina que un evento definido va a formar parte de los eventos a mostrar en el servicio actual
Parámetros:
void agregar_notificacion(
string
$mensaje, [string
$tipo = 'info']
)
|
|
Agrega un mensaje de notificacion a esta pantalla
Parámetros:
|
string |
$mensaje: |
|
|
string |
$tipo: |
Puede ser 'info', 'warning', 'error' |
Redefinido en subclases como:
boolean botonera_abajo(
)
|
|
Devuelve True si la botonera del componente se debe ubicar abajo o en ambos extremos del mismo.
boolean botonera_arriba(
)
|
|
Devuelve True si la botonera del componente se debe ubicar arriba o en ambos extremos del mismo.
integer cant_eventos_sobre_fila(
)
|
|
Retorna la cantidad de eventos que fueron definidos a nivel de fila
Fuerza a que el componente se grafique colpsado, pudiendo el usuario descolapsarlo posteriormente
Fuerza a que el componente se grafique descolapsado, pudiendo el usuario colapsarlo posteriormente
void eliminar_evento(
string
$id
)
|
|
Elimina un evento definido de la lista de eventos a utilizar en el servicio actual
Parámetros:
Recupera el objeto asociado de un evento
Parámetros:
|
string |
$id: |
Id del evento |
Redefinido en subclases como:
-
toba_ci::evento()
: Shortcut para acceder a un evento propio (en realidad es de la pantalla)
void existe_evento(
string
$id
)
|
|
Verifica si un evento esta definido en la lista de eventos a utilizar en el servicio actual
Parámetros:
void extender_objeto_js(
)
|
|
Ventana de extensión javascript del componente
Information Tags:
void generar_boton(
string
$id_evento, [boolean
$excluir_botonera = true], [
$retornar = false]
)
|
|
Metodo para graficar un boton por orden del usuario
Parámetros:
|
string |
$id_evento: |
Id. del evento a generar el botón |
|
boolean |
$excluir_botonera: |
El botón no se incluye en la botonera predeterminada del componente |
|
|
$retornar: |
|
void generar_botones(
[string
$clase = ''], [
$extra = '']
)
|
|
Genera la botonera del componente
Parámetros:
|
string |
$clase: |
Clase css con el que se muestra la botonera |
|
|
$extra: |
|
Redefinido en subclases como:
void generar_botones_eventos(
[
$excluir_botonera = false]
)
|
|
Genera los botones de todos los eventos marcados para aparecer en la botonera.
Parámetros:
void generar_html_barra_sup(
[string
$titulo = null], [boolean
$control_titulo_vacio = false], [string
$estilo = ""]
)
|
|
Genera la barra con el título y los íconos
Parámetros:
|
string |
$titulo: |
Título de la barra |
|
boolean |
$control_titulo_vacio: |
Si el comp. no tiene titulo definido, ni se lo pasa por parametro, no grafica la barra |
|
string |
$estilo: |
Clase css a utilizar |
Genera el html de un botón específico
Parámetros:
|
toba_evento_usuario |
$evento: |
|
|
boolean |
$retornar: |
Define si devuelve como resultado el HTML o lo 'imprime' |
array(id get_eventos_sobre_fila(
)
|
|
Retorna la lista de eventos que fueron definidos a nivel de fila
|
Return: | => toba_evento_usuario) |
Redefinido en subclases como:
string get_grupo_eventos_activo(
)
|
|
Retorna el grupo de eventos activos
Retorna el identificador base para los campos HTML
string get_id_objeto_js(
)
|
|
Retorna el id del componente en javascript.
void get_invocacion_evento_fila(
$evento, integer
$fila,
$clave_fila, [
$salida_como_vinculo = false], [
$param_extra = array()]
)
|
|
Dado una fila, genera el html de los eventos de la misma
Parámetros:
|
integer |
$fila: |
|
|
|
$evento: |
|
|
|
$clave_fila: |
|
|
|
$salida_como_vinculo: |
|
|
|
$param_extra: |
|
array(toba_evento_usuario) get_lista_eventos_internos(
)
|
|
Retorna todos los eventos definidos por el componente (llamados internos), excluyendo los definidos por el usuario
array(toba_evento_usuario) get_lista_eventos_usuario(
)
|
|
Retorna todos los eventos definidos por el usuario, excluyendo los internos del componente
Redefinido en subclases como:
array get_puntos_control(
string
$evento
)
|
|
Retorna la definición de un punto de control para un evento
Parámetros:
|
string |
$evento: |
Id. del evento |
Retorna true si alguno de los eventos definidos por el usuario se va a graficar en la botonera del componente
void mostrar_barra_superior(
[
$estado = true]
)
|
|
Configura la visibilidad de la barra superior
Parámetros:
void reportar_evento(
string
$evento
)
|
|
Reporta un evento en el componente controlador
Puede recibir N parametros adicionales (ej
$this->reportar_evento('modificacion', $datos, $fila,...))
Parámetros:
|
string |
$evento: |
Id. del evento a disparar |
void reportar_evento_interno(
$evento
)
|
|
Parámetros:
void set_colapsable(
boolean
$colapsable
)
|
|
Determina si el componente podra ser colapsado/descolapsado por el usuario
Parámetros:
|
boolean |
$colapsable: |
Si o no se permite colapsar |
void set_descripcion(
string
$desc, [string
$tipo = 'info']
)
|
|
Cambia la descripción del componente para el servicio actual
Parámetros:
|
string |
$desc: |
|
|
string |
$tipo: |
Puede ser 'info', 'warning', 'error' |
Redefinido en subclases como:
void set_disparo_eventos_condicionado_datos(
[boolean
$disparo = true]
)
|
|
Especifica si el disparo de los eventos implicitos debe estar asociado al cambio de datos o no
Parámetros:
void set_grupo_eventos_activo(
string
$grupo
)
|
|
Activa un grupo de eventos, excluyendo a aquellos eventos que no pertenecen al mismo
Parámetros:
|
string |
$grupo: |
Id del grupo de eventos |
void set_modo_descripcion(
[boolean
$tooltip = true]
)
|
|
Cambia el modo en el que se muestra la descripción del componente (por defecto con un tooltip)
Parámetros:
|
boolean |
$tooltip: |
Si es false la descripción se muestra como una barra aparte |
void set_titulo(
string
$titulo
)
|
|
Cambia el titulo del componente para el servicio actual
Parámetros:
boolean tiene_puntos_control(
string
$evento
)
|
|
Determina si el componente tiene algún punto de control asignado para un evento
Parámetros:
|
string |
$evento: |
Id. del evento |
void vista_impresion(
$salida
)
|
|
Despachador de tipos de salidas de impresion
Parámetros:
Impresion HTML por defecto
Parámetros:
Redefinido en subclases como:
string xml_get_att_comunes(
)
|
|
Retorna los atributos que pueden ser incluidos en cualquier tag, y que definen propiedades del documento pdf.
|
Return: | con atributos a incluir en un tag xml |
string xml_get_elem_comunes(
)
|
|
Retorna los elementos que pueden ser incluidos en cualquier tag, y que definen propiedades del documento pdf, como la cabecera y el pié.
|
Return: | con xml de los elementos a incluir. |
void xml_get_informacion_basica_vista(
)
|
|
string xml_imagen(
string
$src, [string
$tipo = 'jpg'], [string
$titulo = false], [string
$caption = false]
)
|
|
Devuelve un string con el xml de una imagen a incluir.
Parámetros:
|
string |
$src: |
Path al archivo de la imagen |
|
string |
$tipo: |
'svg' o 'jpg' (default) |
|
string |
$titulo: |
|
|
string |
$caption: |
|
void xml_set_alto_cabecera(
[string
$alto = false]
)
|
|
Define el alto de la cabecera de página.
Parámetros:
void xml_set_alto_pie(
[string
$alto = false]
)
|
|
Define el alto del pié de página.
Parámetros:
void xml_set_atts_ei(
[array
$atts = array()]
)
|
|
Forma genérica de definir parámetros de usuario. El parámetro $atts debe ser un array de tipo "nombre"=>"valor".
Parámetros:
void xml_set_cabecera(
[string
$cabecera = false]
)
|
|
Define la cabecera de página.
El parámetro $cabecera debe ser un xml creado con las funciones xml_imagen, xml_texto o xml_tabla. Para mostrar el número de página actual, incluir '[[actual]]' dentro del texto. Para mostrar el total de páginas, incluir '[[total]]' dentro del texto. Por ejemplo, si se quiere mostrar pág 1 de 10, se debe incluir el texto 'pág [[actual]] de [[total]]'.
Parámetros:
void xml_set_dim_pagina(
[string
$ancho = false], [string
$alto = false]
)
|
|
Define las dimensiones de la página
Parámetros:
|
string |
$ancho: |
|
|
string |
$alto: |
|
void xml_set_incluir_cabecera(
[boolean
$incluir = true]
)
|
|
Define si se crea la cabecera de la página.
Parámetros:
|
boolean |
$incluir: |
default true |
void xml_set_incluir_pie(
[boolean
$incluir = true]
)
|
|
Define si se crea el pié de página.
Parámetros:
|
boolean |
$incluir: |
default true |
void xml_set_logo(
string
$logo
)
|
|
Define el logo de la institución a utilizar en la cabecera del pdf
Parámetros:
|
string |
$logo: |
Path a la imagen |
void xml_set_margenes(
[array
$margenes = array()]
)
|
|
Define los márgenes de la página. $margenes debe ser un array de tipo 'nombre'=>'valor', donde 'sup', 'inf', 'izq' y 'der' son los nombres para definir los márgenes superior, inferior, izquierdo y derecho respectivamente.
Parámetros:
void xml_set_nro_copias(
[int
$copias = 1]
)
|
|
Define el numero de copias que deben aparecer en el pdf.
Parámetros:
void xml_set_ns(
string
$xmlns, [string
$url = ''], [boolean
$usar = true]
)
|
|
Define un namespace a utilizar con los elementos xml.
Parámetros:
|
string |
$xmlns: |
El namespace propiamente dicho |
|
string |
$url: |
un url del namespace |
|
boolean |
$usar: |
Usar el namespace en este elemento o sólo declararlo. |
void xml_set_orientacion(
[string
$orientacion = 'portrait']
)
|
|
Define la orientación de la página
Parámetros:
|
string |
$orientacion: |
Soporta los valores 'landscape' o 'portrait' (default). |
void xml_set_pie(
[string
$pie = false]
)
|
|
Define el pié de página.
El parámetro $pie debe ser un xml creado con las funciones xml_imagen, xml_texto o xml_tabla. Para mostrar el número de página actual, incluir '[[actual]]' dentro del texto. Para mostrar el total de páginas, incluir '[[total]]' dentro del texto. Por ejemplo, si se quiere mostrar pág 1 de 10, se debe incluir el texto 'pág [[actual]] de [[total]]'.
Parámetros:
unknown_type xml_set_subtitulo(
$subtitulo
$subtitulo
)
|
|
Define el subtítulo a utilizar en la cabecera del pdf
Parámetros:
void xml_set_tabla_cols(
[array
$cols = array()]
)
|
|
Define atributos comunes a columnas de una tabla (atributos del elemento table-column de xsl-fo).
Parámetros:
|
array |
$cols: |
Array de tipo 'nombre'=>'valor' |
void xml_set_titulo(
string
$titulo
)
|
|
Define el titulo a utilizar en la cabecera del pdf
Parámetros:
string xml_tabla(
[array
$datos = array()], [boolean
$es_formulario = true]
)
|
|
Devuelve un string con el xml de una tabla a incluir. $datos es un array cuyo primer nivel representan las
filas, y el segundo nivel representan las columnas dentro de una fila. Es decir $datos[0] representa la primer fila, y $datos[0][0] representa la primer columna de la primer fila. $datos[n][m] a su vez, puede ser tanto un string como un array. Si es un string, se toma este como valor de la celda. Si es un array, debe ser de tipo 'key'=>'value' donde 'key' represente un atributo de la celda de la tabla (atributos del elemento table-cell de xsl-fo). Si existe $datos[n][m]['valor'], entonces no es tomado como atributo, sino como el valor de la celda. $datos[n][m]['valor'] puede ser tanto un array como un string. Si es string, se incluye diréctamente. Si es array, se concatenan todos los valores y se incluye el string resultante. Como valor de una celda se puede incluir otro xml.
Parámetros:
|
array |
$datos: |
|
|
boolean |
$es_formulario: |
Indica que cuando el array tiene una fila se deba tratar como un formulario. |
string xml_texto(
string
$texto, [array
$atts = array()]
)
|
|
Devuelve un string con el xml de un texto y sus atributos a incluir
Parámetros:
|
string |
$texto: |
|
|
array |
$atts: |
Array de tipo 'nombre'=>'valor' |
