de.xima.fc.form.common

Enum XPropertyEnum

java.lang.Object

java.lang.Enum<XPropertyEnum>

de.xima.fc.form.common.XPropertyEnum

All Implemented Interfaces:

Serializable, Comparable<XPropertyEnum>

public enum XPropertyEnum
extends Enum<XPropertyEnum>

An enumeration of all properties a form element may possess. The properties for each form element are saved as a JSON object, with the key being one of these enumeration constants, and mapped to the value of that property. Most of these properties are editable in the XIMA FORMCYCLE designer. Later, when the form element is rendered (translated into HTML), these properties are read and influence how the element is rendered.

When you create a widget plugin to add a new form element to FORMCYCLE, you need to specify which properties your widget should have. First decide on the type of form element (input text, upload fields, pages, headers etc.), then see the individual constants below, which explain whether they are needed for that particular type of form element. Also, please note that each property specifies the data type of its value, see below.

A note on data types: Most properties have their data type set to String. By convention, boolean attributes are represented by a string, with 0 being false and 1 being true. Numbers are usually stored as a string with their decimal representation. Finally, when a property is empty, the default value is used instead.

To illustrate, this is a typical JSON structure for a simple form with one text input field, one select field, and one set of buttons (with a back, next, and submit button):

Click to expand JSON snippet

 [
     {
         "properties": {
             "maxwidth": "700px",
             "computedwidth": "100%",
             "viewstatus": [],
             "viewusergroup": [],
             "rowid": "",
             "cssclasses": [],
             "backgroundcolor": "",
             "showrequiredhint": false,
             "usergrouppendent": "",
             "minwidth": "300px",
             "print_hide": "0",
             "statusdependent": "",
             "name": "header1",
             "attributes": [],
             "comment": "",
             "id": "xi-header-1"
         },
         "className": "XHeader"
     },
     {
         "properties": {
             "maxwidth": "700px",
             "viewstatus": [],
             "viewusergroup": [],
             "readonly_viewusergroup": [],
             "rowid": "",
             "backgroundcolor": "",
             "readonly_viewstatus": [],
             "usergrouppendent": "",
             "helptext": "",
             "print_hide": "0",
             "print_size": "16",
             "statusdependent": "",
             "id": "xi-p-1",
             "readonly_usergrouppendant": "",
             "computedwidth": "100%",
             "i18n": {},
             "cssclasses": [],
             "readonly_statusdependent": "",
             "subheader": "",
             "print_break": "0",
             "minwidth": "300px",
             "name": "p1",
             "header": "",
             "attributes": [],
             "comment": ""
         },
         "className": "XPage"
     },
     {
         "properties": {
             "maxvalue": "6",
             "requiredif": "xi-sel-2",
             "readonly_viewusergroup": [
                 "[!]Administrators",
                 "Users"
             ],
             "hiddenifvalue": "",
             "required": "1",
             "rowid": "",
             "readonly_viewstatus": [
                 "[!]-1"
             ],
             "helptext": "<p>Help text</p>\n",
             "print_size": "10",
             "dynamic": "1",
             "id": "xi-tf-6",
             "readonlyifvalue": "3",
             "labeldir": "top",
             "maxlength": "255",
             "labelwidth": "120px",
             "requiredifvalue": "",
             "readonlyifclear": "1",
             "readonlyifmode": "2",
             "datepicker": "1",
             "dynamicMinSize": "1",
             "i18n": {},
             "print_text_only": "1",
             "aliasname": "asd",
             "unit": "Unit",
             "dynamicHideButtons": "",
             "requiredifcomp": 0,
             "name": "tfOther",
             "minlength": "3",
             "viewstatus": [
                 "Eingegangen"
             ],
             "viewusergroup": [
                 "Administrators",
                 "Users"
             ],
             "dynamicMaxSize": "10",
             "vrule": "",
             "readonlyifcomp": "4",
             "title": "Title",
             "servervalidate": "1",
             "parentid": "xi-p-1",
             "usergrouppendent": "1",
             "datatype": "money",
             "print_hide": "0",
             "flex": "1",
             "print_func": "Word function",
             "statusdependent": "1",
             "isreadonly": "",
             "placeholder": "Placeholder",
             "value": "initial value",
             "readonly_usergrouppendant": "1",
             "mask": "0",
             "computedwidth": "100%",
             "ishidden": "",
             "unitwidth": "60px",
             "requiredgroup": "ad",
             "hiddenifclear": "1",
             "label": "<p>Label</p>",
             "minvalue": "3",
             "cssclasses": [
                 ".my-style",
                 ".your-style"
             ],
             "readonly_statusdependent": "1",
             "print_break": "1",
             "equals": "xi-tf-6",
             "hiddenifcomp": 0,
             "attributes": [
                 {
                     "value": "val",
                     "text": "attr1"
                 }
             ],
             "hiddenif": "xi-sel-2",
             "comment": "",
             "vrulemismatch": "",
             "dynamicTrigger": "xi-sel-2",
             "readonlyif": "xi-sel-2"
         },
         "className": "XTextField"
     },
     {
         "properties": {
             "questions": [
                 {
                     "value": "Question 1"
                 },
                 {
                     "value": "Question 2"
                 },
                 {
                     "value": "Question 3"
                 }
             ],
             "requiredif": "",
             "checkboxmin": "",
             "readonly_viewusergroup": [],
             "hiddenifvalue": "",
             "required": "1",
             "rowid": "",
             "readonly_viewstatus": [],
             "helptext": "",
             "print_size": "10",
             "selectcolumnwidth": "0",
             "options": [
                 {
                     "text": "Option 1",
                     "title": "",
                     "value": "1"
                 },
                 {
                     "text": "Option 2",
                     "title": "",
                     "value": "2"
                 },
                 {
                     "text": "Option 3",
                     "title": "",
                     "value": "3"
                 }
             ],
             "dynamic": "0",
             "id": "xi-sel-2",
             "readonlyifvalue": "0",
             "labeldir": "top",
             "selecttextlayout": "right",
             "isdisabled": "1",
             "labelwidth": "120px",
             "requiredifvalue": "",
             "readonlyifclear": "1",
             "dynamicMinSize": "1",
             "i18n": {},
             "print_text_only": "1",
             "aliasname": "myalias",
             "unit": "",
             "print_list": "0",
             "dynamicHideButtons": "",
             "datasource": "",
             "requiredifcomp": 0,
             "name": "sel2",
             "cob2auto": "1",
             "viewstatus": [
                 "Eingegangen"
             ],
             "viewusergroup": [],
             "dynamicMaxSize": "10",
             "readonlyifcomp": 0,
             "servervalidate": "1",
             "title": "",
             "parentid": "xi-p-1",
             "usergrouppendent": "",
             "print_hide": "0",
             "flex": "4",
             "print_func": "",
             "statusdependent": "1",
             "dsvalueidx": "2",
             "value": "",
             "readonly_usergrouppendant": "",
             "dstextidx": "1",
             "computedwidth": "100%",
             "ishidden": "",
             "selectlayout": "select",
             "checkboxmax": "",
             "unitwidth": "60px",
             "requiredgroup": "",
             "hiddenifclear": "1",
             "dstype": "",
             "label": "<p>Label</p>",
             "cssclasses": [
                 ".your-style"
             ],
             "readonly_statusdependent": "",
             "print_break": "0",
             "hiddenifcomp": 0,
             "attributes": [
                 {
                     "value": "value2",
                     "text": "test2"
                 }
             ],
             "hiddenif": "",
             "comment": "",
             "dynamicTrigger": "",
             "readonlyif": ""
         },
         "className": "XSelect"
     },
     {
         "properties": {
             "viewstatus": [],
             "viewusergroup": [],
             "readonlyifcomp": 0,
             "readonly_viewusergroup": [],
             "hiddenifvalue": "",
             "parentid": "xi-p-1",
             "rowid": "",
             "readonly_viewstatus": [],
             "usergrouppendent": "",
             "helptext": "",
             "flex": "1",
             "statusdependent": "",
             "id": "xi-btn-1",
             "readonlyifvalue": "0",
             "readonly_usergrouppendant": "",
             "computedwidth": "100%",
             "ishidden": "",
             "buttons": [
                 {
                     "name": "btnPrev",
                     "action": {
                         "page": "",
                         "check": "false",
                         "value": "not defined",
                         "optionId": "no action"
                     },
                     "title": "",
                     "value": "back"
                 },
                 {
                     "name": "btnNext",
                     "action": {
                         "page": "",
                         "check": "false",
                         "value": "not defined",
                         "optionId": "no action"
                     },
                     "title": "",
                     "value": "next"
                 },
                 {
                     "name": "btnSubmit",
                     "action": {
                         "optionId": "submit + check",
                         "page": "submit",
                         "check": "true",
                         "value": "submit + check"
                     },
                     "title": "",
                     "value": "submit"
                 }
             ],
             "isdisabled": "",
             "i18n": {},
             "cssclasses": [],
             "readonly_statusdependent": "",
             "hiddenifcomp": 0,
             "name": "btn1",
             "textalign": "left",
             "attributes": [],
             "hiddenif": "",
             "comment": "",
             "readonlyif": ""
         },
         "className": "XButtonList"
     },
     {
         "properties": {
             "maxwidth": "700px",
             "computedwidth": "100%",
             "viewstatus": [],
             "viewusergroup": [],
             "rowid": "",
             "cssclasses": [],
             "backgroundcolor": "",
             "showlogo": "1",
             "showrequiredhint": "1",
             "usergrouppendent": "",
             "minwidth": "300px",
             "print_hide": "0",
             "statusdependent": "",
             "name": "footer1",
             "attributes": [],
             "comment": "",
             "id": "xi-footer-1"
         },
         "className": "XFooter"
     }
 ]
 

