com.telerik.widget.list

Class SelectionBehavior

java.lang.Object

com.telerik.widget.list.ListViewBehavior

com.telerik.widget.list.SelectionBehavior

All Implemented Interfaces:

ItemReorderBehavior.ItemReorderListener, SwipeActionsBehavior.SwipeActionsListener, SwipeExecuteBehavior.SwipeExecuteListener

public class SelectionBehavior
extends ListViewBehavior
implements ItemReorderBehavior.ItemReorderListener, SwipeExecuteBehavior.SwipeExecuteListener, SwipeActionsBehavior.SwipeActionsListener

Represents a ListViewBehavior that can be used to allow the end user to select items from the list with gestures.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SelectionBehavior.SelectionChangedListener Interface definition for a callback to be invoked when the selection is changed.
static class	SelectionBehavior.SelectionMode An enumeration with the different modes of selection that can be used as a parameter for the setSelectionMode(com.telerik.widget.list.SelectionBehavior.SelectionMode) method.
static class	SelectionBehavior.SelectionOnTouch An enumeration with the different modes of selection that can be used as a parameter for the setSelectionOnTouch(com.telerik.widget.list.SelectionBehavior.SelectionOnTouch) method.

Constructor Summary

Constructors

Constructor and Description
SelectionBehavior() Creates a new instance of the SelectionBehavior.

Method Summary

Modifier and Type	Method and Description
void	addListener(SelectionBehavior.SelectionChangedListener listener) Adds a listener to be called when the selection of items changes.
void	changeIsSelected(int position)
void	changeIsSelected(int position, boolean value)
void	endSelection() A method that is used to notify the behavior that the selection should be stopped.
boolean	getIsSelected(int position)
SelectionBehavior.SelectionMode	getSelectionMode() Gets the current SelectionBehavior.SelectionMode.
SelectionBehavior.SelectionOnTouch	getSelectionOnLongPress() Gets the current SelectionBehavior.SelectionOnTouch.
SelectionBehavior.SelectionOnTouch	getSelectionOnTouch() Gets the current SelectionBehavior.SelectionOnTouch.
boolean	isInProgress() Returns true if the current behavior is in progress.
void	onAttached(RadListView listView) Called when the behavior is attached to RadListView with addBehavior(ListViewBehavior).
void	onDetached(RadListView owner) Called when the behavior is detached to RadListView with removeBehavior(ListViewBehavior).
void	onExecuteFinished(int position) Called when the swipe content is dismissed.
void	onExecuteFinished(SwipeActionsBehavior.SwipeActionEvent eventInfo) Called when the swipe content is dismissed.
void	onLongPress(MotionEvent motionEvent) Called when the long press gesture is detected by RadListView's ListViewGestureListener.
void	onReorderFinished() Called when reorder is finished.
void	onReorderItem(int positionFrom, int positionTo) Called when the item at positionFrom needs to be reordered to positionTo.
void	onReorderStarted(int position) Called when the reorder starts for the item at the specified position.
void	onSwipeEnded(int position, int finalOffset) Called when swipe gesture ends.
void	onSwipeEnded(SwipeActionsBehavior.SwipeActionEvent eventInfo) Called when swipe gesture ends.
void	onSwipeProgressChanged(int position, int currentOffset, View swipeContent) Called when the progress of the swipe for the item at the specified position changes.
void	onSwipeProgressChanged(SwipeActionsBehavior.SwipeActionEvent eventInfo) Called when the progress of the swipe for the item at the specified position changes.
void	onSwipeStarted(int position) Called when the swipe gesture starts for the item at the specified position.
void	onSwipeStarted(SwipeActionsBehavior.SwipeActionEvent eventInfo) Called when the swipe gesture starts for the item at the specified position.
void	onSwipeStateChanged(SwipeActionsBehavior.SwipeActionsState oldState, SwipeActionsBehavior.SwipeActionsState newState) Called when the swipe state changes.
boolean	onTapUp(MotionEvent motionEvent) Called when the tap up gesture is detected by RadListView's ListViewGestureListener.
void	removeListener(SelectionBehavior.SelectionChangedListener listener) Removes a listener that is called when the selection of items changes.
List	selectedItems() Gets the list of currently selected items.
void	setSelectionMode(SelectionBehavior.SelectionMode selectionMode) Sets a new SelectionBehavior.SelectionMode.
void	setSelectionOnLongPress(SelectionBehavior.SelectionOnTouch selectionOnLongPress) Sets a new SelectionBehavior.SelectionOnTouch value for long press.
void	setSelectionOnTouch(SelectionBehavior.SelectionOnTouch selectionOnTouch) Sets a new value for SelectionBehavior.SelectionOnTouch.

