Saltar al contenido principal
Version: Next (5.0)

Dependencias

Cada componente (criterio, grilla, gráfico, etc) puede tener algunas dependencias dentro de su comportamiento y contenido. Una dependencia puede ser lanzada dependiendo de las condiciones o eventos de los componentes.

warning

El elemento debe tener el atributo component para que funcione. Si el elemento no tiene el atributo component, el sistema de dependencias no funcionará correctamente.

Esqueleto de XML​

<dependency initial="[initial]" source-type="[source-type]" target-type="[target-type]"
server-action="[server-action]" target-action="[target-action]"
label="[label-to-update]" value="[value]" formule="[formule]"
type="[type]" invert="[invert]" async="[async]" silent="[silent]">
<dependency-element ... />
...
<dependency-action .../>
...
</dependency>

Estructura de dependencias​

ElementoUsoVarias instanciasDescripción
dependencyObligatorioNoNodo global de la dependencia. Define los atributos de dependencia
dependency-elementObligatorioSiCondición para lanzar la dependencia
dependency-actionOpcionalSiAcción que se iniciará si las condiciones de dependencia son válidas

Atributos de dependencias​

AtributoUsoTipoDescripciónValores
initialOpcionalBooleanDependencia se lanzará al cargar la páginaEl valor predeterminado es false
source-typeOpcionalStringFuente de dependencias (donde se tomarán los datos)Ver tipos de fuente. El valor predeterminado es none
target-typeOpcionalStringDestino de dependencias (donde se aplicará la dependencia)Ver tipos de destino. El valor predeterminado es none
server-actionOpcionalStringLlamada de acción del servidor (cuando el tipo de fuente es query)Ver lista de acciones del servidor
target-actionOpcionalStringObjetivo para llamar al servidor / Nombre del criterio, para obtener su valor, cuando el tipo de fuente es launcher
labelOpcionalStringEtiqueta a aplicar al objetivoNota: Puedes usar literales i18n
valueOpcionalStringValor a aplicar al objetivo
formuleOpcionalStringFórmula para obtener el valor que se aplicará al objetivo
typeOpcionalStringCómo evaluar las condiciones condicionesLos valores posibles son and (por defecto) y or.
invertOpcionalBooleanInvierte la evaluación de la condición condiciónEl valor predeterminado es false
asyncOpcionalBooleanEjecutar la acción del servidor de forma asincrónicaEl valor predeterminado es false
silentOpcionalBooleanEjecutar la acción del servidor sin mostrar la barra de cargaEl valor predeterminado es false

Tipo de fuente​

El atributo source-type se refiere al lugar de que estamos recuperando los datos para aplicar al componente.

ValorDescripción
noneNo hacer nada (no recuperar valores)
queryEjecutar una consulta para recuperar valores
launcherObtener los valores del alias almacenado definido en target-action
valueObtener los valores del atributo value definido en la dependencia
labelObtener los valores del atributo label definido en la dependencia (puede ser un i18n local)
formuleObtener los valores de un formulario evaluado en el atributo formule definido en la dependencia
resetBorrar el valor de destino

Nota: source-type="action" no es más necesario. Simplemente añada algunas acciones de dependencia a su dependencia y se lanzarán cuando las condiciones sean válidas.

Tipo de destino​

El atributo target-type se refiere al lugar donde estamos aplicando los datos recuperados del source-type o lo que queramos hacer con el componente donde está la dependencia.

