Showing:

Annotations
Attributes
Instances
Used by

Table of Contents

Group by:
Main schema xml-form-1.0.xsd
[ top ]
Element AllWidgets
[ top ]
Element StandaloneFields
Used by
[ top ]
Element form-single
Annotations
A single form is used to view or edit fields of a single map/hash/record/etc.
Model auto-fields-service* , auto-fields-entity* , field* , field-layout{0,1}
Children auto-fields-entity, auto-fields-service, field, field-layout
Instance
<form-single extends="" focus-field="" name="" skip-end="false" skip-start="false" transition="">
  <auto-fields-service field-type="edit" service-name="">{0,unbounded}</auto-fields-service>
  <auto-fields-entity entity-name="" field-type="find-display">{0,unbounded}</auto-fields-entity>
  <field entry-name="" hide="" name="" validate-parameter="" validate-service="">{0,unbounded}</field>
  <field-layout collapsible="" id="">{0,1}</field-layout>
</form-single>
Attributes
QName Type Fixed Default Use Annotation
extends xs:string optional
The location and name (separated by a hash/pound sign) of the form to
                    extend. If there is no location is a form in the current screen.
focus-field xs:string optional
name xs:string required
skip-end boolean false optional
skip-start boolean false optional
transition xs:string optional
[ top ]
Element auto-fields-service
Used by
Attributes
QName Type Fixed Default Use Annotation
field-type restriction of xs:token edit optional
service-name xs:string required
[ top ]
Element auto-fields-entity
Used by
Attributes
QName Type Fixed Default Use Annotation
entity-name xs:string required
field-type restriction of xs:token find-display optional
[ top ]
Element field
Used by
Model header-field{0,1} , conditional-field* , default-field{0,1}
Children conditional-field, default-field, header-field
Instance
<field entry-name="" hide="" name="" validate-parameter="" validate-service="">
  <header-field show-order-by="false" title="">{0,1}</header-field>
  <conditional-field condition="" red-when="by-name" title="" tooltip="">{0,unbounded}</conditional-field>
  <default-field red-when="by-name" title="" tooltip="">{0,1}</default-field>
</field>
Attributes
QName Type Fixed Default Use Annotation
entry-name xs:string optional
The name of the entry in the context that contains the value to use for
                    this field. By default will use the field name and look in the context and if not found in the
                    context then in a map called "fieldValues" (ie: "fieldValues.${name}"). With this convention when
                    you do an entity find to get a recard to edit, use "fieldValues" for the value-field.
hide boolean optional
If false field will always be visible (at least the title if nothing
                    else). If true will always be hidden regardless of title and widgets defined. If empty (default)
                    will guess based on definition of field.

                    Note that for form-list fields this governs the entire column for the field, and not just a single
                    row.
name xs:string required
A unique name for this field. Used for the parameter name, referencing
                    the field in other places, etc.
validate-parameter xs:string optional
validate-service xs:string optional
[ top ]
Element header-field
Annotations
Only applicable to fields until a form-list element.
            Used to show a field to filter the results by (instead of a separate search form), and/or to show the
            order-by option in the header.
Used by
Element field
Model SubFields{0,1}
Children SubFields
Instance
<header-field show-order-by="false" title="">
  <SubFields>{0,1}</SubFields>
</header-field>
Attributes
QName Type Fixed Default Use Annotation
show-order-by boolean false optional
Only applicable to multi and list type forms. If true header links for
                    ordering by this field will be displayed.
title xs:string optional
The name of this field that will be shown to the user; can use the ${}
                    and map.key (dot) syntax to insert values from the context.
[ top ]
Element SubFields
Used by
[ top ]
Element conditional-field
Used by
Element field
Model SubFields{0,1} , StandaloneFields*
Children StandaloneFields, SubFields
Instance
<conditional-field condition="" red-when="by-name" title="" tooltip="">
  <SubFields>{0,1}</SubFields>
  <StandaloneFields>{0,unbounded}</StandaloneFields>
</conditional-field>
Attributes
QName Type Fixed Default Use Annotation
condition xs:string required
A boolean expression in Groovy.
red-when restriction of xs:token by-name optional
The widget/interaction part will be red if the date value is before-now
                (for thruDate), after-now (for fromDate), or by-name (if the field's name or entry-name or fromDate
                or thruDate the corresponding action will be done); only applicable when the field is a timestamp.