Methods inherited from class com.telerik.widget.list.ListViewBehavior

bindViewHolder, createViewHolder, getItemViewType, managesViewHolders, onActionUpOrCancel, onDispatchDraw, onFling, onInterceptTouchEvent, onLayout, onLongPressDrag, onLongPressDragEnded, onScrolled, onShortPressDrag

Methods inherited from class java.lang.Object

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

Constructor Detail

SelectionBehavior

public SelectionBehavior()

Creates a new instance of the SelectionBehavior.

Method Detail

selectedItems

public List selectedItems()

Gets the list of currently selected items.

getSelectionOnTouch

public SelectionBehavior.SelectionOnTouch getSelectionOnTouch()

Gets the current SelectionBehavior.SelectionOnTouch. This value is used to determine the behavior when the tap gesture is detected. The default value is AFTER_START.

Returns:

the current value.

setSelectionOnTouch

public void setSelectionOnTouch(SelectionBehavior.SelectionOnTouch selectionOnTouch)

Sets a new value for SelectionBehavior.SelectionOnTouch. This value is used to determine the behavior when the tap gesture is detected. The default value is AFTER_START.

Parameters:

selectionOnTouch - the new value.

getSelectionOnLongPress

public SelectionBehavior.SelectionOnTouch getSelectionOnLongPress()

Gets the current SelectionBehavior.SelectionOnTouch. This value is used to determine the behavior when the long press gesture is detected. The default value is ALWAYS.

Returns:

the current value.

setSelectionOnLongPress

public void setSelectionOnLongPress(SelectionBehavior.SelectionOnTouch selectionOnLongPress)

Sets a new SelectionBehavior.SelectionOnTouch value for long press. This value is used to determine the behavior when the long press gesture is detected. The default value is ALWAYS.

Parameters:

selectionOnLongPress - the new value.

getSelectionMode

public SelectionBehavior.SelectionMode getSelectionMode()

Gets the current SelectionBehavior.SelectionMode. The default value is MULTIPLE.

Returns:

the current value.

setSelectionMode

public void setSelectionMode(SelectionBehavior.SelectionMode selectionMode)

Sets a new SelectionBehavior.SelectionMode. The default value is MULTIPLE.

Parameters:

selectionMode - the new value.

addListener

public void addListener(SelectionBehavior.SelectionChangedListener listener)

Adds a listener to be called when the selection of items changes.

Parameters:

listener - the new listener.

removeListener

public void removeListener(SelectionBehavior.SelectionChangedListener listener)

Removes a listener that is called when the selection of items changes.

Parameters:

listener - the listener to remove.

endSelection

public void endSelection()

A method that is used to notify the behavior that the selection should be stopped.

onReorderStarted

public void onReorderStarted(int position)

Description copied from interface: ItemReorderBehavior.ItemReorderListener

Called when the reorder starts for the item at the specified position.

Specified by:

onReorderStarted in interface ItemReorderBehavior.ItemReorderListener

Parameters:

position - the position of the item that is reordered.

onReorderItem

public void onReorderItem(int positionFrom,
                          int positionTo)

Description copied from interface: ItemReorderBehavior.ItemReorderListener

Called when the item at positionFrom needs to be reordered to positionTo.

Specified by:

onReorderItem in interface ItemReorderBehavior.ItemReorderListener

Parameters:

positionFrom - the previous position of the reordered item.

positionTo - the new position of the reordered item.

onReorderFinished

public void onReorderFinished()

Description copied from interface: ItemReorderBehavior.ItemReorderListener

Called when reorder is finished.

Specified by:

onReorderFinished in interface ItemReorderBehavior.ItemReorderListener

onSwipeStarted

public void onSwipeStarted(SwipeActionsBehavior.SwipeActionEvent eventInfo)

Description copied from interface: SwipeActionsBehavior.SwipeActionsListener

Called when the swipe gesture starts for the item at the specified position.

Specified by:

onSwipeStarted in interface SwipeActionsBehavior.SwipeActionsListener

Parameters:

eventInfo - an instance of the SwipeActionsBehavior.SwipeActionEvent class containing information about the event.

onSwipeProgressChanged

public void onSwipeProgressChanged(SwipeActionsBehavior.SwipeActionEvent eventInfo)

Description copied from interface: SwipeActionsBehavior.SwipeActionsListener

Called when the progress of the swipe for the item at the specified position changes.

Specified by:

onSwipeProgressChanged in interface SwipeActionsBehavior.SwipeActionsListener

Parameters:

eventInfo - an instance of the SwipeActionsBehavior.SwipeActionEvent class containing information about the event.

