Skip to main content

Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "Scout/Concepts/ValueField"

(Events)
(Replaced content with "The Scout documentation has been moved to https://eclipsescout.github.io/.")
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{ScoutPage|cat=Concepts}}
+
The Scout documentation has been moved to https://eclipsescout.github.io/.
 
+
Specific type of Fields that contains a value. Depending on the {{ScoutLink|Concepts|Type of Data|type of value}}, one of the child class needs to be considered.
+
 
+
* implements: {{ScoutJavadoc|IValueField<T>|I}}
+
* extends: {{ScoutJavadoc|AbstractValueField<T>|C}}
+
 
+
== Description ==
+
Value fields allow the user to enter some values in the form. Scout provides different implementation of the value fields, in order to add properties and event specific to the type ({{ScoutProp|MinValue}} on {{ScoutLink|Concepts|IntegerField|IntegerField}}, or {{ScoutProp|InputMasked}} for {{ScoutLink|Concepts|IntegerField|StringField}})
+
 
+
=== Type of Value Fields ===
+
* {{ScoutLink|Concepts|StringField|String Field}}
+
* {{ScoutLink|Concepts|IntegerField|Integer Field}}
+
* {{ScoutLink|Concepts|LongField|Long Field}}
+
* {{ScoutLink|Concepts|DoubleField|Double Field}}
+
* {{ScoutLink|Concepts|DateField|Date Field}}
+
* {{ScoutLink|Concepts|TimeField|Time Field}}
+
* {{ScoutLink|Concepts|CheckboxField|Boolean Field}} also called {{ScoutLink|Concepts|CheckboxField|Checkbox Field}}
+
* {{ScoutLink|Concepts|SmartField|Smart Field <T>}}
+
* {{ScoutLink|Concepts|ListBox|List Box <T[]>}}
+
* {{ScoutLink|Concepts|TreeBox|Tree Box <T[]>}}
+
* {{ScoutLink|Concepts|RadioButtonGroup|Radio Button Group <T>}}
+
 
+
== Properties ==
+
''Defined with {{ScoutLink|Concepts|GetConfigured Methods|getConfiguredXxxxxx()}} methods''.
+
 
+
{{note|TODO|Add a description of important properties. The idea is not to recreate the JavaDoc of the getConfiguredXxxxxx() methods but to provide explanations, best practice, example... Group the properties by domain.}}
+
 
+
 
+
== Events ==
+
''Defined with {{ScoutLink|Concepts|Exec_Methods|execXxxxxx()}} methods''.
+
 
+
See also the {{ScoutLink|Concepts|Field|Field}} page for the events that all fields have in common.
+
 
+
=== Input validation ===
+
[[Image:Scout ValueField Validation.png]]
+
 
+
* {{ScoutEvent|ParseValue}}: event to define how the text (String) typed in the UI is converted in a value.
+
* {{ScoutEvent|ValidateValue}}: event to add business logic to define if the value is valid.
+
* {{ScoutEvent|FormatValue}}: event to define how the value is displayed in the field (as String). This function need to be "compatible" with {{ScoutEvent|ParseValue}}
+
* {{ScoutEvent|ChangedValue}}: At this point the validValue is accessible with getValue().
+
 
+
=== Other events ===
+
* {{ScoutEvent|IsSaveNeeded}}
+
* {{ScoutEvent|MarkSaved}}
+
* {{ScoutEvent|IsEmpty}}
+
 
+
== See Also ==
+
* {{ScoutLink|Concepts|Field|Fields}}
+
* {{ScoutLink|Concepts|Form|Form}}
+

Latest revision as of 04:46, 14 March 2024

The Scout documentation has been moved to https://eclipsescout.github.io/.

Back to the top