openxava / documentación / Personalización

Editores

Configuración de editores

<?xml version = "1.0" encoding = "ISO-8859-1"?>

<!DOCTYPE editores SYSTEM "dtds/editores.dtd">

<editores>
 <editor .../> ...
</editores>

<editor
    nombre="nombre"                                         <!--  1  Nuevo en v2.1.3 -->
    url="url"                                               <!--  2 -->
    formatear="true|false"                                  <!--  3 -->
    depende-de-estereotipos="estereotipos"                  <!--  4 -->
    depende-de-propiedades="propiedades"                    <!--  5 -->
    enmarcable="true|false"                                 <!--  6 -->
    recargar-siempre="true|false"                           <!--  7  Nuevo en v3.1.2 -->
    compuesto="true|false"                                  <!--  8  Nuevo en v3.1.3 -->
    icono="icono"                                           <!--  9  Nuevo en v5.7 -->
    accion-iniciar="Controlador.accion"                     <!-- 10  Nuevo en v5.7 -->
    accion-liberar="Controlador.accion"                     <!-- 11  Nuevo en v5.7 -->
    elementos-seleccionables="true|false"                   <!-- 12  Nuevo en v5.7 -->
    formato-etiqueta-defecto="normal|pequena|sin-etiqueta"  <!-- 13  Nuevo en v7.4 -->
>
   <propiedad ... /> ...                                    <!-- 14 -->
   <formateador ... />                                      <!-- 15 -->
   <formateador-lista ... />                                <!-- 16  Nuevo en v3.1.4 -->
   <para-estereotipo ... /> ...                             <!-- 17 -->
   <para-anotacion ... /> ...                               <!-- 18  Nuevo en v6.6 -->
   <para-tipo ... /> ...                                    <!-- 19 -->
   <para-propiedad-modelo ... /> ...                        <!-- 20 -->
   <para-referencia ... /> ...                              <!-- 21  Nuevo en v3.1.3 -->
   <para-coleccion ... /> ...                               <!-- 22  Nuevo en v3.1.3 -->
   <para-tab ... /> ...                                     <!-- 23  Nuevo en v4.6 -->
   <para-valores-posibles />                                <!-- 24  Nuevo en v2.1.2 -->
   <para-referencias />                                     <!-- 25  Nuevo en v3.1.3 -->
   <para-colecciones />                                     <!-- 26  Nuevo en v3.1.3 -->
   <para-colecciones-elementos />                           <!-- 27  Nuevo en v5.0 -->
   <para-tabs />                                            <!-- 28  Nuevo en v4.6 -->
</editor>

