openxava / documentación / Controladores

<controladores>
    <var-entorno ... /> ...    <!-- 1 -->
    <objeto ... /> ...         <!-- 2 -->
    <controlador ... /> ...    <!-- 3 -->
</controladores>

1. var-entorno (varias, opcional): Variable que contienen información de configuración. Estas variables pueden ser accedidas desde las acciones y filtros, y su valor puede ser sobreescrito para cada módulo.
2. objeto (varios, opcional): Define objetos Java de sesión, es decir objetos que se crean y existen durante toda la sesión del usuario.
3. controlador (varios, opcional): Los controladores son agrupaciones de acciones (controlador es opcional desde v6.4.2, antes era obligado).

Variable de entorno

<var-entorno
    nombre="nombre"            <!-- 1 -->
    valor="valor"              <!-- 2 -->
/>

1. nombre (obligado): Nombre de la variable de entorno en mayúsculas y usando subrayados para separar palabras.
2. valor (obligado): Valor para la variable de entorno.

<var-entorno nombre="MIAPLICACION_AÑO_DEFECTO" valor="2007"/>
<var-entorno nombre="MIAPLICACION_COLOR" valor="ROJO"/>

String color = getEnvironment().getValue("MIAPLICACION_COLOR");

Objetos de sesión

<objeto
    nombre="nombreObjeto"           <!-- 1 -->
    clase="tipoObjeto"              <!-- 2 -->
    valor="valorInicial"            <!-- 3 -->
    ambito="modulo|global"          <!-- 4  Muevo en v2.1 -->
/>

1. nombre (obligado): Nombre del objeto, normalmente usaremos el nombre de la aplicación como prefijo para evitar colisión de nombres en proyectos grandes.
2. clase (obligado): Nombre calificado de la clase Java para esto objeto.
3. valor (opcional): Valor inicial para el objeto.
4. ambito (opcional): (Nuevo en v2.1) El valor por defecto es module. Si usamos modulo como ámbito cada módulo tendrá su propia copia de este objeto. Si usamos global como ámbito el mismo objeto será compartido por todos los módulos de todas la aplicaciones OpenXava (que se ejecuten dentro del mismo war).

<object name="xava_view" class="org.openxava.view.View"/>
<object name="xava_referenceSubview" class="org.openxava.view.View"/>
<object name="xava_tab" class="org.openxava.tab.Tab"/>
<object name="xava_mainTab" class="org.openxava.tab.Tab"/>
<object name="xava_row" class="java.lang.Integer" value="0"/>
<object name="xava_language" class="org.openxava.session.Language"/>
<object name="xava_newImageProperty" class="java.lang.String"/>
<object name="xava_currentReferenceLabel" class="java.lang.String"/>
<object name="xava_activeSection" class="java.lang.Integer" value="0"/>
<object name="xava_previousControllers" class="java.util.Stack"/>
<object name="xava_previousViews" class="java.util.Stack"/>

El controlador y sus acciones

<controlador
    nombre="nombre"            <!-- 1 -->
>
    <hereda-de ... /> ...      <!-- 2 -->
    <accion ... /> ...         <!-- 3 -->
    <subcontrolador ... /> ... <!-- 4 Nuevo en v4.8 -->
</controlador>

1. nombre (obligado): Nombre del controlador.
2. hereda-de (varios, opcional): Permite usar herencia múltiple, para que este controlador herede todas las acciones de otro (u otros) controlador. Se puede añadir el atributo acciones-excluidas (nuevo en v5.8) pare impedir que ciertas acciones sean heredadas.
3. accion (varios, obligada): Definición de la lógica a ejecutar cuando el usuario pulse un botón o vínculo.
4. subcontrolador (varios, opcional): (Nuevo en v4.8) Permite agrupar varias acciones que visualizaremos en un botón desplegable.

<accion
    nombre="nombre"                                      <!--  1 -->
    etiqueta="etiqueta"                                  <!--  2 -->
    descripcion="descripcion"                            <!--  3 -->
    modo="detail|list|ALL"                               <!--  4 -->
    icono="icono"                                        <!--  5  Nuevo en v5.4 -->
    imagen="imagen"                                      <!--  6 -->
    clase="clase"                                        <!--  7 -->
    oculta="true|false"                                  <!--  8 -->
    al-iniciar="true|false"                              <!--  9 -->
    en-cada-peticion="true|false"                        <!-- 10  Nuevo en v2.1.2 -->
    antes-de-cada-peticion="true|false"                  <!-- 11  Nuevo en v2.2.5 -->
    despues-de-cada-peticion="true|false"                <!-- 12  Nuevo en v4.0.1 -->
    por-defecto="nunca|casi-nunca (nuevo en v4m6)|
        si-posible|casi-siempre|siempre"                 <!-- 13 -->
    cuesta="true|false"                                  <!-- 14 -->
    confirmar="true|false"                               <!-- 15 -->
    atajo-de-teclado="atajo-de-teclado"                  <!-- 16  Nuevo en v2.0.1 -->
    mostrar-dialogo="true|false"                         <!-- 17  Solo en v4m1 -->
    ocultar-dialogo="true|false|defecto"                 <!-- 18  Solo en v4m1 -->
    en-cada-fila="true|false"                            <!-- 19  Nuevo en v4m4 -->
    procesar-elementos-seleccionados="true|false"        <!-- 20  Nuevo en v5.7 -->
    disponible-en-nuevo="true|false"                     <!-- 21  Nuevo en v5.8 -->
    pierde-datos-cambiados="true|false"                  <!-- 22  Nuevo en v6.3 -->
>
   <poner ... /> ...                                     <!-- 23 -->
   <usa-objeto ... /> ...                                <!-- 24 -->
</accion>

