Skip to content
This repository has been archived by the owner on Oct 10, 2023. It is now read-only.

jsdoc ui

Gabriel edited this page Sep 6, 2021 · 36 revisions

ui

Métodos

obtenerMarco()

obtenerDocumento()

obtenerCuerpo(vista)

Parámetro Tipo Descripción Opcional Predeterminado
vista

buscarHojaEstilos(nombre)

Busca una hoja de estilos por nombre.

Parámetro Tipo Descripción Opcional Predeterminado
nombre string Nombre como expresión regular.

Devuelve: StyleSheet|null

obtenerElementoEstilos()

obtenerUrlBase()

esCordova()

obtenerEstilos(selector,tamano,origen)

Parámetro Tipo Descripción Opcional Predeterminado
selector
tamano
origen

agregarHojaEstilos(url)

Agrega una hoja o un listado de hojas de estilos.

Parámetro Tipo Descripción Opcional Predeterminado
url

procesarObjetoEstilos(selector,obj)

Procesa un objeto de estilos y establece los estilos contenidos en el mismo para el selector dado.

Parámetro Tipo Descripción Opcional Predeterminado
selector string Selector.
obj Object[] Estilos (objeto compatible con la salida de obtenerEstilos()).

Devuelve: ui

establecerEstilosSelector(selector,css[,tamano])

Establece los estilos para un selector.

Parámetro Tipo Descripción Opcional Predeterminado
selector string Selector.
css string|Object[] Estilos. Puede ser código CSS o un objeto compatible con la salida de obtenerEstilos().
tamano string|null Tamaño de pantalla. Si se omite, o si es null, se establecerán los estilos generales (sin media query). Si

Devuelve: CSSStyleRule|null

removerEstilos(selector[,tamano])

Elimina los estilos para el selector especificado.

Parámetro Tipo Descripción Opcional Predeterminado
selector string Selector.
tamano string Tamaño. Si se omite, se eliminarán todos los estilos para todos los tamaños. Si

Devuelve: ui

renombrarEstilos(selector,selectorNuevo)

Renombra los estilos para un selector dado (todos los tamaños).

Parámetro Tipo Descripción Opcional Predeterminado
selector string Selector actual.
selectorNuevo string Selector nuevo.

Devuelve: ui

registrarAplicacion(funcion)

Registra e instancia la clase principal de la aplicación.

Parámetro Tipo Descripción Opcional Predeterminado
funcion function

obtenerAplicacion()

Devuelve la instancia de la clase principal de la aplicacion.
Devuelve: Aplicacion

aplicacion()

Devuelve la instancia de la clase principal de la aplicacion (alias de ui.obtenerAplicacion()).
Devuelve: Aplicacion

generarId()

generarSelector([tipo,nombre])

Genera y devuelve un selector CSS único.

Parámetro Tipo Descripción Opcional Predeterminado
tipo string Tipo de componente. Si
nombre string Nombre del componente. Si

Devuelve: string

registrarComponente(nombre,funcion,configuracion)

Parámetro Tipo Descripción Opcional Predeterminado
nombre
funcion
configuracion

obtenerConfigComponente(nombre)

Parámetro Tipo Descripción Opcional Predeterminado
nombre

obtenerComponentes()

crearComponente(comp[,vista])

Crea una instancia de un componente dado su nombre.

Parámetro Tipo Descripción Opcional Predeterminado
comp Object|string Nombre del componente u objeto que representa el componente, si se está creando un componente previamente guardado (desde JSON).
vista componenteVista Instancia de la vista. Si

Devuelve: Componente

eliminarComponente(componente)

Elimina un componente dada su instancia. Equivalente a componente.eliminar().

Parámetro Tipo Descripción Opcional Predeterminado
componente componente Componente a eliminar.

Devuelve: ui

eliminarComponentes(elemento[,eliminarElemento])

Busca y elimina apropiadamente los componentes descendientes del elemento especificado.