1. nombre (opcional): (Nuevo en v2.1.3) Nombre para referenciar a este editor desde otros sitios, por ejemplo desde @Editor en una entidad JPA o desde <vista-referencia ... editor=/> desde un componente XML.
2. url (obligado): URL de la página JSP que implementa el editor. Empieza desde xava/editors (dentro de la carpeta src/main/webapp de nuestro proyecto, simplemente web antes de v7).
3. formatear (opcional): Si es true es OpenXava el que tiene la responsabilidad de formatear los datos desde HTML hasta Java y viceversa, si vale false tiene que hacerlo el propio editor (generalmente recogiendo información del request y asignandolo a org.openxava.view.View y viceversa). Por defecto vale true.
4. depende-de-estereotipos (opcional): Lista de estereotipos separados por comas de los cuales depende este editor. Si en la misma vista hay algún editor para estos estereotipos éstos lanzarán un evento de cambio si cambian.
5. depende-de-propiedades (opcional): Lista de propiedades separadas por comas de los cuales depende este editor. Si en la misma vista se está visualizando alguna de estas propiedades éstas lanzarán un evento de cambio si cambian.
6. enmarcable (opcional): Si vale true enmarca visualmente el editor. Por defecto vale false. Es útil para cuando hacemos editores grandes (de más de una línea) que pueden quedar más bonitos de esta manera.
7. recargar-siempre (opcional): (Nuevo en v3.1.2) Si es true, este editor se recarga siempre (cada vez que el usuario ejecuta una acción o hace cualquier otra petición a la aplicación). Cuando vale false el editor solo se recarga cuando el dato que está representado ha sido cambiado. Por defecto vale false.
8. compuesto (opcional): (Nuevo en v3.1.3) Una editor compuesto está formado por otros editores; recibe un objeto View que reepresenta una subvista. Por defecto vale false.
9. icono (opcional): (Nuevo en v5.7) Id de un icono de Material Design Icons. Por ejemplo, si escribes icono="bell" un campana se usará como icono para permitir al usuario escoger el editor. Actualmente escoger un editor sólo está disponible en modo lista.
10. accion-iniciar (opcional) (Nuevo en v5.7): Nombre calificado de la acción (de controladores.xml) para iniciar el editor. Actualmente aplica solo a editores de modo lista.
11. accion-liberar (opcional) (Nuevo en v5.7): Nombre calificado de la acción (de controladores.xml) para liberar los recursos usados por el editor. Actualmente aplica sólo a editores de modo lista.
12. elementos-seleccionables (opcional) (Nuevo en v5.7): Si true, el editor permite al usuario seleccionar varios elementos (con casillas de verificación o similares). De esta manera OpenXava puede saber cuando ocultar las acciones que procesan varios elementos. Actualmente aplica sólo a editores de modo lista. Por defecto vale true.
13. formato-etiqueta-defecto (opcional) (Nuevo en v7.4): Permite indicar el formato de la etiqueta que se usara para este editor cuando el miembro no esté anotado con @LabelFormat. Los valores posibles son normal, pequena y sin-etiqueta. Si no se especifica este atributo el formato de etiqueta será el de por defecto para la aplicación, que se puede indicar con defaultLabelFormat en xava.properties.
14. propiedad (varias, opcional): Permite enviar valores al editor, de esta forma podemos configurar un editor y poder usarlo en diferente situaciones.
15. formateador (uno, opcional): Clase java para definir la conversión de Java a HTML y de HTML a Java.
16. formateador-lista (uno, opcional): (Nuevo en v3.1.4) Clase java para definir la conversión de Java a HTML en modo lista.
17. para-estereotipo (varias, opcional): Asocia este editor a un estereotipo. La preferencia es: un editor a una propiedad de un modelo, después por estereotipo, después por anotación y como último por tipo.
18. para-anotacion (varias, opcional): (Nuevo en v6.6) Asocia este editor a una anotación Java. La preferencia es: un editor a una propiedad de un modelo, después por estereotipo, después por anotación y como último por tipo.
19. para-tipo (varias, opcional): Asocia este editor a un tipo. La preferencia es: un editor a una propiedad de un modelo, después por estereotipo, después por anotación y como último por tipo.
20. para-propiedad-modelo (varias, opcional): Asocia este editor a una propiedad concreta de un modelo.
21. para-referencia (varios, opcional): (Nuevo en v3.1.3) Este editor se usará para las referencias al modelo especificado.
22. para-coleccion (varios, opcional): (Nuevo en v3.1.3) Este editor se usará para las colecciones de objetos del modelo especificado.
23. para-tab (varios, opcional): (Nuevo en v4.6) Este editor se usará para los tabs (modo lista) de objetos del modelo especificado.
24. para-valores-posibles (uno, opcional): (Nuevo en v2.1.2) Este será el editor por defecto para enum y <valores-posibles/>.
25. para-referencias (uno, opcional): (Nuevo en v3.1.3) Este será el editor por defecto para las referencias.
26. para-colecciones (uno, opcional): (Nuevo en v3.1.3) Este será el editor por defecto para las colecciones.
27. para-colecciones-elementos (uno, opcional): (Nuevo en v5.0) Este será el editor por defecto para las colecciones de elementos (@ElementCollection).
28. para-tabs (uno, opcional): (Nuevo en v4.6) Este será el editor por defecto para los tabs, es decir para el modo lista.

<editor url="textEditor.jsp">
 <for-type type="java.lang.String"/>
 <for-type type="java.math.BigDecimal"/>
 <for-type type="int"/>
 <for-type type="java.lang.Integer"/>
 <for-type type="long"/>
 <for-type type="java.lang.Long"/>
</editor>

<%@ page import="org.openxava.model.meta.MetaProperty" %>

<%
String propertyKey = request.getParameter("propertyKey"); // 1
MetaProperty p = (MetaProperty) request.getAttribute(propertyKey); // 2
String fvalue = (String) request.getAttribute(propertyKey + ".fvalue"); // 3
String align = p.isNumber()?"right":"left"; // 4
boolean editable="true".equals(request.getParameter("editable")); // 5
String disabled=editable?"":"disabled"; // 5
String script = request.getParameter("script"); // 6  Ignorado desde v7.2, por lo que ya no es necesario
boolean label = org.openxava.util.XavaPreferences.getInstance().isReadOnlyAsLabel();
if (editable || !label) { // 5
%>
<input id="<%=propertyKey%>" name="<%=propertyKey%>" class=editor <!-- 1 -->
 type="text"
 tabindex="1" <!-- 7 -->
 title="<%=p.getDescription(request)%>"
 align='<%=align%>' <!-- 4 -->
 maxlength="<%=p.getSize()%>"
 size="<%=p.getSize()%>"
 value="<%=fvalue%>" <!-- 3 -->
 <%=disabled%> <!-- 5 -->
 <%=script%> <!-- 6  Ignorado desde v7.2 -->
 />
<%
} else {
%>
<%=fvalue%>&nbsp;
<%
}
%>
<% if (!editable) { %>
 <input type="hidden" name="<%=propertyKey%>" value="<%=fvalue%>">
<% } %>