AcciónNecesita datosAcción inversaDescripción
noneNoNingunaSe aplica a nada (valor predeterminado)
labelSiNingunaSe aplica el valor recuperado de source-type a la etiqueta del componente
unitSinoneSe aplica el valor recuperado de source-type a la etiqueta de unidad de componente
iconSinoneSe aplica el valor recuperado de source-type al icono del componente
inputSinoneSe aplica el valor recuperado de source-type al valor del componente
format-numberSirestaurar formato de númeroSe aplica el valor recuperado de source-type al formato de número de criterio (para criterios numéricos solamente)
validateSinoneSe aplica el valor recuperado de source-type al criterio de validación
attributeSinoneEstablece un atributo definido en target-action con el valor recuperado source-type
showNohideMostrar el componente
hideNoshowOcultar el componente
show-columnNohide-columnMostrar la columna (sólo en columnas)
hide-columnNoshow-columnOcultar la columna (aplicable sólo en columnas)
enableNodisableActivar el componente
disableNoenableDesactivar el componente
set-requiredNoset-optionalEstablecer el criterio como requerido
set-optionalNoset-requiredEliminar el criterio de validación requerido
set-readonlyNoset-editableEstablecer el criterio como sólo lectura
set-editableNoset-readonlyPermite editar el criterio
set-visibleNoset-invisibleEstablecer el componente como visible
set-invisibleNoset-visibleEstablece el componente como invisible (similar a ocultar pero manteniendo el criterio oculto)
enable-autorefreshSidisable-autorefreshHabilita la autorefresh y establece el temporizador automático con el valor recuperado de source-type
disable-autorefreshSienable-autorefreshDeshabilita la autorefresca y establece el temporizador automático con el valor recuperado de source-type

Nota: Algunas acciones de target-type tienen una acción inversa, que se ejecuta cuando no se cumplen las condiciones de la dependencia. En este caso, NO es necesario añadir otra dependencia con la acción inversa.

Elemento de dependencias​

Los elementos de dependencia son la definición de las condiciones necesarias para lanzar una dependencia.

Esqueleto del elemento de dependencia​

<dependency-element id="[id]" column="[column]" attribute="[attribute]" condition="[condition]" row="[row]"
id2="[id2]" column2="[column2]" attribute2="[attribute2]" event="[event]" value="[value]"
optional="[optional]" cancel="[cancel]" view="[view]" alias="[alias]"/>

Atributos del elemento de dependencias​

AtributoUsoTipoDescripciónValores
idObligatorioStringIdentificador del componente
columnOpcionalStringIdentificador de columna del componente (aplicable en los grids)
attributeOpcionalStringAtributo a comprobar.Ver atributos a continuación. El valor predeterminado es selected
conditionOpcionalStringCondición de comparaciónVea las condiciones del elemento de dependencia dependency element conditions. El valor predeterminado es is not empty
rowOpcionalStringNúmero de fila del grid para comprobar el atributo
id2OpcionalStringIdentificador de componente a comparar
column2OpcionalStringIdentificador de columna del componente (aplicable en los grids)
attribute2OpcionalStringAtributo a comprobar.
eventOpcionalStringEvento a comprobarVer eventos a continuación.
valueOpcionalStringValor a comprobar
optionalOpcionalBooleanMarcar el elemento como opcional. Es útil usar sus valores incluso si están vacíosEl valor predeterminado es false
cancelOpcionalBooleanCancelar la dependencia si este elemento no ha sido comprobado (útil para eventos obligatorios)El valor predeterminado es false
viewOpcionalStringNombre de la vista donde se encuentra el elemento. Se utiliza cuando es necesario especificar en qué contexto está el elemento sobre el que se quiere actuar.Ex.: view = "base"
aliasOpcionalStringNombre a aplicar al elemento de dependencia. Útil para los destinos de dependencia launcher
check-valueOpcionalBooleanMarca los valores de este elemento (inicia la dependencia si este elemento cambia)El valor predeterminado es true

Condiciones del elemento de dependencias​

  • eq Los valores son iguales
  • ne Los valores no son iguales
  • contains El valor 1 contiene el valor 2
  • not contains El valor 1 no contiene el valor 2
  • ge El valor 1 es mayor o igual que el valor 2
  • le Value1 es menor o igual que el valor 2
  • gt El valor 1 es mayor que el valor 2
  • lt El valor 1 es menor que el valor 2
  • in El valor 1 está en la lista del valor 2
  • not in El valor 1 no está en la lista del valor 2
  • is empty El valor 1 está vacío
  • is not empty El valor 1 no está vacío

Atributos​

Los atributos son todos los datos que se pueden obtener de un componente AWE. Dependiendo del componente, puede recuperar información distinta de cada uno:

ActionAplicar aDescripción
visibleTodos los componentestrue si el componente es visible
valueCriteriosObtiene el valor del criterio. Este es el atributo predeterminado
textCriteriosObtiene el componente valor visible
labelCriteriosObtiene etiqueta de componente
unitCriteriosObtiene etiqueta de edición de componente
editableCriteriostrue si el componente es editable
requiredCriteriostrue si el componente es requerido
selectedValuesSeleccionar y Sugerir MúltiplesObtiene el número de los valores seleccionados del criterio de selección
totalValuesSeleccionarObtiene el número total de valores del criterio de selección
currentRowGridObtiene el identificador de fila actual
currentRowValueGridObtiene el valor de la columna column de la fila actual (no la seleccionada). Esto es útil para actualizar los valores de fila sin una selección
prevCurrentRowGridObtiene la fila anterior a la fila actual
prevCurrentRowValueGridObtiene el valor de la columna column de la fila anterior a la fila actual
nextCurrentRowGridObtiene la siguiente fila a la fila actual
nextCurrentRowValueGridObtiene el valor de la columna column de la siguiente fila a la fila actual
selectedRowGridObtiene el identificador de fila seleccionado
selectedRowValueGridObtiene el valor de la columna column de la fila seleccionada.
prevRowGridObtiene la fila anterior al identificador seleccionado
prevRowValueGridObtiene el valor de la columna column de la fila anterior a la seleccionada
nextRowGridObtiene la siguiente fila al identificador seleccionado
nextRowValueGridObtiene el valor de la columna column de la siguiente fila a la seleccionada
selectedGridNúmero de filas seleccionadas del grid
selectedRowsGridNúmero de filas seleccionadas del grid
modifiedRowsGridNúmero de filas modificadas del grid (en grid multioperativo)
totalRowsGridNúmero total de filas del grid (registros)
hasDataColumnGridtrue si la columna column definida tiene algún dato
emptyDataColumnGridtrue si la columna column definida está vacía
fullDataColumnGridtrue si la columna column definida está llena de datos

Nota: Si desea recuperar un selectedRowValue de una columna de grid que no es editable, debe añadir un lanzador de eventos para asegurarse de que la dependencia está siendo lanzada al seleccionar una fila (p. ej. event="select-row")

Eventos​

Algunos componentes lanzan eventos en algunos casos. Puede capturar esos eventos con un elemento de dependencia para hacer que lancen la dependencia:

EventoAplicar aDescripción
clickBotón, Opciones de contexto y GráficosLanzado al pulsar el elemento
select-rowGridSe lanzó cuando una fila ha sido seleccionada
before-save-rowGridLanzado antes de guardar una fila
save-rowGridIniciado al guardar una fila
after-save-rowGridIniciado después de guardar una fila
before-cancel-rowGridEjecutado antes de cancelar guardar una fila
cancel-rowGridSe lanzó al cancelar guardando una fila
after-cancel-rowGridEjecutado después de cancelar el guardado de una fila
delete-rowGridIniciado al eliminar una fila
after-delete-rowGridIniciado después de eliminar una fila
add-rowGridLanzado al agregar una fila
after-add-rowGridIniciado después de añadir una fila
check-records-savedGridIniciado al comprobar si los registros han sido guardados
check-records-generatedGridIniciado al comprobar si se han generado registros
check-one-selectedGridSe lanzó al comprobar si hay una fila seleccionada
check-some-selectedGridIniciado al comprobar si hay al menos una fila seleccionada
double-clickGráficosSe lanzó al hacer clic dos veces en un punto de gráfico
context-menuGráficosSe lanzó cuando se hace clic derecho en un punto de gráfico
zoomGráficosSe lanzó al seleccionar un rango (zooming) en un gráfico

Acción de dependencias​

Las acciones de dependencias son acciones lanzadas cuando una dependencia ha sido activada y la dependencia source-type es action. Vea acciones para más información.

Ejemplos​

Cuando se hace clic en un botón, actualiza un criterio con un formulario

<dependency initial="true" source-type="formule" target-type="input"
formule="'Valor' + (parseInt('[ButSetVa1]'.substr(5,1),10) + parseInt('[ButSetVa2]'.substr(5,1),10))">
<dependency-element id="ButSetVa3" event="click" />
<dependency-element id="ButSetVa2" />
<dependency-element id="ButSetVa1" />
</dependency>

Validar si un valor de columna ya está en la base de datos

