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

toba_ei

toba_ei

Ubicada en php/nucleo/componentes/interface/toba_ei.php [line 11]



Métodos Propios
static mixed   set_refresh_ejecuta_eventos()  
mixed   __construct ()  
mixed   agregar_evento ()  
mixed   agregar_notificacion ()  
bool   botonera_abajo ()  
bool   botonera_arriba ()  
int   cant_eventos_sobre_fila ()  
mixed   colapsar ()  
mixed   descolapsar ()  
mixed   destruir ()  
mixed   eliminar_evento ()  
\toba_evento_usuario   evento ()  
mixed   existe_evento ()  
mixed   extender_objeto_js ()  
mixed   generar_boton ()  
mixed   generar_botones ()  
mixed   generar_botones_eventos ()  
mixed   generar_html_barra_sup ()  
mixed   generar_html_boton ()  
mixed   get_eventos_sobre_fila ()  
string   get_grupo_eventos_activo ()  
string   get_id_form ()  
string   get_id_objeto_js ()  
mixed   get_invocacion_evento_fila ()  
array|(\toba_evento_usuario)   get_lista_eventos_internos ()  
array|(\toba_evento_usuario)   get_lista_eventos_usuario ()  
mixed   get_objeto_js ()  
array   get_puntos_control ()  
bool   hay_botones ()  
mixed   mostrar_barra_superior ()  
mixed   reportar_evento ()  
mixed   reportar_evento_interno ()  
mixed   set_colapsable ()  
mixed   set_descripcion ()  
mixed   set_disparo_eventos_condicionado_datos ()  
mixed   set_grupo_eventos_activo ()  
mixed   set_modo_descripcion ()  
mixed   set_titulo ()  
bool   tiene_puntos_control ()  
mixed   vista_impresion ()  
mixed   vista_impresion_html ()  
string   xml_get_att_comunes ()  
string   xml_get_elem_comunes ()  
mixed   xml_get_informacion_basica_vista ()  
string   xml_imagen ()  
mixed   xml_set_alto_cabecera ()  
mixed   xml_set_alto_pie ()  
mixed   xml_set_atts_ei ()  
mixed   xml_set_cabecera ()   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]]'.
mixed   xml_set_dim_pagina ()  
mixed   xml_set_incluir_cabecera ()  
mixed   xml_set_incluir_pie ()  
mixed   xml_set_logo ()  
mixed   xml_set_margenes ()  
mixed   xml_set_nro_copias ()  
mixed   xml_set_ns ()  
mixed   xml_set_orientacion ()  
mixed   xml_set_pie ()   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]]'.
\unknown_type   xml_set_subtitulo ()  
mixed   xml_set_tabla_cols ()  
mixed   xml_set_titulo ()  
string   xml_tabla ()   $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.
string   xml_texto ()  

static method set_refresh_ejecuta_eventos  [línea 63]

  static mixed set_refresh_ejecuta_eventos( mixed activado = true ] )

Hace que los componentes reenvien sus eventos cuando se hace un refresh sobre la pagina por defecto se encuentra desactivado
Parámetros:
mixed   activado: 





__construct   [línea 50]

  mixed __construct( mixed definicion )

Parámetros:
mixed   definicion: 





agregar_evento   [línea 169]

  mixed agregar_evento( string id )

Determina que un evento definido va a formar parte de los eventos a mostrar en el servicio actual
Parámetros:
string   id: 





agregar_notificacion   [línea 578]

  mixed agregar_notificacion( string mensaje , [string tipo = 'info' ] )

Agrega un mensaje de notificacion a esta pantalla
Parámetros:
string   mensaje: 
string   tipo: 





botonera_abajo   [línea 432]

  bool botonera_abajo( )

Devuelve True si la botonera del componente se debe ubicar abajo o en ambos extremos del mismo.




botonera_arriba   [línea 441]

  bool botonera_arriba( )

Devuelve True si la botonera del componente se debe ubicar arriba o en ambos extremos del mismo.




cant_eventos_sobre_fila   [línea 265]

  int cant_eventos_sobre_fila( )

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




colapsar   [línea 586]

  mixed colapsar( )

Fuerza a que el componente se grafique colpsado, pudiendo el usuario descolapsarlo posteriormente




descolapsar   [línea 595]

  mixed descolapsar( )

Fuerza a que el componente se grafique descolapsado, pudiendo el usuario colapsarlo posteriormente




destruir   [línea 81]

  mixed destruir( )

Destructor del componente




eliminar_evento   [línea 199]

  mixed eliminar_evento( string id )

Elimina un evento definido de la lista de eventos a utilizar en el servicio actual
Parámetros:
string   id: 





