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

Eis

toba_ei

Resúmen de la Clase | Métodos Heredados | Métodos Propios
\toba_componente
   |
toba_ei

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



Métodos Heredados

Heredado de toba_componente

\toba_componente::__construct()
\toba_componente::__sleep()
\toba_componente::set_modo_compatible_manejo_sesion()
\toba_componente::ini()
\toba_componente::destruir()
\toba_componente::log()
\toba_componente::get_nombre()
\toba_componente::get_titulo()
\toba_componente::get_id()
\toba_componente::inicializado()
\toba_componente::get_parametro()
\toba_componente::controlador()
\toba_componente::invocar_callback()
\toba_componente::get_mensaje()
\toba_componente::informar_msg()
\toba_componente::informar()
\toba_componente::borrar_memoria()
\toba_componente::mantener_estado_sesion()
\toba_componente::set_propiedades_sesion()
\toba_componente::eliminar_estado_sesion()
\toba_componente::get_estado_sesion()
\toba_componente::set_controlador()
\toba_componente::dependencia()
\toba_componente::dep()
\toba_componente::agregar_dependencia()
\toba_componente::agregar_dependencia_por_indice()
\toba_componente::dependencia_cargada()
\toba_componente::existe_dependencia()
\toba_componente::get_dependencias()
\toba_componente::get_cantidad_dependencias()
\toba_componente::get_dependencias_clase()

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





__construct   [línea 50]

  __construct( $definicion )

Parámetros:
   $definicion: 





agregar_evento   [línea 169]

  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 579]

  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]

  boolean botonera_abajo( )

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





botonera_arriba   [línea 441]

  boolean 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]

  integer cant_eventos_sobre_fila( )

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





colapsar   [línea 587]

  colapsar( )

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





descolapsar   [línea 596]

  descolapsar( )

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





destruir   [línea 81]

  destruir( )

Destructor del componente





eliminar_evento   [línea 199]

  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]

  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 841]

  extender_objeto_js( )

Ventana de extensión javascript del componente






generar_boton   [línea 524]

  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: 
boolean   $excluir_botonera: 
   $retornar: 





generar_botones   [línea 466]

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

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





generar_botones_eventos   [línea 482]

  generar_botones_eventos( [ $excluir_botonera = false ] )

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





generar_html_barra_sup   [línea 649]

  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: 
boolean   $control_titulo_vacio: 
string   $estilo: 





generar_html_boton   [línea 498]

  generar_html_boton( \toba_evento_usuario $evento , [boolean $retornar = false ] )

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





get_eventos_sobre_fila   [línea 248]

  \array(id 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 784]

  string get_id_form( )

Retorna el identificador base para los campos HTML





get_id_objeto_js   [línea 822]

  string get_id_objeto_js( )

Retorna el id del componente en javascript.





get_invocacion_evento_fila   [línea 337]

  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:
   $evento: 
integer   $fila: 
   $clave_fila: 
   $salida_como_vinculo: 
   $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 844]

  get_objeto_js( )






get_puntos_control   [línea 558]

  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]

  boolean 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 728]

  mostrar_barra_superior( [ $estado = true ] )

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





reportar_evento   [línea 294]

  reportar_evento( string $evento )

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





reportar_evento_interno   [línea 304]

  reportar_evento_interno( $evento )

Parámetros:
   $evento: 





set_colapsable   [línea 605]

  set_colapsable( boolean $colapsable )

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





set_descripcion   [línea 627]

  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]

  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:
boolean   $disparo: 





set_grupo_eventos_activo   [línea 387]

  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 637]

  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: 





set_titulo   [línea 617]

  set_titulo( string $titulo )

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





tiene_puntos_control   [línea 547]

  boolean 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 877]

  vista_impresion( \toba_impresion $salida )

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





vista_impresion_html   [línea 888]

  vista_impresion_html( \toba_impresion $salida )

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





xml_get_att_comunes   [línea 1051]

  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 1099]

  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 1250]

  xml_get_informacion_basica_vista( )






xml_imagen   [línea 1188]

  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 1006]

  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 976]

  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 1031]

  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 998]

  xml_set_cabecera( [string $cabecera = false ] )

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





xml_set_dim_pagina   [línea 945]

  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 985]

  xml_set_incluir_cabecera( [boolean $incluir = true ] )

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





xml_set_incluir_pie   [línea 955]

  xml_set_incluir_pie( [boolean $incluir = true ] )

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





xml_set_logo   [línea 912]

  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 1017]

  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 1042]

  xml_set_nro_copias( [integer $copias = 1 ] )

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





xml_set_ns   [línea 1239]

  xml_set_ns( string $xmlns , [string $url = '' ] , [boolean $usar = true ] )

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





xml_set_orientacion   [línea 902]

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

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





xml_set_pie   [línea 968]

  xml_set_pie( [string $pie = false ] )

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





xml_set_subtitulo   [línea 934]

  \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 1218]

  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 923]

  xml_set_titulo( string $titulo )

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





xml_tabla   [línea 1144]

  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.
Parámetros:
array   $datos: 
boolean   $es_formulario: 





xml_texto   [línea 1117]

  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