Parámetro Tipo Descripción Opcional Predeterminado
elemento Node Elemento a analizar. elemento puede ser un componente.
eliminarElemento boolean Si es true, luego de eliminar los componentes que pueda contener, también removerá del DOM el nodo especificado en elemento. Si true

Devuelve: ui

Sobrecarga 2: eliminarComponentes(elemento[,eliminarElemento])

Busca y elimina apropiadamente los componentes descendientes del elemento especificado.

Parámetro Tipo Descripción Opcional Predeterminado
elemento NodeList Listado de elementos a analizar.
eliminarElemento boolean Si es true, luego de eliminar los componentes que puedan existir en el listado, también removerá del DOM todos los nodos contenidos en elemento. Si true

Devuelve: ui

Sobrecarga 3: eliminarComponentes(elemento[,eliminarElemento])

Busca y elimina apropiadamente los componentes descendientes del elemento especificado.

Parámetro Tipo Descripción Opcional Predeterminado
elemento Node[] Listado de elementos a analizar.
eliminarElemento boolean Si es true, luego de eliminar los componentes que puedan existir en el listado, también removerá del DOM todos los nodos contenidos en elemento. Si true

Devuelve: ui

componenteEliminado(componente)

Finaliza las tareas de limpieza tras la eliminación de un componente. Método de uso interno.

Parámetro Tipo Descripción Opcional Predeterminado
componente componente

Devuelve: ui

obtenerInstanciasComponentes(vista)

Devuelve las instancias de los componentes existentes.

Parámetro Tipo Descripción Opcional Predeterminado
vista

obtenerInstanciaComponente(param)

Devuelve la instancia de un componente dado su ID, instancia, nombre o elemento del DOM.

Parámetro Tipo Descripción Opcional Predeterminado
param * Valor a evaluar.

Devuelve: Componente

componente(param)

Devuelve la instancia de un componente dado su ID, instancia, nombre o elemento del DOM (alias de ui.obtenerInstanciaComponente(param)).

Parámetro Tipo Descripción Opcional Predeterminado
param * Valor a evaluar.

Devuelve: Componente

eliminarInstanciaComponente(param)

Elimina la instancia de un componente dado su ID, instancia, nombre o elemento del DOM.

Parámetro Tipo Descripción Opcional Predeterminado
param

obtenerValores([vista])

Busca todos los componentes con nombre y devuelve un objeto con sus valores.

Parámetro Tipo Descripción Opcional Predeterminado
vista componenteVista Instancia de la vista. Si se omite, o es null, se devolverán todos los campos de la página. Si

Devuelve: Object

establecerValores(valores[,nombreVista])

Establece los valores de todos los componentes cuyos nombres coincidan con las propiedades del objeto.

Parámetro Tipo Descripción Opcional Predeterminado
valores Object Pares nombre/valor a asignar.
nombreVista string Nombre de la vista. Si se omite, se aplicará sobre todos los campos de la página. Si

agregarComponente(componente)

Registra un componente en el almacén global componentes.

Parámetro Tipo Descripción Opcional Predeterminado
componente componente Instancia del componente.

Devuelve: ui

removerComponente(componente)

Remueve un componente del almacén global componentes.

Parámetro Tipo Descripción Opcional Predeterminado
componente componente Instancia del componente.

Devuelve: ui

obtenerHtml([paginaCompleta])

Devuelve el HTML de la vista.

Parámetro Tipo Descripción Opcional Predeterminado
paginaCompleta boolean Determina si debe devolver el HTML de la página completa o, por el contrario, solo del cuerpo. Si true

Devuelve: string

obtenerCss()

Devuelve el CSS de la vista.

obtenerJson()

Genera y devuelve un JSON con las relaciones entre el DOM y los componentes.

obtenerJsonComponente(obj)

Genera y devuelve el objeto correspondiente a un componente en particular para ser almacenado en el JSON.

Parámetro Tipo Descripción Opcional Predeterminado
obj * Instancia o cualquier valor que identifique al componente compatible con obtenerInstanciaComponente().