<dependency source-type="query" server-action="unique" target-action="AweKeyUni">
<dependency-element id="GrdKeyLst" column="KeyNam" attribute="currentRowValue" />
</dependency>

Activar un botón cuando hay una fila seleccionada en un grid

<dependency target-type="enable" initial="true">
<dependency-element id="GrdKeyLst" attribute="selectedRows" condition="eq" value="1" />
</dependency>

Cambia el formato numérico cuando un valor de criterio es 4decimales

<dependency source-type="formule" target-type="format-number" initial="true"
formule="{vMin: '-999999', mDec: [NumHid], aSign:' JPY', pSign:'s', aPad:true}">
<dependency-element id="Txt" condition="eq" value="4decimales" />
</dependency>

Cambiar la validación de un criterio de tiempo

<dependency source-type="value" target-type="validate" value="{textLE:['TimReq']}">
<dependency-element id="CalReq" condition="eq" name="Cal" />
<dependency-element id="Cal" condition="eq" name="CalReq" />
</dependency>

Iniciar dos acciones cuando un valor de criterio cambia

<dependency initial="true">
<dependency-element id="CalReq" />
<dependency-action type="server" server-action="data" target-action="ProAllLst" target="SelReq" />
<dependency-action type="server" server-action="data" target-action="ProAllLst" target="SelMulReq" />
</dependency>

Hacer que un criterio no sea visible (pero manteniendo el lugar) cuando un valor de criterio es oculta

<dependency target-type="set-invisible" initial="true">
<dependency-element id="Txt" condition="eq" value="oculta" />
</dependency>

Hacer un criterio editable (no solo lectura) cuando un valor de criterio es edita

<dependency target-type="set-editable" initial="true">
<dependency-element id="Txt" condition="eq" value="edita" />
</dependency>

Rellena una etiqueta unitaria de criterio con el resultado de una consulta cuando se comprueba una casilla de verificación

<dependency source-type="query" target-type="unit" server-action="data" target-action="ModSel">
<dependency-element id="ChkBoxVa2" condition="eq" value="1" />
</dependency>

Mostrar un componente cuando el valor de la columna de la fila seleccionada de un grid no es igual a awemadora02

<dependency target-type="show" initial="true">
<dependency-element id="GrdSta" column="Als" attribute="selectedRowValue" condition="ne" value="awemadora02"/>
<dependency-element id="GrdSta" event="select-row"/>
</dependency>

Usar una dependencia sólo en la fila seleccionada

<dependency initial="true" target-type="enable">
<dependency-element id="GridName" attribute="selectedRow" condition="eq" id2="GridName" attribute2="currentRow"/>
</dependency>

Nota: Si desea recuperar un valor de fila seleccionado de una columna de grid que no es editable, debe añadir un lanzador de eventos para asegurarse de que la dependencia está siendo lanzada al seleccionar una fila (p. ej. event="select-row")

Validar un criterio utilizando un método Java

Dependencia

<criteria label="PARAMETER_TEXT" id="TxtVal" variable="TxtVal" component="text">
<dependency source-type="query" server-action="validate" target-action="ValidateBankAccount">
<dependency-element id="TxtVal"/>
</dependency>
</criteria>

Consulta

<query id="ValidateBankAccount" service="ValidateBankAccount">
<variable id="BankAccount" type="STRING" name="TxtVal" />
</query>

Servicio

<service id="ValidateBankAccount">
<java classname="com.almis.awe.test.Validation" method="validateBankAccount">
<service-parameter type="STRING" name="BankAccount" />
</java>
</service>

Método Java

public class Validation {

// PATTERNS
private static final String BANK_ACOUNT = "^[0-9]{4}\\-[0-9]{4}\\-[0-9]{2}\\-[0-9]{10}$";
private static final Pattern BANK_ACCOUNT_PATTERN = Pattern.compile(BANK_ACOUNT, 0);

public ServiceData validateBankAccount(String bankAccount) throws AWException {
ServiceData check = new ServiceData();
Matcher matchAccount = BANK_ACCOUNT_PATTERN.matcher(bankAccount);
if (!matchAccount.matches()) {
check.setType(AnswerType.WARNING);
check.setMessage(LocalSingleton.getInstance().getLocal("ERROR_MESSAGE_WRONG_BANK_ACCOUNT", bankAccount));
}
return check;
}
}