1. nombre (obligado): Nombre identificativo de la acción tiene que ser único dentro del controlador, pero puede repetirse el nombre en diferentes controladores. Cuando referenciemos a una acción desde fuera lo haremos siempre especificando NombreControlador.nombreAccion.
2. etiqueta (opcional): Etiqueta del botón o texto del vínculo. Es mucho mejor usar los archivos i18n.
3. descripcion (opcional): Texto descriptivo de la acción. Es mucho mejor usar los archivos i18n.
4. modo (opcional): Indica en que modo ha de ser visible esta acción para el usuario. Por defecto es ALL, que quiere decir que esta acción es siempre visible.
5. icono (opcional): (Nuevo en v5.4) Id de icono de Material Design Icons. Por ejemplo, si escribes icono="bell" se usará una campanita como icono para la acción sin tener que incluir ninguna imagen. A partir de v5.4 esta es la forma preferida de definir un icono en lugar de imagen.
6. imagen(opcional): URL de la imagen asociada a la acción. En la implementación actual si especificamos imagen aparece la imagen como un vínculo en el que el usuario puede pulsar. Hasta v4.1.x la raiz para la URL era xava, era necesario usar images/ como prefijo. A partir de v4.2 la raiz depende del estilo y en el estilo por defecto es xava/images, por lo que ya no es necesario usar images/ como prefijo, aunque todavía se soporta para no romper la compatibilidad con versiones anteriores. Si defines ambas imagen e icono, icono tiene preferencia sobre imagen, aunque se puede cambiar este comportamiento con useIconsInsteadOfImages=false en xava.properties. Dentro de los portales imagen tiene siempre preferencia.
7. clase (opcional): Clase que implementa la lógica a ejecutar. Ha de implementar la interfaz IAction.
8. oculta (opcional): Una acción oculta no aparece por defecto en la barra de botones, aunque sí que se puede usar para todo lo demás, por ejemplo como acción asociada a un evento de cambio de valor, acción de propiedad, en las colecciones, etc. Por defecto vale false.
9. al-iniciar (opcional): Si la ponemos a true esta acción se ejecutará automáticamente al iniciar el módulo. Por defecto vale false.
10. en-cada-peticion (opcional): (Nuevo en v2.1.2) Si la ponemos a true esta acción se ejecutará automáticamente en cada petición del usuario, es decir, en la primera ejecución del módulo y antes de la ejecución de cada acción del usuario. En el momento de la ejecución todos los objetos de sesión de OpenXava están configurados y listos para usar. Es decir, desde esta acción podemos usar xava_view y xava_tab. Por defecto vale false. Usado conjuntamente con modo podemos discriminar la ejecución de esta acción a un modo concreto (lista o detalle) (nuevo en v3.0.2).
11. antes-de-cada-peticion (opcional): (Nuevo en v2.2.5) Si la ponemos a true esta acción se ejecutará automáticamente antes de cada petición del usuario, es decir, en la primera ejecución del módulo y antes de la ejecución de cada acción del usuario, pero antes de que los objetos de sesión de OpenXava estén configurados y listos para usar. Es decir, desde esta acción no podemos usar xava_view ni xava_tab. Por defecto vale false. Usado conjuntamente con modo podemos discriminar la ejecución de esta acción a un modo concreto (lista o detalle) (nuevo en v3.0.2).
12. despues-de-cada-peticion (opcional): (Nuevo en v4.0.1) Si la ponemos a true esta acción se ejecutará automáticamente después de cada petición del usuario, es decir, en la primera ejecución del módulo y antes de la ejecución de cada acción del usuario. Por defecto vale false. Usado conjuntamente con modo podemos discriminar la ejecución de esta acción a un modo concreto (lista o detalle).
13. por-defecto (opcional): Indica el peso de esta acción a la hora de seleccionar cual es la acción por defecto. Las acción por defecto es la que se ejecuta cuando el usuario pulsa ENTER. Por defecto vale casi-nunca (hasta v4m5 era nunca).
14. cuesta (opcional): Si la ponemos a true indicamos que esta acción cuesta tiempo en ejecutarse (minutos u horas), en la implementación actual OpenXava visualiza una barra de progreso. Por defecto vale false.
15. confirmar (opcional): Si la ponemos a true antes de ejecutarse la acción un diálogo le preguntará al usuario si está seguro de querer ejecutarla. Por defecto vale false.
16. atajo-de-teclado (opcional): Define una atajo de teclado que el usuario puede pulsar para ejecutar esta acción. Los valores posibles son los mismos que para javax.swing.KeyStroke. Ejemplos: "control A", "alt x", "F7" (nuevo en v2.0.1).
17. motrar-dialogo (opcional): (Solo en v4m1, no está disponible desde v4m2) Si true después de ejecutar la acción la interfaz de usuario actual se mostrará dentro de un diálogo modal. Por defecto vale false.
18. ocultar-dialogo (opcional): (Solo en v4m1, no está disponible desde v4m2) Si true si actualmente hay un diálogo mostrándose lo cierra. Por defecto vale defecto, lo que indica que el diálogo se ocultará solo si la acción se llama "cancelar" o es la acción por defecto.
19. en-cada-fila (opcional): (Nuevo en v4m4) Si true y esta acción se muestra en modo lista o en una colección la acción aparecerá en cada fila. La acción tiene que tener una propiedad int row (TabBaseAction y CollectionBaseAction ya tienen la propiedad row incluida). Por defecto vale false.
20. procesar-elementos-seleccionados (opcional): (Nuevo en v5.7) Si true esta acción procesa las filas seleccionadas en la lista. De esta manera OpenXava puede ocultar esta acción si la selección de elementos no está disponible. Por defecto vale false.
21. disponible-en-nuevo (opcional): (Nuevo en v5.8) Si false la acción no estará disponible mientras se crea una nueva entidad (cuando el usuario pulsa Nuevo). Por defecto vale true.
22. pierde-datos-cambiados (opcional): (Nuevo en v6.3) Si true significa que cuando se ejecute todos los datos cambiados por el usuario en la vista desde la última grabación se perderán. Esto puede ser usado por OpenXava para preguntar por confirmación antes de ejecutar la acción. Por defecto vale false.
23. poner (varios, opcional): Sirve para dar valor a las propiedades de la acción. De esta forma una misma acción configurada de forma diferente puede usarse en varios controladores.
24. usa-objeto (varios, opcional): Asigna un objeto de sesión a una propiedad de la acción antes de ejecutarse, y al acabar recoge el valor de la propiedad y lo coloca en el contexto (actualiza el objeto de sesión).

