com.dlsc.formsfx.model.structure

Class SingleSelectionField<V>

java.lang.Object

com.dlsc.formsfx.model.structure.Field<F>

com.dlsc.formsfx.model.structure.SelectionField<V,SingleSelectionField<V>>

com.dlsc.formsfx.model.structure.SingleSelectionField<V>

public class SingleSelectionField<V>
extends SelectionField<V,SingleSelectionField<V>>

This class provides an implementation of a SelectionField allowing only for single selection.

Author:

Sacha Schmid, Rinesch Murugathas

Property Summary

Type	Property and Description
ObjectProperty<V>	selection

Properties inherited from class com.dlsc.formsfx.model.structure.SelectionField

itemsProperty

Properties inherited from class com.dlsc.formsfx.model.structure.Field

changedProperty, editableProperty, errorMessagesProperty, idProperty, labelProperty, placeholderProperty, requiredProperty, spanProperty, styleClassProperty, tooltipProperty, validProperty

Method Summary

Modifier and Type	Method and Description
SingleSelectionField<V>	bind(ListProperty<V> itemsBinding, ObjectProperty<V> selectionBinding) Binds the given items and selection property with the corresponding fields.
SingleSelectionField<V>	deselect() Removes the selection on the current field.
V	getSelection() Gets the value of the property selection.
SingleSelectionField<V>	items(List<V> newValue) Updates the list of available items to a new list, without a pre-defined selection.
SingleSelectionField<V>	items(List<V> newValue, int newSelection) Updates the list of available items to a new list, along with a pre-defined selection.
SingleSelectionField<V>	select(int index) Sets the selection to the element at the given index.
ObjectProperty<V>	selectionProperty()
void	setBindingMode(BindingMode newValue) Activates or deactivates the bindingModeListener based on the given BindingMode.
SingleSelectionField<V>	unbind(ListProperty<V> itemsBinding, ObjectProperty<V> selectionBinding) Unbinds the given items and selection property with the corresponding fields.
SingleSelectionField<V>	validate(Validator<V>... newValue) Sets the list of validators for the current field.

Methods inherited from class com.dlsc.formsfx.model.structure.SelectionField

getItems, itemsProperty

Methods inherited from class com.dlsc.formsfx.model.structure.Field

changedProperty, editable, editableProperty, errorMessagesProperty, getErrorMessages, getID, getLabel, getPlaceholder, getRenderer, getSpan, getStyleClass, getTooltip, hasChanged, id, idProperty, isEditable, isI18N, isRequired, isValid, label, labelProperty, ofBooleanType, ofBooleanType, ofDoubleType, ofDoubleType, ofIntegerType, ofIntegerType, ofMultiSelectionType, ofMultiSelectionType, ofMultiSelectionType, ofSingleSelectionType, ofSingleSelectionType, ofSingleSelectionType, ofStringType, ofStringType, placeholder, placeholderProperty, render, required, required, requiredProperty, span, span, spanProperty, styleClass, styleClassProperty, tooltip, tooltipProperty, validProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Property Detail

selection

public ObjectProperty<V> selectionProperty

See Also:

getSelection()

Method Detail

items

public SingleSelectionField<V> items(List<V> newValue,
                                     int newSelection)

Updates the list of available items to a new list, along with a pre-defined selection.

Parameters:

newValue - The new list of items.

newSelection - The new pre-defined selection.

Returns:

Returns the current field to allow for chaining.

items

public SingleSelectionField<V> items(List<V> newValue)

Updates the list of available items to a new list, without a pre-defined selection.

Parameters:

newValue - The new list of items.

Returns:

Returns the current field to allow for chaining.

validate

@SafeVarargs
public final SingleSelectionField<V> validate(Validator<V>... newValue)

Sets the list of validators for the current field. This overrides all validators that have previously been added.

Parameters:

newValue - The validators that are to be used for validating this field.

Returns:

Returns the current field to allow for chaining.

select

public SingleSelectionField<V> select(int index)

Sets the selection to the element at the given index.

Parameters:

index - The index of the element to be selected.

Returns:

Returns the current field to allow for chaining.

deselect

public SingleSelectionField<V> deselect()

Removes the selection on the current field.

Returns:

Returns the current field to allow for chaining.

bind

public SingleSelectionField<V> bind(ListProperty<V> itemsBinding,
                                    ObjectProperty<V> selectionBinding)

Binds the given items and selection property with the corresponding fields.

Parameters:

itemsBinding - The items property to be bound with.

selectionBinding - The selection property to be bound with.

Returns:

Returns the current field to allow for chaining.

unbind

public SingleSelectionField<V> unbind(ListProperty<V> itemsBinding,
                                      ObjectProperty<V> selectionBinding)

Unbinds the given items and selection property with the corresponding fields.

Parameters:

itemsBinding - The items property to be unbound with.

selectionBinding - The selection property to be unbound with.

Returns:

Returns the current field to allow for chaining.

setBindingMode

public void setBindingMode(BindingMode newValue)

Activates or deactivates the bindingModeListener based on the given BindingMode.

Parameters:

newValue - The new binding mode for the current field.

getSelection

public V getSelection()

Gets the value of the property selection.

selectionProperty

public ObjectProperty<V> selectionProperty()

See Also:

getSelection()