Jump to: navigation, search

Scout/Concepts/ValueField

< Scout‎ | Concepts
Revision as of 05:25, 22 January 2013 by Urs.beeli.sbb.ch (Talk | contribs)


Scout
Wiki Home
Website
DownloadGit
Community
ForumsBlogTwitter
Bugzilla
Bugzilla


Specific type of Fields that contains a value. Depending on the type of value, one of the child class needs to be considered.

  • implements: I obj.pngIValueField<T>
  • extends: C obj.pngAbstractValueField<T>

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 (MinValue on IntegerField, or InputMasked for StringField)

Important.png
Do not use this field in your forms
This class mutualizes the all the common logic for all values fields (validations...) but there is no renderer for this field. You should consider using one of the child classes, depending on the type of the value you want to display. Other such fields that provide common functionality to extensions but have no renderer are NumberField and DecimalFieldand; they shouldn't be used in your forms, either.


Type of Value Fields

Properties

Defined with getConfiguredXxxxxx() methods.

Note.png
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 execXxxxxx() methods.

See also the Field page for the events that all fields have in common.

Input validation

Scout ValueField Validation.png

  • ParseValue: event to define how the text (String) typed in the UI is converted in a value.
  • ValidateValue: event to add business logic to define if the value is valid.
  • FormatValue: event to define how the value is displayed in the field (as String). This function need to be "compatible" with ParseValue
  • ChangedValue: At this point the validValue is accessible with getValue().

Other events

  • IsSaveNeeded
  • MarkSaved
  • IsEmpty

See Also