Interface IEntryValidator

All Known Implementing Classes:
AppIDValidator, AppVersionValidator, ExtServerURLValidator, FontSizeVerifier, GroupNameValidator, IDValidator, IntRange, LocalizedStringPropEditor, LongRange, ModulesEntryValidator, NumberRange, ScreenPropValidator, TimeZoneValidator, UnitRange

public interface IEntryValidator
The entry validator, typically for entry fields. This class provides a mechanism to convert values to/from the original property.
Author:
Christopher Mindus
  • Method Details

    • validate

      String validate(IPropertyEditorController controller, PropertyEditorInfo info, PropCnr[] parents, String value, String[] options)
      Validates the property value after editing. If this is successful, null is returned. Otherwise an error message string is returned that can be used as the tooltip text.
      Parameters:
      controller - The controller of the property editor.
      info - Information about the item being edited.
      parents - Parent property containers of the validated property.
      value - The string value to set.
      options - Validation options, may be null for none.
      Returns:
      An error message or null for OK validation.
    • getDescription

      String getDescription(IPropertyEditorController controller, PropertyEditorInfo info, PropCnr[] parents, String[] options)
      Gets a description of the validation options.
      Parameters:
      controller - The controller of the property editor.
      info - Information about the item being edited.
      parents - Parent property containers of the validated property.
      options - Validation options, may be null for none.
      Returns:
      The descriptive string that can be prepended with e.g. "Enter ";