com.yworks.yfiles.view

Class StripeSelection

java.lang.Object

com.yworks.yfiles.view.StripeSelection

All Implemented Interfaces:

IEnumerable<IStripe>, ISelectionModel<IStripe>, IStripeSelection, Iterable<IStripe>

public class StripeSelection
extends Object
implements IStripeSelection, IEnumerable<IStripe>

Default implementation of the IStripeSelection interface.

Field Summary

Fields inherited from interface com.yworks.yfiles.utils.IEnumerable

EMPTY

Constructor Summary

Constructors

Constructor and Description
StripeSelection() Default constructor that creates empty selection models.

Method Summary

Modifier and Type	Method and Description
void	addItemSelectionChangedListener(IEventHandler<ItemSelectionChangedEventArgs<IStripe>> itemSelectionChangedEvent) Adds the given listener for the ItemSelectionChanged event that occurs when an item changed its selection state from selected to unselected or vice versa.
void	clear() Clears the selection.
IEnumerator<IStripe>	enumerator() Returns an IEnumerator over a set of elements of type T.
ISelectionModel<IColumn>	getSelectedColumns() An ISelectionModel of the selected columns.
ISelectionModel<IRow>	getSelectedRows() An ISelectionModel of the selected rows.
boolean	isCrossTableSelectionAllowed() Whether to allow the selection to span multiple table instances.
boolean	isMixedSelectionAllowed() Whether to allow mixed row/column selections.
boolean	isSelected(IStripe stripe) Return whether stripe is currently selected.
protected void	onItemSelectionChanged(ItemSelectionChangedEventArgs<IStripe> args) Raises the ItemSelectionChanged event.
void	removeItemSelectionChangedListener(IEventHandler<ItemSelectionChangedEventArgs<IStripe>> itemSelectionChangedEvent) Removes the given listener for the ItemSelectionChanged event that occurs when an item changed its selection state from selected to unselected or vice versa.
void	setCrossTableSelectionAllowed(boolean value) Whether to allow the selection to span multiple table instances.
void	setMixedSelectionAllowed(boolean value) Whether to allow mixed row/column selections.
void	setSelected(IStripe item, boolean selected) Sets the selection state of an item.
int	size() Returns the number of selected items.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.yworks.yfiles.utils.IEnumerable

concat, concat, create, create, iterator, parallelStream, stream

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

StripeSelection

public StripeSelection()

Default constructor that creates empty selection models.

Method Detail

addItemSelectionChangedListener

public final void addItemSelectionChangedListener(IEventHandler<ItemSelectionChangedEventArgs<IStripe>> itemSelectionChangedEvent)

Description copied from interface: ISelectionModel

Adds the given listener for the ItemSelectionChanged event that occurs when an item changed its selection state from selected to unselected or vice versa.

Specified by:

addItemSelectionChangedListener in interface ISelectionModel<IStripe>

Parameters:

itemSelectionChangedEvent - The listener to add.

See Also:

ISelectionModel.setSelected(java.lang.Object, boolean), ISelectionModel.removeItemSelectionChangedListener(IEventHandler)

clear

public final void clear()

Description copied from interface: ISelectionModel

Clears the selection.

This is a convenience method that will set the selection state of all elements to unselected.

Specified by:

clear in interface ISelectionModel<IStripe>

See Also:

ISelectionModel.addItemSelectionChangedListener(IEventHandler)

enumerator

public final IEnumerator<IStripe> enumerator()

Description copied from interface: IEnumerable

Returns an IEnumerator over a set of elements of type T.

Specified by:

enumerator in interface IEnumerable<IStripe>

Returns:

an IEnumerator.

getSelectedColumns

public final ISelectionModel<IColumn> getSelectedColumns()

Description copied from interface: IStripeSelection

An ISelectionModel of the selected columns.

This is the column part of the selection that this instance is a composite of.

Specified by:

getSelectedColumns in interface IStripeSelection

Returns:

The SelectedColumns.

getSelectedRows

public final ISelectionModel<IRow> getSelectedRows()

Description copied from interface: IStripeSelection

An ISelectionModel of the selected rows.

This is the row part of the selection that this instance is a composite of.

Specified by:

getSelectedRows in interface IStripeSelection

Returns:

The SelectedRows.

isCrossTableSelectionAllowed

public final boolean isCrossTableSelectionAllowed()

Whether to allow the selection to span multiple table instances.

The default is true

Specified by:

isCrossTableSelectionAllowed in interface IStripeSelection

Returns:

The CrossTableSelectionAllowed.

See Also:

setCrossTableSelectionAllowed(boolean)

isMixedSelectionAllowed

public final boolean isMixedSelectionAllowed()

Whether to allow mixed row/column selections.

The default is false

Specified by:

isMixedSelectionAllowed in interface IStripeSelection

Returns:

The MixedSelectionAllowed.

See Also:

setMixedSelectionAllowed(boolean)

isSelected

public final boolean isSelected(IStripe stripe)

Return whether stripe is currently selected.

Specified by:

isSelected in interface ISelectionModel<IStripe>

Parameters:

stripe - The stripe to test

Returns:

true iff stripe is currently selected

onItemSelectionChanged

protected void onItemSelectionChanged(ItemSelectionChangedEventArgs<IStripe> args)

Raises the ItemSelectionChanged event.

Parameters:

args - The parameters for the event

removeItemSelectionChangedListener

public final void removeItemSelectionChangedListener(IEventHandler<ItemSelectionChangedEventArgs<IStripe>> itemSelectionChangedEvent)

Description copied from interface: ISelectionModel

Removes the given listener for the ItemSelectionChanged event that occurs when an item changed its selection state from selected to unselected or vice versa.

Specified by:

removeItemSelectionChangedListener in interface ISelectionModel<IStripe>

Parameters:

itemSelectionChangedEvent - The listener to remove.

See Also:

ISelectionModel.setSelected(java.lang.Object, boolean), ISelectionModel.addItemSelectionChangedListener(IEventHandler)

setCrossTableSelectionAllowed

public final void setCrossTableSelectionAllowed(boolean value)

Whether to allow the selection to span multiple table instances.

The default is true

Specified by:

setCrossTableSelectionAllowed in interface IStripeSelection

Parameters:

value - The CrossTableSelectionAllowed to set.

See Also:

isCrossTableSelectionAllowed()

setMixedSelectionAllowed

public final void setMixedSelectionAllowed(boolean value)

Whether to allow mixed row/column selections.

The default is false

Specified by:

setMixedSelectionAllowed in interface IStripeSelection

Parameters:

value - The MixedSelectionAllowed to set.

See Also:

isMixedSelectionAllowed()

setSelected

public final void setSelected(IStripe item,
                              boolean selected)

Description copied from interface: ISelectionModel

Sets the selection state of an item.

If the state changes, this will trigger the ItemSelectionChanged event.

Specified by:

setSelected in interface ISelectionModel<IStripe>

Parameters:

item - The item to set the selection state for.

selected - Whether to select the object.

size

public final int size()

Description copied from interface: ISelectionModel

Returns the number of selected items.

Specified by:

size in interface ISelectionModel<IStripe>

Returns:

The Count.