FlexibleViewHolder (flexible-adapter 5.1.0 API)

java.lang.Object
- RecyclerView.ViewHolder
- - eu.davidea.viewholders.FlexibleViewHolder

All Implemented Interfaces:

android.view.View.OnClickListener, android.view.View.OnLongClickListener, android.view.View.OnTouchListener, ItemTouchHelperCallback.ViewHolderCallback

Direct Known Subclasses:

ExpandableViewHolder
```
public abstract class FlexibleViewHolder
extends RecyclerView.ViewHolder
implements android.view.View.OnClickListener, android.view.View.OnLongClickListener, android.view.View.OnTouchListener, ItemTouchHelperCallback.ViewHolderCallback
```
Helper Class that implements:
- Single tap
- Long tap
- Touch for Drag and Swipe.
You must extend and implement this class for the own ViewHolder.

Since:

03/01/2016 Created
23/01/2016 ItemTouch with Drag&Drop, Swipe
26/01/2016 Constructor revisited
18/06/2016 StickyHeader flag is delegated to the super class (ContentViewHolder)

Field Summary

Fields
Modifier and Type Field and Description

protected int mActionState

protected FlexibleAdapter mAdapter

Fields
Modifier and Type	Field and Description
`protected int`	`mActionState`
`protected FlexibleAdapter`	`mAdapter`

Constructor Summary

