To-Do List

https://github.com/yalantis/todolist
Admin
An Android library for creating interactive to-do list applications with smooth animations and...
Tokens:1,836
Snippets:9
Trust Score:8.3
Update:1 year ago
Show doc for...
Tokens:
Raw
### Initialize BatAdapter with Data and Listener

Source: https://github.com/yalantis/todolist/blob/master/README.md

This Java snippet shows how to instantiate `BatAdapter`, passing an `ArrayList` of `BatModel` objects (e.g., `Goal` instances) and a `BatListener` to its constructor. It also demonstrates setting an `OnItemClickListener` to handle item clicks, displaying a `Toast` message with the item's text.

```java
mAdapter = new BatAdapter(mGoals = new ArrayList<BatModel>() {{
      add(new Goal("first"));
      add(new Goal("second"));
      add(new Goal("third"));
      add(new Goal("fourth"));
      add(new Goal("fifth"));
      add(new Goal("sixth"));
      add(new Goal("seventh"));
      add(new Goal("eighth"));
      add(new Goal("ninth"));
      add(new Goal("tenth"));
}}, mListener);
        
mAdapter.setOnItemClickListener(new OnItemClickListener() {
      @Override
      public void onClick(BatModel item, int position) {
            Toast.makeText(ExampleActivity.this, item.getText(), Toast.LENGTH_SHORT).show();
      }
});
```

--------------------------------

### Configure Jitpack Repository in Gradle

Source: https://github.com/yalantis/todolist/blob/master/README.md

This snippet shows how to add the Jitpack Maven repository to your Android project's root `build.gradle` file. This is a prerequisite for fetching dependencies hosted on Jitpack, such as the ToDoList library.

```Groovy
allprojects {
	repositories {
	...
	maven { url "https://jitpack.io" }
	}
}
```

--------------------------------

### Initialize BatRecyclerView and Attach Components

Source: https://github.com/yalantis/todolist/blob/master/README.md

This Java code initializes the `BatRecyclerView` by setting its `LayoutManager` (e.g., `LinearLayoutManager`) and `Adapter`. It also demonstrates attaching an `ItemTouchHelper` with a `BatCallback` for swipe/drag functionality and setting the `AddItemListener` for the `BatRecyclerView` to handle new item additions.

```java
mRecyclerView.getView().setLayoutManager(new LinearLayoutManager(this));
mRecyclerView.getView().setAdapter(mAdapter);

ItemTouchHelper itemTouchHelper = new ItemTouchHelper(new BatCallback(this));
itemTouchHelper.attachToRecyclerView(mRecyclerView.getView());
mRecyclerView.setAddItemListener(mListener);
```

--------------------------------

### Integrate BatItemAnimator for List Animations

Source: https://github.com/yalantis/todolist/blob/master/README.md

This Java snippet illustrates how to use `BatItemAnimator` to add animations to list items, similar to the demo. It shows initializing the animator and passing its instance to both the `BatAdapter` constructor and setting it on the `BatRecyclerView`'s view, enabling custom move animations.

```java
mAnimator = new BatItemAnimator();
mAdapter = new BatAdapter(mGoals = new ArrayList<BatModel>() {{
            add(new Goal("first"));
            add(new Goal("second"));
            add(new Goal("third"));
            add(new Goal("fourth"));
            add(new Goal("fifth"));
            add(new Goal("sixth"));
            add(new Goal("seventh"));
            add(new Goal("eighth"));
            add(new Goal("ninth"));
            add(new Goal("tenth"));
}}, mListener, mAnimator);
mRecyclerView.getView().setItemAnimator(mAnimator);
```

--------------------------------

### Add ToDoList Library Dependency in Gradle

Source: https://github.com/yalantis/todolist/blob/master/README.md

This snippet demonstrates how to declare the ToDoList library as a compilation dependency in your Android project's `build.gradle` file. Once added, the library's functionalities will be available for use in your application.

```Groovy
dependencies {
	compile 'com.github.yalantis:todolist:v1.0.1'
}
```

--------------------------------

### Implement BatListener Interface

Source: https://github.com/yalantis/todolist/blob/master/README.md

This Java code defines an anonymous inner class that implements the `BatListener` interface. It provides concrete implementations for `add`, `delete`, and `move` methods, which handle data manipulation (adding, removing, reordering items) and notify the adapter for UI updates, including special handling for `BatItemAnimator` and scrolling to the correct position.

