com.telerik.widget.list

Class SwipeActionsBehavior.SwipeActionEvent

java.lang.Object

com.telerik.widget.list.SwipeActionsBehavior.SwipeActionEvent

Enclosing class:

SwipeActionsBehavior

public class SwipeActionsBehavior.SwipeActionEvent
extends Object

This class is used to encapsulate information about swipe-actions events that occur during the process swiping and releasing an item. Instances of this class provide information about the index of the item being swiped, the swiped offset, a reference to the View instance being swiped, as well as whether the swipe threshold has been passed.

Method Summary

Modifier and Type	Method and Description
int	currentOffset() Returns an integer representing the current offset of the swiped view.
boolean	isThresholdPassed() Returns a boolean value determining whether the use has passed the swipe threshold while swiping.
View	mainView() Returns an instance of the View class representing the main content of the item being swiped.
int	swipedItemPosition() Returns the index of the item being swiped in the source collection.
int	swipePositionWhenReleased() Returns the swiped item's offset at the moment the user lifted their finger from the screen.
View	swipeView() Returns an instance of the View class representing the swipe content of the item that is being swiped.

Methods inherited from class java.lang.Object

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

Method Detail

swipePositionWhenReleased

public int swipePositionWhenReleased()

Returns the swiped item's offset at the moment the user lifted their finger from the screen. This value can help determine which swipe action will be executed depending on the swipe offset.

Returns:

the swipe position.

swipedItemPosition

public int swipedItemPosition()

Returns the index of the item being swiped in the source collection.

Returns:

the index of the item.

swipeView

public View swipeView()

Returns an instance of the View class representing the swipe content of the item that is being swiped.

Returns:

the View representing the swipe content of the item being swiped.

mainView

public View mainView()

Returns an instance of the View class representing the main content of the item being swiped.

Returns:

the View representing the main content of the item being swiped.

currentOffset

public int currentOffset()

Returns an integer representing the current offset of the swiped view. If the view is swiped to the right or to the bottom - the offset is positive, i.e. the distance of the swiped view from the left/top edge of the item. Consequently, if the item is swiped to the right/top, the value will be negative.

Returns:

the swiped offset.

isThresholdPassed

public boolean isThresholdPassed()

Returns a boolean value determining whether the use has passed the swipe threshold while swiping.

Returns:

true if the threshold has been passed; false otherwise.