openxava / documentación / Vista

Disposición

@View(
 name="nombre", // 1
 members="miembros", // 2
 extendsView="view" // 3 Nuevo en v3.1.2
)
public class MiEntidad {

1. name (opcional): El nombre identifica a la vista, y puede ser usado desde otro lugares de OpenXava (por ejemplo desde aplicacion.xml) o desde otra entidad. Si no se pone nombre se asume que es la vista por defecto, es decir la forma normal de visualizar el objeto. Si el nombre es Simple o Search esta vista se usará por defecto para crear el diálogo de búsqueda (desde v4m4).
2. members (opcional): Indica los miembros que tienen que salir y como tienen que estar dispuestos en la interfaz gráfica. Por defecto visualiza todos los miembros no ocultos en el orden en que están declarados en el modelo. Dentro de miembros podemos usar los elementos seccion y grupo para indicar la disposición; o el elemento accion para mostrar un vínculo asociado a una acción propia dentro de la vista.
3. extendsView (opcional): (Nuevo en v3.1.2) Todos los miembros en la vista extendsView se incluyen automáticamente en la actual. Véase herencia de vistas.

@Entity
@IdClass(OficinistaKey.class)
public class Oficinista {
 
 @Id @Required
 @Column(length=3, name="ZONA")
 private int codigoZona;
 
 @Id @Required
 @Column(length=3, name="OFICINA")
 private int codigoOficina;
 
 @Id @Required
 @Column(length=3, name="CODIGO")
 private int codigo;
 
 @Required @Column(length=40)
 private String nombre;
 
 // Getters and setters
 ...
 
 }

@Entity
@IdClass(OficinistaKey.class)
@View(members="codigoZona; codigoOficina; codigo")
public class Oficinista {
 

@View(members=
 "codigoZona, codigoOficina, codigo;" +
 "nombre"
)
 

Grupos

@View(members=
 "id [ codigoZona, codigoOficina, codigo ];" +
 "nombre"
)
 

@View(members=
 "general [" +
 " codigo;" +
 " tipo;" +
 " nombre;" +
 "]" +
 "contacto [" +
 " telefono;" +
 " correoElectronico;" +
 " sitioWeb;" +
 "]"
)

@View(members=
 "general [" +
 " codigo;" +
 " tipo;" +
 " nombre;" +
 "];" +
 "contacto [" +
 " telefono;" +
 " correoElectronico;" +
 " sitioWeb;" +
 "]"
)

@View(members=
 "factura;" +
 "datosAlbaran [" +
 " tipo, codigo;" +
 " fecha;" +
 " descripcion;" +
 " envio;" +
 " datosTransporte [" +
 " distancia; vehiculo; modoTransporte; tipoConductor;" +
 " ]" +
 " datosEntregadoPor [" +
 " entregadoPor;" +
 " transportista;" +
 " empleado;" +
 " ]" +
 "]"
)

@View(name="Amounts", members=
 "año, numero;" +
 "importes [" +
 "descuentoCliente, descuentoTipoCliente, descuentoAño;" +
 "sumaImportes, porcentajeIVA, iva;" +
 "]"
)
 

@View(name="Amounts", members=
 "año, numero;" +
 "importes [#" +
 "descuentoCliente, descuentoTipoCliente, descuentoAño;" +
 "sumaImportes, porcentajeIVA, iva;" +
 "]"
)

Secciones

@View(members=
 "año, numero, fecha, pagada;" +
 "comentario;" +
 "cliente { cliente }" +
 "lineas { lineas }" +
 "importes { sumaImportes; porcentajeIVA; iva }" +
 "albaranes { albaranes }"
)

@View(name="SeccionesAnidadas", members=
 "año, numero, fecha;" +
 "cliente { cliente }" +
 "datos {" +
 " lineas { lineas }" +
 " importes {" +
 " iva { porcentajeIVA; iva }" +
 " sumaImportes { sumaImportes }" +
 " }" +
 "}" +
 "albaranes { albaranes }"
)

@View(name="ImportesAlineadosEnSeccion", members=
 "año, numero;" +
 "cliente { cliente }" +
 "lineas { lineas }" +
 "importes {#" +
 "descuentoCliente, descuentoTipoCliente, descuentoAño;" +
 "sumaImportes, porcentajeIVA, iva;" +
 "}"
)

Herencia de vistas (nuevo en v3.1.2)

@View(name="MuySimple", members="nombre, sexo"),

@View(name="Simple", extendsView="MuySimple", members="lenguajePrincipal")

@Entity
@View(name="ConSecciones",
 members =
 "nombre, sexo;" +
 "lenguajePrincipal;" +
 "experiencias { experiencias }"
)
public class Programador {

@Entity
@View(name="ConSecciones", extendsView="super.ConSecciones",
 members =
 "marcoTrabajoFavorito;" +
 "marcosTrabajo { marcosTrabajo }"
)
public class ProgramadorJava extends Programador {

@View(members="nombre, sexo; lenguajePrincipal, marcoTrabajoFavorito; experiencias")
@View(name="Completa", extendsView="DEFAULT", members = "marcosTrabajo")

Disposición adaptable (nuevo en v5.7)

flowLayout=true

@View( members=
    "#numero, descripcion;" +
    "color, fotos;" +
    "familia, subfamilia;" +
    "almacen, zonaUno;" +
    "precioUnitario, precioUnitarioEnPesetas;" +
    "precioUnitarioConImpuestos"
)

Filosofía para la disposición

Normas para las anotaciones de vista

@Entity
@View( members="codigo; tipo; nombre; direccion" )
@View( name="A", members="codigo; tipo; nombre; direccion; comercial" )
@View( name="B", members="codigo; tipo; nombre; comercial; comercialAlternativo" )
@View( name="C", members="codigo; tipo; nombre; direccion; lugaresEntrega" )
public class Cliente {

@Entity
@Views({ // Sólo necesario hasta v6.0.2
  @View( members="codigo; tipo; nombre; direccion" ),
  @View( name="A", members="codigo; tipo; nombre; direccion; comercial" ),
  @View( name="B", members="codigo; tipo; nombre; comercial; comercialAlternativo" ),
  @View( name="C", members="codigo; tipo; nombre; direccion; lugaresEntrega" )
})
public class Cliente {

@ReadOnly
private String nombre;

@ReadOnly(forViews="B, C")
private String nombre;

@ReadOnly(notForViews="DEFAULT, A")
private String nombre;

@ReferenceView("Simple")
private Comercial comercial;

@ReferenceView(forViews="B", value="Simple")
private Comercial comercial;

@ReferenceView(forViews="B", value="Simple"),
@ReferenceView(forViews="A", value="MuySimple")

@ReferenceViews({ // Sólo necesario hasta v6.0.2
  @ReferenceView(forViews="B", value="Simple"),
  @ReferenceView(forViews="A", value="MuySimple")
})

Personalización de propiedad

@ReadOnly // 1
@LabelFormat // 2
@DisplaySize // 3
@OnChange // 4
@Action // 5
@Editor // 6
@LabelStyle // 7 Nuevo en v4m4
private tipo nombrePropiedad;

1. @ReadOnly (OX): Si marcas una propiedad con esta anotaciones no será nunca editable por el usuario en esta vista. Una alternativa a esto es hacer la propiedad editable/no editable programáticamente usando org.openxava.view.View. Desde v6.2 puedes especificar @ReadOnly(onCreate=false) para que la propiedad sea editable al crear una nueva entidad, pero de sólo lectura en el resto de casos.
2. @LabelFormat (OX): Forma en que se visualiza la etiqueta para esta propiedad. Su valor puede ser LabelFormatType.NORMAL, LabelFormatType.SMALL o LabelFormatType.NO_LABEL.
3. @DisplaySize (OX): La longitud en caracteres del editor en la interfaz de usuario usado para visualizar esta propiedad. El editor mostrará solo los caracteres indicados con longitud-visual pero permite que el usuario introduzca hasta el total de la longitud de la propiedad. Si @DisplaySize no se especifica se asume el valor de la longitud de la propiedad.
4. @OnChange (OX): Acción a realizar cuando cambia el valor de esta propiedad. Solo una acción @OnChange por vista está permitida.
5. @Action (OX): Acciones (mostradas como vínculos, botones o imágenes al usuario) asociadas (visualmente) a esta propiedad y que el usuario final puede ejecutar. Es posible definir varias @Action por cada vista.
6. @Editor (OX): Nombre del editor a usar para visualizar la propiedad en esta vista. El editor tiene que estar declarado en openxava/src/main/resources/xava/default-editors.xml o src/main/resources/xava/editores.xml de nuestro proyecto. Antes de v7 eran OpenXava/xava/default-editors.xml y xava/editores.xml de nuestro proyecto.
7. @LabelStyle (OX): (Nuevo en v4m4): Estilo con el que se visualiza la etiqueta para esta propiedad. Por defecto están definidos los estilos 'bold-label', 'italic-label' y 'reverse-label'; cualquier otro estilo puede ser definido por el propio usuario (basta con incluirlo en un .css).

Formato de etiqueta

@LabelFormat(LabelFormatType.SMALL)
private int codigoPostal;

Evento de cambio de valor de propiedad

@OnChange(AlCambiarNombreCliente.class)
private String nombre;

package org.openxava.test.actions;
 
import org.openxava.actions.*;
import org.openxava.test.model.*;
 
/**
 * @author Javier Paniza
 */
public class AlCambiarNombreCliente extends OnChangePropertyBaseAction { // 1
 
