Package se.conciliate.extensions.ui.editors

Interface EditSupport

public interface EditSupport

Author:

Per-Erik

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	EditSupport.SupportReason

Method Summary

Modifier and Type	Method	Description
EditSupport.SupportReason	getReason()	Returns the reason the object is supported.
boolean	isSupporting()	Returns true if the supplied value can be edited.
default void	setOnSave(Consumer onSave)

Method Details

isSupporting

boolean isSupporting()

Returns true if the supplied value can be edited.

Returns:

true if the supplied value can be edited.

See Also:

• EditorFactory.getSupport(java.lang.Object, java.lang.String)

getReason

EditSupport.SupportReason getReason()

Returns the reason the object is supported. This can be either because the editor supports editing instances of the object's class (for example a StringEditor would return Class if the object to edit is "foo") or because some value/field on the object is recognized by this editor. The latter might be a PreferenceEditor that is sent a string with value "org.acme.preference.file=/dir/config". Since there would be contention about this object between the StringEditor and the PreferenceEditor (both supports it), the reason is used to pick the best editor (ObjectValue-editors get picked before Class-editors). In the case there are multiple ObjectValue-editors, the user will get to decide which one to use.

Returns:

the reason the object is supported or null if isSupporting() returns false.

See Also:

• EditorFactory.getSupport(java.lang.Object, java.lang.String)

setOnSave

default void setOnSave(Consumer onSave)