com.dlsc.formsfx.model.structure

Class MultiSelectionField<V>

java.lang.Object

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

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

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

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

This class provides an implementation of a MultiSelectionField allowing for multi-selection.

Author:

Sacha Schmid, Rinesch Murugathas

Property Summary

Type	Property and Description
ListProperty<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
MultiSelectionField<V>	bind(ListProperty<V> itemsBinding, ListProperty<V> selectionBinding) Binds the given items and selection property with the corresponding fields.
MultiSelectionField<V>	deselect(int index) Removes the element at the given index from the current selection.
ObservableList<V>	getSelection() Gets the value of the property selection.
MultiSelectionField<V>	items(List<V> newValue) Updates the list of available items to a new list, without a pre-defined selection.
MultiSelectionField<V>	items(List<V> newValue, List<Integer> newSelection) Updates the list of available items to a new list, along with a pre-defined selection.
MultiSelectionField<V>	select(int index) Adds the element at the given index to the current selection.
ListProperty<V>	selectionProperty()
void	setBindingMode(BindingMode newValue) Activates or deactivates the bindingModeListener based on the given BindingMode.
MultiSelectionField<V>	unbind(ListProperty<V> itemsBinding, ListProperty<V> selectionBinding) Unbinds the given items and selection property with the corresponding fields.
MultiSelectionField<V>	validate(Validator<ObservableList<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 ListProperty<V> selectionProperty

See Also:

getSelection()

Method Detail

items

public MultiSelectionField<V> items(List<V> newValue,
                                    List<Integer> 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 MultiSelectionField<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 MultiSelectionField<V> validate(Validator<ObservableList<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 MultiSelectionField<V> select(int index)

Adds the element at the given index to the current selection.

Parameters:

index - The index of the element to be selected.

Returns:

Returns the current field to allow for chaining.

deselect

public MultiSelectionField<V> deselect(int index)

Removes the element at the given index from the current selection.

Parameters:

index - The index of the element to be removed.

Returns:

Returns the current field to allow for chaining.

bind

public MultiSelectionField<V> bind(ListProperty<V> itemsBinding,
                                   ListProperty<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 MultiSelectionField<V> unbind(ListProperty<V> itemsBinding,
                                     ListProperty<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 ObservableList<V> getSelection()

Gets the value of the property selection.

selectionProperty

public ListProperty<V> selectionProperty()

See Also:

getSelection()