<editor url="textEditor.jsp">
 <formatedor clase="org.openxava.formatters.UpperCaseFormatter"/>
 <para-tipo tipo="java.lang.String"/>
</editor>

package org.openxava.formatters;

import javax.servlet.http.*;

/**
 * @author Javier Paniza
 */

public class UpperCaseFormatter implements IFormatter { // 1

 public String format(HttpServletRequest request, Object string) { // 2
 return string==null?"":string.toString().toUpperCase();
 }

 public Object parse(HttpServletRequest request, String string) { // 3
 return string==null?"":string.toString().toUpperCase();
 }

}

Editores para valores múltiples

@Stereotype("REGIONES")
private String [] regiones;

<para estereotipo="REGIONES" tipo="String []"/>

<editor url="editorRegiones.jsp"> <!-- 1 -->
 <propiedad nombre="cantidadRegiones" valor="3"/> <!-- 2 -->
 <formateador clase="org.openxava.formatters.MultipleValuesByPassFormatter"/> <!-- 3 -->
 <para-estereotipo estereotipo="REGIONES"/>
</editor>

<%@ page import="java.util.Collection" %>
<%@ page import="java.util.Collections" %>
<%@ page import="java.util.Arrays" %>
<%@ page import="org.openxava.util.Labels" %>

<jsp:useBean id="style" class="org.openxava.web.style.Style" scope="request"/>

<%
String propertyKey = request.getParameter("propertyKey");
String [] fvalues = (String []) request.getAttribute(propertyKey + ".fvalue"); // (1)
boolean editable="true".equals(request.getParameter("editable"));
String disabled=editable?"":"disabled";
String script = request.getParameter("script"); // Ignorado desde v7.2, ya no es necesario
boolean label = org.openxava.util.XavaPreferences.getInstance().isReadOnlyAsLabel();
if (editable || !label) {
 String sregionsCount = request.getParameter("cantidadRegiones");
 int regionsCount = sregionsCount == null?5:Integer.parseInt(sregionsCount);
 Collection regions = fvalues==null?Collections.EMPTY_LIST:Arrays.asList(fvalues);
%>
<select id="<%=propertyKey%>" name="<%=propertyKey%>" multiple="multiple"
 class=<%=style.getEditor()%>
 <%=disabled%>
 <%=script%>> <!-- No se usa desde v7.2 -->
 <%
 for (int i=1; i<regionsCount+1; i++) {
 String selected = regions.contains(Integer.toString(i))?"selected":"";
 %>
 <option
 value="<%=i%>" <%=selected%>>
 <%=Labels.get("regions." + i, request.getLocale())%>
 </option>
 <%
 }
 %>
</select>
<%
}
else {
 for (int i=0; i<fvalues.length; i++) {
%>
<%=Labels.get("regions." + fvalues[i], request.getLocale())%>
<%
 }
}
%>

<%
if (!editable) {
 for (int i=0; i<fvalues.length; i++) {
%>
 <input type="hidden" name="<%=propertyKey%>" value="<%=fvalues[i]%>">
<%
 }
}
%>

<%@ page import="java.util.Collection" %>
<%@ page import="java.util.Collections" %>
<%@ page import="java.util.Arrays" %>
<%@ page import="org.openxava.util.Labels" %>

<jsp:useBean id="style" class="org.openxava.web.style.Style" scope="request"/>

<%
String propertyKey = request.getParameter("propertyKey");
String [] fvalues = (String []) request.getAttribute(propertyKey + ".fvalue");
boolean editable="true".equals(request.getParameter("editable"));
String disabled=editable?"":"disabled";
String script = request.getParameter("script"); // Ignorado desde v7.2, ya no es necesario
boolean label = org.openxava.util.XavaPreferences.getInstance().isReadOnlyAsLabel();
if (editable || !label) {
    String sregionsCount = request.getParameter("cantidadRegiones");
    int regionsCount = sregionsCount == null?5:Integer.parseInt(sregionsCount);
    Collection regions = fvalues==null?Collections.EMPTY_LIST:Arrays.asList(fvalues);
    for (int i=1; i<regionsCount+1; i++) {
        String checked = regions.contains(Integer.toString(i))?"checked":"";
    %>
        <input name="<%=propertyKey%>" type="checkbox" class="<%=style.getEditor()%>"
                tabindex="1"
                value="<%=i%>"
                <%=checked%>
                <%=disabled%>
                <%=script%> <!-- No se usa desde v7.2 -->
        />
        <%=Labels.get("regions." + i, request.getLocale())%>
    <%
    }
}
else {
    for (int i=0; i<fvalues.length; i++) {
%>
<%=Labels.get("regions." + fvalues[i], request.getLocale())%>
<%
    }
}
%>