Constructors
Constructor and Description
`FlexibleViewHolder(android.view.View view, FlexibleAdapter adapter)` Default constructor.
`FlexibleViewHolder(android.view.View view, FlexibleAdapter adapter, boolean stickyHeader)` Constructor to configure the sticky behaviour of a view.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`float`	`getActivationElevation()` Allows to set elevation while the view is activated.
`android.view.View`	`getContentView()` In case this ViewHolder represents a Header Item, this method returns the contentView of the FrameLayout, otherwise it returns the basic itemView.
`int`	`getFlexibleAdapterPosition()` Overcomes the situation of returning an unknown position (-1) of ViewHolders created out of the LayoutManager (ex.
`android.view.View`	`getFrontView()` On Swipe, override to return the Front View.
`android.view.View`	`getRearLeftView()` On Swipe, override to return the Rear Left View.
`android.view.View`	`getRearRightView()` On Swipe, override to return the Rear Right View.
`boolean`	`isDraggable()`
`boolean`	`isSwipeable()`
`void`	`onActionStateChanged(int position, int actionState)` Here we handle the event of when the `ItemTouchHelper` first registers an item as being moved or swiped.
`void`	`onClick(android.view.View view)`
`void`	`onItemReleased(int position)` Here we handle the event of when the ItemTouchHelper has completed the move or swipe.
`boolean`	`onLongClick(android.view.View view)`
`boolean`	`onTouch(android.view.View view, android.view.MotionEvent event)` Should be used only by the Handle View!
`void`	`scrollAnimators(java.util.List<android.animation.Animator> animators, int position, boolean isForward)` This method is automatically called by FlexibleAdapter to animate the View while the user actively scrolls the list (forward or backward).
`void`	`setBackupPosition(int backupPosition)` Restore the Adapter position if the original Adapter position is unknown.
`protected void`	`setDragHandleView(android.view.View view)` Sets the inner view which will be used to drag this itemView.
`void`	`setFullSpan(boolean enabled)` Support for StaggeredGridLayoutManager.
`protected boolean`	`shouldActivateViewWhileSwiping()` Allows to activate the itemView when Swipe event occurs.
`protected boolean`	`shouldAddSelectionInActionMode()` Allows to add and keep item selection if ActionMode is active.
`void`	`toggleActivation()` Allows to change and see the activation status on the itemView and to perform animation on inner views.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - mAdapter
```
protected final FlexibleAdapter mAdapter
```
  - mActionState
```
protected int mActionState
```
- Constructor Detail
  - FlexibleViewHolder
```
public FlexibleViewHolder(android.view.View view,
                          FlexibleAdapter adapter)
```
    Default constructor.
    
    Parameters:
    
    view - The View being hosted in this ViewHolder
    
    adapter - Adapter instance of type FlexibleAdapter
    
    Since:
    
    5.0.0-b1
  - FlexibleViewHolder
```
public FlexibleViewHolder(android.view.View view,
                          FlexibleAdapter adapter,
                          boolean stickyHeader)
```
    Constructor to configure the sticky behaviour of a view.
    Note: StickyHeader works only if the item has been declared of type IHeader.
    
    Parameters:
    
    view - The View being hosted in this ViewHolder
    
    adapter - Adapter instance of type FlexibleAdapter
    
    stickyHeader - true if the View can be a Sticky Header, false otherwise
    
    Since:
    
    5.0.0-b7
- Method Detail
  - onClick
```
public void onClick(android.view.View view)
```
    Specified by:
    
    onClick in interface android.view.View.OnClickListener
    
    Since:
    
    5.0.0-b1
    
    See Also:
    
    toggleActivation()
  - onLongClick
```
public boolean onLongClick(android.view.View view)
```
    Specified by:
    
    onLongClick in interface android.view.View.OnLongClickListener
    
    Since:
    
    5.0.0-b1
    
    See Also:
    
    toggleActivation()
  - onTouch
```
public boolean onTouch(android.view.View view,
                       android.view.MotionEvent event)
```
    Should be used only by the Handle View!
    
    Specified by:
    
    onTouch in interface android.view.View.OnTouchListener
    
    Since:
    
    5.0.0-b1
    
    See Also:
    
    setDragHandleView(View)
  - setFullSpan
```
public void setFullSpan(boolean enabled)
```
    Support for StaggeredGridLayoutManager.
    
    Parameters:
    
    enabled - true to enable full span size, false to disable
  - setDragHandleView
```
protected void setDragHandleView(android.view.View view)
```
    Sets the inner view which will be used to drag this itemView.
    
    Parameters:
    
    view - handle view
    
    Since:
    
    5.0.0-b1
    
    See Also:
    
    onTouch(View, MotionEvent)
  - toggleActivation
```
public void toggleActivation()
```
    Allows to change and see the activation status on the itemView and to perform animation on inner views.
    Important note! the selected background is visible if you added android:background="?attr/selectableItemBackground" in the item layout AND customized the file style.xml.
    Alternatively, to set a background at runtime, you can use the new DrawableUtils from UI extension.
    Note: This method must be called every time we want the activation state visible on the itemView, for instance: after a Click (to add the item to the selection list) or after a LongClick (to activate the ActionMode) or during dragging (to show that we enabled the Drag).
    If you follow the above instructions, it's not necessary to invalidate this view with notifyItemChanged: In this way bindViewHolder won't be called and inner views can animate without interruptions, eventually you will see the animation running on those inner views at the same time of selection activation.
    
    Since:
    
    5.0.0-b1
    
    See Also:
    
    getActivationElevation()
  - getActivationElevation
```
public float getActivationElevation()
```
    Allows to set elevation while the view is activated.
    Override to return desired value of elevation on this itemView.
    Note: returned value must be in Pixel.
    
    Returns:
    
    0px (never elevate) if not overridden
    
    Since:
    
    5.0.0-b2
    
    See Also:
    
    toggleActivation()
  - shouldActivateViewWhileSwiping
```
protected boolean shouldActivateViewWhileSwiping()
```
    Allows to activate the itemView when Swipe event occurs.
    This method returns always false; Override with "return true" to Not expand or collapse this itemView onClick events.
    
    Returns:
    
    always false, if not overridden
    
    Since:
    
    5.0.0-b2
    
    See Also:
    
    toggleActivation()
  - shouldAddSelectionInActionMode
```
protected boolean shouldAddSelectionInActionMode()
```
    Allows to add and keep item selection if ActionMode is active.
    This method returns always false;Override with "return true" to add the item to the ActionMode count.
    
    Returns:
    
    always false, if not overridden
    
    Since:
    
    5.0.0-b2
    
    See Also:
    
    toggleActivation()
  - scrollAnimators
```
public void scrollAnimators(java.util.List<android.animation.Animator> animators,
                            int position,
                            boolean isForward)
```
    This method is automatically called by FlexibleAdapter to animate the View while the user actively scrolls the list (forward or backward).
    Implement your logic for different animators based on position, selection and/or direction.
    Use can take one of the predefined Animator from package UI class AnimatorHelper or create your own Animator(s), then add it to the list of animators.
    
    Parameters:
    
    animators - NonNull list of animators, which you should add new animators
    
    position - can be used to differentiate the Animators based on positions
    
    isForward - can be used to separate animation from top/bottom or from left/right scrolling
    
    Since:
    
    5.0.0-b8
  - onActionStateChanged
```
public void onActionStateChanged(int position,
                                 int actionState)
```
    Here we handle the event of when the ItemTouchHelper first registers an item as being moved or swiped.
    In this implementation, View activation is automatically handled if dragged: The Item will be added to the selection list if not selected yet and mode MULTI is activated.
    
    Specified by:
    
    onActionStateChanged in interface ItemTouchHelperCallback.ViewHolderCallback
    
    Parameters:
    
    position - the position of the item touched
    
    actionState - one of ItemTouchHelper#ACTION_STATE_SWIPE or ItemTouchHelper#ACTION_STATE_DRAG.
    
    Since:
    
    5.0.0-b1
    
    See Also:
    
    shouldActivateViewWhileSwiping(), shouldAddSelectionInActionMode()
  - onItemReleased
```
public void onItemReleased(int position)
```
    Here we handle the event of when the ItemTouchHelper has completed the move or swipe.
    In this implementation, View activation is automatically handled.
    In case of Drag, the state will be cleared depends by current selection mode!
    
    Specified by:
    
    onItemReleased in interface ItemTouchHelperCallback.ViewHolderCallback
    
    Parameters:
    
    position - the position of the item released
    
    Since:
    
    5.0.0-b1
    
    See Also:
    
    shouldActivateViewWhileSwiping(), shouldAddSelectionInActionMode()
  - isDraggable
```
public final boolean isDraggable()
```
    Specified by:
    
    isDraggable in interface ItemTouchHelperCallback.ViewHolderCallback
    
    Returns:
    
    the boolean value from the item flag, true to allow dragging
    
    Since:
    
    5.0.0-b7
  - isSwipeable
```
public final boolean isSwipeable()
```
    Specified by:
    
    isSwipeable in interface ItemTouchHelperCallback.ViewHolderCallback
    
    Returns:
    
    the boolean value from the item flag, true to allow swiping
    
    Since:
    
    5.0.0-b7
  - getFrontView
```
public android.view.View getFrontView()
```
    Description copied from interface: ItemTouchHelperCallback.ViewHolderCallback
    
    On Swipe, override to return the Front View.
    Default is itemView.
    
    Specified by:
    
    getFrontView in interface ItemTouchHelperCallback.ViewHolderCallback
    
    Returns:
    
    the item Front View
    
    Since:
    
    5.0.0-b6
  - getRearLeftView
```
public android.view.View getRearLeftView()
```
    Description copied from interface: ItemTouchHelperCallback.ViewHolderCallback
    
    On Swipe, override to return the Rear Left View.
    Default is null (no view).
    
    Specified by:
    
    getRearLeftView in interface ItemTouchHelperCallback.ViewHolderCallback
    
    Returns:
    
    the Rear Left View
    
    Since:
    
    5.0.0-b6
  - getRearRightView
```
public android.view.View getRearRightView()
```
    Description copied from interface: ItemTouchHelperCallback.ViewHolderCallback
    
    On Swipe, override to return the Rear Right View.
    Default is null (no view).
    
    Specified by:
    
    getRearRightView in interface ItemTouchHelperCallback.ViewHolderCallback
    
    Returns:
    
    the Rear Right View
    
    Since:
    
    5.0.0-b6
  - getContentView
```
public final android.view.View getContentView()
```
    In case this ViewHolder represents a Header Item, this method returns the contentView of the FrameLayout, otherwise it returns the basic itemView.
    
    Returns:
    
    the real contentView
    
    Since:
    
    5.0.0-b7
  - getFlexibleAdapterPosition
```
public final int getFlexibleAdapterPosition()
```
    Overcomes the situation of returning an unknown position (-1) of ViewHolders created out of the LayoutManager (ex. StickyHeaders).
    NOTE: Always call this method, instead of getAdapterPosition(), in case of StickyHeaders use case.
    
    Returns:
    
    the Adapter position result of #getAdapterPosition() OR the backup position preset and known, if the previous result was RecyclerView#NO_POSITION.
    
    Since:
    
    5.0.0-b6
    
    See Also:
    
    setBackupPosition(int)
  - setBackupPosition
```
public final void setBackupPosition(int backupPosition)
```
    Restore the Adapter position if the original Adapter position is unknown.
    Called by StickyHeaderHelper to support the clickListeners events.
    
    Parameters:
    
    backupPosition - the known position of this ViewHolder
    
    Since:
    
    5.0.0-b6

Class FlexibleViewHolder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

mAdapter

mActionState

Constructor Detail

FlexibleViewHolder

FlexibleViewHolder

Method Detail

onClick

onLongClick

onTouch

setFullSpan

setDragHandleView

toggleActivation

getActivationElevation

shouldActivateViewWhileSwiping

shouldAddSelectionInActionMode

scrollAnimators

onActionStateChanged

onItemReleased

isDraggable

isSwipeable

getFrontView

getRearLeftView

getRearRightView

getContentView

getFlexibleAdapterPosition

setBackupPosition