<controlador nombre="Observaciones">
    <accion nombre="ocultarObservaciones"
        clase="org.openxava.test.acciones.OcultarMostrarPropiedad">
        <poner propiedad="propiedad" valor="observaciones" />
        <poner propiedad="ocultar" valor="true" />
        <usa-objeto nombre="xava_view"/>  <!-- No necesario desde v4m2 -->
    </accion>
    <accion nombre="mostrarObservaciones" modo="detail"
        clase="org.openxava.test.actiones.OcultarMostrarPropiedad">
        <poner propiedad="propiedad" valor="observaciones" />
        <poner propiedad="ocultar" valor="false" />
        <usa-objeto nombre="xava_view"/>  <!-- No necesario desde v4m2 -->
    </accion>
    <accion nombre="ponerObservaciones" modo="detail"
        clase="org.openxava.test.acciones.PonerValorPropiedad">
        <poner propiedad="propiedad" valor="observaciones" />
        <poner propiedad="valor" valor="Demonios tus ojos" />
        <usa-objeto nombre="xava_view"/>  <!-- No necesario desde v4m2 -->
    </accion>
</controladores>

<modulo nombre="Albaranes">
    <modelo nombre="Albaran"/>
    <controlador nombre="Typical"/>
    <controlador nombre="Observaciones"/>
</modulo>

package org.openxava.test.acciones;
 
import org.openxava.actions.*;
 
/**
 * @author Javier Paniza
 */
 
public class OcultarMostrarPropiedad extends ViewBaseAction {   // 1
 
    private boolean ocultar;
    private String propiedad;
 
    public void execute() throws Exception {                    // 2
        getView().setHidden(propiedad, ocultar);                // 3
    }
 
    public boolean isOcultar() {
        return ocultar;
    }
 
    public void setOcultar(boolean b) {
        ocultar = b;
    }
 
    public String getPropiedad() {
        return propiedad;
    }
 
    public void setPropiedad(String string) {
        propiedad = string;
    }
 
}

<usa-objeto nombre="xava_view"/>  <!-- No necesario desde v4m2 -->

<poner propiedad="propiedad" valor="observaciones" />
<poner propiedad="ocultar" valor="true" />

Subcontrolador (nuevo en v4.8)

<subcontrolador
    controlador="nombreControlador"    <!-- 1 -->
    imagen="imagen"                    <!-- 2 -->
    icono="icono"                      <!-- 3  Nuevo en v5.4 -->
    modo="detail|list|ALL"             <!-- 4 -->

1. controlador: (obligado) Nombre del controlador al que hacemos referencia
2. imagen: (opcional) imagen asociada al subcontrolador
3. icono (opcional): (Nuevo en v5.4) Id de icono de Material Design Icons. Por ejemplo, si escribes icono="bell" se usará una campanita como icono para la acción sin tener que incluir ninguna imagen. A partir de v5.4 esta es la forma preferida de definir un icono en lugar de imagen.
4. modo: (opcional) Por defecto es ALL. Para indicar si el subcontrolador saldrá en el modo lista, detalle o ambos.

<controladores>
    <controlador nombre="Color">
        <accion nombre="verMensaje"
                clase="org.openxava.test.actions.SeeMessageAction"/>
        <subcontrolador
                controlador="ColorSub" <!-- 1 -->
                icono="menu"/>
    </controlador>
 
    <controlador nombre="ColorSub">
        <accion nombre="firsAction" imagen="report.gif"
                clase="org.openxava.test.actions.SeeDialogInColor">
                <poner propiedaad="actionNumber" valor="1"/>
        </accion>
        <accion nombre="secondAction"
                clase="org.openxava.test.actions.SeeDialogInColor">
                <poner propiedaad="actionNumber" valor="2"/>
        </accion>
        <accion nombre="secondAction"
                clase="org.openxava.test.actions.SeeDialogInColor">
                <poner propiedaad="actionNumber" valor="3"/>
        </accion>
        <accion nombre="secondAction" mode="detail" <!-- 2 -->
                clase="org.openxava.test.actions.SeeDialogInColor">
                <poner propiedaad="actionNumber" valor="4"/>
        </accion>
    </controlador
</controladores>

1. controlador: referenciamos al controlador ColorSub que tenemos definido en nuestro controladores.xml
2. mode="detail": esta acción aparecerá en el subcontrolador solo cuando estemos en el modo detalle, si estamos en el modo lista la acción no estará visible.

Inyección de dependencias

@Inject (JSR-330) (nuevo en v4m2)

<controladores>
    <objeto nombre="xavatest_anoActivo" clase="java.lang.Integer" valor="2010" ambito="global"/>
 
    <controlador nombre="AnoActivo">
        <accion nombre="cambiar"
        clase="org.openxava.test.acciones.CambiarAnoActivo"/>
    </controlador>
</controladores>

public class CambiarAnoActivo extends ViewBaseAction {
 
    @Inject
    private int anoActivo; // Los getter y setter no son necesarios
 
    public void execute() throws Exception {
         assert anoActivo == 2010; // El valor del objeto de sesión
         anoActivo = 2012; // Cambia el valor del objeto de sesión
    }
 
}

public class CambiarAnoActivo extends ViewBaseAction {
 
    @Inject @Named("xavatest_anoActivo")
    private int ano; // Los getter y setter no son necesarios
 
    public void execute() throws Exception {
        assert ano == 2010; // El valor del objeto de sesión xavatest_anoActivo
        ano = 2012; // Cambia el valor de avatest_anoActivo
    }
 
}

Usar <usa-objeto /> para inyección de dependencias

<controladores>
    <objeto nombre="xavatest_anoActivo" clase="java.lang.Integer" valor="2010" ambito="global"/>
 
    <controlador nombre="AnoActivo">
        <accion nombre="cambiar"
            clase="org.openxava.test.acciones.CambiarAnoActivo">
            <usa-objeto nombre="xavatest_anoActivo"/>
        </accion>
    </controlador>
</controladores>

public class CambiarAnoActivo extends ViewBaseAction {
 
