Definition of the XML structure (next)

<body>

In preview, the body element is not visible, this is just an area between the header and the footer. The body element extends container.

attributes

none

children

those of container

Example

<body>
  <line>
    <section>
      ...       
    </section>
  </line>
  <line>
    <section>
      ...       
    </section>
  </line>
</body>

<line>

The line element does not have any representation. It only exists to separate the elements with a carriage return. Its height cannot be modified; it will be automatically defined based on its content. The line element extends container and can also contain a list of col elements. It also extends cell.

attributes

those of cell

children

those of container

or

col 0,n

Example

<line height="50%">
  <section>
    ...         
  </section>
</line>
<line height="30px">
  <col width="50">
    ...         
  </col>
  <col>
    ...         
  </col>
</line>

<col>

The col element does not have any representation. It is useful to split a line into several pieces. Each col element has a width expressed in percentage and the total of the widths of the col elements of a line element should be equal to 100.

The col element extends container and cell.

attributes

Those of cell

class (optional)

Defines the CSS style name to use.

The different standard styles for the columns are:

  • "cell-left" : this is a left cell, used to represent a field's label. By default the background colour of the cell is in high contrast, text is aligned to the right and is centered vertically.
  • "cell-right" : this is a right cell, used to represent a field's label. By default the background colour of the cell is lighter, text is aligned to the left and is centered vertically.

    width (optional)

    The column is between 1 and 100 in width The value default,as the * value represents the complement until 100. If several col elements have no values, they shares even-handedly the complement until 100 ex: 30

children

those of container

Example

<line>
  <col width="30" class="cell-right" >
      ...       
  </col>
  <col width="70" class="cell-left" >
    ...
  </col>
</line>
<line>
  <col width="50">
    ...         
  </col>
  <col width="*">
    ...
  </col>
</line>
<line>
  <col width="80">
    ...         
  </col>
  <col>
    ...
  </col>
</line>

<section>

The section element lets you group information thematically. It surrounds its content visually with a frame and has an icon and a title. The styles of these three elements can be modified.

The section element extends container and cell.

attributes

those of cell

title

Section title. Example: Request

class (optional)

Customization of the section style.

The different standard styles for the columns are:

  • "section" : this represents an inactive section
  • "section-highlighted": this represents an active section
  • "subsection" : this represents an inactive sub-section
  • "section-highlighted" : this represents an active sub-section

children

those of container

Example

<section title="Demande" cellpadding="5px">
  ... 
</section>

<field>

The field element displays the value of a document field. It defines whether the value can be modified, indicates the control that will be responsible for this field and allows its style to be modified.

The field element extends cell and contains nothing.

attributes

those of cell

property

System name of the document field to connect. Example: DateDebut

ctrl

Name of the control used Example: text, textarea, date, …

The name must correspond to one of the enumeration values com.axemble.vdp.ui.interfaces.UIControlsEnum

mode (optional)

Execution mode of the control. The possible values are ‘read’ or ‘write’. If the mode is not specified, it is ‘read’.

From the 2005 Service Pack 1 version, the "mode" attribute may get a variable value according to the following syntax:

<field … mode="variable:var_etat" … >

In the same manner than "variable": for the display or not of an element, it is not possible to pre-calculate in a variable the field state. The value of var_etat can be: "write" or "true" or "1" to be modifiable

In every other cases, the field will be in "read" mode only.

required (optional)

Indicates whether or not the field is mandatory. ("yes" or "no")

The "required" attribute can get the variable value according to the following syntax:

<field … required="variable:var_required" … >

In the same manner than "variable": for the display or not of an element, it is not possible to pre-calculate in a variable the field state.

The value of var_required can be: "yes" or "true" or "1" to be modifiable

In every other cases, the field will be in "read" mode only.

extensionclass (optional)

Customization of the control behavior. You can declare a Java extension class which implements the interface :

com.axemble.vdp.ui.core.document.extensions.IFieldExtension

Example

extensionclass="com.axemble.vdp.mapping.extensions.DefaultLinkExtension"

children

subfield

Example

<field property="sys_Title" ctrl="text"/>
<field property="DateDebut" ctrl="date" mode="write"/>

<subfield>

Child tag of field (only available for table type fields).

Determines the dynamic table fields to be displayed when displayed as a list.

attributes

property

identifies the name of the field to be displayed in the column

label

indicates the name of the column to display.

ctrl

indicates the type of the control to display.

Example

<field property="Tableau" ctrl="resourcetable" resourcetemplate="Tableau" mode="write">
  <subfield property="Date" label="Date" ctrl="date"/>
  <subfield property="Type" label="Type" ctrl="textselectlist"/>
  <subfield property="Cout" label="Coût" ctrl="float"/>
  <subfield property="Client" label="Client" ctrl="text"/>
  <subfield property="Commentaire" label="Commentaire" ctrl="text"/>
</field>

<html>

The html element is used to display a portion of HTML, it is used to display static information of the form (help, link…). Its content is placed without transformation in the form. The html element extends cell.

attributes

those of cell

eval (optional)

Name of a Java Script variable declared in the script block. The string value of this variable will be usd as content.

children

text() 0,n

HTML source, often surrounded by ![CDATA[ et ]] to avoid conflicts.

We can also nest elements such as section, actionhistory, text, field, html attribute.

Example

<html><![CDATA[
        <a href="http://www.vdocsoftware.com">Visiativ Software </a>
]]></html>

<html eval="field_Reference"/>

--> Next classes