ItemTouchExpandCallback

java.lang.Object
- ohos.agp.components.listcomponent.ItemTouchExpandCallback

```
public abstract class ItemTouchExpandCallback
extends Object
```
Functions as a bridge between users and the ItemTouchExpand object.
You can use this class to customize the behavior of the ItemTouchExpand object, for example, dragging or swiping. A callback is invoked when the customized behavior is executed.

从以下版本开始:

7

嵌套类概要

嵌套类
限定符和类型类说明

protected static class ItemTouchExpandCallback.ItemTouchExpandCallbackCleaner
Implements the release of the ItemTouchExpandCallback object.

嵌套类
限定符和类型	类	说明
`protected static class`	`ItemTouchExpandCallback.ItemTouchExpandCallbackCleaner`	Implements the release of the `ItemTouchExpandCallback` object.

构造器概要

构造器
构造器说明

ItemTouchExpandCallback(int dragDirs, int swipeDirs)
A constructor used to create a ItemTouchExpandCallback instance.

构造器
构造器	说明
`ItemTouchExpandCallback(int dragDirs, int swipeDirs)`	A constructor used to create a `ItemTouchExpandCallback` instance.

方法概要

所有方法实例方法抽象方法具体方法
限定符和类型	方法	说明
`boolean`	`canPutOnTop(ListComponent listComponent, ComponentOwner current, ComponentOwner target)`	Checks whether a component can be dragged to the target `ComponentOwner`.
`long`	`getAnimationTimePeriod(ListComponent listContainer, int animationType, float xCoordinateOffset, float yCoordinateOffset)`	Obtains the duration of an animation.
`int`	`getAssumedDragDirections(ListComponent listContainer, ComponentOwner componentOwner)`	Obtains the default drag directions of a component.
`int`	`getAssumedSwipeDirections(ListComponent listContainer, ComponentOwner componentOwner)`	Obtains the default swipe directions of a component.
`boolean`	`getComponentSwipeAllowed()`	Checks whether this `ItemTouchExpand` instance should start swiping when a component swipes.
`boolean`	`getLongPressDragAllowed()`	Checks whether this `ItemTouchExpand` instance should start dragging for a component that is being long pressed.
`int`	`getMarginOfOverlapRegion()`	Obtains the margin, which is used to calculate the overlapped area that can trigger the exchange between the dragged component and the target component.
`float`	`getMoveLimit(ComponentOwner componentOwner)`	Obtains the threshold for triggering dragging for a component.
`long`	`getNativePtr()`	Obtains the native object.
`float`	`getSwipeLimit(ComponentOwner componentOwner)`	Obtains the threshold for triggering swiping for a component.
`abstract boolean`	`onMove(ListComponent listContainer, ComponentOwner componentOwner, ComponentOwner target)`	Called when a component is being dragged from a position to another in the provider.
`void`	`onSelectedItemUpdated(ComponentOwner componentOwner, int actionState)`	Called when the component being swiped or dragging is updated.
`abstract void`	`onSwipeDetected(ComponentOwner componentOwner, int direction)`	Called when a component is swiped.
`ComponentOwner`	`selectDropObjective(ComponentOwner selected, List<ComponentOwner> dropTargets, int curX, int curY)`	Chooses a component among a list of `ComponentOwner`s that is closest to the one specified by `selected` and exchanges their positions.
`void`	`setAssumedDragDirections(int assumedDragDirections)`	Updates the default drag directions.
`void`	`setAssumedSwipeDirections(int assumedSwipeDirections)`	Updates the default swipe directions.
`void`	`setItemComponentSwipeAllowed(boolean componentSwipeEnabled)`	Sets whether this `ItemTouchExpand` instance should start swiping when a component swipes.
`void`	`setLongPressDragAllowed(boolean longPressDragEnabled)`	Sets whether this `ItemTouchExpand` instance should start dragging for a component that is being long pressed.
`void`	`setMarginOfOverlapRegion(int marginOfBoundingBox)`	Sets the margin around the boundaries of the dragged component.
`void`	`setMoveLimit(ComponentOwner componentOwner, float moveLimit)`	Sets the threshold for triggering dragging for a component.
`void`	`setSwipeLimit(ComponentOwner componentOwner, float swipeLimit)`	Sets the threshold for trigger swiping for a component.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - ItemTouchExpandCallback
```
public ItemTouchExpandCallback(int dragDirs,
                               int swipeDirs)
```
    A constructor used to create a ItemTouchExpandCallback instance.
    
    参数:
    
    dragDirs - Indicates the drag directions, which must be a combination of ItemTouchExpand#LEFT, ItemTouchExpand#RIGHT, ItemTouchExpand#START, ItemTouchExpand#END, ItemTouchExpand#UP and ItemTouchExpand#DOWN.
    
    swipeDirs - Indicates the swipe directions, which must be a combination of ItemTouchExpand#LEFT, ItemTouchExpand#RIGHT, ItemTouchExpand#START, ItemTouchExpand#END, ItemTouchExpand#UP, and ItemTouchExpand#DOWN.
    
    从以下版本开始:
    
    7
