eu.davidea.flexibleadapter.items

Interface IFlexible<VH extends RecyclerView.ViewHolder>

All Known Subinterfaces:

IExpandable<VH,S>, IHeader<VH>, ISectionable<VH,T>

All Known Implementing Classes:

AbstractExpandableHeaderItem, AbstractExpandableItem, AbstractFlexibleItem, AbstractHeaderItem, AbstractSectionableItem

public interface IFlexible<VH extends RecyclerView.ViewHolder>

Basic interface to manage operations like enabling, selecting, hiding, filtering on items.

Implements this interface or use AbstractFlexibleItem.

Since:

19/01/2016 Created
28/03/2017 Individual item's span size AND shouldNotifyChange
12/05/2017 Simplified createViewHolder params
16/06/2017 Added getBubbleText method
04/09/2017 Added getItemViewType method

See Also:

IExpandable, IFilterable, IHeader, IHolder, ISectionable

Method Summary

Modifier and Type	Method and Description
void	bindViewHolder(FlexibleAdapter<IFlexible> adapter, VH holder, int position, java.util.List<java.lang.Object> payloads) Delegates the binding of this item's data to the given Layout.
VH	createViewHolder(android.view.View view, FlexibleAdapter<IFlexible> adapter) Delegates the creation of the ViewHolder to the user (AutoMap).
java.lang.String	getBubbleText(int position) Custom bubble text for FastScroller.
int	getItemViewType() Identifies a specific view type for this item, used by FlexibleAdapter to auto-map the ViewTypes.
int	getLayoutRes() Returns the layout resource ID to auto-inflate the View for this item.
int	getSpanSize(int spanCount, int position) Individual item's span size to use only with GridLayoutManager.
boolean	isDraggable()
boolean	isEnabled() Returns if the Item is enabled.
boolean	isHidden() (Internal usage).
boolean	isSelectable() Checks if the item can be selected.
boolean	isSwipeable()
void	onViewAttached(FlexibleAdapter<IFlexible> adapter, VH holder, int position) Called when a view created by this adapter has been attached to a window.
void	onViewDetached(FlexibleAdapter<IFlexible> adapter, VH holder, int position) Called when a view created by this adapter has been detached from its window.
void	setDraggable(boolean draggable)
void	setEnabled(boolean enabled) Setter to change enabled behaviour.
void	setHidden(boolean hidden) Setter to change hidden behaviour.
void	setSelectable(boolean selectable) Setter to change selectable behaviour.
void	setSwipeable(boolean swipeable)
boolean	shouldNotifyChange(IFlexible newItem) Called by the FlexibleAdapter when it wants to check if this item should be bound again with new content.
void	unbindViewHolder(FlexibleAdapter<IFlexible> adapter, VH holder, int position) Called when a view created by this adapter has been recycled.

Method Detail

isEnabled

boolean isEnabled()

Returns if the Item is enabled.

Returns:

(default) true for enabled item, false for disabled one.

setEnabled

void setEnabled(boolean enabled)

Setter to change enabled behaviour.

Parameters:

enabled - false to disable all operations on this item

isHidden

boolean isHidden()

(Internal usage). When and item has been deleted (with Undo) or has been filtered out by the adapter, then, it has hidden status.

Returns:

true for hidden item, (default) false for the shown one.

setHidden

void setHidden(boolean hidden)

Setter to change hidden behaviour. Useful while filtering this item. Default value is false.

Parameters:

hidden - true if this item should remain hidden, false otherwise

getSpanSize

int getSpanSize(int spanCount,
                int position)

Individual item's span size to use only with GridLayoutManager.

Note:

• Default implementation in AbstractFlexibleItem already returns 1.
• Not used when StaggeredGridLayoutManager is set. With such layout use FlexibleViewHolder.setFullSpan(boolean).

Parameters:

spanCount - current column count

position - the adapter position of the item

Returns:

the number of span occupied by the item at position.

Since:

5.0.0-rc2

shouldNotifyChange

boolean shouldNotifyChange(IFlexible newItem)

Called by the FlexibleAdapter when it wants to check if this item should be bound again with new content.

You should return true whether you want this item will be updated because its visual representations will change.

Note: This method won't be called if FlexibleAdapter.setNotifyChangeOfUnfilteredItems(boolean) is disabled.

