Package com.jbstrap.core.meta.enums

Enum Class EditorType

java.lang.Object

java.lang.Enum<EditorType>

com.jbstrap.core.meta.enums.EditorType

All Implemented Interfaces:

Serializable, Comparable<EditorType>, Constable

public enum EditorType
extends Enum<EditorType>

Editor components that can be used on editor interfaces

The components can be created through code, (following the specified editor type) or through a DataDescriptor. If the editor interface is built through a DataDescriptor, then the component's parameters can be specified in the DataDescriptor XML. Every editable component's description describes which parameters it accepts, and how those are interpreted.

Since:

4.0

Author:

JBStrap

See Also:

• DataDescriptor

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CHECKBOX	Checkbox component, that can input logic values.
COMBOBOX	Combobox type input field, that will have its set of values be selectable from a drop down menu.
DATE_PICKER	Date picker type input field
DATE_RANGE	Date range input field.
DATETIME_PICKER	Date and time picker type input field
DATETIME_RANGE	Date and time range input field.
DECIMAL_EDITOR	Numeric input field, that allows the input of decimal numbers.
DUAL_LISTBOX	Dual listbox type input field, that will have its set of values be selectable from a list.
FILE	File type input field.
HIDDEN_ITEM	Hidden field component.
INTEGER_EDITOR	Numeric input field, that allows the input of integer numbers.
PASSWORD	Password input field.
RADIO_BUTTONS	An input component, with a set of values, that are assigned to each radio button.
SELECTOR_ITEM	A selector type input field, that allows the user to pick values from a (freely implantable) popup window.
STATIC_TEXT_ITEM	Static text displaying field.
SWITCH_ITEM	Switch component, that is for inputting logic values.
TEXT_EDITOR	Simple text input field, or long text editor textbox.

Method Summary

Modifier and Type	Method	Description
static EditorType	fromEditorClass(Class<?> editorClass)	Determines the editor type, by the class that implements the editor component
static EditorType	fromName(String name)	Determines the editor type, by its name.
OperatorType	getDefaultOperator()
Class<? extends FormItem<?,?>>	getEditorClass()	Gets the class that implements the editor component
List<String>	getNames()
final void	setEditorClass(Class<? extends FormItem<?,?>> editorClass)	Overwrites the default editor component
static EditorType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EditorType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

TEXT_EDITOR

public static final EditorType TEXT_EDITOR

Simple text input field, or long text editor textbox. If the text in the input field can only be 255 character long or less, the field will be small (single line) If the field can have more than 255 characters in it, then a text input box will be used (multiple lines)

This input field can be created in the DataDescriptor, by assigning the "EditorType" attribute to the column parameters, with the value of "TextEditor". The component processes the following column parameters:

MetaParamName constant name	Parameter name in the DataDescriptor	Description	Default
PLACEHOLDER	placeholder	The input field placeholder text	null
SIZE	size	The form item size. The applicable values can be found in the FormItemSize enum	NORMAL
STATE	state	The editable component's state. The applicable values can be found in the FormItemState enum	DEFAULT
DEFAULT_VALUE	defaultValue	The component's default value. Used when a new record is being edited, or if the value is deleted through code. Regardless of this value, it can be altered by the user, or through code to null value, but the default value won't be set in this case.	null
READ_ONLY	readOnly	Determines if the component is read-only. Can be true or false.	false
ENABLED	enabled	Determines if the component is enabled. If a component is not enabled, the component value won't be editable for the user, and it will appear greyed out.	true
HELP	help	If a help text is set, a help icon will appear on the component's right side. If the user mouses over the icon the help text will be displayed in a bubble.	null
HELP_ICON	helpIcon	The help icon that will appear on the component. For applicable values, see the Icon enum.	QUESTION
DESCRIPTION	description	The component description text, that appears under the component, in smaller text.	null
TAB_INDEX	tabIndex	The input field tab index. This number determines the order the fields will gain focus, if the user uses the TAB key If not specified, or set to null, the tab index will be the same as the field order.	null
MASK	mask	The input mask used for formatted data	null
FORCE_TEXT_AREA	forceTextArea	This parameter forces the component, (even in the case of short text), to have a text box, instead of an input field. Can be true or false. If true the use of the text box will be forced in every case.	false

See Also:

• DataDescriptor
• TextItem

INTEGER_EDITOR

public static final EditorType INTEGER_EDITOR

Numeric input field, that allows the input of integer numbers.

This input field can be created in the DataDescriptor, by assigning the "EditorType" attribute to the column parameters, with the value of "IntegerEditor". The component processes the following column parameters:

MetaParamName constant name	Parameter name in the DataDescriptor	Description	Default
PLACEHOLDER	placeholder	The input field placeholder text	null
SIZE	size	The form item size. The applicable values can be found in the FormItemSize enum	NORMAL
STATE	state	The editable component's state. The applicable values can be found in the FormItemState enum	DEFAULT
DEFAULT_VALUE	defaultValue	The component's default value. Used when a new record is being edited, or if the value is deleted through code. Regardless of this value, it can be altered by the user, or through code to null value, but the default value won't be set in this case.	null
READ_ONLY	readOnly	Determines if the component is read-only. Can be true or false.	false
ENABLED	enabled	Determines if the component is enabled. If a component is not enabled, the component value won't be editable for the user, and it will appear greyed out.	true
HELP	help	If a help text is set, a help icon will appear on the component's right side. If the user mouses over the icon the help text will be displayed in a bubble.	null
HELP_ICON	helpIcon	The help icon that will appear on the component. For applicable values, see the Icon enum.	QUESTION
DESCRIPTION	description	The component description text, that appears under the component, in smaller text.	null
TAB_INDEX	tabIndex	The input field tab index. This number determines the order the fields will gain focus, if the user uses the TAB key If not specified, or set to null, the tab index will be the same as the field order.	null
null
MIN_VALUE	minValue	The component minimum value. If the user reaches this value, the value cannot be decreased any further.	null
MAX_VALUE	maxValue	The component maximum value. If the user reaches this value, the value cannot be increased any further.	null
TOUCHSPIN_STEP	step	This parameter determines how much the value will be increased or decreased in each step (either by the button press, or mouse wheel).	1
TOUCHSPIN_BUTTONUP_CLASS	buttonupClass	The name of the custom style class of the touchspin up button.	null
TOUCHSPIN_BUTTONDOWN_CLASS	buttondownClass	The name of the custom style class of the touchspin down button.	null
TOUCHSPIN_PREFIX	touchspinPrefix	The text in front of the input field (The prefix text)	null
TOUCHSPIN_PREFIX_EXTRACLASS	prefixExtraclass	The name of the custom style class of the prefix	null
TOUCHSPIN_POSTFIX	touchspinPostfix	The text after the input field (The postfix text)	null
TOUCHSPIN_POSTFIX_EXTRACLASS	postfixExtraclass	The name of the custom style class of the postfix	null
TOUCHSPIN_VERTICALBUTTONS	verticalbuttons	Determines if the touchspin buttons are displayed vertically. If true, the buttons will be displayed after the input field, vertically. If false, the increase button will be displayed after the input field, the decrease button will be displayed in front of the input field.	false
MOUSEWHEEL	mousewheel	Determines if the mousewheel is usable on the component. If true the user can modify the value using the mousewheel if they are over the input field.	true

See Also:

• DataDescriptor
• IntegerItem

DECIMAL_EDITOR

public static final EditorType DECIMAL_EDITOR

Numeric input field, that allows the input of decimal numbers.

This input field can be created in the DataDescriptor, by assigning the "EditorType" attribute to the column parameters, with the value of "DecimalEditor". The component processes the following column parameters:

MetaParamName constant name	Parameter name in the DataDescriptor	Description	Default
PLACEHOLDER	placeholder	The input field placeholder text	null
SIZE	size	The form item size. The applicable values can be found in the FormItemSize enum	NORMAL
STATE	state	The editable component's state. The applicable values can be found in the FormItemState enum	DEFAULT
DEFAULT_VALUE	defaultValue	The component's default value. Used when a new record is being edited, or if the value is deleted through code. Regardless of this value, it can be altered by the user, or through code to null value, but the default value won't be set in this case.	null
READ_ONLY	readOnly	Determines if the component is read-only. Can be true or false.	false
ENABLED	enabled	Determines if the component is enabled. If a component is not enabled, the component value won't be editable for the user, and it will appear greyed out.	true
HELP	help	If a help text is set, a help icon will appear on the component's right side. If the user mouses over the icon the help text will be displayed in a bubble.	null
HELP_ICON	helpIcon	The help icon that will appear on the component. For applicable values, see the Icon enum.	QUESTION
DESCRIPTION	description	The component description text, that appears under the component, in smaller text.	null
TAB_INDEX	tabIndex	The input field tab index. This number determines the order the fields will gain focus, if the user uses the TAB key If not specified, or set to null, the tab index will be the same as the field order.	null
MIN_VALUE	minValue	The component minimum value. If the user reaches this value, the value cannot be decreased any further.	null
MAX_VALUE	maxValue	The component maximum value. If the user reaches this value, the value cannot be increased any further.	null
TOUCHSPIN_STEP	step	This parameter determines how much the value will be increased or decreased in each step (either by the button press, or mouse wheel).	0.1
TOUCHSPIN_BUTTONUP_CLASS	buttonupClass	The name of the custom style class of the touchspin up button.	null
TOUCHSPIN_BUTTONDOWN_CLASS	buttondownClass	The name of the custom style class of the touchspin down button.	null
TOUCHSPIN_PREFIX	touchspinPrefix	The text in front of the input field (The prefix text)	null
TOUCHSPIN_PREFIX_EXTRACLASS	prefixExtraclass	The name of the custom style class of the prefix	null
TOUCHSPIN_POSTFIX	touchspinPostfix	The text after the input field (The postfix text)	null
TOUCHSPIN_POSTFIX_EXTRACLASS	postfixExtraclass	The name of the custom style class of the postfix	null
TOUCHSPIN_VERTICALBUTTONS	verticalbuttons	Determines if the touchspin buttons are displayed vertically. If true, the buttons will be displayed after the input field, vertically. If false, the increase button will be displayed after the input field, the decrease button will be displayed in front of the input field.	false
MOUSEWHEEL	mousewheel	Determines if the mousewheel is usable on the component. If true the user can modify the value using the mousewheel if they are over the input field.	true

See Also:

• DataDescriptor
• NumberItem

DATE_PICKER

public static final EditorType DATE_PICKER

Date picker type input field

This input field can be created in the DataDescriptor, by assigning the "EditorType" attribute to the column parameters, with the value of "DatePicker". The component processes the following column parameters:

