phpDocumentor
[ árbol de herencia: Componentes ] [ índice: Componentes ] [ índice general ]

toba_ci

Controlador de Interface: Componente responsable de manejar las pantallas y sus distintos elementos

Este componente puede mantener sus propiedades en sesion con solo prefijar los nombres de variables con s__ (por ej. protected $s__cuit )

toba_componente
   |
   --toba_ei
      |
      --toba_ci

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

Deprecated: Function split() is deprecated in /home/ricardo/proyectos/toba_migraciones/proyectos/toba_editor/www/doc/api/Componentes/Efs/c305412028b9a2be48c5677e1d4f636f/%%404^%%40462378^classtags.tpl.php on line 37 Deprecated: Function split() is deprecated in /home/ricardo/proyectos/toba_migraciones/proyectos/toba_editor/www/doc/api/Componentes/Efs/c305412028b9a2be48c5677e1d4f636f/%%404^%%40462378^classtags.tpl.php on line 54
Documentación WIKI
Clase Javascript equivalente: ci

Métodos Heredados

Heredado de toba_ei

__construct()
agregar_evento()
Determina que un evento definido va a formar parte de los eventos a mostrar en el servicio actual
agregar_notificacion()
Agrega un mensaje de notificacion a esta pantalla
botonera_abajo()
Devuelve True si la botonera del componente se debe ubicar abajo o en ambos extremos del mismo.
botonera_arriba()
Devuelve True si la botonera del componente se debe ubicar arriba o en ambos extremos del mismo.
cant_eventos_sobre_fila()
Retorna la cantidad de eventos que fueron definidos a nivel de fila
colapsar()
Fuerza a que el componente se grafique colpsado, pudiendo el usuario descolapsarlo posteriormente
descolapsar()
Fuerza a que el componente se grafique descolapsado, pudiendo el usuario colapsarlo posteriormente
destruir()
Destructor del componente
eliminar_evento()
Elimina un evento definido de la lista de eventos a utilizar en el servicio actual
evento()
Recupera el objeto asociado de un evento
existe_evento()
Verifica si un evento esta definido en la lista de eventos a utilizar en el servicio actual
extender_objeto_js()
Ventana de extensión javascript del componente
generar_boton()
Metodo para graficar un boton por orden del usuario
generar_botones()
Genera la botonera del componente
generar_botones_eventos()
Genera los botones de todos los eventos marcados para aparecer en la botonera.
generar_html_barra_sup()
Genera la barra con el título y los íconos
generar_html_boton()
Genera el html de un botón específico
get_eventos_sobre_fila()
Retorna la lista de eventos que fueron definidos a nivel de fila
get_grupo_eventos_activo()
Retorna el grupo de eventos activos
get_id_form()
Retorna el identificador base para los campos HTML
get_id_objeto_js()
Retorna el id del componente en javascript.
get_invocacion_evento_fila()
Dado una fila, genera el html de los eventos de la misma
get_lista_eventos_internos()
Retorna todos los eventos definidos por el componente (llamados internos), excluyendo los definidos por el usuario
get_lista_eventos_usuario()
Retorna todos los eventos definidos por el usuario, excluyendo los internos del componente
get_objeto_js()
get_puntos_control()
Retorna la definición de un punto de control para un evento
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()
Configura la visibilidad de la barra superior
reportar_evento()
Reporta un evento en el componente controlador
reportar_evento_interno()
set_colapsable()
Determina si el componente podra ser colapsado/descolapsado por el usuario
set_descripcion()
Cambia la descripción del componente para el servicio actual
set_disparo_eventos_condicionado_datos()
Especifica si el disparo de los eventos implicitos debe estar asociado al cambio de datos o no
set_grupo_eventos_activo()
Activa un grupo de eventos, excluyendo a aquellos eventos que no pertenecen al mismo
set_modo_descripcion()
Cambia el modo en el que se muestra la descripción del componente (por defecto con un tooltip)
set_refresh_ejecuta_eventos()
Hace que los componentes reenvien sus eventos cuando se hace un refresh sobre la pagina
set_titulo()
Cambia el titulo del componente para el servicio actual
tiene_puntos_control()
Determina si el componente tiene algún punto de control asignado para un evento
vista_impresion()
Despachador de tipos de salidas de impresion
vista_impresion_html()
Impresion HTML por defecto
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()
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()
xml_imagen()
Devuelve un string con el xml de una imagen a incluir.
xml_set_alto_cabecera()
Define el alto de la cabecera de página.
xml_set_alto_pie()
Define el alto del pié de página.
xml_set_atts_ei()
Forma genérica de definir parámetros de usuario. El parámetro $atts debe ser un array de tipo "nombre"=>"valor".
xml_set_cabecera()
Define la cabecera de página.
xml_set_dim_pagina()
Define las dimensiones de la página
xml_set_incluir_cabecera()
Define si se crea la cabecera de la página.
xml_set_incluir_pie()
Define si se crea el pié de página.
xml_set_logo()
Define el logo de la institución a utilizar en la cabecera del pdf
xml_set_margenes()
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.
xml_set_nro_copias()
Define el numero de copias que deben aparecer en el pdf.
xml_set_ns()
Define un namespace a utilizar con los elementos xml.
xml_set_orientacion()
Define la orientación de la página
xml_set_pie()
Define el pié de página.
xml_set_subtitulo()
Define el subtítulo a utilizar en la cabecera del pdf
xml_set_tabla_cols()
Define atributos comunes a columnas de una tabla (atributos del elemento table-column de xsl-fo).
xml_set_titulo()
Define el titulo a utilizar en la cabecera del pdf
xml_tabla()
Devuelve un string con el xml de una tabla a incluir. $datos es un array cuyo primer nivel representan las
xml_texto()
Devuelve un string con el xml de un texto y sus atributos a incluir