<%
if (!editable) {
    for (int i=0; i<fvalues.length; i++) {
%>
        <input type="hidden" name="<%=propertyKey%>" value="<%=fvalues[i]%>">
<%
    }
}
%>

Editores para referencias (nuevo en v3.1.3)

<editor url="colorEditor.jsp">
 <para-referencia modelo="Color"/>
</editor>

<%@page import="java.util.Iterator"%>
<%@page import="org.openxava.test.model.Color"%>

<%
String propertyKey = request.getParameter("propertyKey"); // Id de la propiedad clave de la referencia (1)
Object value = request.getAttribute(propertyKey + ".value"); // Podemos usar propertyKey + ".value" (2)
if (value == null) value = new Integer(0);
%>

<%
Iterator it = Color.findAll().iterator();
for (int c=0; it.hasNext() && c < 3; c++) {
	Color color = (Color) it.next();
	String checked = value.equals(color.getNumber())?"checked='checked'":"";
%>	
<input name="<%=propertyKey%>" value="<%=color.getNumber()%>" type="radio" <%=checked%> <!-- (3) -->
	tabindex="1"/>
<span>	
	<font color="#<%=color.getHexValue()%>"><b><%=color.getName()%></b></font>
</span>
<%
}
%>

1. referenceKey: El identificador único que OX da a esta referencia.
2. propertyKey: El identificador único de la propiedad que es clave de la referencia.
3. editable: Si la referencia tiene que ser editable por el usuario.
4. viewObject: El nombre del objeto de sesión de la subvista que representa esta referencia. Solo aplica a editores compuestos.
5. propertyPrefix: Prefijo usado para dar nombre a los editores para las propiedades. Solo aplica a editores compuestos.

<editor nombre="MiReferencia" url="miReferenciaEditor.jsp" enmarcable="true" compuesto="true">
 <para-referencias/>
</editor>

Editores para colecciones (nuevo en v3.1.3)

<editor url="comentariosBlogEditor.jsp">
 <para-coleccion modelo="ComentarioBlog"/>
</editor>

<jsp:include page="collectionEditor.jsp">
 <jsp:param name="listEditor" value="comentariosBlogListEditor.jsp"/>
</jsp:include>

<%@ include file="../imports.jsp"%>

<%@page import="org.openxava.view.View"%>
<%@page import="org.openxava.model.MapFacade"%>
<%@page import="org.openxava.test.model.Blog"%>
<%@page import="org.openxava.test.model.BlogComment"%>
<%@page import="java.util.Iterator"%>
<%@page import="java.util.Map"%>
<%@page import="java.text.DateFormat"%>
<%@page import="org.openxava.util.Locales"%>
<%@page import="org.openxava.util.Is"%>

<jsp:useBean id="context" class="org.openxava.controller.ModuleContext" scope="session"/>

<%
String viewObject = request.getParameter("viewObject"); // Id para acceder al objeto view de la colección
View collectionView = (View) context.get(request, viewObject); // Obtenemos el objeto view de la colección mediante context
View rootView = collectionView.getRoot(); // En este caso usamos la vista raiz, la vista de Blog
Map key = rootView.getKeyValues();
if (Is.empty(key)) {
%>
No hay comentarios
<%
} else { // Si la clave tiene valor dibujamos la colección de comentarios

Blog blog = (Blog) MapFacade.findEntity("Blog", key);
String action = request.getParameter("rowAction"); // rowAction es la acción para editar o visualizar cada elemento
String actionArgv = ",viewObject=" + viewObject;
%>

Estos son los comentarios<br/>
<%
DateFormat df = DateFormat.getDateInstance(DateFormat.SHORT, Locales.getCurrent());
int f=0;
for (Iterator it = blog.getComentarios().iterator(); it.hasNext(); f++) {
 ComentarioBlog comentario = (ComentarioBlog) it.next();
%>
<i><b><big>Comentario del <%=df.format(comentario.getFecha())%></big></b></i>
<xava:action action='<%=action%>' argv='<%="row=" + f + actionArgv%>'/>
<p>
<i><%=comentario.getCuerpo()%></i>
</p>
<hr/>
<%
}

}
%>