evento   [línea 152]

  \toba_evento_usuario evento( string id )

Recupera el objeto asociado de un evento
Parámetros:
string   id: 





existe_evento   [línea 183]

  mixed existe_evento( string id )

Verifica si un evento esta definido en la lista de eventos a utilizar en el servicio actual
Parámetros:
string   id: 





extender_objeto_js   [línea 808]

  mixed extender_objeto_js( )

Ventana de extensión javascript del componente





generar_boton   [línea 523]

  mixed generar_boton( string id_evento , [bool excluir_botonera = true ] , [mixed retornar = false ] )

Metodo para graficar un boton por orden del usuario
Parámetros:
string   id_evento: 
bool   excluir_botonera: 
mixed   retornar: 





generar_botones   [línea 466]

  mixed generar_botones( [string clase = '' ] , [mixed extra = '' ] )

Genera la botonera del componente
Parámetros:
string   clase: 
mixed   extra: 





generar_botones_eventos   [línea 481]

  mixed generar_botones_eventos( [mixed excluir_botonera = false ] )

Genera los botones de todos los eventos marcados para aparecer en la botonera.
Parámetros:
mixed   excluir_botonera: 





generar_html_barra_sup   [línea 648]

  mixed generar_html_barra_sup( [string titulo = null ] , [bool control_titulo_vacio = false ] , [string estilo = "" ] )

Genera la barra con el título y los íconos
Parámetros:
string   titulo: 
bool   control_titulo_vacio: 
string   estilo: 





generar_html_boton   [línea 497]

  mixed generar_html_boton( \toba_evento_usuario evento , [bool retornar = false ] )

Genera el html de un botón específico
Parámetros:
\toba_evento_usuario   evento: 
bool   retornar: 





get_eventos_sobre_fila   [línea 248]

  mixed get_eventos_sobre_fila( )

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




get_grupo_eventos_activo   [línea 396]

  string get_grupo_eventos_activo( )

Retorna el grupo de eventos activos




get_id_form   [línea 751]

  string get_id_form( )

Retorna el identificador base para los campos HTML




get_id_objeto_js   [línea 789]

  string get_id_objeto_js( )

Retorna el id del componente en javascript.




get_invocacion_evento_fila   [línea 337]

  mixed get_invocacion_evento_fila( mixed evento , int fila , mixed clave_fila , [mixed salida_como_vinculo = false ] , [mixed param_extra = array() ] )

Dado una fila, genera el html de los eventos de la misma
Parámetros:
mixed   evento: 
int   fila: 
mixed   clave_fila: 
mixed   salida_como_vinculo: 
mixed   param_extra: 





get_lista_eventos_internos   [línea 328]

  array|(\toba_evento_usuario) get_lista_eventos_internos( )

Retorna todos los eventos definidos por el componente (llamados internos), excluyendo los definidos por el usuario




get_lista_eventos_usuario   [línea 319]

  array|(\toba_evento_usuario) get_lista_eventos_usuario( )

Retorna todos los eventos definidos por el usuario, excluyendo los internos del componente




get_objeto_js   [línea 811]

  mixed get_objeto_js( )





get_puntos_control   [línea 557]

  array get_puntos_control( string evento )

Retorna la definición de un punto de control para un evento
Parámetros:
string   evento: 






hay_botones   [línea 450]

  bool hay_botones( )

Retorna true si alguno de los eventos definidos por el usuario se va a graficar en la botonera del componente




mostrar_barra_superior   [línea 706]

  mixed mostrar_barra_superior( [mixed estado = true ] )

Configura la visibilidad de la barra superior
Parámetros:
mixed   estado: 





reportar_evento   [línea 294]

  mixed reportar_evento( string evento )

Reporta un evento en el componente controlador Puede recibir N parametros adicionales (ej <pre>$this->reportar_evento('modificacion', $datos, $fila,...)</pre>)
Parámetros:
string   evento: 





reportar_evento_interno   [línea 304]

  mixed reportar_evento_interno( mixed evento )

Parámetros:
mixed   evento: 





set_colapsable   [línea 604]

  mixed set_colapsable( bool colapsable )

Determina si el componente podra ser colapsado/descolapsado por el usuario
Parámetros:
bool   colapsable: 





set_descripcion   [línea 626]

  mixed set_descripcion( string desc , [string tipo = 'info' ] )

Cambia la descripción del componente para el servicio actual
Parámetros:
string   desc: 
string   tipo: 





set_disparo_eventos_condicionado_datos   [línea 220]

  mixed set_disparo_eventos_condicionado_datos( [bool disparo = true ] )

Especifica si el disparo de los eventos implicitos debe estar asociado al cambio de datos o no
Parámetros:
bool   disparo: 