Heredado de toba_componente

__construct()
agregar_dependencia()
Agregar dinámicamente una dependencia al componente actual
agregar_dependencia_por_indice()
Agregar dinámicamente una dependencia al componente actual utilizando
borrar_memoria()
Elimina toda la memoria interna actual y de pedidos anteriores
controlador()
Retorna la referencia al componente padre o contenedor del actual, generalmente un ci
dep()
dependencia()
Accede a una dependencia del objeto, opcionalmente si la dependencia no esta cargada, la carga
dependencia_cargada()
Retorna verdadero si la dependencia fue construida y asociada en este pedido de página
destruir()
Destructor del componente
eliminar_estado_sesion()
Elimina de la sesion las propiedades de este componente, a su vez pone en null estas propiedades en este objeto
existe_dependencia()
Retorna verdadero si un componente es dependencia del actual
get_cantidad_dependencias()
Retorna la cantidad de dependencias cargadas
get_dependencias()
Retorna un array con las dependencias cargadas del componente
get_dependencias_clase()
Devuelve las dependencias cuya clase de componente coincide con la expresion regular pasada como parametro
get_estado_sesion()
Construye un arreglo con los valores de todas las propiedades a almacenarse en sesion
get_id()
Retorna el identificador del componente
get_mensaje()
Retorna un mensaje asociado al componente
get_nombre()
Retorna el nombre del componente según se definió en el editor
get_parametro()
Retorna un parámetro estático definido en las prop. básicas del componente
get_titulo()
Retorna el título del componente (nombre visible al usuario)
informar()
Informa un mensaje predefinido al usuario, usando toba::notificacion() y toba::mensajes()
informar_msg()
Informa un mensaje al usuario
ini()
Ventana de extensión que se ejecuta al iniciar el componente en todos los pedidos en los que participa.
inicializado()
invocar_callback()
Metodo generico de invocar callbacks en el propio objeto
log()
Shortcut de toba::logger()->debug que incluye información básica del componente actual
mantener_estado_sesion()
set_controlador()
Determina que el componente actual es controlado por otro
set_modo_compatible_manejo_sesion()
Alternativa para que la reutilización de un mismo componente en un mismo request se siga comportando como antes de [3050], es decir el ultimo creado pisa la memoria del 1ero.
set_propiedades_sesion()
Fuerza a persistir en sesion ciertas propiedades internas
__sleep()

