NOMBRE_FORM_CONTROLES_LISTADO
NOMBRE_FORM_CONTROLES_LISTADO
Nombre del formulario que contiene los controles del listado.
Contiene métodos estáticos que proveen definiciones de componentes o secciones de alto nivel de XGAP.
tituloPagina(string $texto, string $id = 'titulo-pag', string $clase = null, boolean $generar_span = true) : string
Devuelve el código HTML para el título interno de la página.
| string | $texto | el contenido del título |
| string | $id | el ID para el div contenedor del título |
| string | $clase | clase CSS para el div contenedor del título |
| boolean | $generar_span | ¿Se debe envolver $texto en un span? |
barraHistorial(\HistorialNavegacion $historial, string $nombre = 'historial-nav', string $separador_entradas = ' > ', integer $max_entradas)
Devuelve el código HTML para una barra de historial de navegación.
Cada entrada del historial queda encerrada por un span con clase 'elem-historial', y toda la barra queda encerrada por un div con clase 'historial-nav' y el nombre dado.
Por ejemplo:
Componentes::barraHistorial($GLOBALS['objeto_historial'])
puede dar como resultado:
<div id="historial-nav" class="historial-nav"> <span class="elem-historial"><a href="index2.php">Inicio</a></span> > <span class="elem-historial">Listado de Personas</span> </div>
| \HistorialNavegacion | $historial | |
| string | $nombre | valor del atributo id del div generado |
| string | $separador_entradas | texto a colocar entre cada entrada del historial |
| integer | $max_entradas | cantidad máxima de entradas a mostrar; si la cantidad de entradas en el historial superan este valor, sólo se incluyen las $max_entradas más recientes y se agrega un indicador de corte |
generarNavegador( $navegador, $info_navegador, integer $cantidad_mostrar, $nro_pagina, integer $total)
Genera el navegador/paginador de los listados.
| $navegador | ||
| $info_navegador | ||
| integer | $cantidad_mostrar | número de filas por página |
| $nro_pagina | ||
| integer | $total | cantidad total de filas |
clasesNavegador(integer $nro_pagina, integer $cant_paginas) : string
Retorna una lista de clases para aplicar al elemento contenedor del navegador.
El resultado contiene las siguientes clases:
| integer | $nro_pagina | número de la página actual (1..$cant_paginas) |
| integer | $cant_paginas | cantidad total de páginas (>=0) |
controlPresentacionBorradoLogico(string $nombre_variable, string $nombre_form, boolean $estado_oculto, boolean $autosubmit = true, string $etiqueta = 'Ocultar borrados')
Genera un control de formulario para indicar si se deben mostrar u ocultar los elementos borrados lógicamente.
La estructura que produce es:
<div class="ctrl-borrado-logico">
<span>
<label for="$nombre_variable"/>
Form::checkbox_con_hidden($nombre_variable, ___, 'Input', ___, ___, '1', '0', $autosubmit);
</span>
</div>
| string | $nombre_variable | nombre del control |
| string | $nombre_form | (no se usa) |
| boolean | $estado_oculto | ¿se inicia con los elementos borrados ocultos? |
| boolean | $autosubmit | ¿se debe hacer submit automáticamente cuando el usuario cambia el estado del checkbox? |
| string | $etiqueta | etiqueta a mostrar para el control |
mensajeFlashEstandar(\Flash $flash)
Genera la estructura HTML para mostrar mensajes guardados en el Flash con nombres predeterminados.
| \Flash | $flash |
mensajesError(array|string $mensajes)
Prepara un bloque HTML para mostrar uno o más mensajes de error.
El formato del HTML generado es el siguiente:
<div id="cont-msjs-error">
<div class="msj-error primero">{$mensajes[0]}</div>
<div class="msj-error">{$mensajes[1]}</div>
...
</div>
| array|string | $mensajes | Los mensajes a mostrar, uno por cada elemento del arreglo; de ser necesario, deben estar preparados previamente con {@link preparar_salida()}. Puede ser un único string si es un solo mensaje. |
buscadorPersonalizadoSimple(array $campos, boolean $incluir_navegador = true, \Conexion $conexion = null)
Crea el código para el buscador personalizado de un listado, con estructura simple: un campo por fila, con la correspondiente etiqueta a la izquierda; un botón "Buscar" y un botón "Limpiar".
| array | $campos | definición de los campos del buscador |
| boolean | $incluir_navegador | ¿Se debe incluir el navegador? |
| \Conexion | $conexion | conexión a la base de datos; sólo se usa si alguno de los campos necesita hacer una consulta |
parametrosDestinoImprimir(string $filtros, array $filtros_personalizados, array $parametros_extra, string $url_retorno, string $orden) : array
Construye el arreglo de parámetros para pasar al {@link Componentes::controlImprimir() control de impresión}.
| string | $filtros | |
| array | $filtros_personalizados | |
| array | $parametros_extra | |
| string | $url_retorno | |
| string | $orden |
controlImprimir(string $pagina, string $titulo, array $params = null, string $teclaacceso = '', string $clase = 'Button', boolean $deshabilitado = false, string $tipo = 'pdf', boolean $retornar = false, string $tip = null) : mixed
Genera un botón para iniciar una impresión de listados.
| string | $pagina | dirección de la página a cargar |
| string | $titulo | texto a mostrar en el botón; si es vacío, se usa un texto predeterminado |
| array | $params | parámetros para la página destino |
| string | $teclaacceso | tecla rápida para acceder al botón |
| string | $clase | clase CSS |
| boolean | $deshabilitado | ¿el botón se debe generar deshabilitado? |
| string | $tipo | indica el tipo de salida que se genera a partir del botón; si no tiene valor vacío, el id del botón pasa a ser "bimprimir$tipo" |
| boolean | $retornar | ¿el método debe retornar el código HTML o emitirlo a la salida? |
| string | $tip | texto para el tooltip; si es vacío, se usa $titulo |
string o nada, dependiendo de $retornar
controlAccionListado(string $nombre, string $titulo, string $urlAccion = '', string $onclick = '', string $teclaacceso = '', string $clase = 'Button', boolean $deshabilitado = false, string $imagen = XGAP_RECURSO_IMG_BTN_ACCION, boolean $retornar = false, string $tip = null) : mixed
Genera un botón para una acción en listados definida por el usuario.
| string | $nombre | nombre de la acción; el id del botón queda "b_$nombre". |
| string | $titulo | texto a mostrar en el botón |
| string | $urlAccion | dirección de la página donde se envía el POST de la acción; por defecto es la página actual |
| string | $onclick | código javascript a ejecutar cuando se hace click en el botón, antes del código predeterminado; no debería hacer un submit del formulario |
| string | $teclaacceso | tecla rápida para acceder al botón |
| string | $clase | clase CSS |
| boolean | $deshabilitado | ¿el botón se debe generar deshabilitado? |
| string | $imagen | |
| boolean | $retornar | ¿el método debe retornar el código HTML o emitirlo a la salida? |
| string | $tip | texto para el tooltip |
string o nada, dependiendo de $retornar
separadorGrupoFormulario(integer $columnas, string $nombre = NULL, string $titulo = NULL, boolean $titulo_es_html = FALSE)
Genera un separador de grupo de campos para un formulario.
| integer | $columnas | cantidad de columnas que debe ocupar |
| string | $nombre | ID del componente |
| string | $titulo | texto a mostrar |
| boolean | $titulo_es_html | ¿$titulo puede contener código HTML? |