1. collectionName: El nombre de la colección tal y como lo tenemos en nuestra entidad.
2. viewObject: El nombre del objeto de sesión de la subvista que representa esta colección.
3. rowAction: El nombre calificado de acción (Controlador.accion como está en controladores.xml) a ejecutar en cada elemento para visualizarlo o editarlo.

<%@page import="org.openxava.view.View"%>
<%@page import="org.openxava.model.MapFacade"%>
<%@page import="org.openxava.test.model.Carrier"%>
<%@page import="java.util.Iterator"%>

<jsp:useBean id="context" class="org.openxava.controller.ModuleContext" scope="session"/>

<%
String viewObject = request.getParameter("viewObject"); // viewObject es el id del objeto view del padre
View view = (View) context.get(request, viewObject); // view es el objeto view de Transportista, el padre de la colección
Transportista transportista = (Transportista) MapFacade.findEntity("Transportista", view.getKeyValues());
%>
Los compañeros de <%=transportista.getNombre()%> son:<br>
<ul>
<%
for (Iterator it = transportista.getCompaneros().iterator(); it.hasNext(); ) {
 Transportista companero = (Transportista) it.next();
%>
<li><%=companero.getNombre()%></li>
<%
}
%>
</ul>

1. collectionName: El nombre de la colección tal y como lo tenemos en nuestra entidad..
2. viewObject: El nombre del objeto de sesión para la vista o subvista que representa el objeto padre de esta colección

<editor nombre="MiColeccion" url="miColeccionEditor.jsp">
 <para-colecciones/>
</editor>

<editor nombre="MiColeccionElementos" url="miColeccionElementosEditor.jsp">
 <para-colecciones-elementos/> <!-- Nuevo en v5.0 -->
</editor>

Editores para tabs (modo lista) (nuevo en v4.6)

<editor url="empleadoCorporativoListEditor.jsp">
  <para-tab modelo="EmpleadoCorporativo"/>
</editor>

<%@ include file="../imports.jsp"%>

<jsp:useBean id="context" class="org.openxava.controller.ModuleContext" scope="session"/>

<%
String tabObject = request.getParameter("tabObject");
tabObject = (tabObject == null || tabObject.equals(""))?"xava_tab":tabObject;
org.openxava.tab.Tab tab = (org.openxava.tab.Tab) context.get(request, tabObject);
String condition = tab.getBaseCondition()==null?"":tab.getBaseCondition();
String all = condition.equals("")?"selected":"";
String low = condition.contains("<=")?"selected":"";
String high = condition.contains(">")?"selected":"";
String action="openxava.executeAction('OpenXavaTest', 'EmpleadoCorporativo'," +
    "false, false, 'EmpleadoCorporativo.filtrar', 'segmento='+this.value)";
%>

<select name="<xava:id name='escogerSegmento'/>" onchange=
    "<%=action%>">
    <option value="all" <%=todos%>>Todos los empleados</option>
    <option value="low" <%=bajo%>>Empleados con salario bajo</option>
    <option value="high" <%=alto%>>Empleados con salario alto</option>
</select>

<jsp:include page="listEditor.jsp"/>

<%@ include file="../imports.jsp"%>

<jsp:useBean id="context" class="org.openxava.controller.ModuleContext" scope="session"/>

<%
String collection = request.getParameter("collection");
String id = "list";
String collectionArgv = "";
String prefix = "";
String tabObject = request.getParameter("tabObject");
tabObject = (tabObject == null || tabObject.equals(""))?"xava_tab":tabObject;
if (collection != null && !collection.equals("")) {
    id = collection;
    collectionArgv=",collection="+collection;
    prefix = tabObject + "_";
}
org.openxava.tab.Tab tab = (org.openxava.tab.Tab) context.get(request, tabObject);
org.openxava.tab.impl.IXTableModel model = tab.getTableModel();
for (int r=tab.getInitialIndex(); r<model.getRowCount() && r < tab.getFinalIndex(); r++) {
%>
    <xava:link action="List.viewDetail"><div class="ficha-cliente">
    <h4><%=model.getValueAt(r, 1)%>(<%=model.getValueAt(r, 0)%>)</h4>
    <%=model.getValueAt(r, 2)%><br/>
    <%=model.getValueAt(r, 3)%> (<%=model.getValueAt(r, 4)%>)
    </div></xava:link>
<%
}
%>

.ficha-cliente {
    border: 2px solid rgb(130, 143, 149); 
    display: inline-block; 
    padding: 10px; 
    margin-bottom: 10px;
}