- 方法详细资料
  - getNativePtr
```
public long getNativePtr()
```
    Obtains the native object.
    
    返回:
    
    Returns the native object.
  - onMove
```
public abstract boolean onMove(ListComponent listContainer,
                               ComponentOwner componentOwner,
                               ComponentOwner target)
```
    Called when a component is being dragged from a position to another in the provider.
    
    参数:
    
    listContainer - Indicates the ListComponent bound to the ItemTouchExpand instance.
    
    componentOwner - Indicates the current ComponentOwner of the component that is being dragged.
    
    target - Indicates the new ComponentOwner of the component.
    
    返回:
    
    Returns true if the component is moved to the new position; returns false otherwise.
    
    从以下版本开始:
    
    7
  - onSwipeDetected
```
public abstract void onSwipeDetected(ComponentOwner componentOwner,
                                     int direction)
```
    Called when a component is swiped.
    
    参数:
    
    componentOwner - Indicates the ComponentOwner of the component that is swiped.
    
    direction - Indicates the swipe direction, which can be ItemTouchExpand#UP, ItemTouchExpand#DOWN, ItemTouchExpand#LEFT, or ItemTouchExpand#RIGHT.
    
    从以下版本开始:
    
    7
  - setLongPressDragAllowed
```
public void setLongPressDragAllowed(boolean longPressDragEnabled)
```
    Sets whether this ItemTouchExpand instance should start dragging for a component that is being long pressed.
    
    参数:
    
    longPressDragEnabled - Specifies whether to start dragging for a component that is being long pressed. The value true means to start dragging in such a case, and false means the opposite. The default value is true.
    
    从以下版本开始:
    
    7
  - getLongPressDragAllowed
```
public boolean getLongPressDragAllowed()
```
    Checks whether this ItemTouchExpand instance should start dragging for a component that is being long pressed.
    
    返回:
    
    Returns true if the ItemTouchExpand instance should start dragging in such a case; returns false otherwise.
    
    从以下版本开始:
    
    7
  - setItemComponentSwipeAllowed
```
public void setItemComponentSwipeAllowed(boolean componentSwipeEnabled)
```
    Sets whether this ItemTouchExpand instance should start swiping when a component swipes.
    
    参数:
    
    componentSwipeEnabled - Specifies whether to start swiping when a component swipes. The value true means to start swiping in such a case, and false means the opposite.
    
    从以下版本开始:
    
    7
  - getComponentSwipeAllowed
```
public boolean getComponentSwipeAllowed()
```
    Checks whether this ItemTouchExpand instance should start swiping when a component swipes.
    
    返回:
    
    Returns true if the ItemTouchExpand instance should start swiping when a component swipes; returns false otherwise.
    
    从以下版本开始:
    
    7
  - canPutOnTop
```
public boolean canPutOnTop(ListComponent listComponent,
                           ComponentOwner current,
                           ComponentOwner target)
```
    Checks whether a component can be dragged to the target ComponentOwner.
    
    参数:
    
    listContainer - Indicates the ListComponent bound to the ItemTouchExpand instance.
    
    componentOwner - Indicates the ComponentOwner of the component that is being dragged.
    
    target - Indicates the target ComponentOwner.
    
    返回:
    
    Returns true if the component can be dragged to the target ComponentOwner; returns false otherwise.
    
    从以下版本开始:
    
    7
  - setSwipeLimit
```
public void setSwipeLimit(ComponentOwner componentOwner,
                          float swipeLimit)
```
    Sets the threshold for trigger swiping for a component.
    
    参数:
    
    componentOwner - Indicates the ComponentOwner of the component to swipe.
    
    swipeLimit - Indicates the threshold to set.
    
    从以下版本开始:
    
    7
  - getSwipeLimit
```
public float getSwipeLimit(ComponentOwner componentOwner)
```
    Obtains the threshold for triggering swiping for a component.
    
    参数:
    
    componentOwner - Indicates the ComponentOwner of the component that is being swiped.
    
    返回:
    
    Returns the threshold if obtained; returns 0 if componentOwner is null.
    
    从以下版本开始:
    
    7
  - setMoveLimit
```
public void setMoveLimit(ComponentOwner componentOwner,
                         float moveLimit)
```
    Sets the threshold for triggering dragging for a component.
    
    参数:
    
    componentOwner - Indicates the ComponentOwner of the component to drag.
    
    moveLimit - Indicates the threshold to set.
    
    从以下版本开始:
    
    7
  - getMoveLimit
```
public float getMoveLimit(ComponentOwner componentOwner)
```
    Obtains the threshold for triggering dragging for a component.
    
    参数:
    
    componentOwner - Indicates the ComponentOwner of the component that is being dragged.
    
    返回:
    
    Returns the threshold if obtained; returns 0 if componentOwner is null.
    
    从以下版本开始:
    
    7
  - selectDropObjective
