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

toba_ef_seleccion

Clase base de los elementos de formulario que permiten seleccionar un único elemento
toba_ef
   |
   --toba_ef_seleccion

Ubicada en /nucleo/componentes/interface/efs/toba_ef_combo.php [line 8]


Abstract  

Subclases directas
toba_ef_combo Combo equivalente a un <select> en HTML
toba_ef_radio Radio buttons equivalentes a <input type='radio'>
toba_ef_combo_editable Combo editable, es una caja de texto y un div que se deplega con las opciones

Métodos Heredados

Heredado de toba_ef

__construct()
agregar_icono_utileria()
Agrega un icono con comportamiento al lado del elemento
cargar_estado_post()
Carga el estado actual del ef a partir del $_POST dejado por este mismo componente en el pedido anterior
carga_depende_de_estado()
La carga de opciones de este ef depende de su estado actual?
clave_memoria()
controlador()
Retorna la referencia al componente padre o formulario
crear_objeto_js()
Retorna la sentencia de creación del objeto javascript que representa al EF
esta_expandido()
Un ef no expandido se muestra oculto en el layout del formulario.
es_estado_unico()
El ef maneja un único valor como estado? O maneja un arreglo de estados?
es_obligatorio()
Un ef obligatorio lanza una excepción en PHP si su estado actual es nulo
es_seleccionable()
El ef permite seleccionar valores o solo se pueden editar?
es_solo_lectura()
get_campos_clave()
Retorna la/s columna/s clave/s del ef.
get_campo_valor()
Retorna la columna 'valor' del ef Esto está disponible cuando se brinda un mecanismo de carga asociado al ef.
get_consumo_javascript()
Esta funcion permite que un EF declare la necesidad de incluir
get_cuando_cambia_valor()
Retorna el js utilizado cuando el ef cambia de valor en el cliente
get_dato()
El 'dato' del ef es la o las columnas de datos asociadas.
get_descripcion()
Retorna la descripción o ayuda del ef.
get_descripcion_estado()
Retorna una descripción textual del estado.
get_estado()
Retorna el valor o estado actual del ef
get_estilo_etiqueta()
Retorna la clase css asociada a la etiqueta
get_etiqueta()
Retorna el texto de la etiqueta asociada
get_excepciones()
get_fila_actual()
Obtiene la fila actual en el multiplexado en el ef (usado en el formulario_ml)
get_html_iconos_utilerias()
get_id()
Devuelve el id del ef dentro del framework
get_id_form()
Retorna el id html del ef en el formulario
get_id_form_orig()
Como el id html puede variar si se multiplexa el ef (caso formulario_ml), este metodo retorna el id original del ef
get_input()
Genera el HTML del elemento
get_maestros()
Retorna la lista de efs de los cuales depende
get_toggle()
El checkbox esta configurado en los ML para tener un tilde sel/des todos?
guardar_dato_sesion()
ir_a_fila()
Multiplexa el ef (usado en el formulario_ml)
normalizar_parametro_cascada()
Permite normalizar un parametro recibido de una cascada a un formato estandar
objeto_js()
Retorna el nombre de la instancia del objeto en javascript
parametros_js()
Lista de parametros necesarios para el constructor del objeto en javascript
permite_seleccion_multiple()
El ef permite seleccionable permite elegir más de un valor?
quitar_maestro()
resetear_estado()
Retorna el valor del ef a su estado inicial.
seleccionado()
El ef tiene un valor positivo, similar a tiene_estado() pero puede ser mas restrictivo
set_cuando_cambia_valor()
Determina el codigo personalizado a ejecutar cuando el ef cambia de valor en el cliente.
set_descripcion()
Cambia la descripción o ayuda del ef.
set_estado()
Cambia el valor o estado actual del ef
set_estado_defecto()
Cambia el valor que toma el ef cuando no se lo carga con un estado
set_estilo_etiqueta()
Cambia la clase css aplicada a la etiqueta
set_etiqueta()
Cambia la etiqueta actual del ef
set_excepciones()
set_expandido()
Determina si un ef se muestra o no expandido Un ef no expandido se muestra oculto en el layout del formulario.
set_iconos_utilerias()
Cambia los iconos visibles a un lado del elemento
set_obligatorio()
Cambia la obligatoriedad de un ef Notar que este cambio no se persiste para el siguiente pedido.
set_permitir_html()
Determina si el ef puede contener en su estado HTML, por defecto falso para evitar ataques de seguridad XSS
set_solo_lectura()
Cuando un ef se encuentra en solo_lectura su valor es visible al usuario pero no puede modificarlo.
son_campos_posicionales()
Retorna true si tanto los campos clave como valor son posicionales
tiene_estado()
Retorna true si el ef tiene un valor o estado distinto al nulo
tiene_etiqueta()
El ef maneja el concepto de etiqueta?
tiene_opciones_cargadas()
Si el ef permite seleccionar opciones, estas ya estan cargadas?
validar_estado()
Chequea la validez del estado actual del ef