    private int anoActivo; // Sin @Inject, estamos usando <usa-objeto/>
 
    public void execute() throws Exception {
         assert anoActivo == 2010; // El valor del objeto de sesión
         anoActivo = 2012; // Cambia el valor del objeto de sesión
    }
 
    public void setAnoActivo(int anoActivo) {  // Setter y...
         this.anoActivo = anoActivo;
    }
 
    public int getAnoActivo() { // getter son necesarios
         return anoActivo;
    }
 
}

<accion nombre="cambiar"
   class="org.openxava.test.acciones.CambiarAnoActivo">
   <usa-objeto nombre="xavatest_anoActivo" propiedad-accion="ano"/>
</accion>

public class CambiarAnoActivo extends ViewBaseAction {
 
    private int ano; // Sin @Inject, estamos usando <usa-objeto/>
 
    public void execute() throws Exception {
        assert ano == 2010; // El valor del objeto de sesión xavatest_anoActivo
        ano = 2012; // Cambia el valor de xavatest_anoActivo
    }
 
    public void setAno(int ano) {  // Setter y...
         this.ano = ano;
    }
 
    public int getAno() { // getter son necesarios
         return ano;
    }
 
}

Herencia de controladores

<controller name="Typical">
    <extends controller="Print"/>
    <extends controller="CRUD"/>
</controller>

<controlador nombre="Familia">
    <hereda-de controlador="Typical" acciones-excluidas="refresh, delete"/>
    <accion nombre="new" icono="library-plus"
        clase="org.openxava.test.acciones.CrearNuevaFamilia">
        <usa-objeto nombre="xava_view"/>  <!-- No obligatorio desde v4m2 -->
    </accion>
</controlador>

Acciones en modo lista

<accion nombre="borrarSeleccionados" modo="list"         <!-- 1 -->
    confirmar="true"                                     <!-- 2 -->
    clase="org.openxava.actions.DeleteSelectedAction">
</accion>

package org.openxava.actions;
 
import java.util.*;
 
import org.openxava.model.*;
import org.openxava.validators.*;
 
/**
 * @author Javier Paniza
 */
 
public class DeleteSelectedAction extends TabBaseAction implements IModelAction {    // 1
    private String model;
 
    public void execute() throws Exception {
        // int [] selectedOnes = getTab().getSelected();                             // 2
        // int [] selectedOnes = getSelected(); // Nuevo en v4m4.                    // 2
        // Desde v4.7 es preferible getSelectedKeys() a getSelected()
        Map [] selectedOnes = getSelectedKeys(); // Nuevo en v4.7                    // 2
        if (selectedOnes != null) {
            for (int i = 0; i < selectedOnes.length; i++) {
                Map clave = selectedOnes[i];
                try {
                    MapFacade.remove(model, clave);                                  // 3
                }
                catch (ValidationException ex) {
                    addError("no_delete_row", new Integer(i), clave);// (4)
                    addErrors(ex.getErrors());
                }
                catch (Exception ex) {
                    addError("no_delete_row", new Integer(i), clave);
                }
            }
            getTab().deselectAll();                                                  // 5
            resetDescriptionsCache();                                                // 6
        }
    }
 
    public void setModel(String modelName) {                                         // 7
        this.model = modelName;
    }
}

Sobreescribir búsqueda por defecto

<modulo nombre="Albaranes">
    <var-entorno nombre="XAVA_SEARCH_ACTION" valor="Albaranes.buscar"/>
    <modelo nombre="Albaran"/>
    <controlador nombre="Typical"/>
    <controlador nombre="Observaciones"/>
    <controlador nombre="Albaranes"/>
</modulo>

<controlador nombre="Albaranes">
    <accion nombre="buscar" modo="detail"
        por-defecto="si-posible" oculta="true"
        clase="org.openxava.test.acciones.BuscarAlbaran"
        atajo-de-teclado="F8">
        <usa-objeto nombre="xava_view"/>  <!-- No obligatorio desde v4m2 -->
    </accion>
    ...
</controlador>

package org.openxava.test.acciones;
 
import java.util.*;
 
import org.openxava.actions.*;
import org.openxava.util.*;
 
/**
 * @author Javier Paniza
 */
 
public class BuscarAlbaran extends SearchByViewKeyAction {                    // 1
 
    public void execute() throws Exception {
        super.execute();                                                      // 2
        if (!Is.emptyString(getView().getValueString("empleado"))) {
            getView().setValue("entregadoPor", new Integer(1));
            getView().setHidden("transportista", true);
            getView().setHidden("empleado", false);
        }
        else {
            Map transportista = (Map) getView().getValue("transportista");
            if (!(transportista == null || transportista.isEmpty())) {
                getView().setValue("entregadoPor", new Integer(2));
                getView().setHidden("transportista", false);
                getView().setHidden("empleado", true);
            }
            else {
                getView().setHidden("transportista", true);
                getView().setHidden("empleado", true);
            }
        }
    }
 
}

• CRUD.searchByViewKey: Esta es la configurada por defecto. Hace una búsqueda a partir de la clave que hay ese momento en la vista, no ejecuta ningún evento.
• CRUD.searchExecutingOnChange: Funciona como la anterior pero al buscar ejecuta las acciones @OnChange/al-cambiar asociadas a las propiedades de la vista.
• CRUD.searchReadOnly: Funciona como searchByViewKey pero pone la vista de detalle a estado no editable al buscar. Útil para crear módulos de consulta.

<modulo nombre="ProductosAccionesAlCambiarAlBuscar">
    <var-entorno nombre="XAVA_SEARCH_ACTION" valor="CRUD.searchExecutingOnChange"/>
    <modelo nombre="Producto"/>
    <controlador nombre="Typical"/>
    <controlador nombre="Productos"/>
</modulo>

Inicializando un módulo con una acción

<controlador nombre="Facturas2002">
    <accion nombre="iniciar" al-iniciar="true" oculta="true"
        clase="org.openxava.test.acciones.IniciarAñoDefectoA2002">
        <!-- <usa-objeto nombre="xavatest_añoDefecto"/> A partir de v4m2 podemos usar @Inject -->
        <!-- <usa-objeto nombre="xava_tab"/> A partir de v4m2 podemos usar @Inject -->
    </accion>
    ...