Devuelve: Object

reemplazarHtml(html)

Inserta el código html en el cuerpo del editor. Este método solo debería utilizarse en modo edición.

Parámetro Tipo Descripción Opcional Predeterminado
html

establecerJson(valor)

Almacena el JSON para la vista principal.

Parámetro Tipo Descripción Opcional Predeterminado
valor Object|string Objeto o JSON codificado.

procesarJson(json[,controlador,vista,soloVista])

Inicializa la vista y sus componentes dado su json.

Parámetro Tipo Descripción Opcional Predeterminado
json Object|string Objeto de la vista.
controlador controlador Instancia del controlador de la vista. Si
vista componenteVista Instancia de la vista. Si
soloVista boolean Si es true, buscará e inicializará únicamente el componente de la vista; false, solo los componentes excepto la vista; null (o la omisión del parámetro) procesará todos los componentes. Si null

Devuelve: string|undefined

procesarJsonVista(json[,controlador])

Inicializa la vista dado su json.

Parámetro Tipo Descripción Opcional Predeterminado
json Object|string Objeto de la vista.
controlador controlador Instancia del controlador de la vista. Si

Devuelve: componenteVista

procesarJsonComponentes(json[,controlador,vista])

Inicializa los componentes de la vista (excepto el componente Vista propiamente dicho) dado su json.

Parámetro Tipo Descripción Opcional Predeterminado
json Object|string Objeto de la vista.
controlador controlador Instancia del controlador de la vista. Si
vista componenteVista Instancia de la vista. Si

Devuelve: ui

crearControlador(nombre,principal)

Crea la instancia del controlador.

Parámetro Tipo Descripción Opcional Predeterminado
nombre
principal

limpiar()

Limpia todos los parámetros de la ui.

autofoco([elem])

Busca el primer componente o elemento con autofoco y da foco al mismo.

Parámetro Tipo Descripción Opcional Predeterminado
elem Node Limitar a la descendencia del elemento especificado. Si

Devuelve: ui

autoseleccionar()

Prepara la utilidad de auto-seleccionar-todo el contenido de los campos.
Devuelve: ui

obtenerInstanciasVistas()

obtenerInstanciaVista(nombre)

Parámetro Tipo Descripción Opcional Predeterminado
nombre

establecerNombreVistaPrincipal(nombre)

Parámetro Tipo Descripción Opcional Predeterminado
nombre

obtenerNombreVistaPrincipal()

obtenerInstanciaVistaPrincipal()

vista([nombre])

Devuelve la instancia de la vista (es decir, del componente, no del controlador).

Parámetro Tipo Descripción Opcional Predeterminado
nombre string Nombre de la vista embebible. Si se omite, devolverá la vista principal. Si

Devuelve: Componente

actualizar()

Desencadena la actualización de componentes en toda la vista. Este método no redibuja todos los componentes ni reasigna todas las propiedades de cada uno. Está diseñado para poder solicitar a los componentes que se refresquen o vuelvan a cargar determinadas propiedades, como el origen de datos. Cada componente lo implementa, o no, de forma específica.
Devuelve: ui

recargar()

Recarga la página.

obtenerVistaEmbebible(nombre,retorno[,precarga])

Recupera el código HTML y JSON de una vista embebible y envía un objeto {json,html} a la función especificada.

Parámetro Tipo Descripción Opcional Predeterminado
nombre string Nombre de la vista.
retorno function Función de retoro.
precarga boolean|string Mostrar precarga. TRUE para la precarga normal, "barra" para utilizar la barra de progreso o FALSE para deshabilitar. Si "barra"

Devuelve: ui

registrarControlador(nombre,funcion)

Parámetro Tipo Descripción Opcional Predeterminado
nombre
funcion

obtenerInstanciaControladorPrincipal()

Devuelve el controlador de la vista principal.

controlador([nombre])

Devuelve la instancia del controlador.