Métodos Propios
static void   set_navegacion_ajax()  
toba_ci   __construct()  
void   agregar_notificacion()   Agrega un mensaje de notificacion a la pantalla a generar
void   asignar_controlador_negocio()   Asocia al componente un controlador de negocio
toba_cn   cn()   Retorna el componente de negocio asociado a este ci
void   conf()   Ventana para hacer una configuración personalizada del ci
toba_componente   dependencia()   Accede a una dependencia del objeto, opcionalmente si la dependencia no esta cargada, la carga
void   destruir()   Destructor del componente
void   disparar_limpieza_memoria()   Borra la memoria de todas las dependencias, la propia y luego ejecuta ini__operacion
boolean   es_botonera_en_barra_item()   Indica si la botonera superior del ci se grafica en la barra superior del item
toba_evento_usuario   evento()   Shortcut para acceder a un evento propio (en realidad es de la pantalla)
void   evt__cancelar()   Evento predefinido de cancelar, limpia este objeto, y en caso de exisitr, cancela al cn asociado
void   evt__falla_punto_control()   Este evento se invoca por cada control que falla.
void   evt__procesar()   Evento predefinido de procesar, en caso de existir el cn le entrega los datos y limpia la memoria
void   fin()   Ventana de extensión previa a la destrucción del componente, al final de la atención de los servicios
void   generar_html()   Genera el html de la pantalla actual
string   get_id_pantalla()   Retorna el id de la pantalla actualmente seleccionada para graficar
void   get_info_eventos_pantalla()  
array   get_info_objetos_asoc_pantalla()   Retorna los objetos asociados a una pantalla especifica perteneciente a este ci
array   get_info_pantalla()   Retorna los metadatos de una pantalla específica perteneciente a este ci
string   get_pantalla_inicial()   Retorna la pantalla que se muestra al iniciar el componente en la operación
void   ini()   Ventana de extensión que se ejecuta al iniciar el componente en todos los pedidos en los que participa.
void   ini__operacion()   Ventana de extensión que se ejecuta cuando el componente se inicia en la operación.
void   ir_a_limitrofe()   Recorre las pantallas en el sentido actual buscando una válida para mostrar
void   limpiar_memoria()   Borra la memoria de este CI y lo reinicializa
toba_ei_pantalla   pantalla()   Retorna la referencia a la pantalla a graficar
void   post_configurar()   Ventana para insertar lógica de la configuración del ci y sus dependencias
void   post_eventos()   Ventana que se ejecuta una vez que todos los eventos se han disparado para este objeto
void   set_pantalla()   Cambia la pantalla a utilizar en el servicio actual
void   vista_impresion_html()   Genera la vista de impresion HTML de la pantalla actual
string   vista_xml()   Genera el xml del componente y sus hijos
boolean   wizard_avanza()   Retorna true si la navegación por wizard recibio un 'siguiente' en la ultima solicitud
string   xml_get_tag_fin()   Genera el tag de cierre del componente
string   xml_get_tag_inicio()   Genera el tag de inicio del componente

static method set_navegacion_ajax  [línea 46]

  static void set_navegacion_ajax( [ $set = true]  )

Parámetros:
   $set: 


Constructor __construct  [línea 39]

  toba_ci __construct( $id  )

Parámetros:
   $id: 

Redefinición de:
toba_ei::__construct()

agregar_notificacion  [línea 781]

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

Agrega un mensaje de notificacion a la pantalla a generar
Parámetros:
string   $mensaje: 
string   $tipo:  Puede ser 'info', 'warning', 'error'