</controlador>

package org.openxava.test.acciones;
 
import javax.inject.*;
import org.openxava.actions.*;
import org.openxava.tab.*;
 
/**
 * @author Javier Paniza
 */
 
public class IniciarAñoDefectoA2002 extends BaseAction {
 
    @Inject  // A partir de v4m2, si no usamos <usa-objeto/>
    private int añoDefecto;
 
    @Inject  // A partir de v4m2, si no usamos <usa-objeto/>
    private Tab tab;
 
    public void execute() throws Exception {
        setAñoDefecto(2002);                              // 1
        tab.setTitleVisible(true);                        // 2
        tab.setTitleArgument(new Integer(2002));          // 3
    }
 
    public int getAñoDefecto() {
        return añoDefecto;
    }
 
    public void setAñoDefecto(int i) {
        añoDefecto = i;
    }
 
    public Tab getTab() {
        return tab;
    }
 
    public void setTab(Tab tab) {
        this.tab = tab;
    }
 
}

Llamar a otro módulo

<modulo nombre="FacturasDeClientes">
    <var-entorno nombre="XAVA_LIST_ACTION" valor="Facturas.listarDeCliente"/>  <!-- 1 -->
    <modelo nombre="Cliente"/>
    <controlador nombre="Print"/>
    <controlador nombre="ListOnly"/>                                           <!-- 2  Innecesario desde v6.0 -->
    <controlador-modo nombre="Void"/>                                          <!-- 3  Innecesario desde v6.0 -->
</modulo>

<controlador nombre="Facturas">
    <accion nombre="listarDeCliente" oculta="true"
        clase="org.openxava.test.acciones.ListarFacturasDeCliente">
        <!-- <usa-objeto nombre="xava_tab"/> A partir de v4m2 podemos usar @Inject -->
    </accion>
    ...
</controlador>

package org.openxava.test.acciones;
 
import java.util.*;
 
import javax.inject.*;
import org.openxava.actions.*;
import org.openxava.controller.*;
import org.openxava.tab.*;
 
/**
 * @author Javier Paniza
 */
public class ListarFacturasDeCliente extends BaseAction
    implements IChangeModuleAction,                                             // 1
               IModuleContextAction {                                           // 2
 
    private int row;                                                            // 3
    @Inject  // A partir de v4m2, si no usamos <usa-objeto/>
    private Tab tab;
    private ModuleContext context;
 
    public void execute() throws Exception {
        Map claveCliente = (Map) tab.getTableModel().getObjectAt(row);          // 4
        int codigoCliente = ((Integer) claveCliente.get("codigo")).intValue();
        Tab tabFacturas = (Tab)
            context.get("OpenXavaTest", getNextModule(), "xava_tab");           // 5
        tabFacturas.setBaseCondition("${cliente.codigo} = "+codigoCliente);     // 6
    }
 
    public int getRow() {                                                       // 3
        return row;
    }
    public void setRow(int row) {                                               // 3
        this.row = row;
    }
 
    public Tab getTab() {
        return tab;
    }
    public void setTab(Tab tab) {
        this.tab = tab;
    }
 
    public String getNextModule() {                                            // 7
        return "FacturasDeCliente";
    }
 
    public void setContext(ModuleContext context) {                            // 8
        this.context = context;
    }
 
    public boolean hasReinitNextModule() {                                     // 9
        return true;
    }
 
}

public class ListarFacturasDeCliente extends BaseAction
    implements IChangeModuleAction,
    //           IModuleContextAction { // Innecesario desde v4m1
 
    ...
    // private ModuleContext context; // Innecesario desde v4m1
 
    public void execute() throws Exception {
        ...
        Tab tabFacturas = (Tab)
          getContext().  // Puedes usar getContext() de BaseAction
              get("OpenXavaTest", getNextModule(), "xava_tab");
        ...
    }
    ...
    // public void setContext(ModuleContext context) {  // Not needed since v4m1
    //    this.context = context;
    // }
    ...
}

• Coge la clave del objeto asociada a la fila pulsada (4), para ello usa el tab del modulo actual.
• Accede al tab del módulo al que vamos usando context (5).
• Establece la condición base del tab del módulo al que vamos a ir (6) usando la clave obtenida del tab actual.

Mostrar una vista nueva (nuevo en v4m2)

public class VerClienteDesdeFactura extends ViewBaseAction {
 
    public void execute() throws Exception {
        try {
            Object codigo = getView().getValue("cliente.codigo"); // 1
            Map key = new HashMap();
            key.put("codigo", codigo);
            showNewView();                                        // 2
            getView().setModelName("Cliente");                    // 3
            getView().setValues(key);                             // 4
            getView().findObject();                               // 5
            getView().setKeyEditable(false);
            getView().setEditable(false);
            setControllers("Return");                             // 6
        }
        catch (ObjectNotFoundException ex) {
            getView().clear();
            addError("object_not_found");
        }
        catch (Exception ex) {
            ex.printStackTrace();
            addError("system_error");
        }
    }
 
}

Cambiar el modelo de la vista actual

public void execute() throws Exception {
    try {
        setValoresFactura(getView().getValues());                                // 1
        Object codigo = getView().getValue("producto.codigo");
        Map clave = new HashMap();
        clave.put("codigo", codigo);
        getView().setModelName("Producto");                                      // 2
        getView().setValues(clave);                                              // 3
        getView().findObject();                                                  // 4
        getView().setKeyEditable(false);
        getView().setEditable(false);
    }
    catch (ObjectNotFoundException ex) {
        getView().clear();
        addError("object_not_found");
    }
    catch (Exception ex) {
        ex.printStackTrace();
        addError("system_error");
    }
}

Ir a una página JSP

package org.openxava.test.acciones;
 
import org.openxava.actions.*;
 
/**
 * @author Javier Paniza
 */
 
public class MiAccionBuscar extends BaseAction implements INavigationAction {  // 1
 
    public void execute() throws Exception {
    }
 
