Module is.codion.swing.common.ui

Package is.codion.swing.common.ui.component.indicator

Interface ValidationIndicator

All Known Implementing Classes:

BackgroundColorValidationIndicator, FlatLafValidationIndicator

public interface ValidationIndicator

Provides a validation indicator for a component, over the two severities validation has: a value that is invalid and may not be saved, and one that is merely warned about — permitted, but implausible enough to be worth a second look.

Both severities go through one indicator rather than two, because they share a visual channel and the precedence between them (invalid wins) has to be decided in one place.

Field Summary

Fields

Modifier and Type	Field	Description
static final PropertyValue<String>	INDICATOR_CLASS	Specified the ValidationIndicator to use.

Method Summary

Modifier and Type	Method	Description
void	enable(JComponent component, ObservableState valid, ObservableState warned)	Enables the validation indicator for the given component
static Optional<ValidationIndicator>	instance()	Returns an instance from the ServiceLoader, of the type specified by INDICATOR_CLASS
static Optional<ValidationIndicator>	instance(String indicatorClassName)	Returns an instance from the ServiceLoader, of the type specified by indicatorClassName

Field Details

INDICATOR_CLASS

static final PropertyValue<String> INDICATOR_CLASS

Specified the ValidationIndicator to use.

Default BackgroundColorValidationIndicator

Method Details

enable

void enable(JComponent component,
 ObservableState valid,
 ObservableState warned)

Enables the validation indicator for the given component

Parameters:

component - the component

valid - the valid state observer, false while the value may not be saved

warned - the warned state observer, true while the value carries a warning. Independent of [valid] — a value can be both, in which case the invalid presentation wins

instance

static Optional<ValidationIndicator> instance()

Returns an instance from the ServiceLoader, of the type specified by INDICATOR_CLASS

Returns:

an instance from the ServiceLoader or an empty Optional in case one is not found

instance

static Optional<ValidationIndicator> instance(String indicatorClassName)

Returns an instance from the ServiceLoader, of the type specified by indicatorClassName

Returns:

an instance from the ServiceLoader or an empty Optional in case one is not found