<editor nombre="MiLista" url="miListaEditor.jsp">
  <para-tabs/>
</editor>

Editores para formatos de lista (nuevo en v5.7)

<editor name="List" url="listEditor.jsp" icon="table-large">
    <for-tabs/>
</editor>

<editor name="Charts" url="chartsEditor.jsp"
    selectable-items="false"
    icon="chart-line"
    init-action="Chart.init"
    release-action="Chart.release">
    <for-tabs/>
</editor>

<editor nombre="MiFicha" url="miFichaEditor.jsp" icono="view-module">
    <para-tabs/>
</editor>

Editores para formatos de lista en entidades específicas (nuevo en v7.3)

<editor nombre="MiEditor" url="miEditor.jsp"
    icono="puzzle">
    <para-tabs>
        <tiene-tipo tipo="java.util.Date">
	<tiene-tipo tipo="java.time.LocalDate">
	<tiene-anotacion anotacion="DateTime">
	<tiene-estereotipo estereotipo="FECHAHORA">
    </para-tabs>
</editor>

Editores para anotaciones (nuevo en v6.6)

package com.tuempresa.facturacion.anotaciones;

import java.lang.annotation.*;

@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.FIELD, ElementType.METHOD })
public @interface Colorido {

    String color() default "black";

}

@Column(length=40) @Required
@Colorido(color = "green") 
String nombre;

<editor nombre="Colorido" url="coloridoEditor.jsp">
    <propiedad nombre="fondo" valor="yellow"/> 
    <para-anotacion anotacion="com.tuempresa.facturacion.anotaciones.Colorido"/>
</editor>

<%
String fondo = request.getParameter("fondo");
String color = request.getParameter("color");
%>

<span class="colorido-color-<%=color%> colorido-fondo-<%=background%>">
	<jsp:include page="textEditor.jsp"/>
</span>

.colorido-color-black input { color: black; }
.colorido-fondo-black input { background: black; }
.colorido-color-white input{ color: white; }
.colorido-fondo-white input{ background: white; }
.colorido-color-red input{ color: red; }
.colorido-fondo-red input{ background: red; }
.colorido-color-green input{ color: green; }
.colorido-fondo-green input{ background: green; }
.colorido-color-blue input{ color: blue; }
.colorido-fondo-blue input{ background: blue; }
.colorido-color-yellow input{ color: yellow; }
.colorido-fondo-yellow input{ background: yellow; }
.colorido-color-orange input{ color: orange; }
.colorido-fondo-orange input{ background: orange; }
.colorido-color-purple input{ color: purple; }
.colorido-fondo-purple input{ background: purple; }
.colorido-color-gray input{ color: gray; }
.colorido-fondo-gray input{ background: gray; }

package com.tuempresa.facturacion.anotaciones;

import java.lang.annotation.*;

@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.FIELD, ElementType.METHOD })
public @interface Colorido {

    /**
     * Lista de nombres de vistas separados por comas donde se aplica esta anotación. <p>
     * 
     * Exclusivo con notForViews.<br>
     * Si se omiten tanto forViews como notForViews, entonces esta anotación se aplica 
     * a todas las vistas.<br>
     * Puedes usar la cadena "DEFAULT" para hacer referencia a la vista 
     * predeterminada (la vista sin nombre).
     */	
    String forViews() default "";
	
    /**
     * Lista de nombres de vistas separados por comas donde esta anotación no se aplica. <p>
     * 
     * Exclusivo con forViews.<br>
     * Si se omiten tanto forViews como notForViews, entonces esta anotación se aplica 
     * a todas las vistas.<br>
     * Puedes usar la cadena "DEFAULT" para hacer referencia a la vista 
     * predeterminada (la vista sin nombre).
     */ 	
    String notForViews() default "";
	

    String color() default "black";

}

@Column(length=40) @Required
@Colorido(forViews="Completa, Colorida", color = "green") 
String nombre;

JavaScript en los editores

A partir de v4m3

<input ... onclick="f()"/> <!-- NO PERMITIDO DESDE V7.1-->

openxava.addEditorInitFunction(function() {
 /*
 Aquí tu código de inicialización para tu editor.
 Es decir, las cosas que normalmente pondrías en el event onload de JavaScript
 o $(function() { ... }) de jQuery
 */
 ...
});

openxava.addEditorDestroyFunction(function() { // Nuevo en v4.8.1
/*
Aquí el código de destrucción de tu editor.
Esto es para liberar los recursos obtenidos por el editor.
*/
...
});

A partir de v7.1 puedes definir una función a ejecutar antes de cada llamada AJAX de OpenXava, ponla en tu miEditor.js:

openxava.addEditorPreRequestFunction(function() { // Nuevo en v7.1
/*
Aquí el código a ejecutar para tu editor
antes de cada llamada AJAX de OpenXava.
*/
...
});

<input class="mi-editor" type="button" value="Di hola"/>

openxava.addEditorInitFunction(function() {
	
	$(".mi-editor").click(function() {
  		alert("Hola");
	});
	
});

Hasta v4m2

Until 3.0.x

Funciones JavaScript de utilidad (nuevo en v7.6)

openxava.showMessage()

openxava.showMessage("Operación completada con éxito");

openxava.showError()

openxava.showError("No se pudo completar la operación");

Ejemplo de uso en un editor personalizado:

openxava.addEditorInitFunction(function() {
    $(".mi-boton-guardar").click(function() {
        // Lógica de validación
        if (datosValidos) {
            // Procesar datos
            openxava.showMessage("Datos guardados correctamente");
        }
        else {
            openxava.showError("Por favor, revise los datos ingresados");
        }
    });
});

Estas funciones son especialmente útiles si tu editor personalizado necesita mostrar mensajes o errores desde JavaScript sin tener que llamar al servidor, manteniendo la consistencia visual con el resto de la aplicación OpenXava.

CSS en editores (nuevo en v5.4)

Editores personalizables y estereotipos para crear combos

@Stereotype("FAMILY")
private int familyNumber;

@Stereotype("SUBFAMILY")
private int subfamilyNumber;

<editor url="descriptionsEditor.jsp"> <!-- 10 -->
 <propiedad nombre="modelo" valor="Familia"/> <!-- 1 -->
 <propiedad nombre="propiedadClave" valor="codigo"/> <!-- 2 -->
 <propiedad nombre="propiedadDescripcion" valor="descripcion"/> <!-- 3 -->
 <propiedad nombre="ordenadoPorClave" valor="true"/> <!-- 4 -->
 <propiedad nombre="readOnlyAsLabel" valor="true"/> <!-- 5 -->
 <para-estereotipo estereotipo="FAMILIA"/> <!-- 11 -->
</editor>

<!-- Es posible especificar dependencias de estereotipos o propiedades -->
<editor url="descriptionsEditor.jsp" <!-- 10 -->
 depende-de-estereotipos="FAMILIA"> <!-- 12 -->
<!--
<editor url="descriptionsEditor.jsp" depende-de-propiedades="codigoFamilia"> <!-- 13 -->
-->
 <propiedad nombre="modelo" valor="Subfamilia"/> <!-- 1 -->
 <propiedad nombre="propiedadClave" valor="codigo"/> <!-- 2 -->
 <propiedad nombre="propiedadesDescripcion" valor="codigo, descripcion"/> <!-- 3 -->
 <propiedad nombre="condicion" value="${codigoFamilia} = ?"/> <!-- 6 -->
 <propiedad nombre="estereotiposValoresParametros" valor="FAMILIA"/> <!-- 7 -->
 <!--
 <propiedad nombre="propiedadesValoresParametros" valor="codigoFamilia"/> <!-- 8 -->
 -->
 <propiedad nombre="formateadorDescripciones" <!-- 9 -->
 valor="org.openxava.test.formatters.FormateadorDescripcionesFamilia"/>
 <para-estereotipo estereotipo="SUBFAMILIA"/> <!-- 11 -->
</editor>

1. modelo: Modelo del que se obtiene los datos. Puede ser el nombre de una entidad (Factura) o el nombre de un modelo usado en una colección incrustada (Factura.LineaFactura).
2. propiedadClave o propiedadesClave: Propiedad clave o lista de propiedades clave que es lo que se va a usar para asignar valor a la propiedad actual. No es obligado que sean las propiedades clave del modelo, aunque sí que suele ser así.
3. propiedadDescripcion o propiedadesDescripcion: Propiedad o lista de propiedades a visualizar en el combo.
4. ordenadoPorClave: Si ha de estar ordenador por clave, por defecto sale ordenado por descripción. También se puede usar order con un orden al estilo SQL, si lo necesitas.
5. readOnlyAsLabel: Si cuando es de solo lectura se ha de visualizar como una etiqueta. Por defecto es false.
6. condicion: Condición para restringir los datos a obtener. Tiene formato SQL, pero podemos poner nombres de propiedades con ${}, incluso calificadas. Podemos poner argumentos con ?. En ese caso es cuando dependemos de otras propiedades y solo se obtienen los datos cuando estas propiedades cambian.
7. estereotiposValoresParametros: Lista de estereotipos de cuyas propiedades dependemos. Sirven para rellenar los argumentos de la condición y deben coincidir con el atributo depende-de-estereotipos. (12)
8. propiedadesValoresParametros: Lista de propiedades de las que dependemos. Sirven para rellenar los argumentos de la condición y deben coincidir con el atributo depende-de-propiedades. (13)
9. formateadorDescripciones: Formateador para las descripciones visualizadas en el combo. Ha de implementar IFormatter.

Vistas JSP propias y taglibs de OpenXava

Ejemplo

<modulo nombre="ComercialJSP" carpeta="facturacion.variaciones">
 <modelo nombre="Comercial"/>
 <vista nombre="ParaJSPPropio"/> <!-- 1 -->
 <vista-web url="jsp-propios/comercial.jsp"/> <!-- 2 -->
 <controlador nombre="Typical"/>
</modulo>

<%@ include file="../xava/imports.jsp"%>

<table>
<tr>
 <td>C&oacute;digo: </td>
 <td>
 <xava:editor property="codigo"/>
 </td>
</tr>
<tr>
 <td>Nombre: </td>
 <td>
 <xava:editor property="nombre"/>
 </td>
</tr>

<tr>
 <td>Nivel: </td>
 <td>
 <xava:editor property="nivel.id"/>
 <xava:editor property="nivel.descripcion"/>
 </td>
</tr>
</table>

xava:editor

<xava:editor
 property="nombrePropiedad" <!-- 1 -->
 editable="true|false" <!-- 2 Nuevo en v2.0.1 -->
 throwPropertyChanged="true|false" <!-- 3 Nuevo en v2.0.1 -->
 value="valorExplicito" <!-- 4 Nuevo en v7.6 -->
/>

1. property (obligado): Propiedad del modelo asociado al módulo actual.
2. editable (opcional): Nuevo en v2.0.1. Fuerza a este editor a ser editable, de otra forma se asume un valor por defecto apropiado.
3. throwPropertyChanged (opcional): Nuevo en v2.0.1. Fuerza a este editor a lanzar el evento de propiedad cambiada, de otra forma se asume un valor por defecto apropiado.
4. value (opcional): Nuevo en v7.6. Permite establecer el valor que se mostrará en el editor directamente, en lugar de que el editor lo obtenga automáticamente de la vista usando view.getValue(property). Esto proporciona mayor flexibilidad para mostrar valores que pueden no estar directamente en el modelo de vista.

xava:action, xava:link, xava:image, xava:button

<xava:action action="controlador.accion" argv="argv"/>

<xava:action action="CRUD.save" argv="resetAfter=true"/>

<xava:action action=""/>

xava:message (nuevo en v2.0.3)

<xava:message key="clave_mensaje" param="parametroMensaje" intParam="paramMensaje"/>

<xava:message key="cantidad_lista" intParam="<%=cantidadTotal%>"/>

xava:label (nuevo en v5.5)

<xava:label key="nombreMiembro"/>

<tr>
    <td>Number: </td><td>
    <xava:editor property="number"/>
    </td>
</tr>

<tr>
    <td><xava:label key="number"/>: </td><td>
    <xava:editor property="number"/>
    </td>
</tr>

xava:descriptionsList (nuevo en v2.0.3)

<xava:descriptionsList
 reference="nombreReferencia"  <!-- 1 -->
 readOnlyAsLabel="true|false"  <!-- 2 Nuevo en v6.0.1 -->
 descriptionValue="valorDescripcion"  <!-- 3 Nuevo en v7.6 -->
/>

1. reference (obligado): Una referencia del modelo asociado con el módulo actual.
2. readOnlyAsLabel (opcional): Nuevo en v6.0.1. Si es true se visualizará como una etiqueta cuando la referencia sea de sólo lectura.
3. descriptionValue (opcional): Nuevo en v7.6. Permite establecer explícitamente el valor de la descripción que se mostrará en la lista desplegable, en lugar de obtenerlo automáticamente desde la vista.

<tr>
 <td>Nivel: </td>
 <td>
 <xava:descriptionsList reference="nivel"/>
 </td>
</tr>

<tr>
 <td>Cliente: </td>
 <td>
 <xava:descriptionsList reference="cliente" descriptionValue="${nombreCliente}"/>
 </td>
</tr>

Modificar el código JSP del núcleo de OpenXava

<%@include file="../xava/imports.jsp"%>
    
    ...
    
<script type="text/javascript" <xava:nonce/>> 
    var button = document.getElementById('welcome_go_signin');
    button.onclick = function () { window.location='m/SignIn'; }
</script>

Configuración de propiedades en xava.properties