    public String[] getNextControllers() {                                     // 2
        return new String [] { "MiReferencia" } ;
    }
 
    public String getCustomView() {                                            // 3
        return "quieresBuscar.jsp";
    }
 
    public void setKeyProperty(String s) {
    }
 
}

Generar un informe propio con JasperReports

package org.openxava.test.acciones;
 
import java.util.*;
 
import net.sf.jasperreports.engine.*;
import net.sf.jasperreports.engine.data.*;
 
import org.openxava.actions.*;
import org.openxava.model.*;
import org.openxava.test.model.*;
import org.openxava.util.*;
import org.openxava.validators.*;
 
/**
 * Informe de productos de la subfamilia seleccionada. <p>
 *
 * Usa JasperReports. <br>
 *
 * @author Javier Paniza
 */
public class InformeProductosDeFamiliaAction extends JasperReportBaseAction {  // 1
 
    private Subfamilia subfamilia;
 
    public Map getParameters() throws Exception  {                             // 2
        Messages errores =
            MapFacade.validate("FiltroPorSubfamilia", getView().getValues());
        if (errores.contains()) throw new ValidationException(errores);        // 3
        Map parametros = new HashMap();
        parametros.put("familia", getSubfamilia().getFamilia().getDescripcion());
        parametros.put("subfamilia", getSubfamilia().getDescripcion());
        return parametros;
    }
 
    protected JRDataSource getDataSource() throws Exception {                  // 4
        return new JRBeanCollectionDataSource(
            getSubfamilia().getProductosValues());
    }
 
    protected String getJRXML() {                                              // 5
        return "Productos.jrxml"; // Para leer del classpath
        //return "/home/javi/Products.jrxml"; // Para leer del sistema de ficheros
    }
 
    private Subfamilia getSubfamilia() throws Exception {
        if (subfamilia == null) {
            int codigoSubfamilia = getView().getValueInt("subfamilia.codigo");
            subfamilia = XPersistence.getManager().find(
                Subfamilia.class, codigoSubfamilia);
        }
        return subfamilia;
    }
 
}

• getParameters() (2): Un Map con los parámetros a enviar al informe, en este caso hacemos también la validación de los datos entrados (usando MapFacade.validate()) (3).
• getDataSource() (4): Un JRDataSource con los dato a imprimir. En este caso una colección de JavaBeans obtenidos llamando a un objeto modelo. Si usas EJB EntityBeans CMP2 sé cuidadoso y no hagas un bucle sobre una colección de EntityBeans EJB2 dentro de este método, como en este caso obtén los datos con una sola llamada EJB.
• getJRXML() (5): El XML con el diseño JasperReports, este archivo puede estar en el classpath. Deberías poner este archivo en src/main/resources/informes (nuevo en v7.0). En versiones anteriores a la 7 puedes tener para esto una carpeta de código fuente llamada informes en tu proyecto. Otra opción es poner este archivo en el sistema de ficheros (nuevo en v2.0.3), esto se consigue especificando la ruta completa del archivo, por ejemplo: /home/javi/Productos.jrxml o c:\\informes\\Productos.jrxml (empezar con una letra de unidad de windows es reconocido como ruta absoluta desde v3.0.3).

Cargar y procesar un fichero desde el cliente (AJAX) (nuevo en v6.2)

package com.tuempresa.tuaplicacion.modelo;

import java.time.*;
import org.apache.commons.fileupload.*;
import org.openxava.annotations.*;

public class MostrarFichero {
		
    @FileItemUpload(acceptFileTypes="text/plain", maxFileSizeInKb=200) // Since v6.6
    private FileItem fichero;
	
    private LocalDate fecha;

    public FileItem getFichero() {
        return fichero;
    }

    public void setFichero(FileItem fichero) {
        this.fichero = fichero;
    }

    public LocalDate getFecha() {
        return fecha;
    }

    public void setFecha(LocalDate fecha) {
        this.fecha = fecha;
    }

}

<modulo nombre="MostrarFichero">
	<modelo nombre="MostrarFichero"/>
	<controlador nombre="MostrarFichero"/>
</modulo>

<controlador nombre="MostrarFichero">
	<accion nombre="mostrarFichero"
		clase="com.tuempresa.tuaplicacion.acciones.AccionMostrarFichero"/>    
</controlador>

package com.tuempresa.tuaplicacion.acciones;

import java.time.*;
import org.apache.commons.fileupload.*;
import org.openxava.actions.*;

public class AccionMostrarFichero extends ViewBaseAction {

	public void execute() throws Exception {
		FileItem fichero = (FileItem) getView().getValue("fichero");
		LocalDate fecha = (LocalDate) getView().getValue("fecha");
		addMessage(fichero.getName() + " mostrado en: " + fecha);
		addMessage(fichero.getName() + " contenido: " + fichero.getString());
	}
	
}

public class CambiarImagen extends BaseAction implements ILoadFileAction {  // 1
    ...
    public void execute() throws Exception {                                // 2
        showDialog();                                                       // 3
    }
 
    public String[] getNextControllers() {                                  // 4
        return new String [] { "CargarImagen" };
    }
 
    public String getCustomView() {                                         // 5
        return "xava/editors/cambiarImagen";
    }
 
    public boolean isLoadFile() {                                           // 6
        return true;
    }
 
    ...
}

<%@ include file="../imports.jsp"%>
 
<jsp:useBean id="style" class="org.openxava.web.style.Style" scope="request"/>
 
<table>
<th align='left' class=<%=style.getLabel()%>>
<fmt:message key="introducir_nueva_imagen"/>
</th>
<td>
<input name = "nuevaImagen" class=<%=style.getEditor()%> type="file" size='60'/>
</td>
</table>

public class CargarImagen extends BaseAction
    implements INavigationAction, IProcessLoadedFileAction {          // 1
 
    private List fileItems;
    private View view;
    private String newImageProperty;
 
    public void execute() throws Exception {
        Iterator i = getFileItems().iterator();                       // 2
        while (i.hasNext()) {
            FileItem fi = (FileItem)i.next();                         // 3
            String fileName = fi.getName();
            if (!Is.emptyString(fileName)) {
                getView().setValue(getNewImageProperty(), fi.get());  // 4
            }
        }
    }
 
    public String[] getNextControllers() {
        return DEFAULT_CONTROLLERS;
    }
 
    public String getCustomView() {
        return DEFAULT_VIEW;
    }
 
    public List getFileItems() {
        return fileItems;
    }
 
    public void setFileItems(List fileItems) {                        // 5
        this.fileItems = fileItems;
    }
    ...
}

