openxava / documentation / Customizing

Editors

Editors configuration

<?xml version = "1.0" encoding = "ISO-8859-1"?>
 
<!DOCTYPE editors SYSTEM "dtds/editors.dtd">
 
<editors>
 <editor .../> ...
</editors>

<editor
    name="name"                         <!--  1  New in v2.1.3 -->
    url="url"                           <!--  2 -->
    format="true|false"                 <!--  3 -->
    depends-stereotypes="stereotypes"   <!--  4 -->
    depends-properties="properties"     <!--  5 -->
    frame="true|false"                  <!--  6 -->
    always-reload="true|false"          <!--  7  New in v3.1.2 -->
    composite="true|false"              <!--  8  New in v3.1.3 -->
    icon="icon"                         <!--  9  New in v5.7 -->
    init-action="Controller.action"     <!-- 10  New in v5.7 -->
    release-action="Controller.action"  <!-- 11  New in v5.7 -->
    selectable-items="true|false"       <!-- 12  New in v5.7 -->
>
   <property ... /> ...                 <!-- 13 -->
   <formatter ... />                    <!-- 14 -->
   <list-formatter ... />               <!-- 15  New in v3.1.4 -->
   <for-stereotype ... /> ...           <!-- 16 -->
   <for-annotation ... /> ...           <!-- 17  New in v6.6 -->
   <for-type ... /> ...                 <!-- 18 -->
   <for-model-property ... /> ...       <!-- 19 -->
   <for-reference ... /> ...            <!-- 20  New in v3.1.3 -->
   <for-collection ... /> ...           <!-- 21  New in v3.1.3 -->
   <for-tab ... /> ...                  <!-- 22  New in v4.6 -->
   <for-valid-values />                 <!-- 23  New in v2.1.2 -->
   <for-references />                   <!-- 24  New in v3.1.3 -->
   <for-collections />                  <!-- 25  New in v3.1.3 -->
   <for-element-collections />          <!-- 26  New in v5.0 -->
   <for-tabs />                         <!-- 27  New in v4.6 -->
</editor>

1. name (optional): (New in v2.1.3) Name for referencing to this editor from other places, like @Editor from a JPA entity or <reference-view ... editor=/> from a XML component.
2. url (required): URL of JSP fragment that implements editor. Starts from xava/editors (inside the src/main/webapp folder of your project, just web before v7).
3. format (optional): If true, then OpenXava has the responsibility of formatting the data from HTML to Java and vice versa; if false, then the responsibility of this is for the editor itself (generally getting the data from request and assigning it to org.openxava.view.View and vice versa). The default is true.
4. depends-stereotypes (optional): List of stereotypes (comma separated) which this editor depends on. If in the same view there are some editors for these stereotypes they throw a change value event if its values change.
5. depends-properties (optional): List of properties (comma separated) on which this editor depends. If in the same view there are some editors for these properties they throw a change value event if its values change.
6. frame (optional): If true, then the editor will be displayed inside a frame. The default is false. Useful for big editors (more than one line) that can be prettier this way.
7. always-reload (optional): (New in v3.1.2) If true, this editor is reloaded always (each time a user executes an action or he does any other request to the application). When false the editor is reloaded only when the data it represents has been changed. The default is false.
8. composite (optional): (New in v3.1.3) A composite editor is made up by several other editors; it receives a View object that represents a subview. The default is false.
9. icon (optional): (New in v5.7) Icon id from Material Design Icons. For example, if you write icon="bell" a bell will be used as icon to allow the user choose that editor. Currently choosing an editor is only available for list mode.
10. init-action (optional) (New in v5.7): Qualified name of the action (from controllers.xml) to init the editor. Currently applies only to list mode editors.
11. release-action (optional) (New in v5.7): Qualified name of the action (from controllers.xml) to relase the resources used by the editor. Currently applies only to list mode editors.
12. selectable-items (optional) (New in v5.7): if true, the editor allows the user to select several elements (with a checkbox or similar). In this way OpenXava can know when to hide the actions that process several elements. Currently applies only to list mode editors. The default is true.
13. property (several, optional): Set values in the editor; this way you can configure your editor and use it several times in different cases.
14. formatter (one, optional): Java class to define the conversion from Java to HTML and from HTML to Java.
15. list-formatter (one, optional): (New in v3.1.4) Java class to define the conversion from Java to HTML in list mode.
16. for-stereotype (several, optional): Associates this editor with a stereotype. The preference order is: first model property, then stereotype, afterwards annotation and finally type.
17. for-annotation (several, optional): (New in v6.6) Associates this editor with a Java annotation. The preference order is: first model property, then stereotype, afterwards annotation and finally type.
18. for-type (several, optional): Associates this editor with a type. The preference order is: first model property, then stereotype,  afterwards annotation and finally type.
19. for-model-property (several, optional): Associates this editor with a concrete property of a model. The preference order is: first model property, then stereotype, afterwards annotation and finally type.
20. for-reference (several, optional): (New in v3.1.3) This editor will be used for the references to the specified model.
21. for-collection (several, optional): (New in v3.1.3) This editor will be used for the collections of objects of the specified model.
22. for-tab (several, optional): (New in v4.6) This editor will be used for the tabs (list mode) of objects of the specified model.
23. for-valid-values (one, optional): (New in v2.1.2) This will be the default editor for enum and <valid-values/>.
24. for-references (one, optional): (New in v3.1.3) This will be the default editor for references.
25. for-collections (one, optional): (New in v3.1.3) This will be the default editor for collections.
26. for-element-collections (one, optional): (New in v5.0) This will be the default editor for element collections.
27. for-tabs (one, optional): (New in v4.6) This will be the default editor for tabs, that is for list mode.