set_grupo_eventos_activo   [línea 387]

  mixed set_grupo_eventos_activo( string grupo )

Activa un grupo de eventos, excluyendo a aquellos eventos que no pertenecen al mismo
Parámetros:
string   grupo: 





set_modo_descripcion   [línea 636]

  mixed set_modo_descripcion( [bool tooltip = true ] )

Cambia el modo en el que se muestra la descripción del componente (por defecto con un tooltip)
Parámetros:
bool   tooltip: 





set_titulo   [línea 616]

  mixed set_titulo( string titulo )

Cambia el titulo del componente para el servicio actual
Parámetros:
string   titulo: 





tiene_puntos_control   [línea 546]

  bool tiene_puntos_control( string evento )

Determina si el componente tiene algún punto de control asignado para un evento
Parámetros:
string   evento: 






vista_impresion   [línea 844]

  mixed vista_impresion( \toba_impresion salida )

Despachador de tipos de salidas de impresion
Parámetros:
\toba_impresion   salida: 





vista_impresion_html   [línea 855]

  mixed vista_impresion_html( \toba_impresion salida )

Impresion HTML por defecto
Parámetros:
\toba_impresion   salida: 





xml_get_att_comunes   [línea 1018]

  string xml_get_att_comunes( )

Retorna los atributos que pueden ser incluidos en cualquier tag, y que definen propiedades del documento pdf.




xml_get_elem_comunes   [línea 1066]

  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é.




xml_get_informacion_basica_vista   [línea 1217]

  mixed xml_get_informacion_basica_vista( )





xml_imagen   [línea 1155]

  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: 
string   tipo: 
string   titulo: 
string   caption: 





xml_set_alto_cabecera   [línea 973]

  mixed xml_set_alto_cabecera( [string alto = false ] )

Define el alto de la cabecera de página.
Parámetros:
string   alto: 





xml_set_alto_pie   [línea 943]

  mixed xml_set_alto_pie( [string alto = false ] )

Define el alto del pié de página.
Parámetros:
string   alto: 





xml_set_atts_ei   [línea 998]

  mixed 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:
array   atts: 





xml_set_cabecera   [línea 965]

  mixed xml_set_cabecera( [string cabecera = false ] )

Define la cabecera de página.
Parámetros:
string   cabecera: 





xml_set_dim_pagina   [línea 912]

  mixed xml_set_dim_pagina( [string ancho = false ] , [string alto = false ] )

Define las dimensiones de la página
Parámetros:
string   ancho: 
string   alto: 





xml_set_incluir_cabecera   [línea 952]

  mixed xml_set_incluir_cabecera( [bool incluir = true ] )

Define si se crea la cabecera de la página.
Parámetros:
bool   incluir: 





xml_set_incluir_pie   [línea 922]

  mixed xml_set_incluir_pie( [bool incluir = true ] )

Define si se crea el pié de página.
Parámetros:
bool   incluir: 





xml_set_logo   [línea 879]

  mixed xml_set_logo( string logo )

Define el logo de la institución a utilizar en la cabecera del pdf
Parámetros:
string   logo: 





xml_set_margenes   [línea 984]

  mixed 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:
array   margenes: 





xml_set_nro_copias   [línea 1009]

  mixed xml_set_nro_copias( [int copias = 1 ] )

Define el numero de copias que deben aparecer en el pdf.
Parámetros:
int   copias: 





xml_set_ns   [línea 1206]

  mixed xml_set_ns( string xmlns , [string url = '' ] , [bool usar = true ] )

Define un namespace a utilizar con los elementos xml.
Parámetros:
string   xmlns: 
string   url: 
bool   usar: 





xml_set_orientacion   [línea 869]

  mixed xml_set_orientacion( [string orientacion = 'portrait' ] )

Define la orientación de la página
Parámetros:
string   orientacion: 





xml_set_pie   [línea 935]

  mixed xml_set_pie( [string pie = false ] )

Define el pié de página.
Parámetros:
string   pie: 





xml_set_subtitulo   [línea 901]

  \unknown_type xml_set_subtitulo( subtitulo )

Define el subtítulo a utilizar en la cabecera del pdf
Parámetros:
   subtitulo: 





xml_set_tabla_cols   [línea 1185]

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





xml_set_titulo   [línea 890]

  mixed xml_set_titulo( string titulo )

Define el titulo a utilizar en la cabecera del pdf
Parámetros:
string   titulo: 





xml_tabla   [línea 1111]

  string xml_tabla( [array datos = array() ] , [bool 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.
Parámetros:
array   datos: 
bool   es_formulario: 





xml_texto   [línea 1084]

  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: 






Desarrollado por SIU.
Documentación generada con phpDocumentor