<controlador nombre="Collection">
    <accion nombre="new"
        clase="org.openxava.actions.CreateNewElementInCollectionAction"/>
    <accion nombre="hideDetail"                                           <!-- 1 -->
        clase="org.openxava.test.acciones.MiOcultarDetalle"/>
    <accion nombre="save"
        clase="org.openxava.actions.SaveElementInCollectionAction">
        <usa-objeto nombre="xava_view"/>  <!-- No obligatorio desde v4m2 -->
    </accion>
    <accion nombre="remove"
        clase="org.openxava.actions.RemoveElementFromCollectionAction">
        <usa-objeto nombre="xava_view"/>  <!-- No obligatorio desde v4m2 -->
    </accion>
    <accion nombre="edit"
        clase="org.openxava.actions.EditElementInCollectionAction">
        <usa-objeto nombre="xava_view"/>  <!-- No obligatorio desde v4m2 -->
    </accion>
    <accion nombre="view"
        clase="org.openxava.actions.EditElementInCollectionAction">
        <usa-objeto nombre="xava_view"/>  <!-- No obligatorio desde v4m2 -->
    </accion>
    <accion nombre="next" <!-- Nuevo desde v7.3 --> 
	imagen="next.gif" 
	icono="skip-next"
        clase="org.openxava.actions.EditElementInCollectionAction">
        <poner propiedad="openDialog" valor="false"/>  
	<poner propiedad="nextValue" valor="1"/>  
    </accion> 
    <accion nombre="previous" <!-- Nuevo desde v7.3 -->
	imagen="previous.gif" 
	icono="skip-previous"
        clase="org.openxava.actions.EditElementInCollectionAction">
        <poner propiedad="openDialog" valor="false"/>  
	<poner propiedad="nextValue" valor="-1"/>  
    </accion> 
</controlador>

<controlador nombre="Direccion">
    <accion nombre="anadirDireccionCompleta"
        clase="org.openxava.test.acciones.IrAnadirDireccionCompleta"/>
</controlador>

public class IrAnadirDireccionCompleta extends ViewBaseAction {           // 1
 
    public void execute() throws Exception {
        showDialog();                                                     // 2
        getView().setTitleId("introduce_direccion_completa");             // 3
        // getView().setTitle("Introduce la dirección completa");         // 4
        getView().setModelName("DireccionUnaLinea");                      // 5
        setControllers("AnadirDireccionCompleta", "Dialog");              // 6
        // addActions("AnadirDireccionCompleta.anadir", "Dialog.cancel"); // 7
    }
 
}

public class DireccionUnaLinea {
 
    private String direccionCompleta;
 
    public String getDireccionCompleta() {
        return direccionCompleta;
    }
 
    public void setDireccionCompleta(String direccionCompleta) {
        this.direccionCompleta = direccionCompleta;
    }
 
}

<controlador nombre="AnadirDireccionCompleta">
    <accion nombre="anadir"
        clase="org.openxava.test.acciones.AnadirDireccionCompleta"/>
</controlador>

public class AnadirDireccionCompleta extends ViewBaseAction {
 
    public void execute() throws Exception {
        String direccionCompleta = getView().getValueString("direccionCompleta"); // 1
        String [] trozos = direccionCompleta.split(" ");
        View vistaDireccion = getPreviousView().getSubview("direccion");          // 2
        String [] propiedades = { "provincia.id", "municipio", "codigoPostal", "viaPublica" };
        int iTrozos = trozos.length;
        for (int iPropiedades = 0; iPropiedades < 4 && iTrozos > 0; iPropiedades++) {
            vistaDireccion.setValue(propiedades[iPropiedades], trozos[--iTrozos]);
        }
        StringBuffer viaPublica = new StringBuffer();
        for (int i = 0; i <= iTrozos; i++) {
            street.append(trozos[i]);
            street.append(' ');
        }
        addressView.setValue("viaPublica", viaPublica.toString().trim());
 
        closeDialog();                                                           // 3
   }
 
}

<controlador nombre="Direccion">
 
    <accion nombre="anadirDireccionCompleta"
        mostrar-dialogo="true"                     <!-- 1 -->
        clase="org.openxava.test.acciones.IrAnadirDireccionCompleta">
        <usa-objeto nombre="xava_view"/>           <!-- 2 -->
        <usa-objeto nombre="xava_previousViews"/>  <!-- 3 -->
    </accion>
 
</controlador>

public class IrAnadirDireccionCompleta
    extends ViewBaseAction                                        // 1
    implements IChangeControllersAction {                         // 2
 
    public void execute() throws Exception {
        showNewView();                                            // 3
        getView().setTitleId("introduce_direccion_completa");     // 4
        // getView().setTitle("Introduce la dirección completa");
        getView().setModelName("DireccionUnaLinea");              // 5
    }
 
    public String[] getNextControllers() throws Exception {
        return new String [] { "AnadirDireccionCompleta" };       // 1
    }
 
}

public class DireccionUnaLinea {
 
    private String direccionCompleta;
 
    public String getDireccionCompleta() {
        return direccionCompleta;
    }
 
    public void setDireccionCompleta(String direccionCompleta) {
        this.direccionCompleta = direccionCompleta;
    }
 
}

<controlador nombre="AnadirDireccionCompleta">
 
    <accion nombre="anadir" ocultar-dialogo="true"  <!-- 1 -->
        clase="org.openxava.test.acciones.AnadirDireccionCompleta">
        <usa-objeto nombre="xava_previousViews"/>   <!-- 2 -->
        <usa-objeto nombre="xava_view"/>
    </accion>
 
    <accion nombre="cancelar"                       <!-- 3 -->
        clase="org.openxava.actions.CancelAction">
        <usa-objeto nombre="xava_previousViews"/>   <!-- 2 -->
        <usa-objeto nombre="xava_view"/>
    </accion>
 
</controlador>

public class AnadirDireccionCompleta extends ViewBaseAction {
 
    public void execute() throws Exception {
        String direccionCompleta = getView().getValueString("direccionCompleta"); // 1
        String [] trozos = direccionCompleta.split(" ");
        View vistaDireccion = getPreviousView().getSubview("direccion");          // 2
        String [] propiedades = { "provincia.id", "municipio", "codigoPostal", "viaPublica" };
        int iTrozos = trozos.length;
        for (int iPropiedades = 0; iPropiedades < 4 && iTrozos > 0; iPropiedades++) {
            vistaDireccion.setValue(propiedades[iPropiedades], trozos[--iTrozos]);
        }
        StringBuffer viaPublica = new StringBuffer();
        for (int i = 0; i <= iTrozos; i++) {
            street.append(trozos[i]);
            street.append(' ');
        }
        addressView.setValue("viaPublica", viaPublica.toString().trim());
 
        returnToPreviousView();                                                  // 3
   }
 
}

Sobrescribir acción de ir a lista

<modulo nombre="Autor">
	<modelo nombre="Autor"/> 
	<controlador nombre="Typical"/>
	<controlador-modo nombre="MiIrModoLista"/>
</modulo>        

<controlador nombre="MiIrModoLista">
	<hereda-de controlador="Mode"/>
	<accion nombre="list"
		icono="chevron-left"
		clase="org.openxava.test.acciones.IrModoLista"
		atajo-de-teclado="F9"/>
</controlador>

package org.openxava.test.acciones;

import org.openxava.actions.*;

public class IrModoLista extends GoListAction {
	
	public void execute() throws Exception {
		super.execute();
		addMessage("volvemos_a_lista"); 
	}

}

Todos los tipos de acciones

• IAction: Interfaz básica que obligatoriamente ha de implementar toda acción.
• IAvailableAction: (Nuevo en v5.9) La acción puede estar disponible para el usuario u oculta, dependiendo de una condición programática.
• IChainAction: Permite encadenar acciones, es decir que cuando se termine de ejecutar nuestra acción ejecute otra inmediatamente.
• IChainActionWithArgv: (Nuevo en v2.2) Es un refinamiento de IChainAction. Permite enviar como argumentos valores para llenar las propiedades de la acción encadenada antes de ejecutarla.
• IChangeControllersAction: Para cambiar los controladores (y por ende las acciones) disponible al usuario. Nuevo en v4m2: Puedes usar los métodos setControllers(), returnToPreviousControllers(), setDefaultControllers(), addActions(), removeActions() and clearActions() de BaseAction en lugar de implementar directamente esta interfaz.
• IChangeModeAction: Para cambiar de modo, de lista a detalle o viceversa. Nuevo en v4m1: Puedes usar el método setNextMode() de BaseAction en lugar de implementar directamente esta interfaz.
• IChangeModuleAction: Para cambiar de módulo.
• ICustomViewAction: Para que la vista sea una página JSP propia.
• IForwardAction: Redirecciona a una URI interna en la misma aplicación, como un JSP o un Servlet, o a una URL absoluta en internet (URL absoluta nuevo en v4m1). No es como ICustomViewAction, ICustomViewAction hace que la vista que está dentro de nuestro interfaz generado con OpenXava (que a su vez puede estar dentro de un portal) sea nuestro JSP, mientras que IForwardAction redirecciona de forma completa a la URI indicada.
• IHideActionAction, IHideActionsAction: Permite ocultar una acción o un conjunto de acciones en la interfaz de usuario (nuevo en v2.0). Nuevo en v4m2: Puedes usar los métodos removeActions() and clearActions() de BaseAction en lugar de implementar directamente estas interfaces. Otra alternativa para ocultar y mostrar acciones es que la acción a ocultar implemente IAvailableAction (nuevo en v5.9).
• IJavaScriptPostAction: Ejecuta código JavaScript después de la ejecución normal de la acción.
• IJDBCAction: Permite usar directamente JDBC en una acción. Recibe un IConnectionProvider. Funciona de forma parecida a un IJDBCCalculator (ver capítulo 3).
• ILoadFileAction: Permite navegar a una vista con la posibilidad de cargar un archivo.
• IModelAction: Una acción que recibe el nombre del modelo.
• IModuleContextAction: Recibe un ModuleContext para poder acceder a objetos de sesión de otros módulos, por ejemplo. Nuevo en v4m1: Puedes usar el método getContext() de BaseAction en lugar de implementar directamente esta interfaz.
• IMultipleForwardAction: (Nuevo en v4.3) Redirecciona a varias URIs internas en la misma aplicación, como JSPs o Servlets; o a varias URLs absolutas en internet.
• INavigationAction: Extiende de IChangeControllersAction y ICustomViewAction.
• IOnChangePropertyAction: Este interfaz lo ha de implementar las acciones que reaccionan a un cambio de valor de propiedad en la interfaz gráfica.
• IProcessLoadedFileAction: Procesa una lista de archivos cargados desde el cliente al servidor.
• IPropertyAction: Esta accíon está asociada a una propiedad (visualizada en la interfaz de usuario), antes de ejecutarla el nombre de la propiedad y la vista contenedora son inyectados (nuevo en in v2.0.2).
• IRequestAction: Recibe un request de Servlets. Hace que nuestras acciones se vinculen a la tecnología de servlets/jsp, por lo que es mejor evitarla. Pero a veces es necesario cierta flexibilidad. Nuevo en v4m1: Puedes usar el método getRequest() de BaseAction en lugar de implementar directamente esta interfaz.
• IShowActionAction, IShowActionsAction: Permite mostrar una acción o un grupo de acciones previamente ocultadas en una IHideAction(s)Action (nuevo en v2.0). Nuevo en v4m2: Puedes usar el método addActions() de BaseAction en lugar de implementar directamente estas interfaces. Otra alternativa para ocultar y mostrar acciones es que la acción a mostrar implemente IAvailableAction (nuevo en v5.9).