Parámetro Tipo Descripción Opcional Predeterminado
nombre string Nombre del controlador de vista embebible. Si se omite, devolverá el controlador de la vista principal. Si

Devuelve: Controlador

obtenerControladores()

Devuelve el listado de controladores disponibles.

obtenerInstanciasControladores()

Devuelve el listado de controladores instanciados.

obtenerInstanciaControlador(nombre[,principal,unico])

Busca y devuelve un controlador dado su nombre, creándolo si no existe.

Parámetro Tipo Descripción Opcional Predeterminado
nombre string Nombre del controlador.
principal boolean Determina si es el controlador de la vista principal. Si false
unico boolean Si es false, devolverá la instancia existente en lugar de crear una nueva (singleton). Si false

Devuelve: controlador

obtenerInstanciaControladorVista(nombre)

Devuelve la instancia del controlador para la vista dada. No creará el controlador si no existe.

Parámetro Tipo Descripción Opcional Predeterminado
nombre string Nombre de la vista.

Devuelve: controlador|null

registrarModulo(nombre,funcion)

Registra un módulo.

Parámetro Tipo Descripción Opcional Predeterminado
nombre string Nombre del módulo.
funcion function Función.

Devuelve: ui

obtenerInstanciaModulo(nombre)

Crea y devuelve una nueva instancia del módulo especificado.

Parámetro Tipo Descripción Opcional Predeterminado
nombre string Nombre del módulo.

Devuelve: Modulo

establecerModoEdicion()

enModoEdicion()

obtenerTamano()

Devuelve el tamaño de pantalla como string: xs|sm|md|lg|xl.

obtenerTamanos()

Devuelve todos los posibles tamaños con formato {nombre:ancho máximo}.

obtenerArrayTamanos()

Devuelve los nombres de los posibles tamaños como array ordenado de menor a mayor.

obtenerTamanosPx()

Devuelve todos los posibles tamaños con formato {ancho máximo:nombre}.

cargarJs(ruta,funcion)

Inlcuye un archivo js, invocando el callback cuando el archivo haya sido cargado y ejecutado.

Parámetro Tipo Descripción Opcional Predeterminado
ruta
funcion

cargarCss(ruta)

Inlcuye un archivo CSS.

Parámetro Tipo Descripción Opcional Predeterminado
ruta

esMovil()

Determina si se está ejecutando en un dispositivo móvil.

evaluarExpresion([valores])

Evalúa una expresión utilizando el intérprete configurado con diferentes objetos predefinidos relacionados a la interfaz y la aplicación.

Parámetro Tipo Descripción Opcional Predeterminado
valores Object Valores de las variables en la expresión. Si

Propiedades de valores

Propiedad Tipo Descripción Opcional Predeterminado
objeto * Valor de objeto. Si
controlador controlador Valor de controlador. Si
componente componente Valor de componente. Si
componentes componentes Valor de componentes. Si valores.controlador.componentes
this * Valor de this, si la expresión resuelve a una función. Si
valor * Valor de valor. Si

registrarEnrutador(nombre,funcion)

Registra un enrutador.

Parámetro Tipo Descripción Opcional Predeterminado
nombre string
funcion function

obtenerEnrutador()

Devuelve la instancia del enrutador.

enrutador()

Devuelve la instancia del enrutador (alias de ui.obtenerEnrutador()).

procesarUrl(url)

Parámetro Tipo Descripción Opcional Predeterminado
url

irA(ruta[,nuevaVentana])

Navega a la vista o URL especificada.

Parámetro Tipo Descripción Opcional Predeterminado
ruta string URL o nombre de vista de destino.
nuevaVentana boolean Abrir en una nueva ventana. Si false

Devuelve: ui

noIrA(ruta[,nuevaVentana])

Cambia la URL hacia la vista o URL especificada, sin navegar hacia ella.

Parámetro Tipo Descripción Opcional Predeterminado
ruta string URL o nombre de vista de destino.
nuevaVentana boolean Abrir en una nueva ventana. Si false

Devuelve: ui