<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  Ignored since v7.2, so no longer needed
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  Ignored since v7.2 -->
 />
<%
} else {
%>
<%=fvalue%>&nbsp;
<%
}
%>
<% if (!editable) { %>
 <input type="hidden" name="<%=propertyKey%>" value="<%=fvalue%>">
<% } %>

<editor url="textEditor.jsp">
 <formatter class="org.openxava.formatters.UpperCaseFormatter"/>
 <for-type type="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();
 }
 
}

Multiple values editors

@Stereotype("REGIONS")
private String [] regions;

<for stereotype="REGIONS" type="String []"/>

<editor url="regionsEditor.jsp"> <!-- 1 -->
 <property name="regionsCount" value="3"/> <!-- 2 -->
 <formatter class="org.openxava.formatters.MultipleValuesByPassFormatter"/> <!-- 3 -->
 <for-stereotype stereotype="REGIONS"/>
</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"); // Ignored since v7.2, no longer needed
boolean label = org.openxava.util.XavaPreferences.getInstance().isReadOnlyAsLabel();
if (editable || !label) {
 String sregionsCount = request.getParameter("regionsCount");
 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%>> <%-- Not used since 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"); // Ignored since v7.2, no longer needed
boolean label = org.openxava.util.XavaPreferences.getInstance().isReadOnlyAsLabel();
if (editable || !label) {
    String sregionsCount = request.getParameter("regionsCount");
    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%> <%-- Not used since 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]%>">
<%
    }
}
%>

Editors for references (new in v3.1.3)

<editor url="colorEditor.jsp">
 <for-reference model="Color"/>
</editor>

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

<%
String propertyKey = request.getParameter("propertyKey"); // Id of the key property of the reference (1)
Object value = request.getAttribute(propertyKey + ".value"); // You can use 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: Unique identifier OX gives to this reference.
2. propertyKey: Unique identifier of the property that is the key of the reference.
3. editable: If the reference must be editable by the user.
4. viewObject: The session object name of the subview that represents this reference. Only applies to composite editors.
5. propertyPrefix: Prefix used for giving name to editors for properties. Only applies to composite editors.

<editor name="MyReference" url="myReferenceEditor.jsp" frame="true" composite="true">
 <for-references/>
</editor>

Editors for collections (new in v3.1.3)

<editor url="blogCommentsEditor.jsp">
 <for-collection model="BlogComment"/>
</editor>

<jsp:include page="collectionEditor.jsp">
 <jsp:param name="listEditor" value="blogCommentsListEditor.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 to access to the view object of the collection
View collectionView = (View) context.get(request, viewObject); // We get the collection view by means of context
View rootView = collectionView.getRoot(); // In this case we use the root view, the view of Blog
Map key = rootView.getKeyValues();
if (Is.empty(key)) {
%>
There are no comments
<%
} else { // If the key has value, then we render the collection of comments
 
Blog blog = (Blog) MapFacade.findEntity("Blog", key);
String action = request.getParameter("rowAction"); // rowAction is the action to edit or view each element
String actionArgv = ",viewObject=" + viewObject;
%>
 
These are the comments:<br/>
<%
DateFormat df = DateFormat.getDateInstance(DateFormat.SHORT, Locales.getCurrent());
int f=0;
for (Iterator it = blog.getComments().iterator(); it.hasNext(); f++) {
 BlogComment comment = (BlogComment) it.next();
%>
<i><b><big>Comment at <%=df.format(comment.getDate())%></big></b></i>
<xava:action action='<%=action%>' argv='<%="row=" + f + actionArgv%>'/>
<p>
<i><%=comment.getBody()%></i>
</p>
<hr/>
<%
}
 
}
%>

