An Easy to use adapter for android, a fork from GenericAdapter
From version 2.0.0 the library is rewritten in Kotlin and RxBinding dependency is removed!
- No need to create a separate class for each adapter
- No need of ViewHolder
- More readable code
-
GenericAdapter : extends from RecyclerView.Adapter
-
GenericListAdapter : extends from ListAdapter
-
GenericFilterAdapter : extends from RecyclerView.Adapter
-
GenericListFilterAdapter : extends from ListAdapter
This library is available in jitPack which is the default Maven repository used in Android Studio.
Step 1. Add it in your root build.gradle at the end of repositories
allprojects
{
repositories {
...
maven { url 'https://jitpack.io' }
}
}Step 2. Add the dependency in your apps module build.gradle
dependencies {
implementation 'com.github.ivankostadinovic:GenericAdapter:<latest-version>'
}In App level build.gradle
dataBinding {
enabled true
} adapter = new GenericAdapter<Radio, RvRadioItemBinding>(radios, R.layout.rv_radio_item) {
@Override
public void onBindData(Radio model, int position, RvRadioItemBinding dataBinding) {
}
@Override
public void onItemClick(Radio model, int position) {
}
};
recyclerView.setAdapter(adapter);
//don't forget to set a LayoutManager to the recycler view EditText editSearch = findViewById(R.id.editSearch);
filterAdapter = new GenericFilterAdapter<Radio, RvRadioItemBinding>(radios, R.layout.rv_radio_item, editSearch) {
@Override
public void onBindData(Radio model, int position, RvRadioItemBinding dataBinding) {
}
@Override
public void onItemClick(Radio model, int position) {
}
@Override
public boolean filter(Radio item, String searchText) {
return item.name.contains(text); //return true if the item matches the search text in the way you prefer
}
};
recyclerView.setAdapter(adapter);
//don't forget to set a LayoutManager to the recycler viewThis method is called when adapter method onCreateViewHolder is called. You can optionally add things like focus listeners that would require to be set only once per view holder:
...
@Override
public void onCreateHolder(RvRadioItemBinding dataBinding) {
}
...Both adapters have support for pagination. If you wish to use pagination with these adapters, override the loadMoreItems method:
...
@Override
public void loadMoreItems(int loadedCount) {
//make API/db call
}
...
//when new items are fetched, add them to the adapter
adapter.addItems(newItems);This method is called when the adapter method onBindViewHolder is called for an item that is close to the end of the item list. By default, the pagination offset is 3, meaning that when onBindViewHolder is called with the position being getItemCount() - 3, the loadMoreItems method is called. You can change this offset by creating any of the adapters with the additional parameter in constructor:
adapter = new GenericAdapter<Radio, RvRadioItemBinding>(radios, R.layout.rv_radio_item, 10) {...}
filterAdapter = new GenericFilterAdapter<Radio, RvRadioItemBinding>(radios, R.layout.rv_radio_item, 10) {...}Instead of binding the data manually in the onBindData method, the library takes cares of this internally, and you can access that data through the XML. The data variable name should be set to "data" in the layout for this to work. Example how a layout file should like in order to use this functionality.
<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:app="http://schemas.android.com/apk/res-auto">
<data>
<variable
name="data"
type="com.arena.tv.models.model.Radio" />
<import type="android.view.View" />
</data>
<FrameLayout xmlns:android="http://schemas.android.com/apk/res/android"
android:id="@+id/container"
android:layout_width="match_parent"
android:layout_height="wrap_content">
<TextView
android:id="@+id/txt_name"
android:text="@{data.name}"
android:layout_width="wrap_content"
android:layout_height="wrap_content"/>
<ImageView
android:id="@+id/img_icon"
android:layout_width="match_parent"
android:layout_height="match_parent"
android:focusable="false"
android:focusableInTouchMode="false"
app:imageUrl="@{data.stream_icon}" />
<!-- imageUrl method is provided by a Binding Adapter, that is out of scope for this library-->
</FrameLayout>
</layout>If you don't like this, you can still bind the data in the onBindData method, and set up the XML layout accordingly.
adapter = new GenericAdapter<Radio, RvRadioItemBinding>(radios, R.layout.rv_radio_item) {...}
adapter.setItems(radios); //overrides the current list with a new list
adapter.addItem(radio, itemPosition); //adds a single item at the given position
adapter.addItems(radios); //adds new items at the end of the list
adapter.removeItem(itemPosition); //removes item at the given position
adapter.removeItem(radio); //removes the particular item, if it exists in the list
adapter.clearItems(); //removes all the items from the adapter
adapter.getItem(itemPosition); //retrieves the item at the given position
adapter.updateItem(radio, itemPosition); //replaces the item at the position with a new itemUsage is the same as the GenericAdapter and GenericFilterAdapter, these just require a DiffUtil.ItemCallback passed via the constructors.
Why you should use adapters that extend from ListAdapter instead of RecyclerView.Adapter:
ListAdapter: A RecyclerView Adapter Extension
DiffUtil.ItemCallback<Radio> itemCallback = new DiffUtil.ItemCallback<ListItem>() {
@Override
public boolean areItemsTheSame(@NonNull @NotNull Radio oldItem, @NonNull @NotNull Radio newItem) {
return oldItem.id == newItem.id;
}
@Override
public boolean areContentsTheSame(@NonNull @NotNull Radio oldItem, @NonNull @NotNull Radio newItem) {
return oldItem.id == newItem.id && oldItem.name.equals(newItem.name);
}
}
adapter = new GenericListAdapter<Radio, RvRadioItemBinding>(radios, R.layout.rv_radio_item, itemCallback) {
@Override
public void onBindData(Radio model, int position, RvRadioItemBinding dataBinding) {
}
@Override
public void onItemClick(Radio model, int position) {
}
};
recyclerView.setAdapter(adapter);
//don't forget to add a LayoutManager to the RecyclerViewMIT License
Copyright (c) 2023 Ivan Kostadinovic
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.