volver()

Vuelve a la URL anterior. Este método no invoca el evento 'volver'.
Devuelve: ui

cambiarUrl(url[,estado])

Cambia la URL sin navegar hacia la misma.

Parámetro Tipo Descripción Opcional Predeterminado
url string URL de destino.
estado Object Estado. Si null

Devuelve: ui

abrirVentana(ruta)

Abre una ventana emergente con la vista o URL especificada.

Parámetro Tipo Descripción Opcional Predeterminado
ruta string URL o nombre de vista de destino.

Devuelve: Window

descargar(url)

Inicia la descarga de la URL especificada.

Parámetro Tipo Descripción Opcional Predeterminado
url string URL.

Devuelve: ui

confirmarSalida([activar,mensaje])

Activa o desactiva el diálogo de confirmación antes de navegar a otra URL o salir de la vista actual.

Parámetro Tipo Descripción Opcional Predeterminado
activar boolean Activa (true) o desactiva (false) este comportamiento. Si true
mensaje string Mensaje. Nótese que cuando se utiliza el diálogo nativo, la mayoría de los navegadores actualmente ignora este texto. Si "¿Estás seguro de querer continuar?"

Devuelve: ui

establecerEventos()

Establece los eventos globales de la interfaz.
Devuelve: ui

evento(nombre[,params,obj])

Invoca el método correspondiente al evento en todos los controladores. Devuelve true si la propagación del evento fue detenida.

Parámetro Tipo Descripción Opcional Predeterminado
nombre string Nombre del evento.
params * Parámetros a pasar al método. Si
obj controlador Ejecutar solo en un controlador en particular, dada su instancia. Si

Devuelve: boolean

eventoComponentes(origen,nombre[,soloImplementados,params])

Invoca el método correspondiente al evento en todos los componentes.

Parámetro Tipo Descripción Opcional Predeterminado
origen Object Repositorio de componentes. Especificar null para ejecutar en todos los componentes del sistema.
nombre string Nombre del evento.
soloImplementados boolean Si es true, solo invocará aquellos métodos implementados en el componente concreto (no invocará métodos heredados). Si false
params * Parámetros a pasar al método. Si

Devuelve: boolean

establecerCordova()

obenerElectron()

Devuelve la instancia de la propia ventana de Electron.
Devuelve: Object|null

salir()

Si es Cordova o cliente de escritorio, cierra la aplicación.
Devuelve: ui

obtenerParametros()

Devuelve los parámetros de la URL.
Devuelve: Object

obtenerParametro(nombre)

Devuelve el valor de un parámetro de la URL, o null si no existe.

Parámetro Tipo Descripción Opcional Predeterminado
nombre string

Devuelve: string|null

inicializar(nombreVista,opciones)

Inicializa el sistema.

Parámetro Tipo Descripción Opcional Predeterminado
nombreVista
opciones

preparar(nuevoDoc)

Prepara las referencias al documento.

Parámetro Tipo Descripción Opcional Predeterminado
nuevoDoc

ejecutarVista(nombre,principal[,json,html,destino,retorno])

Inicializa la vista y ejecuta su controlador.

Parámetro Tipo Descripción Opcional Predeterminado
nombre string Nombre de la vista.
principal boolean Determina si se trata de la vista principal.
json Object Objeto JSON decodificado de la vista. Si
html string Código HTML, en caso de tratarse de una vista secundaria. Si
destino Node Elemento de destino, en caso de tratarse de una vista secundaria. Si
retorno function Función de retorno. Si

Devuelve: ui

finalizarVista(vista)

Finaliza la ejecución de la vista e invoca el evento fin en su controlador y sus componentes.

Parámetro Tipo Descripción Opcional Predeterminado
vista componenteVista Vista.

Devuelve: ui

vistaFinalizada(vista)

Elimina todas las referencias a la vista, su controlador y sus componentes. Se espera el llamado a este método desde el controlador tras responder al evento fin.

Parámetro Tipo Descripción Opcional Predeterminado
vista componenteVista Vista.