title xs:string optional
The name of this field that will be shown to the user; can use the ${}
                and map.key (dot) syntax to insert values from the context.
tooltip xs:string optional
The text to show on mouse over or help for more information; can use
                the ${} and map.key (dot) syntax to insert values from the context.
[ top ]
Element default-field
Used by
Element field
Model SubFields{0,1} , StandaloneFields*
Children StandaloneFields, SubFields
Instance
<default-field red-when="by-name" title="" tooltip="">
  <SubFields>{0,1}</SubFields>
  <StandaloneFields>{0,unbounded}</StandaloneFields>
</default-field>
Attributes
QName Type Fixed Default Use Annotation
red-when restriction of xs:token by-name optional
The widget/interaction part will be red if the date value is before-now
                (for thruDate), after-now (for fromDate), or by-name (if the field's name or entry-name or fromDate
                or thruDate the corresponding action will be done); only applicable when the field is a timestamp.
title xs:string optional
The name of this field that will be shown to the user; can use the ${}
                and map.key (dot) syntax to insert values from the context.
tooltip xs:string optional
The text to show on mouse over or help for more information; can use
                the ${} and map.key (dot) syntax to insert values from the context.
[ top ]
Element field-layout
Used by
Element form-single
Model field-group | field-row | field-ref
Children field-group, field-ref, field-row
Instance
<field-layout collapsible="" id="">
  <field-group style="" title="">{1,1}</field-group>
  <field-row>{1,1}</field-row>
  <field-ref name="">{1,1}</field-ref>
</field-layout>
Attributes
QName Type Fixed Default Use Annotation
collapsible boolean optional
id xs:string optional
[ top ]
Element field-group
Used by
Element field-layout
Model field-ref | field-row
Children field-ref, field-row
Instance
<field-group style="" title="">
  <field-ref name="">{1,1}</field-ref>
  <field-row>{1,1}</field-row>
</field-group>
Attributes
QName Type Fixed Default Use Annotation
style xs:string optional
title xs:string required
[ top ]
Element field-ref
Used by
Attributes
QName Type Fixed Default Use Annotation
name xs:string required
[ top ]
Element field-row
Annotations
Fields in the field-row will be "floated" left so that they stack up on a
            single line as long as them will fit, and then will overflow to the next line, etc.
Used by
Model field-ref*
Children field-ref
Instance
<field-row>
  <field-ref name="">{0,unbounded}</field-ref>
</field-row>
[ top ]
Element form-list
Annotations
A
            list form is a list of individual forms in a table (could
            be called a tabular form), it has a list of sets of values and creates one form for each
            list element.

            A variation on the list form is the multi form (set the attribute multi=true). In the multi mode all
            list elements will be put into a single large form with suffixes on each field for each row, with a
            single submit button at the bottom instead of a submit button on each row.
Model row-actions{0,1} , auto-fields-service* , auto-fields-entity* , field* , form-list-column*
Children auto-fields-entity, auto-fields-service, field, form-list-column, row-actions
Instance
<form-list extends="" list="" list-entry="" multi="true" name="" paginate="true" skip-end="false" skip-start="false" transition="">
  <row-actions>{0,1}</row-actions>
  <auto-fields-service field-type="edit" service-name="">{0,unbounded}</auto-fields-service>
  <auto-fields-entity entity-name="" field-type="find-display">{0,unbounded}</auto-fields-entity>
  <field entry-name="" hide="" name="" validate-parameter="" validate-service="">{0,unbounded}</field>
  <form-list-column>{0,unbounded}</form-list-column>
</form-list>
Attributes
QName Type Fixed Default Use Annotation
extends xs:string optional
The location and name (separated by a hash/pound sign) of the form to
                    extend. If there is no location is a form in the current screen.
list xs:string optional
The name of the list in the context to iterate over.
list-entry xs:string optional
If specified each list entry will be put in the context with this
                    name; otherwise the list entry must be a Map and the entries in the Map will be put into the context
                    root directly.
