static void set_navegacion_ajax(
[
$set = true]
)
|
|
Parámetros:
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
void asignar_controlador_negocio(
toba_cn
$controlador
)
|
|
Asocia al componente un controlador de negocio
Parámetros:
Retorna el componente de negocio asociado a este ci
Ventana para hacer una configuración personalizada del ci
Information Tags:
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
void disparar_limpieza_memoria(
[
$no_borrar = array()]
)
|
|
Borra la memoria de todas las dependencias, la propia y luego ejecuta ini__operacion
Parámetros:
boolean es_botonera_en_barra_item(
)
|
|
Indica si la botonera superior del ci se grafica en la barra superior del item
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
Evento predefinido de cancelar, limpia este objeto, y en caso de exisitr, cancela al cn asociado
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: |
|
Evento predefinido de procesar, en caso de existir el cn le entrega los datos y limpia la memoria
Ventana de extensión previa a la destrucción del componente, al final de la atención de los servicios
Information Tags:
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(
$id
)
|
|
Parámetros:
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 |
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 |
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 |
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:
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.
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:
Recorre las pantallas en el sentido actual buscando una válida para mostrar
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 |
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
Ventana para insertar lógica de la configuración del ci y sus dependencias
Information Tags:
Ventana que se ejecuta una vez que todos los eventos se han disparado para este objeto
Information Tags:
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 |
void vista_impresion_html(
$salida
)
|
|
Genera la vista de impresion HTML de la pantalla actual
Parámetros:
Redefinición de:
- toba_ei::vista_impresion_html()
- Impresion HTML por defecto
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 |
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
Return: | Tag de inicio del componente |