Method Details

• getField

  HasValue<?,?> getField()

  Gets the field the binding uses.

  Returns:

  the field for the binding

• validate

  default BindingValidationStatus<TARGET> validate()

  Validates the field value and returns a ValidationStatus instance representing the outcome of the validation. This method is a short-hand for calling validate(boolean) with fireEvent true.

  Returns:

  the validation result.

  See Also:

  • validate(boolean)
  • Binder.validate()
  • Validator.apply(Object, ValueContext)

• validate

  BindingValidationStatus<TARGET> validate(boolean fireEvent)

  Validates the field value and returns a ValidationStatus instance representing the outcome of the validation.

  Parameters:

  fireEvent - true to fire status event; false to not

  Returns:

  the validation result.

  See Also:

  • validate()

• getValidationStatusHandler

  BindingValidationStatusHandler getValidationStatusHandler()

  Gets the validation status handler for this Binding.

  Returns:

  the validation status handler for this binding

• unbind

  void unbind()

  Unbinds the binding from its respective Binder. Removes any ValueChangeListener Registration from associated HasValue.

• read

  void read(BEAN bean)

  Reads the value from given item and stores it to the bound field.

  Parameters:

  bean - the bean to read from

• setReadOnly

  void setReadOnly(boolean readOnly)

  Sets the read-only status on for this Binding. Setting a Binding read-only will mark the field read-only and not write any values from the fields to the bean.

  This helper method is the preferred way to control the read-only state of the bound field.

  Parameters:

  readOnly - true to set binding read-only; false to enable writes

  Throws:

  IllegalStateException - if trying to make binding read-write and the setter is null

• isReadOnly

  boolean isReadOnly()

  Gets the current read-only status for this Binding.

  Returns:

  true if read-only; false if not

  See Also:

  • setReadOnly(boolean)

• getGetter

  ValueProvider<BEAN,TARGET> getGetter()

  Gets the getter associated with this Binding.

  Returns:

  the getter

• getSetter

  Setter<BEAN,TARGET> getSetter()

  Gets the setter associated with this Binding.

  Returns:

  the setter

• setAsRequiredEnabled

  void setAsRequiredEnabled(boolean asRequiredEnabled)

  Enable or disable asRequired validator. The validator is enabled by default.

  Parameters:

  asRequiredEnabled - false if asRequired validator should be disabled, true otherwise (default)

  See Also:

  • Binder.BindingBuilder.asRequired(String)
  • Binder.BindingBuilder.asRequired(ErrorMessageProvider)

• isAsRequiredEnabled

  boolean isAsRequiredEnabled()

  Returns whether asRequired validator is currently enabled or not.

  Returns:

  false if asRequired validator is disabled true otherwise (default)

  See Also:

  • Binder.BindingBuilder.asRequired(String)
  • Binder.BindingBuilder.asRequired(ErrorMessageProvider)

• setValidatorsDisabled

  void setValidatorsDisabled(boolean validatorsDisabled)

  Define whether validators are disabled or enabled for this specific binding.

  Parameters:

  validatorsDisabled - A boolean value.

• isValidatorsDisabled

  boolean isValidatorsDisabled()

  Returns if validators are currently disabled or not.

  Returns:

  A boolean value.

• setDefaultValidatorEnabled

  void setDefaultValidatorEnabled(Boolean defaultValidatorEnabled)

  Sets up this binding to either enable or disable the default field validator (e.g. min/max validators in DatePicker). This binding-level setting will override the Binder-level setting for this property. Defaults to null.

  Parameters:

  defaultValidatorEnabled - true to enable default validator for this binding, false to disable it, null to reset (fall back to Binder-level setting)

  See Also:

  • for faster way to toggle default validators for all bound fields.

• isDefaultValidatorEnabled

  Boolean isDefaultValidatorEnabled()

  Returns if default validator of bound field is enabled.

  Returns:

  true if default validator is enabled for this binding, false if it is disabled, null if falls back to Binder-level setting

• setConvertBackToPresentation

  void setConvertBackToPresentation(boolean convertBackToPresentation)

  Define whether the value should be converted back to the presentation in the field when a converter is used in binding.

  As of version 6.0, when a converter is used on a binding and the user input value is modified by the converter, the value from the converter is applied back to the input. It is possible to control this behavior with this API.

  Parameters:

  convertBackToPresentation - A boolean value

  See Also:

  • Binder.BindingBuilder.withConverter(Converter)
  • Binder.BindingBuilder.withConverter(SerializableFunction, SerializableFunction)
  • Binder.BindingBuilder.withConverter(SerializableFunction, SerializableFunction, String)

• isConvertBackToPresentation

  boolean isConvertBackToPresentation()

  Returns whether the value is converted back to the presentation in the field when a converter is used in binding.

  Returns:

  A boolean value

• hasChanges

  boolean hasChanges()

  Checks whether the field that the binding uses has uncommitted changes.

  Returns:

  true if the field the binding uses has uncommitted changes, otherwise false.

  Throws:

  IllegalStateException - if the binding is no longer attached to a Binder.

• getEqualityPredicate

  SerializableBiPredicate<TARGET,TARGET> getEqualityPredicate()

  Used in comparison of the current value of a field with its initial value.

  Once set, the value of the field that binding uses will be compared with the initial value for hasChanged.

  Returns:

  the predicate to use for equality comparison