Class ValidationManager<TState>

Constructor

Example

{
  services: createValidationServices(); <-- see and customize your create_services.ts file
  valueHostConfigs: [
    // see elsewhere for details on ValueHostConfigs as they are the heavy lifting in this system.
    // Just know that you need one object for each value that you want to connect
    // to the Validation Manager
     ],
  savedInstanceState: null, // or the state object previously returned with OnInstanceStateChanged
  savedValueHostInstanceStates: null, // or an array of the state objects previously returned with OnValueHostInstanceStateChanged
  onInstanceStateChanged: (validationManager, state)=> { },
  onValueHostInstanceStateChanged: (valueHost, state) => { },
  onValidationStateChanged: (validationManager, validationState)=> { },
  onValueHostValidationStateChanged: (valueHost, valueHostValidationState) => { },
  onValueChanged: (valueHost, oldValue) => { },
  onInputValueChanged: (valueHost, oldValue) => { }
  onConfigChanged: (valueHost, valueHostConfig) => { }
}
Copy

Provides access to ValidationServices (override IServices).

When true, the current state of validation does not know of any errors. However, there are other factors to consider: there may be warning issues found (in IssuesFound), an async validator is still running, validator evaluated as Undetermined. So check

Link

doNotSave|doNotSave as the ultimate guide to saving. When false, there is at least one validation error.

Determines if a validator doesn't consider the ValueHost's value ready to save based on the latest call to validate(). (It does not run validate().) True when at least one ValueHost's ValidationStatus is Invalid or NeedsValidation

When true, an async Validator is running in any ValueHost

Called when ValidationManager's validate() function has returned. Supplies the result to the callback. Examples: Use to notify the Validation Summary widget(s) to refresh. Use to change the disabled state of the submit button based on validity.

Called when ValueHost's validate() function has returned. Also when validation is cleared or BusinessLogicErrors are added or removed. Supplies the result to the callback. Examples: Use to notify the validation related aspects of the component to refresh, such as showing error messages and changing style sheets. Use to change the disabled state of the submit button based on validity. You can setup the same callback on individual ValueHosts. Here, it aggregates all ValueHost notifications.

If the user needs to abandon this instance, they should use this to clean up active resources (like timers)

Easier way to add or modify a ValueHostConfig than using addValueHost(), addOrUpdateValueHost(), or addOrMergeValueHost(). It returns an object whose methods allow adding ValueHosts and their validators. Upon calling its apply() method, your changes will be applied through the addOrMergeValueHost() function.

let vm = new ValidationManager(builder);
// later when you need to modify vm:
let modifier = vm.startModifying();
// supply changes to the ValueHostConfigs
modifier.input('Field3').regExp(null, { enabled: false });   // let's disable the existing validator
// merge those changes into the ValidationManager
modifier.apply(); // consider modifier disposed at this point 
Copy

Retrieves the ValidatorsValueHostBase of the identified by valueHostName

Retrieves the InputValueHost of the identified by valueHostName

Retrieves the PropertyValueHost of the identified by valueHostName

Runs validation against all validatable ValueHosts, except those that do not match the validation group supplied in options. Updates this ValueHost's InstanceState and notifies parent if changes were made.

Changes the validation state to itself initial: Undetermined with no error messages.

ValueHosts that validate should try to fire onValidationStateChanged, even though they also fire onValueHostValidationStateChanged. This allows systems that observe validation changes at the validationManager level to know. This function is optionally debounced with a delay in ms coming from ValidationManagerConfig.notifyValidationStateChangedDelay

When Business Logic gathers data from the UI, it runs its own final validation. If its own business rule has been violated, it should be passed here where it becomes exposed to the Validation Summary (getIssuesFound) and optionally for an individual ValueHostName, by specifying that valueHostName in associatedValueHostName. Each time its called, all previous business logic errors are abandoned. Internally, a BusinessLogicErrorsValueHost is added to the list of ValueHosts to hold any error that lacks an associatedValueHostName.

Lists all issues found (error messages and supporting info) for a single InputValueHost so the input field/element can show error messages and adjust its appearance.

A list of all issues from all InputValueHosts optionally for a given group. Use with a Validation Summary widget and when validating the Model itself.

Adds or replaces all IssueFound items to the appropriate ValueHosts. Each ValueHost will invoke the onValueHostValidationStateChanged callback if needed.

Use case: client-side getting server-side Jivs-generated IssuesFound, so the UI can incorporate it.