multi boolean true optional
name xs:string required
paginate xs:string true optional
Indicate if this form should paginate or not. Defaults to true.
skip-end boolean false optional
skip-start boolean false optional
transition xs:string optional
[ top ]
Element row-actions
Used by
Element form-list
Model (CallOperations | EnvOperations | EntityMiscOperations | EntityFindOperations | EntityValueOperations | EntityListOperations | ControlOperations | IfBasicOperations | IfOtherOperations | OtherOperations)
Children CallOperations, ControlOperations, EntityFindOperations, EntityListOperations, EntityMiscOperations, EntityValueOperations, EnvOperations, IfBasicOperations, IfOtherOperations, OtherOperations
Instance
<row-actions>
  <CallOperations>{1,1}</CallOperations>
  <EnvOperations>{1,1}</EnvOperations>
  <EntityMiscOperations>{1,1}</EntityMiscOperations>
  <EntityFindOperations>{1,1}</EntityFindOperations>
  <EntityValueOperations>{1,1}</EntityValueOperations>
  <EntityListOperations>{1,1}</EntityListOperations>
  <ControlOperations>{1,1}</ControlOperations>
  <IfBasicOperations>{1,1}</IfBasicOperations>
  <IfOtherOperations>{1,1}</IfOtherOperations>
  <OtherOperations>{1,1}</OtherOperations>
</row-actions>
[ top ]
Element form-list-column
Annotations
Fields in this set will be in the same column in the list form table.
Used by
Element form-list
Model field-ref*
Children field-ref
Instance
<form-list-column>
  <field-ref name="">{0,unbounded}</field-ref>
</form-list-column>
[ top ]
Element link
Model parameter* , image{0,1}
Children image, parameter
Instance
<link confirmation="" id="" link-type="auto" parameter-map="" target-window="" text="" url="" url-type="transition">
  <parameter from="" name="" value="">{0,unbounded}</parameter>
  <image alt="" height="" id="" url="" url-type="content" width="">{0,1}</image>
</link>
Attributes
QName Type Fixed Default Use Annotation
confirmation xs:string optional
If there is a message here it will show in a confirmation box when the link is clicked on.
id xs:string optional
link-type restriction of xs:token auto optional
parameter-map xs:string optional
A Map to get parameter names and values from in addition to the parameter sub-elements.
target-window xs:string optional
text xs:string optional
url xs:string required
url-type url-type transition optional
The type for the url attribute. Defaults to transition (on this screen).
[ top ]
Element parameter
Used by
Element link
Attributes
QName Type Fixed Default Use Annotation
from xs:string optional
name xs:string required
value xs:string optional
[ top ]
Element image
Used by
Elements link, submit
Attributes
QName Type Fixed Default Use Annotation
alt xs:string optional
height xs:string optional
id xs:string optional
url xs:string required
url-type url-type content optional
width xs:string optional
[ top ]
Element label
Attributes
QName Type Fixed Default Use Annotation
encode boolean true optional
If true text will be encoded so that it does not interfere with markup of the target output.

                    For example, if output is HTML then data presented will be HTML encoded so that all
                    HTML-specific characters are escaped.
id xs:string optional
text xs:string optional
type restriction of xs:token span optional
[ top ]
Element check
Model list-options | option
Children list-options, option
Instance
<check all-checked="" no-current-selected-key="">
  <list-options key="" list="" text="">{1,1}</list-options>
  <option key="" text="">{1,1}</option>
</check>
Attributes
QName Type Fixed Default Use Annotation
all-checked boolean optional
no-current-selected-key xs:string optional
[ top ]
Element list-options
Annotations
Create options based on data in a List of Maps.
Used by
Elements check, drop-down, radio
Attributes
QName Type Fixed Default Use Annotation
key xs:string optional
The text representing the key. Use the ${} syntax to insert entries
                    from a Map in the list or from the context. If empty and the List contains EntityValue instances
                    then will use the first primary key field name to lookup a value in the context, otherwise will
                    use the name of the field to lookup a value in the context.
list xs:string required
The name of the list to iterate through to get values.
text xs:string optional
Actual text shown to the user. Use the ${} syntax to insert entries
                    from a Map in the list or from the context. If empty defaults to the value of the key.
[ top ]
Element option
Used by
Elements check, drop-down, radio
Attributes
QName Type Fixed Default Use Annotation
key xs:string required
text xs:string optional
What the user will see in the widget; defaults to the value of the key
                    attribute.
[ top ]
Element date-find
Attributes
QName Type Fixed Default Use Annotation
default-value-from xs:string optional
default-value-thru xs:string optional
format xs:string optional
Used to format the output of Time/Date/Timestamp objects. With
                    auto-fields-service will inherit from service parameter.
type restriction of xs:token timestamp optional
[ top ]
Element date-time
Attributes
QName Type Fixed Default Use Annotation
default-value xs:string optional
format xs:string optional
Used to format the output of Time/Date/Timestamp objects. With
                    auto-fields-service will inherit from service parameter.
