org.datacleaner.widgets.properties

Interface PropertyWidget<E>

Type Parameters:

E -

All Known Implementing Classes:

AbstractPropertyWidget, MinimalPropertyWidget

public interface PropertyWidget<E>

Defines an interface for (wrappers of) widgets that are used to edit configurable properties of analyzers, transformers and filters.

Method Summary

Modifier and Type	Method and Description
ConfiguredPropertyDescriptor	getPropertyDescriptor() Gets the ConfiguredPropertyDescriptor that this PropertyWidget is modelling.
E	getValue() Gets the current value of the property given the current state in the UI.
javax.swing.JComponent	getWidget() Gets the visual widget to show on the UI.
void	initialize(E value) Initializes the property widget with the initial value of the property
boolean	isSet() Determines if the property is set given the current state in the UI.
void	onValueTouched(E value) Called on a widget if the value it contains is prone to have been changed by a another party (typically some sort of shortcut in the UI to populate values or similar).

Method Detail

initialize

void initialize(E value)

Initializes the property widget with the initial value of the property

Parameters:

value -

getWidget

javax.swing.JComponent getWidget()

Gets the visual widget to show on the UI. This may (in special cases) return null if the widget should not be shown, or if it is represented as part of a different part of the UI.

Returns:

getPropertyDescriptor

ConfiguredPropertyDescriptor getPropertyDescriptor()

Gets the ConfiguredPropertyDescriptor that this PropertyWidget is modelling.

Returns:

onValueTouched

void onValueTouched(E value)

Called on a widget if the value it contains is prone to have been changed by a another party (typically some sort of shortcut in the UI to populate values or similar). Note that this method will sometimes also be invoked at when the surrounding environment is not able to determine if it has changed or not. The property widget should therefore investigate if the incoming value does in deed differ from the existing.

isSet

boolean isSet()

Determines if the property is set given the current state in the UI.

Returns:

getValue

E getValue()

Gets the current value of the property given the current state in the UI.

Returns: