data-binding listview

Author: ManaliN

.gitignore

@@ -34,6 +34,7 @@ captures/
 
 # IntelliJ
 *.iml
+.idea/*
 .idea/workspace.xml
 .idea/tasks.xml
 .idea/gradle.xml
@@ -63,3 +64,8 @@ fastlane/Preview.html
 fastlane/screenshots
 fastlane/test_output
 fastlane/readme.md
+app/
+databinding-example/libs/
+gradle/
+gradlew.bat
+libs/

.idea/modules.xml

@@ -1,2 +1,64 @@
 # Databinding-Kotlin-Android
 An MVP app example using Databinding 
+
+
+## Steps to set up data binding
+Add the following in the module level build.gradle file e.g. app/build.gradle,
+ 1. Add the following inside android section:
+
+ ```
+ dataBinding {
+ enabled = true
+ }
+ ```
+ 2. Along with other plugins add the following in the top:
+ ```
+ apply plugin: 'kotlin-kapt'
+ 
+ ```
+ 3. Add the following in the dependencies:
+ 
+ ```
+ kapt "com.android.databinding:compiler:$gradle_version" 
+
+ ```
+ 4. Create a model class, e.g. SearchViewModel in this example.
+ 
+ 5. In the xml file of the activity where data binding will be used, create a layout tag.
+ Place data tag inside this layout tag. If we have multiple data models which we want to bind to the Ui, 
+ we can create different data variables. We use the name field to access parameters of Model class.
+ 
+ 6. Inside the activity, where we implement data binding, create a binding variable of ActivityMainBinding.
+ 
+ 7. Replace the defaule setContentView with the DataBindingUtil.setContentView:
+ ```
+ e.g.
+ binding = DataBindingUtil.setContentView(this, R.layout.activity_main)
+ ```
+ 
+## Features included in the example:
+
+#### Basic Data Binding:
+
+* This is a basic example showing use of data binding to bridge the communication between data and UI. 
+
+#### Network Communication 
+* This app takes user input and makes a query to the Github public API to search repositories.
+https://developer.github.com/v3/search/#search-repositories. 
+* Remember to add android.permission.INTERNET in the AndroidManifest file as any network call will need this permission.
+
+#### JSON Data Parsing 
+* After receiving response from the API it parses the Json data to search for Repository Name, Description, Star count and URL of User's Avatar.
+
+#### Communication between UI Thread and Background Thread
+* In this example we briefly cover making network calls, parsing the response and then communicating the parsed data back to the UI thread.
+
+#### Loading Image from an URL
+* Use of Picasso Library has been included to highlight getting data from an URL.
+
+#### Data Binding with List View
+* The response is displayed in List View using data binding.
+
+#### Preserving data on Runtime Configuration Changes
+
+* The app preserves data on runtime configuration changes like Screen rotations, keyboard changes.

README.md

@@ -0,0 +1,28 @@
+// Top-level build file where you can add configuration options common to all sub-projects/modules.
+
+buildscript {
+ ext.kotlin_version = '1.2.41'
+ ext.gradle_version = '3.1.2'
+ repositories {
+ google()
+ jcenter()
+ }
+ dependencies {
+ classpath "com.android.tools.build:gradle:$gradle_version"
+ classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
+
+ // NOTE: Do not place your application dependencies here; they belong
+ // in the individual module build.gradle files
+ }
+}
+
+allprojects {
+ repositories {
+ google()
+ jcenter()
+ }
+}
+
+task clean(type: Delete) {
+ delete rootProject.buildDir
+}

build.gradle

@@ -0,0 +1 @@
+/build

databinding-listview-example/.gitignore

@@ -0,0 +1,46 @@
+apply plugin: 'com.android.application'
+apply plugin: 'kotlin-android'
+apply plugin: 'kotlin-android-extensions'
+apply plugin: 'kotlin-kapt'
+
+android {
+ compileSdkVersion 27
+
+ defaultConfig {
+ applicationId "com.github.databinding.databinding_listview_example"
+ minSdkVersion 21
+ targetSdkVersion 27
+ versionCode 1
+ versionName "1.0"
+
+ testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
+
+ }
+
+ buildTypes {
+ release {
+ minifyEnabled false
+ proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
+ }
+ }
+
+ dataBinding {
+ enabled = true
+ }
+}
+
+dependencies {
+ implementation fileTree(dir: 'libs', include: ['*.jar'])
+ implementation"org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
+ implementation 'com.android.support:appcompat-v7:27.1.1'
+ implementation 'com.android.support.constraint:constraint-layout:1.1.0'
+ testImplementation 'junit:junit:4.12'
+ androidTestImplementation 'com.android.support.test:runner:1.0.2'
+ androidTestImplementation 'com.android.support.test.espresso:espresso-core:3.0.2'
+
+ // required for data binding
+ kapt "com.android.databinding:compiler:$gradle_version"
+
+ // added for loading image from url
+ implementation 'com.squareup.picasso:picasso:2.5.2'
+}

databinding-listview-example/build.gradle

@@ -0,0 +1,21 @@
+# Add project specific ProGuard rules here.
+# You can control the set of applied configuration files using the
+# proguardFiles setting in build.gradle.
+#
+# For more details, see
+# http://developer.android.com/guide/developing/tools/proguard.html
+
+# If your project uses WebView with JS, uncomment the following
+# and specify the fully qualified class name to the JavaScript interface
+# class:
+#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
+# public *;
+#}
+
+# Uncomment this to preserve the line number information for
+# debugging stack traces.
+#-keepattributes SourceFile,LineNumberTable
+
+# If you keep the line number information, uncomment this to
+# hide the original source file name.
+#-renamesourcefileattribute SourceFile

databinding-listview-example/proguard-rules.pro

@@ -0,0 +1,24 @@
+package com.github.databinding.listviewexample
+
+import android.support.test.InstrumentationRegistry
+import android.support.test.runner.AndroidJUnit4
+
+import org.junit.Test
+import org.junit.runner.RunWith
+
+import org.junit.Assert.*
+
+/**
+ * Instrumented test, which will execute on an Android device.
+ *
+ * See [testing documentation](http://d.android.com/tools/testing).
+ */
+@RunWith(AndroidJUnit4::class)
+class ExampleInstrumentedTest {
+ @Test
+ fun useAppContext() {
+ // Context of the app under test.
+ val appContext = InstrumentationRegistry.getTargetContext()
+ assertEquals("com.github.databinding.databinding_listview_example", appContext.packageName)
+ }
+}

databinding-listview-example/src/androidTest/java/com/github/databinding/listviewexample/ExampleInstrumentedTest.kt

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+ package="com.github.databinding.listviewexample">
+
+ <uses-permission android:name="android.permission.INTERNET"/>
+ <application
+ android:allowBackup="true"
+ android:icon="@mipmap/ic_launcher"
+ android:label="@string/app_name"
+ android:roundIcon="@mipmap/ic_launcher_round"
+ android:supportsRtl="true"
+ android:theme="@style/AppTheme">
+ <activity android:name="com.github.databinding.listviewexample.MainActivity">
+ <intent-filter>
+ <action android:name="android.intent.action.MAIN"/>
+
+ <category android:name="android.intent.category.LAUNCHER"/>
+ </intent-filter>
+ </activity>
+ </application>
+
+</manifest>