type restriction of xs:token timestamp optional
[ top ]
Element display
Attributes
QName Type Fixed Default Use Annotation
also-hidden boolean true optional
If set to true, a hidden form field is also rendered, with the name of
                    the field and its value.
currency-unit-field xs:string optional
Specifies the currency uomId (ISO code) used to format the value.
                Will only format as currency if this is specified.
encode boolean true optional
If true text will be encoded so that it does not interfere with markup of the target output.
format xs:string optional
Used to format the output of Time/Date/Timestamp objects. With
                    auto-fields-service will inherit from service parameter.
text xs:string optional
Specifies the string to display, can use the ${} syntax to insert
                    context values; if empty the value of the field will be printed for a default.
[ top ]
Element display-entity
Annotations
This is just like display but looks up a description using the Entity Facade;
            note that if also-hidden is true then it uses the key as the value, not the shown description.
Attributes
QName Type Fixed Default Use Annotation
also-hidden boolean true optional
encode boolean true optional
If true text will be encoded so that it does not interfere with markup of the target output.
entity-name xs:string required
key-field-name xs:string optional
text xs:string ${description} optional
use-cache boolean true optional
[ top ]
Element drop-down
Model (list-options | option)
Children list-options, option
Instance
<drop-down allow-empty="false" allow-multiple="false" combo-box="false" current="first-in-list" current-description="" no-current-selected-key="" size="1">
  <list-options key="" list="" text="">{1,1}</list-options>
  <option key="" text="">{1,1}</option>
</drop-down>
Attributes
QName Type Fixed Default Use Annotation
allow-empty boolean false optional
allow-multiple boolean false optional
combo-box boolean false optional
current restriction of xs:token first-in-list optional
current-description xs:string optional
no-current-selected-key xs:string optional
The key to mark as selected when there is no current entry value.
size xs:integer 1 optional
[ top ]
Element file
Attributes
QName Type Fixed Default Use Annotation
default-value xs:string optional
maxlength xs:positiveInteger optional
size xs:positiveInteger 30 optional
[ top ]
Element hidden
Attributes
QName Type Fixed Default Use Annotation
default-value xs:string optional
[ top ]
Element ignored
[ top ]
Element password
Attributes
QName Type Fixed Default Use Annotation
maxlength xs:positiveInteger optional
size xs:positiveInteger 30 optional
[ top ]
Element radio
Model list-options | option
Children list-options, option
Instance
<radio no-current-selected-key="">
  <list-options key="" list="" text="">{1,1}</list-options>
  <option key="" text="">{1,1}</option>
</radio>
Attributes
QName Type Fixed Default Use Annotation
no-current-selected-key xs:string optional
[ top ]
Element range-find
Attributes
QName Type Fixed Default Use Annotation
default-value-from xs:string optional
default-value-thru xs:string optional
maxlength xs:positiveInteger optional
size xs:positiveInteger 10 optional
[ top ]
Element reset
[ top ]
Element submit
Model image{0,1}
Children image
Instance
<submit confirmation="">
  <image alt="" height="" id="" url="" url-type="content" width="">{0,1}</image>
</submit>
Attributes
QName Type Fixed Default Use Annotation
confirmation xs:string optional
If there is a message here it will show in a confirmation box when the button is clicked on.
[ top ]
Element text-line
Attributes
QName Type Fixed Default Use Annotation
ac-delay xs:positiveInteger 300 optional
ac-min-length xs:positiveInteger 1 optional
ac-transition xs:string optional
If specified the text-line will have auto-complete added to it with
                    this transition as the source of the auto-complete options.
default-value xs:string optional
disabled boolean false optional
maxlength xs:positiveInteger optional
size xs:positiveInteger 30 optional
[ top ]
Element text-area
Attributes
QName Type Fixed Default Use Annotation
cols xs:positiveInteger 60 optional
default-value xs:string optional
maxlength xs:positiveInteger optional
read-only boolean false optional
rows xs:positiveInteger 3 optional
[ top ]
Element text-find
Attributes
QName Type Fixed Default Use Annotation
default-operator restriction of xs:string contains optional
default-value xs:string optional
hide-options restriction of xs:token false optional
ignore-case boolean true optional
maxlength xs:positiveInteger optional
size xs:positiveInteger 30 optional
[ top ]