MetaParamName constant name	Parameter name in the DataDescriptor	Description	Default
PLACEHOLDER	placeholder	The input field placeholder text	null
SIZE	size	The form item size. The applicable values can be found in the FormItemSize enum	NORMAL
STATE	state	The editable component's state. The applicable values can be found in the FormItemState enum	DEFAULT
DEFAULT_VALUE	defaultValue	The component's default value. Used when a new record is being edited, or if the value is deleted through code. Regardless of this value, it can be altered by the user, or through code to null value, but the default value won't be set in this case.	null
READ_ONLY	readOnly	Determines if the component is read-only. Can be true or false.	false
ENABLED	enabled	Determines if the component is enabled. If a component is not enabled, the component value won't be editable for the user, and it will appear greyed out.	true
HELP	help	If a help text is set, a help icon will appear on the component's right side. If the user mouses over the icon the help text will be displayed in a bubble.	null
HELP_ICON	helpIcon	The help icon that will appear on the component. For applicable values, see the Icon enum.	QUESTION
DESCRIPTION	description	The component description text, that appears under the component, in smaller text.	null
TAB_INDEX	tabIndex	The input field tab index. This number determines the order the fields will gain focus, if the user uses the TAB key If not specified, or set to null, the tab index will be the same as the field order.	null
DATE_FORMAT	dateFormat	The component's date format	JBStrapParamType.DATE_FORMAT

See Also:

• DataDescriptor
• DatePicker

DATETIME_PICKER

public static final EditorType DATETIME_PICKER

Date and time picker type input field

This input field can be created in the DataDescriptor, by assigning the "EditorType" attribute to the column parameters, with the value of "DatePicker". The component processes the following column parameters:

MetaParamName constant name	Parameter name in the DataDescriptor	Description	Default
PLACEHOLDER	placeholder	The input field placeholder text	null
SIZE	size	The form item size. The applicable values can be found in the FormItemSize enum	NORMAL
STATE	state	The editable component's state. The applicable values can be found in the FormItemState enum	DEFAULT
DEFAULT_VALUE	defaultValue	The component's default value. Used when a new record is being edited, or if the value is deleted through code. Regardless of this value, it can be altered by the user, or through code to null value, but the default value won't be set in this case.	null
READ_ONLY	readOnly	Determines if the component is read-only. Can be true or false.	false
ENABLED	enabled	Determines if the component is enabled. If a component is not enabled, the component value won't be editable for the user, and it will appear greyed out.	true
HELP	help	If a help text is set, a help icon will appear on the component's right side. If the user mouses over the icon the help text will be displayed in a bubble.	null
HELP_ICON	helpIcon	The help icon that will appear on the component. For applicable values, see the Icon enum.	QUESTION
DESCRIPTION	description	The component description text, that appears under the component, in smaller text.	null
TAB_INDEX	tabIndex	The input field tab index. This number determines the order the fields will gain focus, if the user uses the TAB key If not specified, or set to null, the tab index will be the same as the field order.	null
DATE_FORMAT	dateFormat	The component's date format	JBStrapParamType.DATETIME_FORMAT

See Also:

• DataDescriptor
• DatePicker

COMBOBOX

public static final EditorType COMBOBOX

Combobox type input field, that will have its set of values be selectable from a drop down menu. The user can filter these values, thus making the dropdown menu smaller.

This input field can be created in the DataDescriptor, by assigning the "EditorType" attribute to the column parameters, with the value of "Combobox". The component processes the following column parameters:

MetaParamName constant name	Parameter name in the DataDescriptor	Description	Default
PLACEHOLDER	placeholder	The input field placeholder text	null
SIZE	size	The form item size. The applicable values can be found in the FormItemSize enum	NORMAL
STATE	state	The editable component's state. The applicable values can be found in the FormItemState enum	DEFAULT
DEFAULT_VALUE	defaultValue	The component's default value. Used when a new record is being edited, or if the value is deleted through code. Regardless of this value, it can be altered by the user, or through code to null value, but the default value won't be set in this case.	null
READ_ONLY	readOnly	Determines if the component is read-only. Can be true or false.	false
ENABLED	enabled	Determines if the component is enabled. If a component is not enabled, the component value won't be editable for the user, and it will appear greyed out.	true
HELP	help	If a help text is set, a help icon will appear on the component's right side. If the user mouses over the icon the help text will be displayed in a bubble.	null
HELP_ICON	helpIcon	The help icon that will appear on the component. For applicable values, see the Icon enum.	QUESTION
DESCRIPTION	description	The component description text, that appears under the component, in smaller text.	null
TAB_INDEX	tabIndex	The input field tab index. This number determines the order the fields will gain focus, if the user uses the TAB key If not specified, or set to null, the tab index will be the same as the field order.	null
MULTIPLE	multiple	Determines if multiple values can be selected at the same time. If true, multiple values can be selected.	false
ALLOW_NULL	allowNull	Determines if the component accepts a null value. If true, the component can accept a null value, and an icon that deletes the value appears on the right side of the component.	Inherited from the column
NULL_DATA	nullData	Determines what value the component will have, if it is assigned a null value (either directly, or if the user doesn't select a value). This setting allows that instead of null, a value corresponding to the type of the column is assigned.	null
NULL_DISPLAY	nullText	Sets what is displayed when it's value is null	""
DATADESCRIPTOR	dataDescriptor	If this parameter is used, the DataDescriptor specified here (by its name) will provide the selectable values for the component. This means that the selectable values can be read from a different DataDescriptor.	null
DATA_COLUMN	dataColumn	If the component is using a different DataDescriptor for the selectable values, use this parameter to set the name of the DataDescriptor data column. When saving, this value will be saved to the database.	null
DISPLAY_COLUMN	displayColumn	Sets the name of the DataDescriptor display column(s). This is the data that is displayed to the user. When saving these values will not be saved to the database. If multiple columns are specified, (they can be separated by a "," character), all of them will be displayed.	null
DISPLAY_COLUMN_SEPARATOR	displayColumnSeparator	If multiple display columns are assigned, their text values will be separated by the character specified here.	""
CRITERIA	criteria	If the selectable values are from another DataDescriptor, the filter critera used can be specified here. For the filter criteria, any column from the DataDescriptor can be used, regardless if it is one of the columns that is being used by the component or not. For example: "Criteria(columnName, EQUALS, 12)" or "Criteria(AND, Criteria(columnName, op, value), Criteria(ColumnName, op, value))"	null
AUTO_FETCH	autoFetch	Sets if the Auto fetch is enabled on the component. If enabled, the values will be automatically queried from the database. If disabled, If disabled, the query of the set of values must be handled by the application. If this is not done, the user will see an empty set of values.	true
MULTI_VALUE_JOIN_TABLE	multiValueJoinTable	The name of the connector table in the database, that is in the 1:N connection Must be defined if the multiple selection is enabled.	null
MULTI_VALUE_RECORD_COLUMN	multiValueRecordColumn	This parameter is where the saved record and the connector table record must be connected. This is done by specifying the name of the column that is in the connector table. This is where the record's primary key will be saved. If the record key is complex then every column's field in the key have to be listed here, separated by commas, in the order they are in record. If the matching table and record isn't connected by the primary key, then in this parameter the connection must be specified, by naming the field in the matching table. Then, connect it, with a "=" character to the name of the record attribute, whose value will be saved to the specified field. For example: column=recordAttributeName. Multiple connections can be specified, separated by ",".	null
MULTI_VALUE_VALUE_COLUMN	multiValueValueColumn	This parameter where it's specified which connector table column, that will hold the component value (The component values are in the dataValue list). If there are multipel values selected in the component, then the matching table will have multiple records as well. When the component is modified, the records in the matching table will also be modified. (ie if something is deleted from the component, it will also be deleted from the table).	null
MULTI_VALUE_EXTEND_VALUES	multiValueExtendValues	If the matching table is to store furter values, this parameter provides a solution for that. The parameter can have static values specified to the matching table. This is done by specifying the name of the field in the table, then putting a "=" character, then a static value, that will also be saved to the field. (For example: column=12 or column=ABC) If a non-static value is specified, then a saved record's attribute can be used. This is defined similarily: First the name of the field in the matching table, then "=", followed by the name of the attribute that is in the record: columnName=${recordAttributeName}. Data specified like this will be saved to every matching table record. If more than one extra data is to be specified, then in can be done, following the above listed format, separated by commas.	null

See Also:

• DataDescriptor
• ComboboxItem
• Filterable
• BasedOnDataDescriptor
• MultiValueFormItem
• DifferentDataDisplayValue
• DifferentMultiDataDisplayValue

CHECKBOX

public static final EditorType CHECKBOX

Checkbox component, that can input logic values. If checked, it is considered true, if empty false. When saving, this value will be converted, according to the DEFAULT_BOOLEAN_CONVERTER JBStrap parameter.

This input field can be created in the DataDescriptor, by assigning the "EditorType" attribute to the column parameters, with the value of "CheckBox". The component processes the following column parameters:

Sets the type of the checkbox. The applicable values can be found in the CheckboxType enum.Sets the shape of the Checkbox. The applicable values can be found in the CheckboxShape enum.

MetaParamName constant name	Parameter name in the DataDescriptor	Description	Default
PLACEHOLDER	placeholder	The input field placeholder text	null
SIZE	size	The form item size. The applicable values can be found in the FormItemSize enum	NORMAL
STATE	state	The editable component's state. The applicable values can be found in the FormItemState enum	DEFAULT
DEFAULT_VALUE	defaultValue	The component's default value. Used when a new record is being edited, or if the value is deleted through code. Regardless of this value, it can be altered by the user, or through code to null value, but the default value won't be set in this case.	null
READ_ONLY	readOnly	Determines if the component is read-only. Can be true or false.	false
ENABLED	enabled	Determines if the component is enabled. If a component is not enabled, the component value won't be editable for the user, and it will appear greyed out.	true
HELP	help	If a help text is set, a help icon will appear on the component's right side. If the user mouses over the icon the help text will be displayed in a bubble.	null
HELP_ICON	helpIcon	The help icon that will appear on the component. For applicable values, see the Icon enum.	QUESTION
DESCRIPTION	description	The component description text, that appears under the component, in smaller text.	null
TAB_INDEX	tabIndex	The input field tab index. This number determines the order the fields will gain focus, if the user uses the TAB key If not specified, or set to null, the tab index will be the same as the field order.	null
TYPE	type	DEFAULT
SHAPE	shape	DEFAULT

See Also:

• DataDescriptor
• CheckboxItem
• BooleanValueFormItem

PASSWORD

public static final EditorType PASSWORD

Password input field. Text in this field will be displayed as dots, so it is not readable.

This input field can be created in the DataDescriptor, by assigning the "EditorType" attribute to the column parameters, with the value of "Password". The component processes the following column parameters:

MetaParamName constant name	Parameter name in the DataDescriptor	Description	Default
PLACEHOLDER	placeholder	The input field placeholder text	null
SIZE	size	The form item size. The applicable values can be found in the FormItemSize enum	NORMAL
STATE	state	The editable component's state. The applicable values can be found in the FormItemState enum	DEFAULT
DEFAULT_VALUE	defaultValue	The component's default value. Used when a new record is being edited, or if the value is deleted through code. Regardless of this value, it can be altered by the user, or through code to null value, but the default value won't be set in this case.	null
READ_ONLY	readOnly	Determines if the component is read-only. Can be true or false.	false
ENABLED	enabled	Determines if the component is enabled. If a component is not enabled, the component value won't be editable for the user, and it will appear greyed out.	true
HELP	help	If a help text is set, a help icon will appear on the component's right side. If the user mouses over the icon the help text will be displayed in a bubble.	null
HELP_ICON	helpIcon	The help icon that will appear on the component. For applicable values, see the Icon enum.	QUESTION
DESCRIPTION	description	The component description text, that appears under the component, in smaller text.	null
TAB_INDEX	tabIndex	The input field tab index. This number determines the order the fields will gain focus, if the user uses the TAB key If not specified, or set to null, the tab index will be the same as the field order.	null
MASK	mask	The input mask used for formatted data	null
FORCE_TEXT_AREA	forceTextArea	This parameter forces the component, (even in the case of short text), to have a text box, instead of an input field. Can be true or false. If true the use of the text box will be forced in every case.	false

See Also:

• DataDescriptor
• PasswordItem

RADIO_BUTTONS

public static final EditorType RADIO_BUTTONS

An input component, with a set of values, that are assigned to each radio button. From this, only one can be chosen. The values are displayed vertically, under each other, or horizontally, next to each other.

This input field can be created in the DataDescriptor, by assigning the "EditorType" attribute to the column parameters, with the value of "RadioButton". The component processes the following column parameters:

If the component is using a different DataDescriptor it's values, use this parameter to set the name of the DataDescriptor display column(s). This is the data that is displayed to the user. When saving these values will not be saved to the database. If multiple columns are specified, (they can be separated by a "," character), all of them will be displayed.

MetaParamName constant name	Parameter name in the DataDescriptor	Description	Default
PLACEHOLDER	placeholder	The input field placeholder text	null
SIZE	size	The form item size. The applicable values can be found in the FormItemSize enum	NORMAL
STATE	state	The editable component's state. The applicable values can be found in the FormItemState enum	DEFAULT
DEFAULT_VALUE	defaultValue	The component's default value. Used when a new record is being edited, or if the value is deleted through code. Regardless of this value, it can be altered by the user, or through code to null value, but the default value won't be set in this case.	null
READ_ONLY	readOnly	Determines if the component is read-only. Can be true or false.	false
ENABLED	enabled	Determines if the component is enabled. If a component is not enabled, the component value won't be editable for the user, and it will appear greyed out.	true
HELP	help	If a help text is set, a help icon will appear on the component's right side. If the user mouses over the icon the help text will be displayed in a bubble.	null
HELP_ICON	helpIcon	The help icon that will appear on the component. For applicable values, see the Icon enum.	QUESTION
DESCRIPTION	description	The component description text, that appears under the component, in smaller text.	null
TAB_INDEX	tabIndex	The input field tab index. This number determines the order the fields will gain focus, if the user uses the TAB key If not specified, or set to null, the tab index will be the same as the field order.	null
DATADESCRIPTOR	dataDescriptor	If this parameter is used, the DataDescriptor specified here (by its name) will provide the selectable values for the component. This means that the selectable values can be read from a different DataDescriptor.	null
DATA_COLUMN	dataColumn	If the component is using a different DataDescriptor for its values, use this parameter to set the name of the DataDescriptor data column. When saving, this value will be saved to the database.	null
DISPLAY_COLUMN	displayColumn	null
DISPLAY_COLUMN_SEPARATOR	displayColumnSeparator	If multiple display columns are assigned, their text values will be separated by the character specified here.	""
CRITERIA	criteria	If the selectable values are from another DataDescriptor, the filter critera used can be specified here. For the filter criteria, any column from the DataDescriptor can be used, regardless if it is one of the columns that is being used by the component or not. For example: "Criteria(columnName, EQUALS, 12)" or "Criteria(AND, Criteria(columnName, op, value), Criteria(ColumnName, op, value))"	null
AUTO_FETCH	autoFetch	Sets if the Auto fetch is enabled on the component. If enabled, the values will be automatically queried from the database. If disabled, If disabled, the query of the set of values must be handled by the application. If this is not done, the user will see an empty set of values.	true
INLINE	inline	Determines if the values are displayed inline. If true, the values will be next to each other. If false, then they will be under each other.	false

See Also:

• DataDescriptor
• RadioButtonItem
• Filterable
• BasedOnDataDescriptor
• DifferentDataDisplayValue

FILE

public static final EditorType FILE

File type input field. The file specified here will be uploaded to the server, and they will be stored by the Filestores, following the specified parameters. For more information about filestores, refer to the FileStoreAPI class description

The files will be uploaded automatically, but they will be only stored, if they were saved to the database. If enabled, the user can upload multiple files, and they will be processed simultaneously. The component supports both drag&drop and the regular browser method to select the file(s). For more information about customizing the storing of files, see the FileHandler class description.

This input field can be created in the DataDescriptor, by assigning the "EditorType" attribute to the column parameters, with the value of "File". The component processes the following column parameters:

null

MetaParamName constant name	Parameter name in the DataDescriptor	Description	Default
PLACEHOLDER	placeholder	The input field placeholder text	null
SIZE	size	The form item size. The applicable values can be found in the FormItemSize enum	NORMAL
STATE	state	The editable component's state. The applicable values can be found in the FormItemState enum	DEFAULT
DEFAULT_VALUE	defaultValue	The component's default value. Used when a new record is being edited, or if the value is deleted through code. Regardless of this value, it can be altered by the user, or through code to null value, but the default value won't be set in this case.	null
READ_ONLY	readOnly	Determines if the component is read-only. Can be true or false.	false
ENABLED	enabled	Determines if the component is enabled. If a component is not enabled, the component value won't be editable for the user, and it will appear greyed out.	true
HELP	help	If a help text is set, a help icon will appear on the component's right side. If the user mouses over the icon the help text will be displayed in a bubble.	null
HELP_ICON	helpIcon	The help icon that will appear on the component. For applicable values, see the Icon enum.	QUESTION
DESCRIPTION	description	The component description text, that appears under the component, in smaller text.	null
TAB_INDEX	tabIndex	The input field tab index. This number determines the order the fields will gain focus, if the user uses the TAB key If not specified, or set to null, the tab index will be the same as the field order.	null
MULTIPLE	multiple	Determines if the component can handle multiple simultaneous files. If true, this function will be enabled. If false, only one file will be allowed on the component. In this case the second upload will overwrite teh first one./td>	false
DRAGABLE	dragable	Determines if the user can drag a file to the component. If true, this function is enabled, and the user can drag and drop files to the component, that will be then uploaded.	false
FILE_STORE_NAME	fileStoreName	The name of the Filestore, where the files will be saved to.

See Also:

• DataDescriptor
• FileItem
• FileStoreAPI
• FileHandler
• FileValueFormItem

DUAL_LISTBOX

public static final EditorType DUAL_LISTBOX

Dual listbox type input field, that will have its set of values be selectable from a list. A second list will be displayed, that will have the component's values in it. The user can move the values between these two lists. The user can select multiple values.

This input field can be created in the DataDescriptor, by assigning the "EditorType" attribute to the column parameters, with the value of "DualListBox". The component processes the following column parameters:

MetaParamName constant name	Parameter name in the DataDescriptor	Description	Default
PLACEHOLDER	placeholder	The input field placeholder text	null
SIZE	size	The form item size. The applicable values can be found in the FormItemSize enum	NORMAL
STATE	state	The editable component's state. The applicable values can be found in the FormItemState enum	DEFAULT
DEFAULT_VALUE	defaultValue	The component's default value. Used when a new record is being edited, or if the value is deleted through code. Regardless of this value, it can be altered by the user, or through code to null value, but the default value won't be set in this case.	null
READ_ONLY	readOnly	Determines if the component is read-only. Can be true or false.	false
ENABLED	enabled	Determines if the component is enabled. If a component is not enabled, the component value won't be editable for the user, and it will appear greyed out.	true
HELP	help	If a help text is set, a help icon will appear on the component's right side. If the user mouses over the icon the help text will be displayed in a bubble.	null
HELP_ICON	helpIcon	The help icon that will appear on the component. For applicable values, see the Icon enum.	QUESTION
DESCRIPTION	description	The component description text, that appears under the component, in smaller text.	null
TAB_INDEX	tabIndex	The input field tab index. This number determines the order the fields will gain focus, if the user uses the TAB key If not specified, or set to null, the tab index will be the same as the field order.	null
DATADESCRIPTOR	dataDescriptor	If this parameter is used, the DataDescriptor specified here (by its name) will provide the selectable values for the component. This means that the selectable values can be read from a different DataDescriptor.	null
DATA_COLUMN	dataColumn	If the component is using a different DataDescriptor for the selectable values, use this parameter to set the name of the DataDescriptor data column. When saving, this value will be saved to the database.	null
DISPLAY_COLUMN	displayColumn	Sets the name of the DataDescriptor display column(s). This is the data that is displayed to the user. When saving these values will not be saved to the database. If multiple columns are specified, (they can be separated by a "," character), all of them will be displayed.	null
DISPLAY_COLUMN_SEAPARATOR	displayColumnSeparator	If multiple display columns are assigned, their text values will be separated by the character specified here.	""
CRITERIA	criteria	If the selectable values are from another DataDescriptor, the filter critera used can be specified here. For the filter criteria, any column from the DataDescriptor can be used, regardless if it is one of the columns that is being used by the component or not. For example: "Criteria(columnName, EQUALS, 12)" or "Criteria(AND, Criteria(columnName, op, value), Criteria(ColumnName, op, value))"	null
AUTO_FETCH	autoFetch	Sets if the Auto fetch is enabled on the component. If enabled, the values will be automatically queried from the database. If disabled, If disabled, the query of the set of values must be handled by the application. If this is not done, the user will see an empty set of values.	true
MULTI_VALUE_JOIN_TABLE	multiValueJoinTable	The name of the connector table in the database, that is in the 1:N connection Must be defined if the multiple selection is enabled.	null
MULTI_VALUE_RECORD_COLUMN	multiValueRecordColumn	This parameter is where the saved record and the connector table record must be connected. This is done by specifying the name of the column that is in the connector table. This is where the record's primary key will be saved. If the record key is complex then every column's field in the key have to be listed here, separated by commas, in the order they are in record. If the matching table and record isn't connected by the primary key, then in this parameter the connection must be specified, by naming the field in the matching table. Then, connect it, with a "=" character to the name of the record attribute, whose value will be saved to the specified field. For example: column=recordAttributeName. Multiple connections can be specified, separated by ",".	null
MULTI_VALUE_VALUE_COLUMN	multiValueValueColumn	This parameter where it's specified which connector table column, that will hold the component value (The component values are in the dataValue list). If there are multipel values selected in the component, then the matching table will have multiple records as well. When the component is modified, the records in the matching table will also be modified. (ie if something is deleted from the component, it will also be deleted from the table).	null
MULTI_VALUE_EXTEND_VALUES	multiValueExtendValues	If the matching table is to store furter values, this parameter provides a solution for that. The parameter can have static values specified to the matching table. This is done by specifying the name of the field in the table, then putting a "=" character, then a static value, that will also be saved to the field. (For example: column=12 or column=ABC) If a non-static value is specified, then a saved record's attribute can be used. This is defined similarily: First the name of the field in the matching table, then "=", followed by the name of the attribute that is in the record: columnName=${recordAttributeName}. Data specified like this will be saved to every matching table record. If more than one extra data is to be specified, then in can be done, following the above listed format, separated by commas.	null

See Also:

• DataDescriptor
• DualListBox
• Filterable
• BasedOnDataDescriptor
• MultiValueFormItem
• DifferentDataDisplayValue
• DifferentMultiDataDisplayValue

SELECTOR_ITEM

public static final EditorType SELECTOR_ITEM

A selector type input field, that allows the user to pick values from a (freely implantable) popup window. The default selector window offers a list, that the user can filter, so finding data is made easier.

It is recommended to use this component, if there is a large number of selectable values. This component reads it's values in chunks, and it is filterable, so this component is much faster than components that fill a similar role. The user can also sort and modify the read data.

The component also allows the use of a custom implementation, so for example, it is possible that nothing is displayed in the list. The custom window implementation must have a class, that extends from the SelectorWindow class, and it's mandatory methods must be implemented. This class must be specified for the component.

This input field can be created in the DataDescriptor, by assigning the "EditorType" attribute to the column parameters, with the value of "SelectorItem". The component processes the following column parameters:

DefaultValueSelector

MetaParamName constant name	Parameter name in the DataDescriptor	Description	Default
PLACEHOLDER	placeholder	The input field placeholder text	null
SIZE	size	The form item size. The applicable values can be found in the FormItemSize enum	NORMAL
STATE	state	The editable component's state. The applicable values can be found in the FormItemState enum	DEFAULT
DEFAULT_VALUE	defaultValue	The component's default value. Used when a new record is being edited, or if the value is deleted through code. Regardless of this value, it can be altered by the user, or through code to null value, but the default value won't be set in this case.	null
READ_ONLY	readOnly	Determines if the component is read-only. Can be true or false.	false
ENABLED	enabled	Determines if the component is enabled. If a component is not enabled, the component value won't be editable for the user, and it will appear greyed out.	true
HELP	help	If a help text is set, a help icon will appear on the component's right side. If the user mouses over the icon the help text will be displayed in a bubble.	null
HELP_ICON	helpIcon	The help icon that will appear on the component. For applicable values, see the Icon enum.	QUESTION
DESCRIPTION	description	The component description text, that appears under the component, in smaller text.	null
TAB_INDEX	tabIndex	The input field tab index. This number determines the order the fields will gain focus, if the user uses the TAB key If not specified, or set to null, the tab index will be the same as the field order.	null
SELECTOR_CLASS	selectorClass	The class containing the implementation of the selector window. The class must be specified by the fully-qualified class name
DATADESCRIPTOR	dataDescriptor	If this parameter is used, the DataDescriptor specified here (by its name) will provide the selectable values for the component. This means that the selectable values can be read from a different DataDescriptor.	null
DATA_COLUMN	dataColumn	If the component is using a different DataDescriptor for the selectable values, use this parameter to set the name of the DataDescriptor data column. When saving, this value will be saved to the database.	null
DISPLAY_COLUMN	displayColumn	Sets the name of the DataDescriptor display column(s). This is the data that is displayed to the user. When saving these values will not be saved to the database. If multiple columns are specified, (they can be separated by a "," character), all of them will be displayed.	null
DISPLAY_COLUMN_SEPARATOR	displayColumnSeparator	If multiple display columns are assigned, their text values will be separated by the character specified here.	""
CRITERIA	criteria	If the selectable values are from another DataDescriptor, the filter critera used can be specified here. For the filter criteria, any column from the DataDescriptor can be used, regardless if it is one of the columns that is being used by the component or not. For example: "Criteria(columnName, EQUALS, 12)" or "Criteria(AND, Criteria(columnName, op, value), Criteria(ColumnName, op, value))"	null
SELECTOR_FILTER_TYPE	selectorFilterType	The filter type name that will be used in the window. This parameter only works, if the default window is used.	SIMPLE

See Also:

• DataDescriptor
• SelectorItem
• DefaultValueSelector
• SelectorWindow
• DifferentDataDisplayValue

STATIC_TEXT_ITEM

public static final EditorType STATIC_TEXT_ITEM

Static text displaying field. The value of this field cannot be edited, it is for displaying text only.

This field can be created in the DataDescriptor, by assigning the "EditorType" attribute to the column parameters, with the value of "StaticText". The component processes the following column parameters:

MetaParamName constant name	Parameter name in the DataDescriptor	Description	Default
PLACEHOLDER	placeholder	The input field placeholder text	null
SIZE	size	The form item size. The applicable values can be found in the FormItemSize enum	NORMAL
STATE	state	The editable component's state. The applicable values can be found in the FormItemState enum	DEFAULT
DEFAULT_VALUE	defaultValue	The component's default value. Used when a new record is being edited, or if the value is deleted through code. Regardless of this value, it can be altered by the user, or through code to null value, but the default value won't be set in this case.	null
ENABLED	enabled	Determines if the component is enabled. If a component is not enabled, the component value won't be editable for the user, and it will appear greyed out.	true
HELP	help	If a help text is set, a help icon will appear on the component's right side. If the user mouses over the icon the help text will be displayed in a bubble.	null
HELP_ICON	helpIcon	The help icon that will appear on the component. For applicable values, see the Icon enum.	QUESTION
DESCRIPTION	description	The component description text, that appears under the component, in smaller text.	null

See Also:

• DataDescriptor
• StaticTextItem

SWITCH_ITEM

public static final EditorType SWITCH_ITEM

Switch component, that is for inputting logic values. If the switch is on, the value will be true, if it is off, the value will be false. When saving, the component value will be converted, using the converter specified here: DEFAULT_BOOLEAN_CONVERTER.

This field can be created in the DataDescriptor, by assigning the "EditorType" attribute to the column parameters, with the value of "SwitchItem". The component processes the following column parameters:

MetaParamName constant name	Parameter name in the DataDescriptor	Description	Default
DEFAULT_VALUE	defaultValue	The component's default value. Used when a new record is being edited, or if the value is deleted through code. Regardless of this value, it can be altered by the user, or through code to null value, but the default value won't be set in this case.	null
READ_ONLY	readOnly	Determines if the component is read-only. Can be true or false.	false
ENABLED	enabled	Determines if the component is enabled. If a component is not enabled, the component value won't be editable for the user, and it will appear greyed out.	true
HELP	help	If a help text is set, a help icon will appear on the component's right side. If the user mouses over the icon the help text will be displayed in a bubble.	null
HELP_ICON	helpIcon	The help icon that will appear on the component. For applicable values, see the Icon enum.	QUESTION
DESCRIPTION	description	The component description text, that appears under the component, in smaller text.	null
TAB_INDEX	tabIndex	The input field tab index. This number determines the order the fields will gain focus, if the user uses the TAB key If not specified, or set to null, the tab index will be the same as the field order.	null

See Also:

• DataDescriptor
• SwitchItem
• BooleanValueFormItem

DATE_RANGE

public static final EditorType DATE_RANGE

Date range input field. The input field is built on two DataDescriptor columns, representing its minimum and maximum values. The two DataDescriptor column's parameters will be interpreted individually, but the mutual parameters specified here, will be applied, and overwrite them.

The component will be made of two IntegerItem input fields. The parameters of these is also described in DATE_PICKER enum.

This field can be created in the DataDescriptor, by assigning the "EditorType" attribute to the column parameters, with the value of "DateRangePicker". The component processes the following column parameters:

MetaParamName constant name	Parameter name in the DataDescriptor	Description	Default
MIN_COLUMN	minColumn	The name of the DataDescriptor column that will be used as a basis for the minimum value component. For the component's parameters, see:DATE_PICKER	null
MAX_COLUMN	maxColumn	The name of the DataDescriptor column that will be used as a basis for the maximum value component. For the component's parameters, see: DATE_PICKER	null

The component won't use the label parameter, only the current column's label will be displayed.

See Also:

• DataDescriptor
• DateRangePicker
• DatePicker

DATETIME_RANGE

public static final EditorType DATETIME_RANGE

Date and time range input field. The input field is built on two DataDescriptor columns, representing its minimum and maximum values. The two DataDescriptor column's parameters will be interpreted individually, but the mutual parameters specified here, will be applied, and overwrite them.

The component will be made of two IntegerItem input fields. The parameters of these is also described in the DATETIME_PICKER enum.

This field can be created in the DataDescriptor, by assigning the "EditorType" attribute to the column parameters, with the value of "DateTimeRangePicker". The component processes the following column parameters:

MetaParamName constant name	Parameter name in the DataDescriptor	Description	Default
MIN_COLUMN	minColumn	The name of the DataDescriptor column that will be used as a basis for the minimum value component. For the component's parameters, see:DATETIME_PICKER	null
MAX_COLUMN	maxColumn	The name of the DataDescriptor column that will be used as a basis for the maximum value component. For the component's parameters, see: DATETIME_PICKER	null

The component won't use the label parameter, only the current column's label will be displayed.

See Also:

• DataDescriptor
• DateRangePicker
• DatePicker

HIDDEN_ITEM

public static final EditorType HIDDEN_ITEM

Hidden field component. A field of this type won't appear on the editing interface, but it will appear on the form.

This field can be created in the DataDescriptor, by assigning the "EditorType" attribute to the column parameters, with the value of "HiddenItem". The component processes the following column parameters:

MetaParamName constant name	Parameter name in the DataDescriptor	Description	Default
DEFAULT_VALUE	defaultValue	The component's default value. Used when a new record is being edited, or if the value is deleted through code. Regardless of this value, it can be altered by the user, or through code to null value, but the default value won't be set in this case.	null

See Also:

• DataDescriptor
• HiddenItem

Method Details

values

public static EditorType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static EditorType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getNames

public List<String> getNames()

Returns:

A list of names. If no names were specified, the list will be empty.

getDefaultOperator

public OperatorType getDefaultOperator()

Returns:

The assigned default filter operator

fromName

public static EditorType fromName(String name)

Determines the editor type, by its name.

Parameters:

name - The name of the editor

Returns:

The specified editor or null, if not found

fromEditorClass

public static EditorType fromEditorClass(Class<?> editorClass)

Determines the editor type, by the class that implements the editor component

Parameters:

editorClass - The class that implements the editor component

Returns:

The specified editor or null, if not found

getEditorClass

public Class<? extends FormItem<?,?>> getEditorClass()

Gets the class that implements the editor component

Returns:

The class that implements the editor component

setEditorClass

public final void setEditorClass(Class<? extends FormItem<?,?>> editorClass)

Overwrites the default editor component

Parameters:

editorClass - The class that implements the editor type's editor component. This class must be extended from the FormItem class