Redefinición de:
toba_ei::agregar_notificacion()
Agrega un mensaje de notificacion a esta pantalla

asignar_controlador_negocio  [línea 172]

  void asignar_controlador_negocio( toba_cn $controlador  )

Asocia al componente un controlador de negocio
Parámetros:
toba_cn   $controlador: 

See:  toba_cn


cn  [línea 162]

  toba_cn cn( )

Retorna el componente de negocio asociado a este ci


conf  [línea 664]

  void conf( )

Ventana para hacer una configuración personalizada del ci

Access:  protected

Information Tags:
Ventana:  

dependencia  [línea 463]

  toba_componente dependencia( string $id, [ $carga_en_demanda = true], boolean $cargar_en_demanda  )

Accede a una dependencia del objeto, opcionalmente si la dependencia no esta cargada, la carga

si la dependencia es un EI y no figura en la lista GI (generacion de interface) dispara el evento de carga!

Parámetros:
string   $id:  Identificador de la dependencia dentro del objeto actual
boolean   $cargar_en_demanda:  En caso de que el objeto no se encuentre cargado en memoria, lo carga
   $carga_en_demanda: 

Redefinición de:
toba_componente::dependencia()
Accede a una dependencia del objeto, opcionalmente si la dependencia no esta cargada, la carga

destruir  [línea 55]

  void destruir( )

Destructor del componente

Redefinición de:
toba_ei::destruir()
Destructor del componente

disparar_limpieza_memoria  [línea 125]

  void disparar_limpieza_memoria( [ $no_borrar = array()]  )

Borra la memoria de todas las dependencias, la propia y luego ejecuta ini__operacion
Parámetros:
   $no_borrar: 


es_botonera_en_barra_item  [línea 712]

  boolean es_botonera_en_barra_item( )

Indica si la botonera superior del ci se grafica en la barra superior del item


evento  [línea 771]

  toba_evento_usuario evento( string $id  )

Shortcut para acceder a un evento propio (en realidad es de la pantalla)
Parámetros:
string   $id:  Identificador del evento

Redefinición de:
toba_ei::evento()
Recupera el objeto asociado de un evento

evt__cancelar  [línea 387]

  void evt__cancelar( )

Evento predefinido de cancelar, limpia este objeto, y en caso de exisitr, cancela al cn asociado


evt__falla_punto_control  [línea 379]

  void evt__falla_punto_control( string $punto_control, &$control, toba_control $control  )

Este evento se invoca por cada control que falla.

Como el resultado de la ejecucion del control se toma despues de invocar a este metodo, se puede alterar desde aqui el comportarmiento del control y su resultado.

Parámetros:
string   $punto_control:  Punto de control en ejecucion.
toba_control   $control:  Referencia al control que falló.
   &$control: 


evt__procesar  [línea 399]

  void evt__procesar( )

Evento predefinido de procesar, en caso de existir el cn le entrega los datos y limpia la memoria


fin  [línea 76]

  void fin( )

Ventana de extensión previa a la destrucción del componente, al final de la atención de los servicios

Information Tags:
Ventana:  

generar_html  [línea 833]

  void generar_html( )

Genera el html de la pantalla actual


get_id_pantalla  [línea 825]

  string get_id_pantalla( )

Retorna el id de la pantalla actualmente seleccionada para graficar

Access:  protected


get_info_eventos_pantalla  [línea 696]

  void get_info_eventos_pantalla( $id  )

Parámetros:
   $id: 

Access:  protected


get_info_objetos_asoc_pantalla  [línea 685]

  array get_info_objetos_asoc_pantalla( string $id  )

Retorna los objetos asociados a una pantalla especifica perteneciente a este ci
Parámetros:
string   $id:  Identificador de la pantalla

Access:  protected


get_info_pantalla  [línea 671]

  array get_info_pantalla( string $id  )

Retorna los metadatos de una pantalla específica perteneciente a este ci
Parámetros:
string   $id:  Identificador de pantalla