Devuelve: ui

ejecutar()

Inicia la ejecución del sistema.
Devuelve: ui

construirMenu(items[,clase,destino])

Construye un menú.

Parámetro Tipo Descripción Opcional Predeterminado
items Object[] Items del menú.
clase string Clase CSS. Si
destino Node Elemento de destino. Si ui.obtenerCuerpo()

Propiedades de items[]

Propiedad Tipo Descripción Opcional Predeterminado
etiqueta string Etiqueta.
accion function Función a ejecutar al seleccionarse la opción. Si
habilitado function|boolean Estado del item o función a ejecutar para determinar si el item se encuentra habilitado. Si true
separador boolean Determina si el item es seguido de un separador. Si false
submenu Object[] Items del submenú (admiten las mismas propiedades que items). Si

Devuelve: Object

actualizarMenu(menu)

Actualiza el estado de los items del menú.

Parámetro Tipo Descripción Opcional Predeterminado
menu Object Menú generado con ui.construirMenu().

Devuelve: ui

esMenu(elem)

Determina si un elemento o nodo es parte del DOM de un menú que se encuentra abierto.

Parámetro Tipo Descripción Opcional Predeterminado
elem Node Elemento a evaluar.

Devuelve: boolean

obtenerMenuAbierto()

Devuelve los menú actualmente abiertos.
Devuelve: Object[]

abrirMenu(obj[,posicion,clase])

Abre un menú.

Parámetro Tipo Descripción Opcional Predeterminado
obj Object[]|Object Array de items de menú, un menú generado con ui.construirMenu() o cualquier elemento del DOM compatible.
posicion Node|Object Si se especifica un elemento del DOM, se posicionará el menú sobre el mismo; en caso contrario, debe especificarse un objeto con las propiedades {x,y}. Si
clase string Clase CSS. Si

Devuelve: ui

animarAparecer(elem[,retorno])

Hace aparecer el elemento en forma animada utilizando animaciones CSS.

Parámetro Tipo Descripción Opcional Predeterminado
elem Node Elemento.
retorno function Función de retorno. Si

Devuelve: ui

animarDesaparecer(elem[,retorno])

Hace desaparecer y oculta el elemento en forma animada utilizando animaciones CSS.

Parámetro Tipo Descripción Opcional Predeterminado
elem Node Elemento.
retorno function Función de retorno. Si

Devuelve: ui

desaparecer(elem)

Oculta el elemento mediante el mismo mecanismo que animarDesaparecer(), pero de forma inmediata.

Parámetro Tipo Descripción Opcional Predeterminado
elem Node Elemento.

Devuelve: ui

detenerAnimacion(elem)

Detiene la animación en curso.

Parámetro Tipo Descripción Opcional Predeterminado
elem Node Elemento.

Devuelve: ui

mostrarPrecarga([tipo])

Muestra una animación de precarga.

Parámetro Tipo Descripción Opcional Predeterminado
tipo string Tipo de precarga. "barra" mostrará una barra de progreso superior que no bloquee la vista; cualquier otro valor mostrará la precarga normal a pantalla completa. Si

Devuelve: ui

ocultarPrecarga([tipo])

Oculta la animación de precarga.

Parámetro Tipo Descripción Opcional Predeterminado
tipo string Tipo de precarga. "barra" mostrará una barra de progreso superior que no bloquee la vista; cualquier otro valor mostrará la precarga normal a pantalla completa. Si

Devuelve: ui

construirDialogo(parametros)

Construye un cuadro de diálogo.

Parámetro Tipo Descripción Opcional Predeterminado
parametros Object Parámetros.

Propiedades de parametros

Propiedad Tipo Descripción Opcional Predeterminado
cuerpo string|Node Elemento o HTML a incluir en el cuerpo. Si
opciones Object[] Botones de acción a generar. Si
opciones.etiqueta string Etiqueta del botón. Si
opciones.clase string Clase CSS del botón. Si
opciones.predeterminado boolean Determina si es la acción predeterminada. Si
retorno function Función de retorno al cerrar el diálogo (Resultado). Recibirá como parámetro el índice del botón, o NULL si fue cancelado. Si
retornoAbierto function Función de retorno al abrir el diálogo. Si
mostrarCerrar boolean Determina si se debe mostrar la X para cancelar el diálogo. Si false
eliminar boolean Determina si el diálogo se debe eliminar luego de cerrado. Si false
modal boolean Si es true, deshabilitará las posibilidades de cancelar el diálogo. Si false
sobreponer boolean Si es true, se forzará que quede por encima de todo, incluso de la precarga. Si false
icono string Ícono. Admite una ruta relativa al directorio recursos de la aplicación actual, una URL absoluta, o uno de los siguientes valores: pregunta, exclamacion, alerta, error, informacion, ubicacion, audio, camara, notificacion, seguridad, ok, problema-red. Si null
destino string|Node Elemento de destino, dentro del cual se creará el diálogo. Si document.body

Devuelve: dialogo

abrirDialogo(dialogo)

Abre un diálogo construido con construirDialogo().

Parámetro Tipo Descripción Opcional Predeterminado
dialogo dialogo

Devuelve: ui

obtenerDialogoAbierto()

Devuelve el diálogo actualmente abierto.
Devuelve: Dialogo|null

obtenerDialogosAbiertos()

Devuelve todos los diálogos abiertos.
Devuelve: dialogo[]

cerrarDialogo([dialogo,opcion,omitirAnimacion,eliminar])

Cierra un diálogo construido con construirDialogo().

Parámetro Tipo Descripción Opcional Predeterminado
dialogo dialogo Diálogo. Si
opcion number Número de opción que cierra el diálogo, o NULL. Si null
omitirAnimacion boolean Si es true, ierra el diálogo inmediatamente. Si false
eliminar boolean Eliminar el diálogo luego de cerrar. Si se omite, se tomará de la configuración del diálogo. Si

Devuelve: ui

eliminarDialogo(dialogo)

Elimina o destruye un diálogo construido con construirDialogo().

Parámetro Tipo Descripción Opcional Predeterminado
dialogo dialogo

construirMenu(items[,clase,destino])

Construye un menú.

Parámetro Tipo Descripción Opcional Predeterminado
items Object[] Items del menú.
clase string Clase CSS. Si
destino Node Elemento de destino. Si ui.obtenerCuerpo()

Propiedades de items[]

Propiedad Tipo Descripción Opcional Predeterminado
etiqueta string Etiqueta.
accion function Función a ejecutar al seleccionarse la opción. Si
habilitado function|boolean Estado del item o función a ejecutar para determinar si el item se encuentra habilitado. Si true
separador boolean Determina si el item es seguido de un separador. Si false
submenu Object[] Items del submenú (admiten las mismas propiedades que items). Si

Devuelve: Object

actualizarMenu(menu)

Actualiza el estado de los items del menú.

Parámetro Tipo Descripción Opcional Predeterminado
menu Object Menú generado con ui.construirMenu().

Devuelve: ui

esMenu(elem)

Determina si un elemento o nodo es parte del DOM de un menú que se encuentra abierto.

Parámetro Tipo Descripción Opcional Predeterminado
elem Node Elemento a evaluar.

Devuelve: boolean

obtenerMenuAbierto()

Devuelve los menú actualmente abiertos.
Devuelve: Object[]

abrirMenu(obj[,posicion,clase])

Abre un menú.

Parámetro Tipo Descripción Opcional Predeterminado
obj Object[]|Object Array de items de menú, un menú generado con ui.construirMenu() o cualquier elemento del DOM compatible.
posicion Node|Object Si se especifica un elemento del DOM, se posicionará el menú sobre el mismo; en caso contrario, debe especificarse un objeto con las propiedades {x,y}. Si
clase string Clase CSS. Si

Devuelve: ui

Clone this wiki locally