 public void execute() throws Exception {
 String valor = (String) getNewValue(); // 2
 if (valor == null) return;
 if (valor.startsWith("Javi")) {
 getView().setValue("tipo", Cliente.Tipo.FIJO); // 3
 }
 }
 
}

Acciones de la propiedad

@Action("Albaran.generarNumero")
private int numero;

<controlador nombre="Albaran">
 ...
 <accion nombre="generarNumero" oculta="true"
 clase="org.openxava.test.acciones.GenerarNumeroAlbaran">
 <usa-objeto nombre="xava_view"/> <!-- No obligatorio desde v4m2 -->
 </accion>
 ...
</controlador>

@Action(value="Albaran.generarNumero", alwaysEnabled=true)

package org.openxava.test.acciones;
 
import org.openxava.actions.*;
 
/**
 * @author Javier Paniza
 */
public class GenerarNumeroAlbaran extends ViewBaseAction {
 
 public void execute() throws Exception {
 getView().setValue("numero", new Integer(77));
 }
 
}

package org.openxava.test.acciones;
 
import org.openxava.actions.*;
import org.openxava.view.*;
 
/**
 * @author Javier Paniza
 */
public class GenerarNumeroAlbaran
 extends BaseAction
 implements IPropertyAction { // 1
 private View view;
 private String property;
 
 public void execute() throws Exception {
 view.setValue(property, new Integer(77)); // 2
 }
 
 public void setProperty(String property) { // 3
 this.property = property;
 }
 public void setView(View view) { // 4
 this.view = view;
 }
}

Escoger un editor (propiedad)

@Editor(forViews="TipoConRadioButton", value="ValidValuesRadioButton")
private Tipo tipo;
public enum Tipo { NORMAL, FIJO, ESPECIAL };

<editor name="ValidValuesRadioButton" url="radioButtonEditor.jsp"/>

Combos dinámicos (nuevo en v5.8)

private String color;

getView().addValidValue("color", "blc", "Blanco");
getView().addValidValue("color", "ngr", "Negro");

@Editor("EditableValidValues")
@Column(length = 15)
private String color;

Personalización de referencia

@ReferenceView       // 1
@ReadOnly            // 2
@NoFrame             // 3
@NoCreate            // 4
@NoModify            // 5
@NoSearch            // 6
@AsEmbedded          // 7
@SearchAction        // 8
@SearchListCondition // 9 Nuevo en v4m4
@DescriptionsList    // 10
@LabelFormat         // 11
@Action              // 12
@OnChange            // 13
@OnChangeSearch      // 14
@Editor              // 15 Nuevo en v3.1.3
@LabelStyle          // 16 Nuevo en v4m4
@Collapsed           // 17 Nuevo en v5.0
@ManyToOne
private tipo nombreReferencia;

1. @ReferenceView (OX): Si omitimos esta anotación usa la vista por defecto del objeto referenciado para visualizarlo, con este anotación podemos indicar que use otra vista.
2. @ReadOnly (OX): Si usamos esta anotación esta referencia no será nunca editable por el usuario en esta vista. Una alternativa a esto es hacer la propiedad editable/no editable programáticamente usando org.openxava.view.View. Desde v6.2 puedes especificar @ReadOnly(onCreate=false) para que la referencia sea editable al crear una nueva entidad, pero de sólo lectura en el resto de casos.
3. @NoFrame (OX): El dibujador de la interfaz gráfica usa un marco para envolver todos los datos de la referencia. Con esta anotación se puede indicar que no se use ese marco.
4. @NoCreate (OX): Por defecto el usuario tiene opción para crear un nuevo objeto del tipo referenciado. Con esta anotación anulamos esta posibilidad.
5. @NoModify (OX): Por defecto el usuario tiene opción para modificar el objeto actualmente referenciado. Con esta anotación anulamos esta posibilidad.
6. @NoSearch (OX): Por defecto el usuario tiene un vínculo para poder realizar búsquedas con una lista, filtros, etc. Con esta anotación anulamos esta posibilidad.
7. @AsEmbedded (OX): Por defecto en el caso de una referencia a una clase incrustable el usuario puede crear y editar sus datos, mientras que en el caso de una referencia a una entidad el usuario escoge una entidad existente. Si ponemos @AsEmbedded entonce la interfaz de usuario para referencias a entidad se comporta como en el caso de los incrustados, permitiendo al usuario crear un nuevo objeto y editar sus datos directamente. No tiene efecto en el caso de una referencia a un objeto incrustado. ¡Ojo! Si borramos una entidad sus entidades referenciadas no se borran, incluso si estamos usando @AsEmbedded.
8. @SearchAction (OX): Nos permite especificar nuestra propia acción de búsqueda cuando se pulsa al vínculo de buscar. Solo es posible una por vista.
9. @SearchListCondition (OX): (Nuevo en v4m4) Condición a usar para la lista de elementos seleccionable susceptibles de ser asignados a la referencia.
10. @DescriptionsList (OX): Permite visualizar los datos como una lista descripciones, típicamente un combo. Práctico cuando hay pocos elementos del objeto referenciado.
11. @LabelFormat (OX): Formato de la etiqueta de la referencia. Solo aplica si esta referencia se ha anotado con @DescriptionsList. Funciona como en el caso de las propiedades.
12. @Action (OX): Acciones (mostradas como vínculos, botones o imágenes al usuario) asociadas (visualmente) a esta referencia y que el usuario final puede ejecutar. Funciona como en el caso de las propiedades. Podemos definir varias acciones a la misma referencia en una vista.
13. @OnChange (OX): Acción a realizar cuando cambia el valor de esta propiedad. Solo una acción @OnChange por vista está permitida.
14. @OnChangeSearch (OX): Nos permite especificar nuestra propia acción de búsqueda cuando el usuario teclea una clave nueva. Solo es posible una por vista.
15. @Editor (OX): (Nuevo en v3.1.3) Nombre del editor a usar para visualizar la referencia en esta vista. El editor tiene que estar declarado en openxava/src/main/resources/xava/default-editors.xml o src/main/resources/xava/editores.xml de nuestro proyecto. Antes de v7 eran OpenXava/xava/default-editors.xml y xava/editores.xml de nuestro proyecto.
16. @LabelStyle (OX): (Nuevo en v4m4): Estilo de la etiqueta de la referencia. Solo aplica si esta referencia se ha anotado con @DescriptionsList. Funciona como en el caso de las propiedades.
17. @Collapsed (OX): (Nuevo en v5.0) La referencia se mostrará contraída para las vistas indicadas. Visualmente significa que el marco que rodea a la vista de la referencia se iniciará cerrado. Más tarde el usuario podrá establecer sus preferencias haciendo clic en el icono de expansión.

@ManyToOne
private Familia familia;

Escoger vista

@ManyToOne(fetch=FetchType.LAZY)
@ReferenceView("Simple")
private Factura factura;

@Entity
@Views({
 ...
 @View(name="Simple", members="año, numero, fecha, descuentoAño;"),
 ...
})
public class Factura {

Personalizar el enmarcado

@View( members=
 ...
 "comercial [" +
 " comercial; " +
 " relacionConComercial;" +
 "]" +
 ...
)
public class Cliente {
 ...
 @ManyToOne(fetch=FetchType.LAZY)
 @NoFrame
 private Comercial comercial;
 ...
}

Acción de búsqueda propia

@ManyToOne(fetch=FetchType.LAZY) @SearchAction("MiReferencia.buscar")
private Comercial comercial;

<controlador nombre="MiReferencia">
 <accion nombre="buscar" oculta="true"
 clase="org.openxava.test.acciones.MiAccionBuscar"
 imagen="images/search.gif">
 <usa-objeto nombre="xava_view"/> <!-- No obligatorio desde v4m2 -->
 <usa-objeto nombre="xava_referenceSubview"/> <!-- No obligatorio desde v4m2 -->
 <usa-objeto nombre="xava_tab"/> <!-- No obligatorio desde v4m2 -->
 <usa-objeto nombre="xava_currentReferenceLabel"/> <!-- No obligatorio desde v4m2 -->
 </accion>
 ...
</controlador>

package org.openxava.test.acciones;
 
import org.openxava.actions.*;
 
/**
 * @author Javier Paniza
 */
 
public class MiAccionBuscar extends ReferenceSearchAction {
 