1. collectionName: The name of collection as you write it in your entity.
2. viewObject: The session object name of the subview that represents this collection.
3. rowAction: The qualified action name (Controller.action as in controllers.xml) to execute in each element in order to view or edit it.

<%@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 is the id of the view of the parent object
View view = (View) context.get(request, viewObject); // view is the view of Carrier, the parent of the collection
Carrier carrier = (Carrier) MapFacade.findEntity("Carrier", view.getKeyValues());
%>
The fellows of <%=carrier.getName()%> are:<br>
<ul>
<%
for (Iterator it = carrier.getFellowCarriers().iterator(); it.hasNext(); ) {
 Carrier fellow = (Carrier) it.next();
%>
<li><%=fellow.getName()%></li>
<%
}
%>
</ul>

1. collectionName: The name of collection as you write it in your entity.
2. viewObject: The session object name of the view or subview that represents the parent object of this collection.

<editor name="MyCollection" url="myCollectionEditor.jsp">
 <for-collections/>
</editor>
 
<editor name="MyElementCollection" url="myElementCollectionEditor.jsp">
 <for-element-collections/> <!-- New in v5.0 -->
</editor>

Editors for tabs (list mode) (new in v4.6)

<editor url="corporationEmployeeListEditor.jsp">
  <for-tab model="CorporationEmployee"/>
</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', 'CorporationEmployee'," +
    "false, false, 'CorporationEmployee.filter', 'segment='+this.value)";
%>
 
<select name="<xava:id name='chooseSegment'/>" onchange=
    "<%=action%>">
    <option value="all" <%=all%>>All employees</option>
    <option value="low" <%=low%>>Low salary employees</option>
    <option value="high" <%=high%>>High salary employees</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="customer-card">
    <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>
<%
}
%>

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

<editor name="MyList" url="myListEditor.jsp">
  <for-tabs/>
</editor>

Editors for list formats (new in 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 name="MyCards" url="myCardsEditor.jsp" icon="view-module">
    <for-tabs/>
</editor>

Editors for list formats in specific entities (new in v7.3)

<editor name="MyEditor" url="myEditor.jsp"
    icon="puzzle">
    <for-tabs> 
        <has-type type="java.util.Date">
	<has-type type="java.time.LocalDate">
	<has-annotation annotation="DateTime">
	<has-stereotype stereotype="DATETIME">
    </for-tabs>
</editor>

Editors for annotations (new in v6.6)

package com.yourcompany.invoicing.annotations;

import java.lang.annotation.*;

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

    String color() default "black";

}

@Column(length=40) @Required
@Colorful(color = "green") 
String name;

<editor name="Colorful" url="colorfulEditor.jsp">
    <property name="background" value="yellow"/> 
    <for-annotation annotation="com.yourcompany.invoicing.annotations.Colorful"/>
</editor>

<%
String background = request.getParameter("background"); // Read property from editors.xml
String color = request.getParameter("color"); // Read the attribute from the @Colorful annotation
%>

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

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

JavaScript in editors

Since v4m3

<input ... onclick="f()"/> <!-- NOT ALLOWED SINCE v7.1 -->

openxava.addEditorInitFunction(function() {
/*
Here your initialization code for your editor.
That is the things your usually put in onload JavaScript event
or $(function() { ... }) of jQuery
*/
...
});

openxava.addEditorDestroyFunction(function() { // New in v4.8.1
/*
Here the destroy code for your editor.
This is to free resources obtained by the editor.
*/
...
});

Since v7.1 you can also define a function to call just after each AJAX request done by OpenXava for your editor in your myEditor.js file:

openxava.addEditorPreRequestFunction(function() { // New in v7.1
/*
Here the code to execute on your editor
before each AJAX request from OpenXava.
*/
...
});

<input class="my-editor" type="button" value="Say hello"/>

openxava.addEditorInitFunction(function() {
	
	$(".my-editor").click(function() {
  		alert("Hello");
	});
	
});

Until v4m2

Until 3.0.x

CSS in editors (new in v5.4)

Custom editors and stereotypes for displaying combos

@Stereotype("FAMILY")
private int familyNumber;
 
@Stereotype("SUBFAMILY")
private int subfamilyNumber;
 

<editor url="descriptionsEditor.jsp"> <!-- 10 -->
<property name="model" value="Family"/> <!-- 1 -->
<property name="keyProperty" value="number"/> <!-- 2 -->
<property name="descriptionProperty" value="description"/> <!-- 3 -->
<property name="orderByKey" value="true"/> <!-- 4 -->
<property name="readOnlyAsLabel" value="true"/> <!-- 5 -->
<for-stereotype stereotype="FAMILY"/> <!-- 11 -->
</editor>
 