```
public ComponentOwner selectDropObjective(ComponentOwner selected,
                                          List<ComponentOwner> dropTargets,
                                          int curX,
                                          int curY)
```
    Chooses a component among a list of ComponentOwners that is closest to the one specified by selected and exchanges their positions.
    
    参数:
    
    selected - Indicates the ComponentOwner of the component that is being dragged.
    
    dropTargets - Indicates the list of ComponentOwners from which a component will be chosen as the candidate.
    
    curX - Indicates the distance to be dragged in the horizontal direction.
    
    curY - Indicates the distance to be dragged in the vertical direction.
    
    返回:
    
    Returns the ComponentOwner of the chosen component; returns null otherwise.
    
    从以下版本开始:
    
    7
  - onSelectedItemUpdated
```
public void onSelectedItemUpdated(ComponentOwner componentOwner,
                                  int actionState)
```
    Called when the component being swiped or dragging is updated.
    
    参数:
    
    componentOwner - Indicates the ComponentOwner of the component that is being swiped or dragged.
    
    actionState - Indicates the action state of the ItemTouchExpand instance, which can be ItemTouchExpand#ITEM_TOUCH_IDLE_STATE, ItemTouchExpand#ITEM_TOUCH_SWIPE_STATE, or ItemTouchExpand#ITEM_TOUCH_DRAG_STATE.
    
    从以下版本开始:
    
    7
  - setAssumedSwipeDirections
```
public void setAssumedSwipeDirections(int assumedSwipeDirections)
```
    Updates the default swipe directions.
    
    参数:
    
    assumedSwipeDirections - Indicates the new default directions.
    
    从以下版本开始:
    
    7
  - setAssumedDragDirections
```
public void setAssumedDragDirections(int assumedDragDirections)
```
    Updates the default drag directions.
    
    参数:
    
    assumedDragDirections - Indicates the new default drag directions.
    
    从以下版本开始:
    
    7
  - getAssumedSwipeDirections
```
public int getAssumedSwipeDirections(ListComponent listContainer,
                                     ComponentOwner componentOwner)
```
    Obtains the default swipe directions of a component.
    
    参数:
    
    listContainer - Indicates the ListComponent bound to the ItemTouchExpand instance.
    
    componentOwner - Indicates the ComponentOwner of the component to swipe.
    
    返回:
    
    Returns the directions if obtained; returns 0 if componentOwner is null.
    
    从以下版本开始:
    
    7
  - getAssumedDragDirections
```
public int getAssumedDragDirections(ListComponent listContainer,
                                    ComponentOwner componentOwner)
```
    Obtains the default drag directions of a component.
    
    参数:
    
    listContainer - Indicates the ListComponent bound to the ItemTouchExpand instance.
    
    componentOwner - Indicates the ComponentOwner of the component to drag.
    
    返回:
    
    Returns the directions if obtained; returns 0 if componentOwner is null.
    
    从以下版本开始:
    
    7
  - setMarginOfOverlapRegion
```
public void setMarginOfOverlapRegion(int marginOfBoundingBox)
```
    Sets the margin around the boundaries of the dragged component. The margin is used to calculate the overlapped area between the dragged component and the target component, based on which an exchange between the components can be triggered.
    
    参数:
    
    marginOfBoundingBox - Indicates the margin to set.
    
    从以下版本开始:
    
    7
  - getMarginOfOverlapRegion
```
public int getMarginOfOverlapRegion()
```
    Obtains the margin, which is used to calculate the overlapped area that can trigger the exchange between the dragged component and the target component.
    
    返回:
    
    Returns the margin if obtained; returns 0 if an exception occurs.
    
    从以下版本开始:
    
    7
  - getAnimationTimePeriod
```
public long getAnimationTimePeriod(ListComponent listContainer,
                                   int animationType,
                                   float xCoordinateOffset,
                                   float yCoordinateOffset)
```
    Obtains the duration of an animation.
    This method is called by the ItemTouchCallback instance when the operation on a component is complete.
    
    参数:
    
    listComponent - Indicates the ListComponent bound to the ItemTouchExpand instance
    
    animationType - Indicates the animation type, which can be ItemTouchExpand#DRAG_ANIMATION_TYPE, ItemTouchExpand#SWIPE_CANCEL_ANIMATION_TYPE, or ItemTouchExpand#SWIPE_SUCCESS_ANIMATION_TYPE.
    
    xCoordinateOffset - Indicates the distance that the animation will move in the horizontal direction.
    
    yCoordinateOffset - Indicates the distance that the animation will move in the vertical direction.
    
    返回:
    
    Returns the duration if obtained; returns 0 if an exception occurs.
    
    从以下版本开始:
    
    7

类 ItemTouchExpandCallback

嵌套类概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

ItemTouchExpandCallback

方法详细资料

getNativePtr

onMove

onSwipeDetected

setLongPressDragAllowed

getLongPressDragAllowed

setItemComponentSwipeAllowed

getComponentSwipeAllowed

canPutOnTop

setSwipeLimit

getSwipeLimit

setMoveLimit

getMoveLimit

selectDropObjective

onSelectedItemUpdated

setAssumedSwipeDirections

setAssumedDragDirections

getAssumedSwipeDirections

getAssumedDragDirections

setMarginOfOverlapRegion

getMarginOfOverlapRegion

getAnimationTimePeriod