Default value is true.

Parameters:

newItem - The new item object with the new content

Returns:

True will trigger a new binding to display new content, false if the content shown is already the latest data.

Since:

5.0.0-rc2

isSelectable

boolean isSelectable()

Checks if the item can be selected.

Returns:

(default) true for a Selectable item, false otherwise

setSelectable

void setSelectable(boolean selectable)

Setter to change selectable behaviour.

Parameters:

selectable - false to disable selection on this item

getBubbleText

java.lang.String getBubbleText(int position)

Custom bubble text for FastScroller.

To be called from the implementation of onCreateBubbleText(). Example:

 public String onCreateBubbleText(int position) {
     return getItem(position).getBubbleText(position);
 }

Parameters:

position - the current mapped position

Returns:

Any desired value

Since:

5.0.0-rc3

isDraggable

boolean isDraggable()

setDraggable

void setDraggable(boolean draggable)

isSwipeable

boolean isSwipeable()

setSwipeable

void setSwipeable(boolean swipeable)

getItemViewType

int getItemViewType()

Identifies a specific view type for this item, used by FlexibleAdapter to auto-map the ViewTypes.

HELP: To know how to implement AutoMap for ViewTypes please refer to the FlexibleAdapter Wiki Page on GitHub.

Returns:

user defined item view type identifier or layout reference if not overridden

Since:

5.0.0-rc3

getLayoutRes

int getLayoutRes()

Returns the layout resource ID to auto-inflate the View for this item. Optionally, you can assign same layout for multiple item types, but getItemViewType() must return unique values!

NOTE: Should identify a resource Layout reference R.layout.

Returns:

layout identifier

createViewHolder

VH createViewHolder(android.view.View view,
                    FlexibleAdapter<IFlexible> adapter)

Delegates the creation of the ViewHolder to the user (AutoMap).

HELP: To know how to implement AutoMap for ViewTypes please refer to the FlexibleAdapter Wiki Page on GitHub.

Parameters:

view - the already inflated view

adapter - the Adapter instance extending FlexibleAdapter

Returns:

a new ViewHolder that holds a View of the given view type

bindViewHolder

void bindViewHolder(FlexibleAdapter<IFlexible> adapter,
                    VH holder,
                    int position,
                    java.util.List<java.lang.Object> payloads)

Delegates the binding of this item's data to the given Layout.

HELP: To know how to implement AutoMap for ViewTypes please refer to the FlexibleAdapter Wiki Page on GitHub.

How to use Payload, please refer to RecyclerView.Adapter#onBindViewHolder(RecyclerView.ViewHolder, int, List).

Parameters:

adapter - the FlexibleAdapter instance

holder - the ViewHolder instance

position - the current position

payloads - a non-null list of merged payloads. Can be empty list if requires full update

unbindViewHolder

void unbindViewHolder(FlexibleAdapter<IFlexible> adapter,
                      VH holder,
                      int position)

Called when a view created by this adapter has been recycled.

A view is recycled when a RecyclerView.LayoutManager decides that it no longer needs to be attached to its parent RecyclerView. This can be because it has fallen out of visibility or a set of cached views represented by views still attached to the parent RecyclerView.

If an item view has large or expensive data bound to it such as large bitmaps, this may be a good place to release those resources.

Parameters:

adapter - the FlexibleAdapter instance

holder - the ViewHolder instance being recycled

position - the current position

onViewAttached

void onViewAttached(FlexibleAdapter<IFlexible> adapter,
                    VH holder,
                    int position)

Called when a view created by this adapter has been attached to a window.

This can be used as a reasonable signal that the view is about to be seen by the user.

Parameters:

adapter - the FlexibleAdapter instance

holder - the ViewHolder instance being recycled

position - the current position

onViewDetached

void onViewDetached(FlexibleAdapter<IFlexible> adapter,
                    VH holder,
                    int position)

Called when a view created by this adapter has been detached from its window.

Becoming detached from the window is not necessarily a permanent condition; the consumer of an Adapter's views may choose to cache views offscreen while they are not visible, attaching and detaching them as appropriate.

Parameters:

adapter - the FlexibleAdapter instance

holder - the ViewHolder instance being recycled

position - the current position