onSwipeEnded

public void onSwipeEnded(SwipeActionsBehavior.SwipeActionEvent eventInfo)

Description copied from interface: SwipeActionsBehavior.SwipeActionsListener

Called when swipe gesture ends.

Specified by:

onSwipeEnded in interface SwipeActionsBehavior.SwipeActionsListener

Parameters:

eventInfo - an instance of the SwipeActionsBehavior.SwipeActionEvent class containing information about the event.

onSwipeStateChanged

public void onSwipeStateChanged(SwipeActionsBehavior.SwipeActionsState oldState,
                                SwipeActionsBehavior.SwipeActionsState newState)

Description copied from interface: SwipeActionsBehavior.SwipeActionsListener

Called when the swipe state changes.

Specified by:

onSwipeStateChanged in interface SwipeActionsBehavior.SwipeActionsListener

Parameters:

oldState - a value from the SwipeActionsBehavior.SwipeActionsState enum representing the old state.

newState - a value from the SwipeActionsBehavior.SwipeActionsState enum representing the old state.

onExecuteFinished

public void onExecuteFinished(SwipeActionsBehavior.SwipeActionEvent eventInfo)

Description copied from interface: SwipeActionsBehavior.SwipeActionsListener

Called when the swipe content is dismissed.

Specified by:

onExecuteFinished in interface SwipeActionsBehavior.SwipeActionsListener

Parameters:

eventInfo - an instance of the SwipeActionsBehavior.SwipeActionEvent class containing information about the event.

onSwipeStarted

public void onSwipeStarted(int position)

Description copied from interface: SwipeExecuteBehavior.SwipeExecuteListener

Called when the swipe gesture starts for the item at the specified position.

Specified by:

onSwipeStarted in interface SwipeExecuteBehavior.SwipeExecuteListener

Parameters:

position - the position of the item that is swiped.

onSwipeProgressChanged

public void onSwipeProgressChanged(int position,
                                   int currentOffset,
                                   View swipeContent)

Description copied from interface: SwipeExecuteBehavior.SwipeExecuteListener

Called when the progress of the swipe for the item at the specified position changes.

Specified by:

onSwipeProgressChanged in interface SwipeExecuteBehavior.SwipeExecuteListener

Parameters:

position - the position of the item that is swiped.

currentOffset - the current offset from the start that the swiped item has made.

swipeContent - the swipe content that is shown behind the item.

onSwipeEnded

public void onSwipeEnded(int position,
                         int finalOffset)

Description copied from interface: SwipeExecuteBehavior.SwipeExecuteListener

Called when swipe gesture ends.

Specified by:

onSwipeEnded in interface SwipeExecuteBehavior.SwipeExecuteListener

Parameters:

position - the position of the item that is swiped.

finalOffset - the final offset from the start that the swiped item has made.

onExecuteFinished

public void onExecuteFinished(int position)

Description copied from interface: SwipeExecuteBehavior.SwipeExecuteListener

Called when the swipe content is dismissed.

Specified by:

onExecuteFinished in interface SwipeExecuteBehavior.SwipeExecuteListener

Parameters:

position - the position of the item that is swiped.

isInProgress

public boolean isInProgress()

Description copied from class: ListViewBehavior

Returns true if the current behavior is in progress.

Overrides:

isInProgress in class ListViewBehavior

getIsSelected

public boolean getIsSelected(int position)

changeIsSelected

public void changeIsSelected(int position,
                             boolean value)

changeIsSelected

public void changeIsSelected(int position)

onLongPress

public void onLongPress(MotionEvent motionEvent)

Description copied from class: ListViewBehavior

Called when the long press gesture is detected by RadListView's ListViewGestureListener.

Overrides:

onLongPress in class ListViewBehavior

Parameters:

motionEvent - The motion event

onTapUp

public boolean onTapUp(MotionEvent motionEvent)

Description copied from class: ListViewBehavior

Called when the tap up gesture is detected by RadListView's ListViewGestureListener.

Overrides:

onTapUp in class ListViewBehavior

Parameters:

motionEvent - The motion event

onAttached

public void onAttached(RadListView listView)

Description copied from class: ListViewBehavior

Called when the behavior is attached to RadListView with addBehavior(ListViewBehavior).

Overrides:

onAttached in class ListViewBehavior

Parameters:

listView - The parent list view

onDetached

public void onDetached(RadListView owner)

Description copied from class: ListViewBehavior

Called when the behavior is detached to RadListView with removeBehavior(ListViewBehavior).

Overrides:

onDetached in class ListViewBehavior

Parameters:

owner - The parent list view