<!-- It is possible to specify dependencies from stereotypes or properties -->
<editor url="descriptionsEditor.jsp" <!-- 10 -->
depends-stereotypes="FAMILY"> <!-- 12 -->
<!--
<editor url="descriptionsEditor.jsp" depends-properties="familyNumber"> <!-- 13 -->
-->
<property name="model" value="Subfamily"/> <!-- 1 -->
<property name="keyProperty" value="number"/> <!-- 2 -->
<property name="descriptionProperties" value="number, description"/> <!-- 3 -->
<property name="condition" value="${familyNumber} = ?"/> <!-- 6 -->
<property name="parameterValuesStereotypes" value="FAMILY"/> <!-- 7 -->
<!--
<property name="parameterValuesProperties" value="familyNumber"/> <!-- 8 -->
-->
<property name="descriptionsFormatter" <!-- 9 -->
value="org.openxava.test.formatters.FamilyDescriptionsFormatter"/>
<for-stereotype stereotype="SUBFAMILY"/> <!-- 11 -->
</editor>

1. model: Model to obtain data from. It can be the name of an entity (e.g. Invoice) or the name of the model used in an embedded collection (Invoice.InvoiceDetail).
2. keyProperty or keyProperties: Key property or list of key properties; this is used to obtain the value to assign to the current property. It is not required that they are the key properties of the model, although this is the typical case.
3. descriptionProperty or descriptionProperties: Property or list of properties to show in combo.
4. orderByKey: If it has to be ordered by the key, by default it is ordered by description. You can also use order with an order clause in SQL style if you need it.
5. readOnlyAsLabel: When it is read only, then it is rendered as label. The default is false.
6. condition: Condition to limit the data to be displayed. Has SQL format, but you can use the property names with ${}, even qualified properties are supported. You can put arguments with ?. This last case is when this property depends on other ones and only obtain data when these other properties change.
7. parameterValuesStereotypes: List of stereotypes from which properties depend. It's used to fill the condition arguments and has to match with depends-stereotypes attribute (12).
8. parameterValuesProperties: List of properties from which properties depends. It's used to fill the condition arguments and has to match with depends-properties attribute (13).
9. descriptionsFormatter: Formatter for the descriptions displayed in a combo. It must implement IFormatter.

Custom JSP view and OpenXava taglibs

Example

<module name="SellersJSP" folder="invoicing.variations">
<model name="Seller"/>
<view name="ForCustomJSP"/> <!-- 1 -->
<web-view url="custom-jsp/seller.jsp"/> <!-- 2 -->
<controller name="Typical"/>
</module>

<%@ include file="../xava/imports.jsp"%>
 
<table>
<tr>
<td>Number: </td>
<td>
<xava:editor property="number"/>
</td>
</tr>
<tr>
<td>Name: </td>
<td>
<xava:editor property="name"/>
</td>
</tr>
 
<tr>
<td>Level: </td>
<td>
<xava:editor property="level.id"/>
<xava:editor property="level.description"/>
</td>
</tr>
</table>

xava:editor

<xava:editor
property="propertyName" <!-- 1 -->
editable="true|false" <!-- 2 New in v2.0.1 -->
throwPropertyChanged="true|false" <!-- 3 New in v2.0.1 -->
/>

1. property (required): It's the property of the model associated with the current module
2. editable (optional): New in v2.0.1. Forces to this editor to be editable, otherwise the appropriate default value is assumed.
3. throwPropertyChanged (optional): New in v2.0.1. Forces to this editor to throws property changed event, otherwise the appropriate default value is assumed.

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

<xava:action action="controller.action" argv="argv"/>

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

<xava:action action=""/>

xava:message (new in v2.0.3)

<xava:message key="message_key" param="messageParam" intParam="messageParam"/>

<xava:message key="list_count" intParam="<%=totalSize%>"/>

xava:label (new in v5.5)

<xava:label key="memberName"/>

<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 (new in v2.0.3)

<xava:descriptionsList
 reference="referenceName"     <!-- 1 -->
 readOnlyAsLabel="true|false"  <!-- 2 New in v6.0.1 -->
/>

1. reference (required): It's a reference of the model associated with the current module.
2. readOnlyAsLabel (optional): New in v6.0.1. If true and the reference is read only it's displayed as a label.

<tr>
<td>Level: </td>
<td>
<xava:descriptionsList reference="level"/>
</td>
</tr>

Modifying OpenXava core JSPs

• Use custom editors to define how a part of your view is generated.
• Use custom JSP views to define the way the complete view for a module is generated
• Use custom style, when combining CSS and some JSP you can add any visual elements to your application, like banners, footers or headers.

<%@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>

Xava Properties Settings