 public void execute() throws Exception {
 super.execute(); // El comportamiento por defecto para buscar
 getTab().setBaseCondition("${codigo} < 3"); // Añadir un filtro a la lista
 }
 
}

Condición para la lista de búsqueda (referencia, nuevo en v4m4)

@ManyToOne(fetch=FetchType.LAZY) @SearchListCondition("${codigo} < 3")
private Comercial comercial;
 

Acción de creación propia

<!--
Puesto que su nombre es AlmacenCreation (nombre modelo + Creation) es usado
por defecto para crear desde referencias, en vez de NewCreation.
La accion 'new' es ejecutada automáticamente.
-->
<controlador nombre="AlmacenCreation">
 <hereda-de controlador="NewCreation"/>
 <accion nombre="new" oculta="true"
 clase="org.openxava.test.actions.CrearNuevoAlmacenDesdeReferencia">
 <usa-objeto nombre="xava_view"/> <!-- No obligatorio desde v4m2 -->
 </accion>
</controlador>

Acción de modificación propia

<!--
Dado que su nombre es AlmacenModification (nombre modelo + Modification) es usado
por defecto para modificar desde referencias, en lugar de Modification.
La acción 'search' se ejecuta automáticamente.
-->
<controlador nombre="AlmacenModification">
 <hereda-de controlador="Modification"/>
 <accion nombre="search" oculta="true"
 clase="org.openxava.test.actions.ModificarAlmacenDesdeReferencia">
 <usa-objeto nombre="xava_view"/> <!-- No obligatorio desde v4m2 -->
 </accion>
</controlador>

Lista descripciones (combos)

@DescriptionsList(
  descriptionProperties="propiedades",  // 1
  depends="depende de",                 // 2
  condition="condición",                // 3
  orderByKey="true|false",              // 4
  order="orden"                         // 5
  filtro="clase del filtro"             // 6 Nuevo en v6.4
  showReferenceView="true|false",       // 7 Nuevo en v5.5
  forTabs="tab1,tab2,...",              // 8 Nuevo en v4m4
  notForTabs="tab1,tab2,..."            // 9 Nuevo en v4m4
)

1. descriptionProperties (opcional): Indica que propiedad o propiedades tienen que aparecer en la lista, si no se especifica asume la propiedad description, descripcion, name o nombre (desde v7.1 puedes especificar tus propias propiedades por defecto añadiendo la entrada defaultDescriptionPropertiesValueForDescriptionsList en xava.properties). Si el objeto referencia no tiene ninguna propiedad llamada así entonces es obligado especificar aquí un nombre de propiedad. Permite poner una lista de propiedades separadas por comas. Al usuario le aparecen concatenadas.
2. depends (opcional): Se usa junto con condition para hacer que el contenido de la lista dependa de los valores de otros miembros visualizados en la vista principal (si simplemente ponemos los nombres de los miembro) o en la misma vista (si ponemos this. delante de los nombres de los miembros). Para usar más de un miembro sepáralos con comas.
3. condition (opcional): Permite poner una condición (al estilo SQL) para filtrar los valores que aparecen en la lista de descripciones.
4. orderByKey (opcional): Por defecto los datos salen ordenados por descripción, pero si ponemos está propiedad a true saldrán ordenados por clave.
5. order (opcional): Permite poner un orden (al estilo SQL) para los valores que aparecen en la lista de descripciones.
6. filter (opcional): (Nuevo en v6.4) Permite definir la lógica para rellenar los valores de los parametros usados en la condición (los ?). Tiene que implementar IFilter y puedes usar aquí los mismos filtros usadado para @Tab.
7. showReferenceView (opcional): (Nuevo en v5.5) Muestra un combo y una vista detalle de la referencia al mismo tiempo. La vista de la referencia es de solo lectura y sus valores cambian cuando el usuario cambia el combo. La vista usada es la que se especifica en @ReferenceView. El valor por defecto es false.
8. forTabs (opcional): (Nuevo en v4m4) Permite poner una lista de nombres de tabs entre comas. Si alguna de las propiedades de descriptionProperties se pone en alguno de esos tabs la propiedad se visualizará como una lista de descripciones para seleccionar en la parte del filtro.
9. notForTabs (opcional): (Nuevo en v4m4) Permite poner una lista de nombres de tabs entre comas. Si alguna de las propiedades de descriptionProperties se pone en alguno de esos tabs la propiedad continuará visualizarándose como una propiedad plana en la parte del filtro.

@ManyToOne(fetch=FetchType.LAZY)
@DescriptionsList
private Almacen almacen;

@ManyToOne(fetch=FetchType.LAZY)
@DescriptionsList(orderByKey=true) // 1
private Familia familia;
 
@ManyToOne(fetch=FetchType.LAZY) @NoCreate // 2
@DescriptionsList(
 descriptionProperties="descripcion", // 3
 depends="familia", // 4
 condition="${familia.codigo} = ?" // 5
 order="${descripcion} desc" // 6
 )
private Subfamilia subfamilia;

@Entity @Getter @Setter
@IdClass(AlmacenKey.class)
public class Almacen {