Añadir una clase a un elemento HTML cuando ocurre un evento​

Animación de Campanas

A veces necesitamos mostrar un consejo en la pantalla para notar a los usuarios que algo ha sucedido en el back-end como una nueva entrada en la base de datos o similar. Vamos a explicar cómo agregar dos nombres de clase ("animated" y "faa-slow" para ajustar la velocidad animada) a un elemento HTML para animar un icono de campana y mostrar un número sobre el icono que representa una serie de errores en la aplicación. Al pulsar este botón, la campana detiene la animación y muestra un diálogo con un grid que muestra los detalles del error.

Definición de los elementos de la pantalla

Primero debemos definir el elemento HTML en la pantalla xml, en este caso un elemento "info-button" con un atributo "icon" con un valor "bell" y un atributo "unit". Este último atributo representará el número de errores en la aplicación.

<info-button style="nav-icon-btn-danger" title="BUTTON_NOTIFICATIONS" icon="bell" id="Warnings" unit="">
...
</info-button>

El siguiente paso es agregar la acción para detener la animación de la campana (quitar el nombre de la clase) y mostrar el diálogo.

<info-button style="nav-icon-btn-danger" title="BUTTON_NOTIFICATIONS" icon="bell" id="Warnings" unit="">
<button-action type="remove-class" target-action="animated faa-slow" target="#Warnings .fa-bell" />
<button-action type="dialog" target="MessageWarnings" />
</info-button>

La primera acción del botón elimina los nombres de clase "animated" y "faa-slow" del elemento HTML apuntado en el atributo "target", en este caso el elemento con el nombre de clase "fa-bell" dentro del elemento con el id "Warnings".

La segunda acción del botón abre el diálogo con el id "MessageWarnings".

Estas acciones se activan cuando el usuario hace clic en el botón.

Ahora debemos agregar las dependencias requeridas para mostrar los números de errores y agregar los nombres de clase "animated" y "faa-slow". Estas acciones deben ejecutarse cuando los usuarios entren en la pantalla o inicien sesión en la aplicación, por lo que vamos a añadir una acción adicional.

<info-button style="nav-icon-btn-danger" title="BUTTON_NOTIFICATIONS" icon="bell" id="Warnings" unit="">
<button-action type="remove-class" target-action="animated faa-slow" target="#Warnings .fa-bell" />
<button-action type="dialog" target="MessageWarnings" />
<dependency source-type="launcher" target-type="unit" target-action="notification" initial="true">
<dependency-element id="NotificationNumber" alias="notification"/>
</dependency>
<dependency>
<dependency-element id="NotificationNumber" attribute="value" condition="ne" value="0" />
<dependency-action type="add-class" target-action="animated faa-slow" target="#Warnings .fa-bell" />
</dependency>
</info-button>

La primera dependencia es de tipo "launcher" y se ejecuta cuando el usuario entra en la pantalla donde este elemento se define gracias al atributo "initial" establecido en "true". La dependencia, apunta al atributo "unit" del botón info-button y depende de un elemento con un id "NotificationNumber" representado en la etiqueta "dependency-element". Este nuevo elemento se creará en los siguientes pasos.

La segunda dependencia es de tipo "action". Esta acción se activará cuando el valor del "dependency-element" (el elemento con un identificador de "NotificationNumber") no sea igual (ne) a cero. Esto se representa con los siguientes atributos: attribute="value" condition="ne" value="0". La acción para esta dependencia es de tipo "add-class", así que cuando se ejecuta esta acción, se añadirá un nombre de clase a un elemento. Esta acción apunta al elemento con el nombre de la clase "fa-bell" dentro del elemento con el id "Warnings" (atributo "target" en la etiqueta dependency-action), por lo que este elemento recibirá el nombre de la clase descrito en el atributo "target-action" ("animated faa-slow").

Ahora vamos a definir el elemento de dependencia "NotificationNumber". Este elemento será un criterio oculto y tiene un atributo "initial-load" definido como "value" y un "target-action" que apunta a una consulta que debe definirse en "Queries.xml" en AWE.