Author:

XIMA MEDIA GmbH

Enum Constant Summary

Enum Constants

Enum Constant and Description
aliasname Data type: String Default: (same as name) Required for all form elements.
alt Data type: String Default: (empty string) Available only for XImages.
appointmentTemplate Data type: String Default: (empty string) Available only for XAppointments.
attributes
autosize Data type: String Default: 0.
backgroundcolor Data type: String Default: (empty string).
buttons Data type: JSONArray Default: (empty array) Available only for XButtonLists.
catalogue
catalogueitem
cataloguelabel
cataloguename
catalogueunique
characterCount Data type: String Default: 0.
checkboxmax
checkboxmin
checkboxvalue Data type: String Default: on Available only for XCheckboxes.
checkedvalue Data type: String Default: 0 Available only for XCheckboxes.
closeable Data type: String Default: 0 Available only for XAppointments.
cob2auto Data type: String Default: 0.
comment Data type: String Default: (empty string) Available for all elements.
computedwidth Data type: String Default: 100% Required for all form elements for which flex is required.
cssclasses
datasource Data type: String Default: (empty string) Available only for XSelects.
datatype
dateFormat Data type: String Default: dd.mm.yy Available only for XAppointments.
dateFormatCustom Data type: String Default: dd.mm.yy Available only for XAppointments.
datepicker
dstextidx Data type: String Default: 1 Available only for XSelects.
dstype Data type: String Default: (empty string) Available only for XSelects.
dsvalueidx Data type: String Default: 2 Available only for XSelects.
dynamic Data type: String Can be added to input elements to allow marking an element as repeated, i.e.
dynamicHideButtons Data type: String Required for all elements that have the property dynamic enabled.
dynamicMaxSize Data type: String Required for all elements that have the property dynamic enabled.
dynamicMinSize Data type: String Required for all elements that have the property dynamic enabled.
dynamicTrigger Data type: String Required for all elements that have the property dynamic enabled.
equals
fileextension
fileoutputalias
filepreview Data type: String Default: 0.
flex Data type: String Required for all elements that can be arranged horizontally in a row next to other form elements, i.e.
header Data type: String Default: (empty string) Only for form elements of type XPage.
height Data type: String Default: 25px Applies to XSpacer, XLine, and XTextArea.
helptext Data type: HTML String Default: (empty string) Available for all elements other that XHeader, XPages, and XFooter.
hiddenif Data type: String Default: (no condition).
hiddenifclear Data type: String Default: (empty string) Available for all elements other than XPage, XHeader and XFooter.
hiddenifcomp Data type: String Default: 0 Available for all elements other than XPage, XHeader and XFooter.
hiddenifvalue Data type: String Default: (empty string) Available for all elements other than XPage, XHeader and XFooter.
i18n
id Data type: String Default: (auto-generated) Required for all form elements.
image Data type: Data URL String Default: (dummy image) Available only for XImages.
imagegallerie Data type: String Default: 0 Available only for XImages.
imagegroup Data type: String Default: (empty string) Available only for XImages.
imageheight Data type: String Default: 0 Applies only to form elements of type XImage.
imagelink Data type: String Default: (empty string) Available only for XImages.
imagequality Data type: String Default: 100% Available only for XImages.
imagetarget Data type: String Default: _blank Available only for XImages.
imagewidth Data type: String Default: 0 Applies only to form elements of type XImage.
isdisabled Data type: String Default: (empty string).
ishidden Data type: String Default: (empty string).
isreadonly Data type: String Default: (empty string).
label Data type: HTML String Default: Label Available for all form elements that allow a value to be entered.
labeldir Data type: String Default: top Available for all elements that admit the label property.
labelwidth Data type: String Default: 120px Available for all elements that admit the label property.
legend Data type: HTML String Default: 120px Available for XFieldSets.
mask Data type: String Default: 0.
maxfilesize
maxlength
maxvalue
maxwidth Data type: String Default: 700px Applies only to form elements of type XHeader, XPage, and XFooter.
minlength
minvalue
minwidth Data type: String Default: 300px Applies only to form elements of type XHeader, XPage, and XFooter.
name Data type: String Default: (auto-generated) Required for all form elements.
options Data type: JSONArray Default: (empty array) Available only for XSelects.
parentid Data type: String Default: (computed) Required for all form elements.
placeholder Data type: String Default: (empty string) Available for XTextFields and XTextAreas.
print_break
print_func
print_hide
print_list
print_size
print_text_only
questions Data type: JSONArray Default: (empty array) Available only for XSelects when selectlayout is set to either table or table1 (a table with a list of questions that can be answered with one of the available options.
readonly_statusdependent
readonly_usergrouppendant
readonly_viewstatus
readonly_viewusergroup
readonlyif Data type: String Default: (no condition).
readonlyifclear Data type: String Default: (empty string) Available for all forms element that allow a value to be entered.
readonlyifcomp Data type: String Default: 0 Available for all forms element that allow a value to be entered.
readonlyifmode Data type: String Default: 2 Available only for XTextFields and XTextAreas.
readonlyifvalue Data type: String Default: (empty string) Available for all forms element that allow a value to be entered.
required Data type: String Default: 0.
requiredgroup
requiredif Data type: String Default: (no condition).
requiredifcomp Data type: String Default: 0 Available for all forms element that allow a value to be entered.
requiredifvalue Data type: String Default: (empty string) Available for all forms element that allow a value to be entered.
rowid Data type: String Default: (auto-generated) Required for all form elements.
rtevalue Data type: HTML String Default: Text Available only for XSpans that is used to add informational text to a form.
selectcolumnwidth Data type: String Default: 0.
selectlayout Data type: String Default: select.
selecttextlayout Data type: String Default: right.
servervalidate
showCapacity Data type: String Default: 0 Available only for XAppointments.
showlogo Data type: String Default: 1 Applies only to form elements of type XFooter.
showpleaseselect Data type: String Default: 0 Applies only to form elements of type XSelect with set required option to 0.
showpleaseselectreq Data type: String Default: 1 Applies only to form elements of type XSelect with set required option to 1.
showrequiredhint Data type: String Default: 1 Applies only to form elements of type XHeader and XFooter.
showUntil Data type: String Default: 0 Available only for XAppointments.
statusdependent
subheader Data type: String Default: (empty string) Only for form elements of type XPage.
textalign Data type: String Default: left Available for XButtonLists and XImages.
title Data type: String Default: (empty string) Available for all form elements that allow a value to be entered and also for XImages.
unit Data type: String Default: (empty string) Available for XTextAreas, XTextFields, XUploads and XSelects.
unitwidth Data type: String Default: 60px Available for all elements that admit the property unit.
usergrouppendent
value Data type: String Default: (empty string) Available for XTextFields, XTextAreas, and XSelects.
viewstatus
viewusergroup
vrule
vrulemismatch

Method Summary

Modifier and Type	Method and Description
static boolean	contains(String name)
Class<?>	getClazz()
Serializable	getDefaultValue()
static XPropertyEnum	valueOf(String name) Returns the enum constant of this type with the specified name.
static XPropertyEnum[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

parentid

public static final XPropertyEnum parentid

Data type: String

Default: (computed)

Required for all form elements. This is the id of the parent element, if one exists, and cannot be edited in the designer directly. For example, the parent of a text field could be an XFieldSet or an XPage.

rowid

public static final XPropertyEnum rowid

Data type: String

Default: (auto-generated)

Required for all form elements. This is the ID of the horizontal row (.xm-form-row) which contains the form element, if any. This property cannot be edited in the designer directly. When a form element is not placed in a row next to other form elements, its row ID is empty.

showpleaseselect

public static final XPropertyEnum showpleaseselect

Data type: String

Default: 0

Applies only to form elements of type XSelect with set required option to 0. If set to 1, the "please select" option is shown in the select. Otherwise, when set to 0, the "please select" option is not shown.

showpleaseselectreq

public static final XPropertyEnum showpleaseselectreq

Data type: String

Default: 1

Applies only to form elements of type XSelect with set required option to 1. If set to 1, the "please select" option is shown in the select. Otherwise, when set to 0, the "please select" option is not shown.

showlogo

public static final XPropertyEnum showlogo

Data type: String

Default: 1

Applies only to form elements of type XFooter. If set to 1, the XIMA FORMCYCLE logo is shown in the footer. Otherwise, when set to 0, the logo is not shown.

showrequiredhint

public static final XPropertyEnum showrequiredhint

Data type: String

Default: 1

Applies only to form elements of type XHeader and XFooter. If set to 1, a note is shown in the header or footer explaining that all form elements marked with an asterix (*) are required elements. If set to 0, the note is not shown.

name

public static final XPropertyEnum name

Data type: String

Default: (auto-generated)

Required for all form elements. This is the name of a form element, as it can be edited in the Designer. It identifiers a form element and is used in placeholders and when accessing form elements via JavaScript. The name may contains only letters (a-z, A-Z), numbers (0-9), and underscore (_). The name should be unique across all form element of a form, but does not need to be.

aliasname

public static final XPropertyEnum aliasname

Data type: String

Default: (same as name)

Required for all form elements. This is the alias of a form element, as it can be edited in the designer. By default, the alias is set to the name of the form element. Compared with the name, the alias may contain any character. It can be used in placeholders, and for addressing third-party system that require a particular name. The alias, if set, needs to be unique across all form elements of a form.

id

public static final XPropertyEnum id

Data type: String

Default: (auto-generated)

Required for all form elements. This is a unique ID of a form element and is generated automatically. Currently, IDs are of the form xi-[type]-[index], e.g. xi-tf-7 for input fields or xi-sel-9 for select fields.

header

public static final XPropertyEnum header

Data type: String

Default: (empty string)

Only for form elements of type XPage. This is the header (heading, h2) text displayed to the top of a page in a large font size. Default to the empty string, i.e. no header.

subheader

public static final XPropertyEnum subheader

Data type: String

Default: (empty string)

Only for form elements of type XPage. This is the sub header (heading, h3) text displayed to the top of a page in a font size smaller than the header text. Default to the empty string, i.e. no sub header.

maxwidth

public static final XPropertyEnum maxwidth

Data type: String

Default: 700px

Applies only to form elements of type XHeader, XPage, and XFooter. This is the maximum width of the header, page, or footer, as a CSS unit. If the browser viewport is larger than this width, the header, page, or footer takes this maximum width, leaving white or grey borders around the form.

minwidth

public static final XPropertyEnum minwidth

Data type: String

Default: 300px

Applies only to form elements of type XHeader, XPage, and XFooter. This is the minimum width of the header, page, or footer, as a CSS unit. If the browser viewport smaller than this width, the form is displayed in responsive mode. This includes, for example, rearranging horizontal form elements vertically.

imageheight

public static final XPropertyEnum imageheight

Data type: String

Default: 0

Applies only to form elements of type XImage. This is the height of the image in pixels. Defaults to 0, which adjusts the height automatically so that aspect ratio of the image is preserved.

imagewidth

public static final XPropertyEnum imagewidth

Data type: String

Default: 0

Applies only to form elements of type XImage. This is the width of the image in pixels. Defaults to 0, which adjusts the width automatically so that the aspect ratio of the image is preserved.

height

public static final XPropertyEnum height

Data type: String

Default: 25px

Applies to XSpacer, XLine, and XTextArea. This is the height of the image, line, space, or text area, as a CSS unit.

autosize

public static final XPropertyEnum autosize

Data type: String

Default: 0.

Available for all textarea elements that allow to resize the field, to a size it needs to show the whole content. If set to 0, the form element will not be resized.

characterCount

public static final XPropertyEnum characterCount

Data type: String

Default: 0.

Available for XTextAreas and other input elements that should display the number of entered characters. When set to 1, the number characters the user has entered is displayed below the textarea. If maxlength is larger than 0, the maximum number of characters allowed is displayed as well. Otherwise, when set to 0, no character count is shown.

computedwidth

public static final XPropertyEnum computedwidth

Data type: String

Default: 100%

Required for all form elements for which flex is required. This is a computed property that is filled automatically and cannot be edited in the designer directly. When multiple form elements are arranged horizontally in row, this property contains the computed relative width of the form element, in percent. When there is only one element in a row, this defaults to 100%.

selectlayout

public static final XPropertyEnum selectlayout

Data type: String

Default: select.

Applies to select form elements (XSelect). Indicates how the select element is rendered, e.g. as a list of checkboxes or an HTML SELECT element. Supported values are currently

select

Renders the select element as a drop down list, i.e. as an HTML (single) SELECT element. Only one option can be selected at any given time.

list

Renders the select element as an inline list of options, i.e. as an HTML SELECT element with a size="5" attribute. Only one option can be selected at any given time.

checkbox

Renders the select element as a horizontal list of checkboxes (one checkbox for each option). Allows for multiple options to be selected. See also checkboxmin and checkboxmax, which control how many options can be selected at once. The checkboxes may be displayed in multiple rows when no more space is available on the first row.

checkbox1

Renders the select element as a vertical list of checkboxes, with one checkbox on each line. Allows for multiple options to be selected. See also checkboxmin and checkboxmax, which control how many options can be selected at once.

radio

Renders the select element as a horizontal list of radio buttons (one radio button for each option). Only allows for one option to be selected. The radio buttons may be displayed in multiple rows when no more space is available on the first row.

radio1

Renders the select element as a vertical list of radio buttons (one radio button for each option). Only allows for one option to be selected. The radio buttons may be displayed in multiple rows when no more space is available on the first row.

table

Renders the select element as a questionnaire with checkboxes, implemented via a table. Each of the available questions is shown as a row of the table, with one column for each available answer (see options). Allows the user to select multiple answer per question.

table1

Renders the select element as a questionnaire with radio buttons, implemented via a table. Each of the available questions is shown as a row of the table, with one column for each available answer (see options). Only allows the user to select one answer per question.

cob2auto

public static final XPropertyEnum cob2auto

Data type: String

Default: 0.

Only available for XSelect items with the property selectlayout set to select. When this property is set to 1, the SELECT element is transformed into a text input field that features auto completion as the user types. The suggested items are the options of the SELECT element.

selecttextlayout

public static final XPropertyEnum selecttextlayout

Data type: String

Default: right.

Only available for XSelect items with the property selectlayout set to one of checkbox, checkbox1, radio or radio1. Controls the position where the label text is shown for each checkbox or radio button. The following values are supported currently:

top

The label text is shown above the checkbox or radio button.

right

The label text is shown to the right of the checkbox or radio button.

bottom

The label text is shown below the checkbox or radio button.

left

The label text is shown to the left of the checkbox or radio button.

selectcolumnwidth

public static final XPropertyEnum selectcolumnwidth

Data type: String

Default: 0.

Only available for XSelect items with the property selectlayout set to one of checkbox, radio, table or table1. This property specifies the width (in pixels) of each option with a checkbox or radio button and the label text. Defaults to 0, which computes a width automatically.

ishidden

public static final XPropertyEnum ishidden

Data type: String

Default: (empty string).

Available for all elements other than XPage, XHeader and XFooter. Controls whether the element is visible (when set 1) or hidden (when set to 0 or the empty string). An element that is hidden is still present in the DOM, but hidden via CSS. See readonly_viewstatus and readonly_viewusergroup, which remove form elements completely for certain states or user groups. See hiddenif to hide or show elements dynamically, depending on the value of some other form element.

isreadonly

public static final XPropertyEnum isreadonly

Data type: String

Default: (empty string).

Available for form elements of type XTextField and XTextField. Controls whether the value of the form element can be modified by the user. The following values are supported currently:

0 (or empty string)

The form element is not disabled, the user can change its value.

1

The form element is disabled and the user cannot change its value. This makes use of the disabled HTML attribute, which does not submit the current value of the form element when the form is submitted.

2

The form element is disabled and the user cannot change its value. This makes use of the readonly HTML attribute, which still submits the current value of the form element when the form is submitted.

isdisabled

public static final XPropertyEnum isdisabled

Data type: String

Default: (empty string).

Available for all form input elements other than XTextField and XTextArea, such as XSelect and XCheckbox. If set to 0 or the empty string, the user can modify the value of the form input element normally. When set to 1, the user cannot edit or modify the value of the form input element. This makes use of the disabled HTML attribute, which does not submit the current value of the form element when the form is submitted.

filepreview

public static final XPropertyEnum filepreview

Data type: String

Default: 0.

Available only for form elements of type XUpload. When set to 1 and the user select a file for the upload element, a small preview of that file is shown next to the upload element. When it is an image file, a thumbnail of that image is shown. Otherwise, a generic icon for the type of file is shown. When set to 0, no preview is shown.

mask

public static final XPropertyEnum mask

Data type: String

Default: 0.

Available only for form elements of type XTextField. When set to 1, the value entered by the user is masked or obfuscated, usually used for password input fields. Otherwise, when set to 0, the value is shown normally.

backgroundcolor

public static final XPropertyEnum backgroundcolor

Data type: String

Default: (empty string).

Available for container elements such as XHeader, XPage, XFooter, XContainer, and XFieldSet. This sets the background color of the container elements. When set to the empty string, no background color is used (transparent). Can be any valid CSS color specifier, such as red, rgb(112,93,0), or #666.

hiddenif

public static final XPropertyEnum hiddenif

Data type: String

Default: (no condition).

Available for all elements other than XPage, XHeader and XFooter. A form element can be hidden automatically based on the value of another form element. This the ID of the other (referenced) form element. When the value of this property is empty, the form element is not hidden automatically.

hiddenifcomp

public static final XPropertyEnum hiddenifcomp

Data type: String

Default: 0

Available for all elements other than XPage, XHeader and XFooter. A form element can be hidden automatically based on the value of another form element. This is the condition applied to the value of the other form element. Available condition types are:

0 (has a value)

The form field is hidden when the other field is non-empty.

1 (equals)

The form field is hidden when the value of the other field equals the hiddenifvalue.

2 (does not equal)

The form field is hidden when value of the the other field does not equal the hiddenifvalue.

3 (matches regular expression)

The form field is hidden when the other field matches the regular expression contained in hiddenifvalue.

4 (is lower than)

The form field is hidden when the other field's value is lower than the hiddenifvalue.

5 (is greater than)

The form field is hidden when the other field's value is greater than the hiddenifvalue.

6 (lies between)

The form field is hidden when the other field's value lies in the range as specified by hiddenifvalue. The hiddenifvalue must be a range in the format x-y, e.g. 2-37.

7 (is lower than or equal to)

The form field is hidden when the other field's value is lower than or equal to the hiddenifvalue.

8 (is greater than or equal to)

The form field is hidden when the other field's value is greater than or equal to the hiddenifvalue.

9 (has no value)

The form field is hidden when the other field does not have a value.

hiddenifvalue

public static final XPropertyEnum hiddenifvalue

Data type: String

Default: (empty string)

Available for all elements other than XPage, XHeader and XFooter. A form element can be hidden automatically based on the value of another form element. This is the value against which the other form element is compared. Whether this property is required and what it must contain depends on the selected condition, see hiddenifcomp for further details.

hiddenifclear

public static final XPropertyEnum hiddenifclear

Data type: String

Default: (empty string)

Available for all elements other than XPage, XHeader and XFooter. A form element can be hidden automatically based on the value of another form element. This is a flag that indicates whether the form element is cleared when it is hidden. Can be set to one of the following options:

0 (keep)

The value of the form element is not changed when it is hidden.

1 (clear)

The value of the form element is cleared when it is hidden. For text input fields, the value is set to the empty string; for select fields, all selected options are deselected.

2 (reset)

The value of the form element is reset to its initial value when it is hidden. The initial value is determined by value for XTextFields, XTextAreas, and XSelects; and checkedvalue for XCheckboxes

required

public static final XPropertyEnum required

Data type: String

Default: 0.

Available for all forms element that allow a value to be entered. If set to 0, the form element is not required and can be left empty. Otherwise, if set to 1, the form element is required and a value must be entered.

requiredif

public static final XPropertyEnum requiredif

Data type: String

Default: (no condition).

Available for all forms element that allow a value to be entered. A form element can be made a required field automatically based on the value of another form element. This the ID of the other (referenced) form element. When the value of this property is empty, the form element is not made a required field automatically.

requiredifcomp

public static final XPropertyEnum requiredifcomp

Data type: String

Default: 0

Available for all forms element that allow a value to be entered. A form element can be made a required field automatically based on the value of another form element. This is the condition applied to the value of the other form element. Available condition types are:

0 (has a value)

The form field is a required field when the other field is non-empty.

1 (equals)

The form field is a required field when the value of the other field equals the requiredifvalue.

2 (does not equal)

The form field is a required field when value of the the other field does not equal the requiredifvalue.

3 (matches regular expression)

The form field is a required field when the other field matches the regular expression contained in requiredifvalue.

4 (is lower than)

The form field is a required field when the other field's value is lower than the requiredifvalue.

5 (is greater than)

The form field is a required field when the other field's value is greater than the requiredifvalue.

6 (lies between)

The form field is a required field when the other field's value lies in the range as specified by requiredifvalue. The requiredifvalue must be a range in the format x-y, e.g. 2-37.

7 (is lower than or equal to)

The form field is a required field when the other field's value is lower than or equal to the requiredifvalue.

8 (is greater than or equal to)

The form field is a required field when the other field's value is greater than or equal to the requiredifvalue.

9 (has no value)

The form field is a required field when the other field does not have a value.

requiredifvalue

public static final XPropertyEnum requiredifvalue

Data type: String

Default: (empty string)

Available for all forms element that allow a value to be entered. A form element can be made a required field automatically based on the value of another form element. This is the value against which the other form element is compared. Whether this property is required and what it must contain depends on the selected condition, see requiredifcomp for further details.

readonlyif

public static final XPropertyEnum readonlyif

Data type: String

Default: (no condition).

Available for all forms element that allow a value to be entered. A form element can be disabled automatically based on the value of another form element. When a form field is disabled, its value cannot be changed anymore. This the ID of the other (referenced) form element. When the value of this property is empty, the form element is not disabled field automatically.

readonlyifcomp

public static final XPropertyEnum readonlyifcomp

Data type: String

Default: 0

Available for all forms element that allow a value to be entered. A form element can be disabled automatically based on the value of another form element. When a form field is disabled, its value cannot be changed anymore. This is the condition applied to the value of the other form element. Available condition types are:

0 (has a value)

The form field is disabled when the other field is non-empty.

1 (equals)

The form field is disabled when the value of the other field equals the readonlyifvalue.

2 (does not equal)

The form field is disabled when value of the the other field does not equal the readonlyifvalue.

3 (matches regular expression)

The form field is disabled when the other field matches the regular expression contained in readonlyifvalue.

4 (is lower than)

The form field is disabled field when the other field's value is lower than the readonlyifvalue.

5 (is greater than)

The form field is disabled when the other field's value is greater than the readonlyifvalue.

6 (lies between)

The form field is disabled when the other field's value lies in the range as specified by readonlyifvalue. The readonlyifvalue must be a range in the format x-y, e.g. 2-37.

7 (is lower than or equal to)

The form field is disabled field when the other field's value is lower than or equal to the readonlyifvalue.

8 (is greater than or equal to)

The form field is disabled when the other field's value is greater than or equal to the readonlyifvalue.

9 (has no value)

The form field is disabled when the other field does not have a value.

readonlyifvalue

public static final XPropertyEnum readonlyifvalue

Data type: String

Default: (empty string)

Available for all forms element that allow a value to be entered. A form element can be disabled automatically based on the value of another form element. When a form field is disabled, its value cannot be changed anymore. This is the value against which the other form element is compared. Whether this property is required and what it must contain depends on the selected condition, see readonlyifcomp for further details.

readonlyifclear

public static final XPropertyEnum readonlyifclear

Data type: String

Default: (empty string)

Available for all forms element that allow a value to be entered. A form element can be disabled automatically based on the value of another form element. When a form field is disabled, its value cannot be changed anymore. This is a flag that indicates whether the form element is cleared when it is disabled. Can be set to one of the following options:

0 (keep)

The value of the form element is not changed when it is disabled.

1 (clear)

The value of the form element is cleared when it is disabled. For text input fields, the value is set to the empty string; for select fields, all selected options are deselected.

2 (reset)

The value of the form element is reset to its initial value when it is disabled. The initial value is determined by value for XTextFields, XTextAreas, and XSelects; and checkedvalue for XCheckboxes

readonlyifmode

public static final XPropertyEnum readonlyifmode

Data type: String

Default: 2

Available only for XTextFields and XTextAreas. A form element can be disabled automatically based on the value of another form element. When a form field is disabled, its value cannot be changed anymore. When this property is set to 1, the current value of the disabled text input field is discarded and not submitted to the server. This corresponds to the HTML disabled attribute. Otherwise, when set to 2, the value is submitted to the server. This corresponds to the HTML attribute readonly.

Please note that this property is not available for other form elements as the readonly HTML attribute is supported only by INPUT elements.

label

public static final XPropertyEnum label

Data type: HTML String

Default: Label

Available for all form elements that allow a value to be entered. This is the text of the label indicating the purpose of the form field. Please note that this property is interpreted as an HTML snippet, so special characters such as angle brackets (<>) need to be escaped.

labeldir

public static final XPropertyEnum labeldir

Data type: String

Default: top

Available for all elements that admit the label property. Indicates the position where the label is placed, relative to the form field. Available options are:

top

The label is displayed above the form element.

bottom

The label is displayed below the form element.

left

The label is displayed to the left of the form element.

right

The label is displayed to the right of the form element.

followup

The label is displayed inside the form element. When the user enters text, the label becomes smaller and moves to the top left of the form element.

labelwidth

public static final XPropertyEnum labelwidth

Data type: String

Default: 120px

Available for all elements that admit the label property. When the labeldir is set to left or right: The width of the label in pixels. The wider the label, the less space is available for the form element next to the label.

legend

public static final XPropertyEnum legend

Data type: HTML String

Default: 120px

Available for XFieldSets. This is the text of the fieldset legend, usually displayed above the fieldset content. Please note that this property is interpreted as an HTML snippet, so special characters such as angle brackets (<>) need to be escaped.

textalign

public static final XPropertyEnum textalign

Data type: String

Default: left

Available for XButtonLists and XImages. Indicates how the buttons or the image should be aligned. May be one of left (left alignment), center (centered), or right (right alignment).

unitwidth

public static final XPropertyEnum unitwidth

Data type: String

Default: 60px

Available for all elements that admit the property unit. The width of the unit text in pixels. The widget the unit text, the less space is available for the form element.

unit

public static final XPropertyEnum unit

Data type: String

Default: (empty string)

Available for XTextAreas, XTextFields, XUploads and XSelects. An optional text that is shown to the right of the form element. A common use case is displaying a unit such as kg or liter next to a text input field.

placeholder

public static final XPropertyEnum placeholder

Data type: String

Default: (empty string)

Available for XTextFields and XTextAreas. This is an optional placeholder text that is displayed when no value was entered in the input field. This property usually corresponds to the HTML attribute placeholder.

title

public static final XPropertyEnum title

Data type: String

Default: (empty string)

Available for all form elements that allow a value to be entered and also for XImages. This is an optional title that is displayed as a tooltip when the user hover over the element with the mouse cursor. This property usually corresponds to the HTML attribute title.

alt

public static final XPropertyEnum alt

Data type: String

Default: (empty string)

Available only for XImages. This is an optional description for the image that is used, for example, when the browser cannot display images user the user is using a screen reader. This property corresponds to the HTML attribute alt.

helptext

public static final XPropertyEnum helptext

Data type: HTML String

Default: (empty string)

Available for all elements other that XHeader, XPages, and XFooter. This is an optional informative description that is displayed when the user hovers over the help icon located next to the form element. Please note that this property is interpreted as an HTML snippet, so special characters such as angle brackets (<>) need to be escaped.

comment

public static final XPropertyEnum comment

Data type: String

Default: (empty string)

Available for all elements. This is an optional comment that is shown only in the designer and does not affect the rendered form in any way. This is usually used for internal comments when designing a form.

value

public static final XPropertyEnum value

Data type: String

Default: (empty string)

Available for XTextFields, XTextAreas, and XSelects. This property contains the initial value of the corresponding HTML INPUT or SELECT element. This initial value is set when the form is opened for the first time. By default, input fields and select elements are empty and do not have a value initially.

rtevalue

public static final XPropertyEnum rtevalue

Data type: HTML String

Default: Text

Available only for XSpans that is used to add informational text to a form. This is the text displayed by the span element. Please note that this property is interpreted as an HTML snippet, so special characters such as angle brackets (<>) need to be escaped.

buttons

public static final XPropertyEnum buttons

Data type: JSONArray

Default: (empty array)

Available only for XButtonLists. This property contains the list of buttons that are displayed. The list is a JSON array, where each entry represents a button. Each button is a JSONObject with the properties as described below.

Click to show example for the value of the buttons property

 [
     {
         "optionId": "p1",
         "page": "p1",
         "check": "false",
         "value": "Pagina p1"
     },
     {
         "optionId": "p1 + check",
         "page": "p1",
         "check": "true",
         "value": "Pagina p1 + controle"
     },
     {
         "optionId": "submit + check",
         "page": "submit",
         "check": "true",
         "value": "Verwerken + controle"
     },
     {
      "optionId": "submit",
      "page": "submitNoCheck",
      "check": "false",
      "value": "Verwerken"
     },
     {
         "optionId": "submit no save",
         "page": "submitPreview",
         "check": "false",
         "value": "Indienen"
     },
     {
         "optionId": "submit no save popup",
         "page": "submitPreviewWindowed",
         "check": "false",
         "value": "Indienen + popup"
     },
     {
         "optionId": "save + check",
         "page": "submitSave",
         "check": "true",
         "value": "Bewaren + controleren"
     },
     {
         "optionId": "save",
         "page": "submitSaveNoCheck",
         "check": "false",
         "value": "Bewaren"
     },
     {
         "page": "-1",
         "check": "false",
         "value": "Geen actie",
         "optionId": "no action"
     }
 ]
 

name (type String)

The name of the button which is used as the value of name attribute of the button. Please note that this is not the text that is displayed to the user (for that, see value)

title (type String)

An optional tooltip for the button that is shown when the user hovers of the button with the mouse or a pointer.

value (type String)

The text on the button that is shown to the user.

action (type JSONObject)

The action of the button that describes what should happen when the button is pressed. This is another JSONObject with the following properties:

check (type String)

Either true to indicate the current page should be validated when the button is pressed, or false otherwise.

value (type String)

The name of the that is performed when the button is pressed. This is the value as it can be selected in the designer, such as page p1 or Verwerken + controle. Please note that this value depends on the selected language and should not be used by code to check the action.

page (type String)

When the button is used for switching to a different page, this is the name of that page. Otherwise, this is the ID of the action that is performed when the button is pressed. Must be one of the following:

• submit: Validates the current page; and if it is valid, submits the form. Otherwise, highlights the error.
• submitNoCheck: Submits the form and send the data to the server, without prior validation.
• submitPreview: Submit the form and runs the workflow, but does not create a new form record.
• submitPreviewWindowed: Same as submitPreview, but displays the response from the server in a popup window.
• submitSave: Validates the form; and if it is valid, saves the current form data on the server. The user receives a link they can use to open the form again and finish filling out the form. If the current page is not valid, highlights the error.
• submitSaveNoCheck: Saves the current form data on the server, without prior validation. The user receives a link they can use to open the form again and finish filling out the form.
• -1: Performs no action when the button is pressed. Custom actions can be set up via JavaScript.
• <page-name>: Must be the name of an existing page. Switches to that page when the button is pressed. Whether the current page is validated before switching depends on the value of check.

optionId (type String)

ID of the action that is performed when the button is pressed. Must be one of the following:

• submit + check: Validates the current page; and if it is valid, submits the form. Otherwise, highlights the error.
• submit: Submits the form and send the data to the server, without prior validation.
• submit no save: Submit the form and runs the workflow, but does not create a new form record.
• submit no save popup: Same as submitPreview, but displays the response from the server in a popup window.
• save + check: Validates the form; and if it is valid, saves the current form data on the server. The user receives a link they can use to open the form again and finish filling out the form. If the current page is not valid, highlights the error.
• save: Saves the current form data on the server, without prior validation. The user receives a link they can use to open the form again and finish filling out the form.
• no action: Performs no action when the button is pressed. Custom actions can be set up via JavaScript.
• <page-name> + check:Validates the current page; and if it is valid, switches to that page. Otherwise, highlights the error. Example: p1 + check or pCarDetails + check.
• <page-name>: Must be the name of an existing page. Switches to that page when the button is pressed, without prior validation. Example: p1 or pCarDetails.

options

public static final XPropertyEnum options

Data type: JSONArray

Default: (empty array)

Available only for XSelects. This property contains the list of options for the select element. It must be a JSON array with one entry for each option. Each entry is a JSONObject with the following properties:

text (type String)

The text of the select option that is displayed to the user.

title (type String)

An optional tooltip that is displayed when the user hovers over the select option with the mouse or pointer.

value (type String)

The value of the select option that is sent to the server when the form is submitted.

questions

public static final XPropertyEnum questions

Data type: JSONArray

Default: (empty array)

Available only for XSelects when selectlayout is set to either table or table1 (a table with a list of questions that can be answered with one of the available options. This property contains the list of available questions, as a JSONArray. Each entry of the JSON array must be a JSONObject with the following properties:

value

The text of the question that is shown to the user (first row in the table of questions)

checkedvalue

public static final XPropertyEnum checkedvalue

Data type: String

Default: 0

Available only for XCheckboxes. Either 0 or 1. If this property is set to 1, the checkbox is initially checked. Otherwise, when set to 0, the checkbox is not checked initially.

checkboxvalue

public static final XPropertyEnum checkboxvalue

Data type: String

Default: on

Available only for XCheckboxes. The value that is sent to the server when the checkbox is checked. When the checkbox is not checked, no value is sent to the server.

image

public static final XPropertyEnum image

Data type: Data URL String

Default: (dummy image)

Available only for XImages. A data URL with a base64 string of the images that is displayed. For example, for a PNG image the data URL would look like

 data:image/png;base64,iVBOR...
 

imagelink

public static final XPropertyEnum imagelink

Data type: String

Default: (empty string)

Available only for XImages. Currently unused.

imagetarget

public static final XPropertyEnum imagetarget

Data type: String

Default: _blank

Available only for XImages. Currently unused.

imagegallerie

public static final XPropertyEnum imagegallerie

Data type: String

Default: 0

Available only for XImages. Currently unused.

imagegroup

public static final XPropertyEnum imagegroup

Data type: String

Default: (empty string)

Available only for XImages. Currently unused.

imagequality

public static final XPropertyEnum imagequality

Data type: String

Default: 100%

Available only for XImages. Currently unused.

datasource

public static final XPropertyEnum datasource

Data type: String

Default: (empty string)

Available only for XSelects. The name of a data source to be used for the select options. When no data source is set, the configured options are used.

appointmentTemplate

public static final XPropertyEnum appointmentTemplate

Data type: String

Default: (empty string)

Available only for XAppointments. The UUID of an appointment template to be used for booking appointment and finding free dates. When no appointment template is set, no appointments can be booked.

dstype

public static final XPropertyEnum dstype

Data type: String

Default: (empty string)

Available only for XSelects. The type of the data source that is used for the select options. Must be one of the following:

• USER: Uses the configured options.
• PLUGIN: Uses a plugin data source.
• DB: Uses a database query as the data source.
• CSV: Uses a static CSV file as the data source.
• LDAP: Uses an LDAP query as the data source.
• XML: Uses a static XML file as the data source.
• JSON: Uses a static JSON file as the data source.

dstextidx

public static final XPropertyEnum dstextidx

Data type: String

Default: 1

Available only for XSelects. When a datasource is set: The 1-based index of the column that contains the text of the select option that is shown to the user.

dsvalueidx

public static final XPropertyEnum dsvalueidx

Data type: String

Default: 2

Available only for XSelects. When a datasource is set: The 1-based index of the column that contains the value of the select option that sent to the server when the form is submitted.

datepicker

public static final XPropertyEnum datepicker

datatype

public static final XPropertyEnum datatype

showCapacity

public static final XPropertyEnum showCapacity

Data type: String

Default: 0

Available only for XAppointments. Describes if the amount of free appointments slots (capacity) should be appear in the appointment picker."

showUntil

public static final XPropertyEnum showUntil

Data type: String

Default: 0

Available only for XAppointments. Describes if the end time should be appear in the appointment picker."

closeable

public static final XPropertyEnum closeable

Data type: String

Default: 0

Available only for XAppointments. Describes if appointment picker can be closed an appear as usual input field."

dateFormat

public static final XPropertyEnum dateFormat

Data type: String

Default: dd.mm.yy

Available only for XAppointments. Describes the format dates will appear in the appointment picker. "Custom means the Property dateFormatCustom will be used."

dateFormatCustom

public static final XPropertyEnum dateFormatCustom

Data type: String

Default: dd.mm.yy

Available only for XAppointments. Describes the format dates will appear in the appointment picker when dateFormat equals "Custom".

requiredgroup

public static final XPropertyEnum requiredgroup

vrule

public static final XPropertyEnum vrule

maxlength

public static final XPropertyEnum maxlength

minlength

public static final XPropertyEnum minlength

minvalue

public static final XPropertyEnum minvalue

maxvalue

public static final XPropertyEnum maxvalue

checkboxmin

public static final XPropertyEnum checkboxmin

checkboxmax

public static final XPropertyEnum checkboxmax

maxfilesize

public static final XPropertyEnum maxfilesize

equals

public static final XPropertyEnum equals

fileextension

public static final XPropertyEnum fileextension

fileoutputalias

public static final XPropertyEnum fileoutputalias

vrulemismatch

public static final XPropertyEnum vrulemismatch

servervalidate

public static final XPropertyEnum servervalidate

flex

public static final XPropertyEnum flex

Data type: String

Required for all elements that can be arranged horizontally in a row next to other form elements, i.e. XButtonList, XCheckbox, XContainer, XFieldSet, XImage, XLine, XSelect, XSpacer, XSpan, XTextArea, XTextField, and XUpload. This is the relative width as a dimensionless number that can also be edited in the designer. The computedwidth is calculated by taking the ration of this property and dividing by the sum of the flex values of all items in the same row.

catalogue

public static final XPropertyEnum catalogue

cataloguename

public static final XPropertyEnum cataloguename

catalogueitem

public static final XPropertyEnum catalogueitem

catalogueunique

public static final XPropertyEnum catalogueunique

cataloguelabel

public static final XPropertyEnum cataloguelabel

dynamic

public static final XPropertyEnum dynamic

Data type: String

Can be added to input elements to allow marking an element as repeated, i.e. XContainer, XFieldSet, XSelect, XTextArea, XTextField, and XUpload. When set to 1, the element is repeated and the user can use the plus and minus buttons to create one or multiple copies of the form element. Otherwise, when set to 0, the element cannot be repeated.

dynamicMinSize

public static final XPropertyEnum dynamicMinSize

Data type: String

Required for all elements that have the property dynamic enabled. This property can be edited in the designer only when dynamic is activated. It controls the lower limit of allowed repetitions and defaults to 1.

dynamicMaxSize

public static final XPropertyEnum dynamicMaxSize

Data type: String

Required for all elements that have the property dynamic enabled. This property can be edited in the designer only when dynamic is activated. It controls the upper limit of allowed repetitions and defaults to 10.

dynamicTrigger

public static final XPropertyEnum dynamicTrigger

Data type: String

Required for all elements that have the property dynamic enabled. This property can be edited in the designer only when dynamic is activated. This is the id of another form element whose value controls the number of repetitions of this element. For example, when the dynamic trigger is set to another XTextField and the user enters 4 in that text field, this will cause this element to have 4 repetitions (either by adding new repetitions or removing existing repetitions).

dynamicHideButtons

public static final XPropertyEnum dynamicHideButtons

Data type: String

Required for all elements that have the property dynamic enabled. This property can be edited in the designer only when dynamic is activated. When this property is set to 1, the plus and minus buttons for adding and removing repetitions are hidden. Otherwise, when set to 0, the buttons are shown normally. Hiding the buttons may be useful when the number of repetitions should be controlled only by the dynamicTrigger.

cssclasses

public static final XPropertyEnum cssclasses

attributes

public static final XPropertyEnum attributes

i18n

public static final XPropertyEnum i18n

statusdependent

public static final XPropertyEnum statusdependent

viewstatus

public static final XPropertyEnum viewstatus

usergrouppendent

public static final XPropertyEnum usergrouppendent

viewusergroup

public static final XPropertyEnum viewusergroup

readonly_statusdependent

public static final XPropertyEnum readonly_statusdependent

readonly_viewstatus

public static final XPropertyEnum readonly_viewstatus

readonly_usergrouppendant

public static final XPropertyEnum readonly_usergrouppendant

readonly_viewusergroup

public static final XPropertyEnum readonly_viewusergroup

print_hide

public static final XPropertyEnum print_hide

print_list

public static final XPropertyEnum print_list

print_text_only

public static final XPropertyEnum print_text_only

print_func

public static final XPropertyEnum print_func

print_break

public static final XPropertyEnum print_break

print_size

public static final XPropertyEnum print_size

Method Detail

values

public static XPropertyEnum[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (XPropertyEnum c : XPropertyEnum.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static XPropertyEnum valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

contains

public static boolean contains(String name)

getClazz

public Class<?> getClazz()

getDefaultValue

public Serializable getDefaultValue()