    @Id 
    int codigoZona;

    @Id 
    int codigo;

    @Column(length=40) @Required
    String nombre;

}

@ManyToOne
@DescriptionsList
Warehouse almacenPrincipal;
	
@ManyToOne
@DescriptionsList(
    depends="almacenPrincipal", 
    condition="${almacen.codigoZona} = ? and ${almacen.codigo} = ?") 
    // condition="${almacen} = ?" // A partir de v6.6.3
Carrier transportistaDefecto;

@DescriptionsList(
    depends="familia", 
    // condition="${familia.codigo} = ?" // Forma clásica
    condition="${familia} = ?" // A partir de v6.6.3
)

@DescriptionsList( descriptionProperties="nombre",
 condition="${familia.nivel.descripcion} = 'TOPE'"
)
private Subfamilia subfamilia;

@DescriptionsList(
 condition="e.cosa.codigo = (SELECT c.codigo FROM Cosa c WHERE c.nombre = 'COCHE')"
)
private Subfamilia subfamilia;

@ManyToOne(fetch=FetchType.LAZY)
@ReadOnly
@DescriptionsList(descriptionProperties="nivel.descripcion, nombre")
private Comercial comercialAlternativo;
 

@ManyToOne(fetch=FetchType.LAZY)
@DescriptionsList(showReferenceView=true) // Combo y vista al mismo tiempo
@ReferenceView("Simple") // Esta será la vista usada
private Comercial comercial;

public class OnChangeStateConditionInCity extends OnChangePropertyBaseAction {
    public void execute() throws Exception{
        String value = (String)getNewValue();
        String condition = "";
        if ( Is.empty(value)) condition = "1=1";
        else condition = "upper(name) like '%" + value + "%'";
        getView().setDescriptionsListCondition("state", condition);    // modificamos la condición del combo 'state'
    }
}

Evento de cambio de valor de referencia

@ManyToOne(fetch=FetchType.LAZY)
@OnChange(AlCambiarTransportistaEnAlbaran.class)
private Transportista transportista;
 

package org.openxava.test.acciones;
 
import org.openxava.actions.*;
 
/**
 * @author Javier Paniza
 */
public class AlCambiarTransportistaEnAlbaran
 extends OnChangePropertyBaseAction { // 1
 
 public void execute() throws Exception {
 if (getNewValue() == null) return;
 getView().setValue("observaciones",
 "El transportista es " + getNewValue());
 addMessage("transportista_cambiado");
 }
 
}

Búsqueda de referencia al cambiar

@ManyToOne(fetch=FetchType.LAZY)
@OnChangeSearch(BuscarAlCambiarSubfamilia.class)
private Subfamilia subfamilia;

package org.openxava.test.acciones;
 
import org.openxava.actions.*;
 
/**
 *
 * @author Javier Paniza
 */
public class BuscarAlCambiarSubfamilia
 extends OnChangeSearchAction { // 1
 
 public void execute() throws Exception {
 if (getView().getValueInt("codigo") == 0) {
 getView().setValue("codigo", new Integer("1"));
 }
 super.execute();
 }
 
}
 

Escoger un editor (referencia, nuevo in v3.1.3)

@ManyToOne(fetch=FetchType.LAZY)
@Editor("ColorBotonesRadiales")
private Color color;

<editor nombre="ColorBotonesRadiales" url="colorBotonesRadialesEditor.jsp"/>

Personalización de colección

@CollectionView         //  1
@ReadOnly               //  2
@EditOnly               //  3
@NoCreate               //  4
@NoModify               //  5
@AsEmbedded             //  6
@ListProperties         //  7
@RowStyle               //  8
@EditAction             //  9
@ViewAction             // 10
@NewAction              // 11
@AddAction              // 12 Nuevo en v5.7
@SaveAction             // 13
@HideDetailAction       // 14
@RemoveAction           // 15
@RemoveSelectedAction   // 16
@ListAction             // 17
@RowAction              // 18 Nuevo en v4.6
@DetailAction           // 19
@OnSelectElementAction  // 20 Nuevo en v3.1.2
@Editor                 // 21 Nuevo en v3.1.3
@SearchListCondition    // 22 Nuevo en v4m4
@Tree                   // 23 Nuevo en v4m4
@Collapsed              // 24 Nuevo en v5.0
@ListSubcontroller      // 25 Nuevo en v5.7
@OneToMany/@ManyToMany
private Collection nombreColeccion;

@ReadOnly               //  2 Nuevo en v5.1
@EditOnly               //  3 Nuevo en v5.1
@ListProperties         //  7
@RemoveSelectedAction   // 15 Nuevo en v5.3
@Editor                 // 20
@Collapsed              // 23
@ElementCollection
private Collection nombreColleccion;

1. @CollectionView (OX): La vista del objeto referenciado que se ha de usar para representar el detalle. Por defecto usa la vista por defecto.
2. @ReadOnly (OX): Si la ponemos solo podremos visualizar los elementos de la colección, no podremos ni añadir, ni borrar, ni modificar los elementos.
3. @EditOnly (OX): Si la ponemos podemos modificar los elementos existentes, pero no podemos añadir nuevos ni eliminar.
4. @NoCreate (OX): Si la ponemos el usuario final no tendrá el vínculo que le permite crear o añadir objetos del tipo del objeto referenciado.
5. @NoModify (OX): Si la ponemos el usuario final no tendrá el vínculo que le permite modificar objetos del tipo del objeto referenciado. Sólo aplica a colecciones incrustadas.
6. @AsEmbedded (OX): Por defecto las colecciones incrustadas permiten al usuario crear y añadir elementos, mientras que las colecciones convencionales permiten solo escoger entidades existentes para añadir (o quitar) de la colección. Si ponemos @AsEmbedded entonces la colección de entidades se comportan como una colección de agregados, permitiendo al usuario añadir objetos y editarlos directamente. No tiene efecto en el caso de una colección incrustada.
7. @ListProperties (OX): Indica las propiedades que han de salir en la lista al visualizar la colección. Podemos calificar las propiedades. Por defecto saca todas las propiedades persistentes del objeto referenciado (sin incluir referencias ni calculadas). Solo una @ListProperties por vista está permitida. El sufijo + (nuevo en v4.1) se puede añadir a una propiedad para mostrar la suma de la columna, como en los tabs. Antes de v5.9 el sumatorio de columnas no funcionaba en las colecciones calculadas, en las colecciones de elementos ni en las listas @OrderColumn. El sumatorio (+) no funciona con propiedades calculadas en colecciones convencionales (@OneToMany sin @OrderColumn). En el caso de las colecciones de elementos se puede poner el nombre de una referencia (nuevo en v5.1) si ésta está anotada con @DescriptionsList en la clase incrustable.
8. @RowStyle (OX): Para dar un estilo especial a algunas filas. Se comporta igual que en el caso del Tab. No funciona para colecciones calculadas. Es posible definir varias @RowStyle por cada vista.
9. @EditAction (OX): Permite sobreescribir la acción que inicia la edición de un elemento de la colección. Esta es la acción mostrada en cada fila cuando la colección es editable. Solo una @EditAction por vista está permitida.
10. @ViewAction (OX): Permite sobreescribir la acción para visualizar un elemento de la colección. Esta es la acción mostrada en cada fila cuando la colección es de solo lectura. Solo una @ViewAction por vista está permitida.
11. @NewAction (OX): Permite definir nuestra propia acción para empezar a crear un nuevo elemento y añadirlo en la colección. Ésta es la acción que se ejecuta al pulsar en el vínculo 'Nuevo'. Solo una @NewAction por vista está permitida. Antes de v5.7 esta anotación también se usaba para sobrescribir la acción 'Añadir', porque entonces no coexistían.
12. @AddAction (OX): (Nuevo en v5.7) Permite definir nuestra propia acción para empezar a añadir un nuevo elemento a la colección escogiendo uno preexistente. Ésta es la acción que se ejecuta al pulsar en el vínculo 'Añadir'. Solo una @AddAction por vista está permitida.
13. @SaveAction (OX): Permite definir nuestra propia acción para grabar el elemento de la colección. Ésta es la acción que se ejecuta al pulsar el vínculo 'Grabar detalle'. Solo una @SaveAction por vista está permitida.
14. @HideDetailAction (OX): Permite definir nuestra propia acción para ocultar la vista de detalle. Ésta es la acción que se ejecuta al pulsar el bóton 'Cerrar' o al cerrar el diálogo. Solo una @HideDetailAction por vista está permitida.
15. @RemoveAction (OX): Permite definir nuestra propia acción para borrar un elemento de la colección. Ésta es la acción que se ejecuta al pulsar en el botón 'Quitar' en el detalle del elemento. Solo una @RemoveAction por vista está permitida.
16. @RemoveSelectedAction (OX): Permite definir nuestra propia acción para quitar los elementos seleccionados de la colección. Ésta es la acción que se ejecuta al seleccionar algunas filas y pulsar en el botón 'Quitar seleccionados', o pulsar directamente el icono de eliminar en la fila deseada. Solo una @RemoveSelectedAction por vista está permitida.
17. @ListAction (OX): Para poder añadir acciones en el modo lista; normalmente acciones cuyo alcance es la colección entera. Es posible definir varias @ListAction por cada vista.
18. @RowAction (OX): (Nuevo en v4.6) Para poder añadir acciones en el modo lista asociadas a cada fila; estas acciones no están presente en la barra de botones de la colección sino sólo en cada fila. Es posible definir varias @RowAction por cada vista.
19. @DetailAction (OX): Para poder añadir acciones en detalle, normalmente acciones cuyo alcance es el detalle que se está editando. Es posible definir varias @DetailAction por cada vista.
20. @OnSelectElementAction (OX): (Nuevo en v3.1.2) Para poder definir una acción a ser ejecutada cuando un elemento de la colección se selecciona o se deselecciona. Es posible definir varias @OnSelectElementAction por cada vista.
21. @Editor (OX): (Nuevo en v3.1.3) Nombre del editor a usar para visualizar la colección en esta vista. El editor tiene que estar declarado en openxava/src/main/resources/xava/default-editors.xml o src/main/resources/xava/editores.xml de nuestro proyecto. Antes de v7 eran OpenXava/xava/default-editors.xml y xava/editores.xml de nuestro proyecto.
22. @SearchListCondition (OX): (Nuevo en v4m4) Condición a usar para la lista de elementos seleccionable susceptibles de ser añadidos a la colección. No aplica a colección embebidas.
23. @Tree (OX): (Nuevo en v4m4) Para indicar que esta colección se visualizará usando un árbol en vez de una lista.
24. @Collapsed (OX): (Nuevo en v5.0) La collección se mostrará contraída para las vistas indicadas. Visualmente significa que el marco que rodea a la vista de la collección se iniciará cerrado. Más tarde el usuario podrá establecer sus preferencias haciendo clic en el icono de expansión.
25. @ListSubcontroller: (Nuevo en v5.7) Permite agrupar varias acciones y verlas mediante un único botón desplegable.

Propiedades en lista

@ListProperties("codigo, nombre, observaciones, relacionConComercial, comercial.nivel.descripcion, tipo")
@OneToMany(mappedBy="comercial")
private Collection<Cliente> clientes;

Vista para editar

@CollectionView("Simple"),
@OneToMany(mappedBy="comercial")
private Collection<Cliente> clientes;

@View(name="Simple", members="codigo; tipo; nombre; direccion")

Colección de elementos

@ElementCollection
@ListProperties("producto.codigo, producto.descripcion, precioUnitario, cantidad, importe")
private Collection<LineaPresupuesto> lineas;

@ElementCollection
@ListProperties("factura.ano, factura.numero, factura.importe, estado, recepcionista") // recepcionista es una referencia
private Collection<GastorServicio> gastos;

@Embeddable
public class GastoServicio {
 