Access:  protected


get_pantalla_inicial  [línea 549]

  string get_pantalla_inicial( )

Retorna la pantalla que se muestra al iniciar el componente en la operación

Por defecto retorna la primer pantalla definida en el editor salvo que la rf la oculte Extender para definir una pantalla distinta a través de un método dinámico


Return:  Identificador de la pantalla


ini  [línea 116]

  void ini( )

Ventana de extensión que se ejecuta al iniciar el componente en todos los pedidos en los que participa.

Como la ventana es previa a la atención de eventos y servicios es un punto ideal para la configuración global del componente


Information Tags:
Ventana:  
Redefinición de:
toba_componente::ini()
Ventana de extensión que se ejecuta al iniciar el componente en todos los pedidos en los que participa.

ini__operacion  [línea 109]

  void ini__operacion( )

Ventana de extensión que se ejecuta cuando el componente se inicia en la operación.

Su utilidad recide en por ejemplo inicializar un conjunto de variables de sesion y evitar el chequeo continuo de las mismas. Este momento generalmente se corresponde con el inicio de la operación, aunque existen excepciones:

  • Si el componente es un ci dentro de otro ci, recien se ejecuta cuando entra a la operacion que no necesariamente es al inicio,
si por ejemplo se encuentra en la 3er pantalla del ci principal.
  • Si se ejecuta una limpieza de memoria (comportamiento por defecto del evt__cancelar)


Information Tags:
Ventana:  

ir_a_limitrofe  [línea 564]

  void ir_a_limitrofe( )

Recorre las pantallas en el sentido actual buscando una válida para mostrar

Access:  protected


limpiar_memoria  [línea 146]

  void limpiar_memoria( [array $no_borrar = null]  )

Borra la memoria de este CI y lo reinicializa
Parámetros:
array   $no_borrar:  Excepciones, propiedades que no se van a poner en null


pantalla  [línea 723]

  toba_ei_pantalla pantalla( )

Retorna la referencia a la pantalla a graficar

Una vez que se invoca este metodo se fija la pantalla para el resto del pedido de pagina Es importante relegar esta desicion en caso de querer variar la pantalla a mostrar dinamicamente



post_configurar  [línea 658]

  void post_configurar( )

Ventana para insertar lógica de la configuración del ci y sus dependencias

Information Tags:
Ventana:  

post_eventos  [línea 219]

  void post_eventos( )

Ventana que se ejecuta una vez que todos los eventos se han disparado para este objeto

Access:  protected

Information Tags:
Ventana:  

set_pantalla  [línea 795]

  void set_pantalla( string $id  )

Cambia la pantalla a utilizar en el servicio actual

El cambio recien sera efectivo cuando se utilize la pantalla con el metodo pantalla()

Parámetros:
string   $id:  Identificador de la pantalla, tal como se definio en el editor


vista_impresion_html  [línea 891]

  void vista_impresion_html( $salida  )

Genera la vista de impresion HTML de la pantalla actual
Parámetros:
   $salida: 

Redefinición de:
toba_ei::vista_impresion_html()
Impresion HTML por defecto

vista_xml  [línea 906]

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

Genera el xml del componente y sus hijos
Parámetros:
boolean   $inicial:  Si es el primer elemento llamado desde vista_xml
string   $xmlns:  Namespace para el componente

Return:  XML del componente y sus hijos


wizard_avanza  [línea 578]

  boolean wizard_avanza( )

Retorna true si la navegación por wizard recibio un 'siguiente' en la ultima solicitud

Access:  protected


xml_get_tag_fin  [línea 939]

  string xml_get_tag_fin( )

Genera el tag de cierre del componente

Return:  Tag de cierre


xml_get_tag_inicio  [línea 927]

  string xml_get_tag_inicio( )

Genera el tag de inicio del componente

Return:  Tag de inicio del componente




Desarrollado por SIU.
Documentación generada con phpDocumentor 1.4.3