```java
private BatListener mListener = new BatListener() {
        @Override
        public void add(String string) {
            mGoals.add(0, new Goal(string));
            mAdapter.notify(AnimationType.ADD, 0);
        }

        @Override
        public void delete(int position) {
            mGoals.remove(position);
            mAdapter.notify(AnimationType.REMOVE, position);
        }

        @Override
        public void move(int from, int to) {
            if (from >= 0 && to >= 0) {
                
                //if you use 'BatItemAnimator'
                mAnimator.setPosition(to);
                
                BatModel model = mGoals.get(from);
                mGoals.remove(model);
                mGoals.add(to, model);
                mAdapter.notify(AnimationType.MOVE, from, to);

                if (from == 0 || to == 0) {
                    mRecyclerView.getView().scrollToPosition(Math.min(from, to));
                }
            }
        }
    };
```

--------------------------------

### Add BatRecyclerView to XML Layout

Source: https://github.com/yalantis/todolist/blob/master/README.md

This XML snippet demonstrates how to integrate the `BatRecyclerView` widget into an Android layout file. It includes a `LinearLayout` as the root, a `Toolbar`, and the `BatRecyclerView` itself, configured with custom attributes like `add_button_color`, `hint`, and `radio_button_res` for visual customization.

```xml
<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    android:id="@+id/root"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:background="@drawable/gradient"
    android:orientation="vertical">

    <android.support.v7.widget.Toolbar
        android:id="@+id/toolbar"
        android:layout_width="match_parent"
        android:layout_height="?android:attr/actionBarSize"
        android:background="@android:color/transparent"
        app:logo="@drawable/ic_menu">

        <TextView
            android:id="@+id/text_title"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:layout_gravity="center"
            android:text="14 Feb, 2016"
            android:textColor="@android:color/white"
            android:textSize="20sp" />

    </android.support.v7.widget.Toolbar>

    <com.yalantis.beamazingtoday.ui.widget.BatRecyclerView
        android:id="@+id/bat_recycler_view"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:layout_gravity="center_horizontal"
        app:add_button_color="@drawable/selector_button_add"
        app:hint="@string/str_add_goal"
        app:radio_button_res="@drawable/selector_radio_button" />

</LinearLayout>
```

--------------------------------

### Android UI Component Cursor API Updates (v1.0.1)

Source: https://github.com/yalantis/todolist/blob/master/README.md

Documents the API changes related to cursor handling in version 1.0.1 of the UI component. The `cursor_drawable` attribute and `setCursorDrawable` method are introduced as replacements for the deprecated `cursor_color` attribute and `setCursorColor` method, providing more flexible cursor customization.

```APIDOC
New API:
  Attribute: cursor_drawable
    Description: Specifies a drawable resource to be used as the cursor.
    Type: @DrawableRes int

  Method: setCursorDrawable
    Signature: setCursorDrawable(@DrawableRes int res)
    Parameters:
      res: The drawable resource ID to use for the cursor.
    Return Type: void
    Description: Sets the drawable resource to be used as the cursor.

Deprecated API:
  Attribute: cursor_color
    Description: Specifies the color of the cursor.
    Type: @ColorInt int

  Method: setCursorColor
    Signature: setCursorColor(@ColorInt int color)
    Parameters:
      color: The color integer to use for the cursor.
    Return Type: void
    Description: Sets the color of the cursor. This method is deprecated and should be replaced by setCursorDrawable.
```

--------------------------------

### Update BatListener Move Callback for BatItemAnimator

Source: https://github.com/yalantis/todolist/blob/master/README.md

This Java code provides an updated implementation of the `move` method within `BatListener` specifically when `BatItemAnimator` is used. It's crucial to set the animator's position (`mAnimator.setPosition(to)`) before performing data manipulation and notifying the adapter, ensuring correct animation behavior during item moves.

```java
@Override
public void move(int from, int to) {
     if (from >= 0 && to >= 0) {
           mAnimator.setPosition(to);
           BatModel model = mGoals.get(from);
           mGoals.remove(model);
           mGoals.add(to, model);
           mAdapter.notify(AnimationType.MOVE, from, to);

           if (from == 0 || to == 0) {
                 mRecyclerView.getView().scrollToPosition(Math.min(from, to));
           }
     }
}
```
Tokens:
Raw