<criteria id="NotificationNumber" component="hidden" initial-load="value" target-action="getNotificationErrors" />

Y por último, pero no menos importante, la definición del diálogo.

<dialog id="MessageWarnings" modal="true" style="modal-lg" label="SCREEN_TEXT_WARNINGS" icon="exclamation-triangle" help="HELP_SCREEN_TEXT_PRINT_EMAIL">
<tag type="div" style="modal-body row">
<window label="BUTTON_NOTIFICATIONS" icon="bell" expandible="vertical">
<grid id="GridMessageWarning" style="height-lg" max="50" server-action="data-silent" target-action="getErrorMessageInfo" autoload="true" autorefresh="30">
...
columns definition
...
</grid>
</window>
</tag>
</dialog>

En este punto hemos creado todos los elementos necesarios en la pantalla. El siguiente paso es definir las consultas que extraen los datos de la base de datos.

Queries

En el archivo "Queries.xml" debemos definir las siguientes etiquetas:

<query id="getErrorMessageInfo" service="getErrorMessageInfo"/>
<query id="getNotificationErrors" service="getErrorMessageInfo">
<field id="errors" alias="value" />
<field id="errors" alias="label" />
</query>

La primera consulta apunta a un servicio llamado "getErrorMessageInfo" definido en el archivo "Services.xml" en AWE. Esta consulta será lanzada por el grid creado en el diálogo.

La segunda consulta apunta al mismo servicio y espera dos valores uno para un campo "valor" y otro para un campo "etiqueta". Esta consulta será lanzada por los criterios ocultos.

Servicio

Una vez que las consultas están definidas y apuntan a un servicio, debemos crear este servicio. En el archivo "Services.xml" debemos definir las siguientes etiquetas:

<service id="getErrorMessageInfo">
<java classname="com.example.web.controller.ErrorMessageController" method="getErrorMessageInfo">
</java>
</service>

Este servicio ejecuta el método "getErrorMessageInfo" en la clase "com.example.web.controller.ErrorMessageController".

Java

En el Controlador debemos crear el método "getErrorMessageInfo" y devolver un objeto ServiceData. Este controlador debe llamar a una clase Manager.

public class ErrorMessageController extends AWEController {
public ServiceData getErrorMessageInfo() throws AWException {

// Get event manager
ErrorMessageManager errorMessageManager = new ErrorMessageManager();

return errorMessageManager.getErrorMessageInfo();
}
}

En la definición de Gestor debemos crear una acción de llenado del cliente para cargar datos en el grid de diálogo y una acción de cliente seleccionada para cargar datos en criterios ocultos.

public class ErrorMessageManager extends AWEManager {

/**
* Get error info
*
* @return
* @throws AWException
*/
public ServiceData getErrorMessageInfo() throws AWException {
...
ClientAction fillErrorGrdAction = new ClientAction("fill");
fillErrorGrdAction.setSilent("true");
fillErrorGrdAction.setTarget("GridMessageWarning");

DataList errorGrdParametersDatalist = new DataList();
Integer rowIndex = 0;
for (ErrorBean error : errorList) {
HashMap<String, CellData> parametersRow = new HashMap<String, CellData>();
parametersRow.put("id", new CellData(rowIndex));

...
// add columns data
...

errorGrdParametersDatalist.getRows().add(parametersRow);
rowIndex++;
}
// Set records
errorGrdParametersDatalist.setRecords(rowIndex);

fillErrorGrdAction.addParameter("datalist", errorGrdParametersDatalist);

// Notification Number
ClientAction selectCrtNotificationNumberAction = new ClientAction("select");
selectCrtNotificationNumberAction.setTarget("NotificationNumber");
selectCrtNotificationNumberAction.setSilent("true");

errorListSize = errorList.size();
ArrayNode notifNumberArrayNode = JsonNodeFactory.instance.arrayNode();
notifNumberArrayNode.add(String.valueOf(errorListSize));
selectCrtNotificationNumberAction.addParameter("values", new CellData(notifNumberArrayNode));

// Adds clients actions
serviceData.addClientAction(selectCrtNotificationNumberAction);
serviceData.addClientAction(fillErrorGrdAction);
...
}