de.espirit.firstspirit.access.editor.value
Interface Option

All Superinterfaces:

Comparable<Option>, Label

public interface Option
extends Comparable<Option>, Label

Option is the persistence object for editors like ComboBox, CheckBox, ListEditor

Since:

4.0.17

See Also:

ComboboxEditorValue, CheckboxEditorValue, ListEditorValue

Method Summary

String	getKey() Get a textual key of this options.
Object	getValue() Get the value of this option.
boolean	ignore(Language language) Indicates whether this Option should be ignored and therefore hide in the gui for the given language.
boolean	ignore(String lang) Deprecated. since 4.2.34, use Option.ignore(de.espirit.firstspirit.access.Language) instead

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface de.espirit.firstspirit.access.editor.value.Label

getLabel, getLabel, putLabel, putLabel

Method Detail

getValue

Object getValue()

Get the value of this option.

Returns:

The option's value.

Since:

4.0.17

getKey

String getKey()

Get a textual key of this options.

Returns:

The option's key.

Since:

4.0.17

ignore

@Deprecated
boolean ignore(String lang)

Deprecated. since 4.2.34, use Option.ignore(de.espirit.firstspirit.access.Language) instead

Use Option.ignore(de.espirit.firstspirit.access.Language) instead

Since:

4.0.17

ignore

boolean ignore(@NotNull
               Language language)

Indicates whether this Option should be ignored and therefore hide in the gui for the given language.

Parameters:

language - the language to check the ignore flag against

Returns:

true if this Option should be ignored for the given language, false otherwise

Since:

4.2.34