    @ManyToOne(fetch=FetchType.LAZY)
    @DescriptionsList
    private Recepcionista recepcionista;
 
    ...
 
}

Acción de editar/ver detalle propia

@EditAction("Factura.editarLinea")
@OneToMany (mappedBy="factura", cascade=CascadeType.REMOVE)
private Collection<LineaFactura> lineas;

<controlador nombre="Factura">
 ...
 <accion nombre="editarLinea" oculta="true"
 imagen="images/edit.gif"
 clase="org.openxava.test.acciones.EditarLineaFactura">
 <usa-objeto nombre="xava_view"/> <!-- No obligatorio desde v4m2 -->
 </accion>
 ...
</controlador>

package org.openxava.test.acciones;
import java.text.*;
import org.openxava.actions.*;
/**
 * @author Javier Paniza
 */
public class EditarLineaFactura extends EditElementInCollectionAction { // 1
 public void execute() throws Exception {
 super.execute();
 DateFormat df = new SimpleDateFormat("dd/MM/yyyy");
 getCollectionElementView().setValue( // 2
 "observaciones", "Editado el " + df.format(new java.util.Date()));
 }
}

@EditAction("")
@OneToMany (mappedBy="factura", cascade=CascadeType.REMOVE)
private Collection<LineaFactura> lineas;

Acciones de lista y fila propias

@ListAction("Transportista.traducirNombre"),
private Collection<Transportista> compañeros;

<controlador nombre="Transportista">
 ...
 <accion nombre="traducirNombre" oculta="true"
 clase="org.openxava.test.actiones.TraducirNombreTransportista">
 </accion>
 ...
</controlador>

package org.openxava.test.acciones;
import java.util.*;
import org.openxava.actions.*;
import org.openxava.test.modelo.*;
/**
 * @author Javier Paniza
 */
public class TraducirNombreTransportista extends CollectionBaseAction { // 1
 public void execute() throws Exception {
 Iterator it = getSelectedObjects().iterator(); // 2
 while (it.hasNext()) {
 Transportista transportista = (Transportista) it.next();
 transportista.traducir();
 }
 }
}

Acciones de lista y fila por defecto

<controlador nombre="DefaultListActionsForCollections">
    <hereda-de controlador="CollectionCopyPaste"/> <!-- New in v5.9 -->
    <hereda-de controlador="Print"/>
    <accion nombre="exportarComoXML"
        clase="org.openxava.test.acciones.ExportarComoXML">
    </accion>
</controlador>

Acciones de detalle propias

@DetailAction("Factura.verProducto")
@OneToMany (mappedBy="factura", cascade=CascadeType.REMOVE)
private Collection<InvoiceDetail> lineas;

<controlador nombre="Facturas">
 ...
 <accion nombre="verProducto" oculta="true"
 clase="org.openxava.test.acciones.VerProductoDesdeLineaFactura">
 <usa-objeto nombre="xava_view"/> <!-- No obligatorio desde v4m2 -->
 <usa-objeto nombre="xavatest_valoresFactura"/> <!-- No obligatorio desde v4m2 -->
 </accion>
 ...
</controlador>

package org.openxava.test.acciones;
import java.util.*;
import javax.ejb.*;
import org.openxava.actions.*;
/**
 * @author Javier Paniza
 */
public class VerProductoDesdeLineaFactura
 extends CollectionElementViewBaseAction // 1
 implements INavigationAction {
 @Inject // A partir de v4m2
 private Map valoresFactura;
 public void execute() throws Exception {
 try {
 setValoresFactura(getView().getValues());
 Object codigo =
 getCollectionElementView().getValue("producto.codigo"); // 2
 Map clave = new HashMap();
 clave.put("codigo", codigo);
 getView().setModelName("Producto"); // 3
 getView().setValues(clave); // Desde v4m5 puedes user getParentView()
 getView().findObject(); // como alternativa a getView()
 getView().setKeyEditable(false);
 getView().setEditable(false);
 }
 catch (ObjectNotFoundException ex) {
 getView().clear();
 addError("object_not_found");
 }
 catch (Exception ex) {
 ex.printStackTrace();
 addError("system_error");
 }
 }
 public String[] getNextControllers() {
 return new String [] { "ProductoDesdeFactura" };
 }
 public String getCustomView() {
 return SAME_VIEW;
 }
 public Map getValoresFactura() {
 return valoresFactura;
 }
 public void setValoresFactura(Map map) {
 valoresFactura = map;
 }
}

Refinar comportamiento por defecto para la vista de colección

@SaveAction("LineaAlbaran.grabar")
@OneToMany (mappedBy="albaran", cascade=CascadeType.REMOVE)
private Collection<LineaAlbaran> lineas;

<controlador nombre="LineaAlbaran">
 ...
 <accion nombre="grabar"
 clase="org.openxava.test.acciones.GrabarLineaAlbaran">
 <usa-objeto nombre="xava_view"/> <!-- No obligatorio desde v4m2 -->
 </accion>
 ...
</controlador>

package org.openxava.test.acciones;
import org.openxava.actions.*;
/**
 * @author Javier Paniza
 */
public class GrabarDetalleAlbaran extends SaveElementInCollectionAction { // 1
 public void execute() throws Exception {
 super.execute();
 // Aquí nuestro código // 2
 }
}

@RemoveSelectedAction("")
@OneToMany (mappedBy="albaran", cascade=CascadeType.REMOVE)
private Collection<LineaAlbaran> lineas;

Acción cuando un elemento de la colección es seleccionado (nuevo en v3.1.2)

@OnSelectElementAction("Formula.alSeleccionarIngrediente") // 1
@OneToMany(mappedBy="formula", cascade=CascadeType.REMOVE)
private Collection<IngredienteFormula> ingredientes;

<controlador nombre="Formula">
 ...
 <accion nombre="alSeleccionarIngredientes" oculta="true"
 clase="org.openxava.test.acciones.AlSeleccionarIngrediente">
 <usa-objeto nombre="xava_view"/> <!-- No obligatorio desde v4m2 -->
 </accion>
 ...
</controlador>

public class AlSeleccionarIngrediente extends OnSelectElementBaseAction { // 1
 public void execute() throws Exception {
 int size = getView().getValueInt("cantidadIngredientesSeleccionados");
 size = isSelected() ? size + 1 : size - 1; // 2
 getView().setValue("cantidadIngredientesSeleccionados", new Integer(size));
 }
}

Escoger un editor (colecciones, nuevo in v3.1.3)

@OneToMany(mappedBy="comercial")
@Editor("NombresClientes")
private Collection<Cliente> clientes;

<editor nombre="NombresClientes" url="nombresClientesEditor.jsp"/>

Condición para lista de búsqueda (colección, nuevo en v4m4)

@OneToMany(mappedBy="comercial")
@SearchListCondition(value="${codigo} < 5", forViews="SearchListCondition, SearchListConditionBlank") // 1
private Collection<Cliente> clientes;

Visualizar colecciones en formato árbol (nuevo en v4m4)

@OneToMany(mappedBy="padre", cascade = CascadeType.REMOVE)
@Editor(value="TreeView") // 1
@ListProperties("descripcion") // 2
@OrderBy("carpeta, ordenElement") // 3
@Tree(pathProperty="carpeta") // 4
private Collection<ElementoArbolTreeItem> elementos;

@Tree(
  forViews="",                // 1
  notForViews="",             // 2
  pathProperty="path",        // 3
  idProperties="",            // 4
  initialExpandedState=true,  // 5
  orderIncrement=2,           // 6 obsoleto desde la versión 7.2  
  pathSeparator="/"           // 7
)

1. forViews: Indica las vistas para la que aplica.
2. notForViews: Indica las vistas a las que no debe aplicar.
3. pathProperty: Nombre de la propiedad a ser usada como ruta para el árbol, de manera predeterminada utiliza la propiedad "path" (que debe estar presente en la clase). También puedes indicarle otro nombre.
   
4. idProperties: Cada elemento del árbol debe estar identificado de manera única. Esto normalmente esta asociado con los campos anotados con @Id, por lo tanto la implementación de @Tree utiliza estos campos. No obstante, usted puede preferir utilizar cualquier otro campo para que represente el identificador único del elemento del árbol. Las propiedades definidas aqui deben estar separadas por coma.
5. initialExpandedState: Si tiene el valor verdadero (true) el árbol es desplegado de modo expandido.
6. orderIncrement: Si utilizar la anotación @OrderBy, la misma hace referencia a un campo tipo entero, entonces la implementación de @Tree permite el reordenamiento del árbol. De manera predeterminada utiliza valores de incremento de 2, y es el mínimo aceptado. (obsoleto desde la versión 7.2).
   
7. pathSeparator: Separador utilizado en la ruta que define cada uno de los elementos del árbol y su ubicación.

Propiedades de total (nuevo en v4.3)

@OneToMany (mappedBy="invoice", cascade=CascadeType.REMOVE)
@ListProperties("fechaEntrega[factura.fechaEntrega], cantidad," +
 "importe[factura.sumaImportes, factura.iva, factura.total]")
private Collection<LineaFactura> lineas;

@ListProperties("cantidad, importe[factura.sumaImportes, factura.porcentajeIVA, factura.iva, factura.total]")

@ListProperties("porcentajeIVA, total+[costeTrabajo.porcentajeBeneficio, costeTrabajo.beneficio, costeTrabajo.total]")

@Calculation("sum(facturas.total) * porcentajeBeneficio / 100")
@ReadOnly
private BigDecimal beneficio;

Subcontrolador en una colección (nuevo en v5.7)

@OneToMany(mappedBy="equipo", cascade=CascadeType.ALL)
@ListSubcontroller("Cosas")
private Collection<MiembroEquipo> miembros;

<controlador nombre="Cosas" icono="exclamation">
    <accion nombre="verNombres" clase="org.openxava.test.acciones.VerNombreORolDesdeMiembroEquipo" icono="message-outline"/>
    <accion nombre="verRoles" clase="org.openxava.test.acciones.VerNombreORolDesdeMiembroEquipo" icono="message">
        <poner valor="true" propiedad="roles"/>
    </accion>
</controlador>

Propiedades transitorias para controles gráficos

@Transient
@DefaultValueCalculator(value=EnumCalculator.class,
 properties={
 @PropertyValue(name="enumType", value="org.openxava.test.modelo.Albaran$EntregadoPor")
 @PropertyValue(name="value", value="TRANSPORTISTA")
 }
)
@OnChange(AlCambiarEntradoPor.class)
private EntragadoPor entregadoPor;
public enum EntregadoPor { TRABAJADOR, TRANSPORTISTA }

Acciones de la vista

@View( members=
 "codigo;" +
 "tipo;" +
 "nombre, Cliente.cambiarEtiquetaDeNombre();" +
 ...

@View( members=
 "codigo;" +
 "tipo;" +
 "nombre, Cliente.cambiarEtiquetaDeNombre(ALWAYS);" +
 ...

Clase transitoria: Solo para crear vistas

package org.openxava.test.model;
import javax.persistence.*;
import org.openxava.annotations.*;
/**
 * Ejemplo de una clase OpenXava transitoria (no persistente) del modelo. <p>
 *
 * Esto se puede usar, por ejemplo, para visualizar un diálogo,
 * o cualquier otro interfaz gráfica.<p>
 *
 * Notemos como no está marcada con @Entity <br>
 *
 * @author Javier Paniza
 */
@Views({
 @View(name="Familia1", members="subfamilia"),
 @View(name="Familia2", members="subfamilia"),
 @View(name="ConFormularioSubfamilia", members="subfamilia"),
 @View(name="Rango", members="subfamilia; subfamiliaHasta")
})
public class FiltroPorSubfamilia {
 @ManyToOne(fetch=FetchType.LAZY) @Required
 @NoCreate(forViews="Familia1, Familia2")
 @NoModify(forViews="Familia2, ConFormularioSubfamilia")
 @NoSearch(forViews="ConFormularioSubfamilia")
 @DescriptionsLists({
 @DescriptionsList(forViews="Familia1",
 condition="${familia.codigo} = 1", order="${codigo} desc"
 ),
 @DescriptionsList(forViews="Familia2",
 condition="${familia.codigo} = 2"
 )
 })
 private Subfamilia subfamilia;
 @ManyToOne(fetch=FetchType.LAZY)
 private Subfamilia subfamiliaHasta;
 public Subfamilia getSubfamilia() {
 return subfamilia;
 }
 public void setSubfamilia(Subfamilia subfamilia) {
 this.subfamilia = subfamilia;
 }
 public Subfamilia getSubfamiliaHasta() {
 return subfamiliaHasta;
 }
 public void setSubfamiliaHasta(Subfamilia subfamiliaHasta) {
 this.subfamiliaHasta = subfamiliaHasta;
 }
}

@ListSubcontroller