Métodos Propios
static void   get_lista_parametros_carga()  
static void   get_maximo_descripcion()  
static void   set_maximo_descripcion()  
toba_ef_seleccion   __construct()  
void   cargar_estado_post()  
void   es_estado_no_seleccionado()  
void   es_estado_nulo()  
void   es_seleccionable()  
void   get_consumo_javascript()  
void   get_descripcion_estado()   Retorna la descripción asociada a la opción actualmente seleccionada
void   get_estado()  
void   get_estado_para_input()  
void   set_estado()  
void   set_opciones()   Cambia el conjunto de opciones disponibles para que el usuario seleecione
void   tiene_estado()  

static method get_lista_parametros_carga  [línea 19]

  static void get_lista_parametros_carga( )


Redefinido en subclases como:

static method get_maximo_descripcion  [línea 34]

  static void get_maximo_descripcion( )



static method set_maximo_descripcion  [línea 29]

  static void set_maximo_descripcion( $maximo  )

Parámetros:
   $maximo: 


Constructor __construct  [línea 39]

  toba_ef_seleccion __construct( $padre, $nombre_formulario, $id, $etiqueta, $descripcion, $dato, $obligatorio, $parametros  )

Parámetros:
   $padre: 
   $nombre_formulario: 
   $id: 
   $etiqueta: 
   $descripcion: 
   $dato: 
   $obligatorio: 
   $parametros: 

Redefinición de:
toba_ef::__construct()
Redefinido en subclases como:

cargar_estado_post  [línea 184]

  void cargar_estado_post( )


Redefinición de:
toba_ef::cargar_estado_post()
Carga el estado actual del ef a partir del $_POST dejado por este mismo componente en el pedido anterior
Redefinido en subclases como:

es_estado_no_seleccionado  [línea 142]

  void es_estado_no_seleccionado( )



es_estado_nulo  [línea 128]

  void es_estado_nulo( $estado  )

Parámetros:
   $estado: 

Access:  protected


es_seleccionable  [línea 64]

  void es_seleccionable( )


Redefinición de:
toba_ef::es_seleccionable()
El ef permite seleccionar valores o solo se pueden editar?

get_consumo_javascript  [línea 231]

  void get_consumo_javascript( )


Redefinición de:
toba_ef::get_consumo_javascript()
Esta funcion permite que un EF declare la necesidad de incluir
Redefinido en subclases como:

get_descripcion_estado  [línea 108]

  void get_descripcion_estado( $tipo_salida  )

Retorna la descripción asociada a la opción actualmente seleccionada
Parámetros:
   $tipo_salida: 

Redefinición de:
toba_ef::get_descripcion_estado()
Retorna una descripción textual del estado.
Redefinido en subclases como:

get_estado  [línea 100]

  void get_estado( )


Redefinición de:
toba_ef::get_estado()
Retorna el valor o estado actual del ef

get_estado_para_input  [línea 147]

  void get_estado_para_input( )


Access:  protected


set_estado  [línea 166]

  void set_estado( $estado  )

Parámetros:
   $estado: 

Redefinición de:
toba_ef::set_estado()
Cambia el valor o estado actual del ef

set_opciones  [línea 73]

  void set_opciones( array $datos, [ $maestros_cargados = true], [ $tiene_maestros = false]  )

Cambia el conjunto de opciones disponibles para que el usuario seleecione
Parámetros:
array   $datos:  Arreglo asociativo clave => valor. Si es null se asume que el ef esta temporalmente deshabilitado
   $maestros_cargados: 
   $tiene_maestros: 

Redefinido en subclases como:

tiene_estado  [línea 226]

  void tiene_estado( )


Redefinición de:
toba_ef::tiene_estado()
Retorna true si el ef tiene un valor o estado distinto al nulo



Desarrollado por SIU.
Documentación generada con phpDocumentor 1.4.3