Merge pull request #130 from leinardi/feature/kotlin-sample

Migrated sample project to Kotlin
leinardi · Sep 10, 2019 · 82d4428 · 82d4428
2 parents eb2c0a6 + 93394c7
commit 82d4428
Show file tree

Hide file tree

Showing 19 changed files with 1,109 additions and 601 deletions.
diff --git a/.idea/checkstyle-idea.xml b/.idea/checkstyle-idea.xml
diff --git a/README.md b/README.md
@@ -59,79 +59,70 @@ Add the `SpeedDialView` to your layout:
 
 #### Action items
 Add the items to the `SpeedDialView`:
-```java
-SpeedDialView speedDialView = findViewById(R.id.speedDial);
+```kotlin
+val speedDialView = findViewById<SpeedDialView>(R.id.speedDial)
 speedDialView.addActionItem(
-        new SpeedDialActionItem.Builder(R.id.fab_link, R.drawable.ic_link_white_24dp)
-                .create()
-);
-
+    SpeedDialActionItem.Builder(R.id.fab_no_label, R.drawable.ic_link_white_24dp)
+        .create())
 ```
 
 If the color customization is not requested, it is also possible to inflate the Action items
 form a Menu Resource:
-```java
-speedDialView.inflate(R.menu.menu_speed_dial);
+```kotlin
+speedDialView.inflate(R.menu.menu_speed_dial)
 ```
 Only the attributes `android:id`, `android:icon` and `android:title` are supported.
 
 #### Click listeners
 Add the click listeners:
-```java
-speedDialView.setOnActionSelectedListener(new SpeedDialView.OnActionSelectedListener() {
-    @Override
-    public boolean onActionSelected(SpeedDialActionItem speedDialActionItem) {
-        switch (speedDialActionItem.getId()) {
-            case R.id.fab_link:
-                showToast("Link action clicked!");
-                return false; // true to keep the Speed Dial open
-            default:
-                return false;
+```kotlin
+speedDialView.setOnActionSelectedListener(SpeedDialView.OnActionSelectedListener { actionItem ->
+    when (actionItem.id) {
+        R.id.fab_no_label -> {
+            showToast("No label action clicked!\nClosing with animation")
+            speedDialView.close() // To close the Speed Dial with animation
+            return@OnActionSelectedListener true // false will close it without animation
         }
     }
-});
+    false
+})
 ```
 
 ### Optional steps
 #### Add the main action click listener
-```java
-speedDialView.setOnChangeListener(new SpeedDialView.OnChangeListener() {
-    @Override
-    public void onMainActionSelected() {
-        // Call your main action here
-        return false; // true to keep the Speed Dial open
+```kotlin
+speedDialView.setOnChangeListener(object : SpeedDialView.OnChangeListener {
+    override fun onMainActionSelected(): Boolean {
+        showToast("Main action clicked!")
+        return false // True to keep the Speed Dial open
     }
 
-    @Override
-    public void onToggleChanged(boolean isOpen) {
-        Log.d(TAG, "Speed dial toggle state changed. Open = " + isOpen);
+    override fun onToggleChanged(isOpen: Boolean) {
+        Log.d(TAG, "Speed dial toggle state changed. Open = $isOpen")
     }
-});
+})
 ```
 
 #### Customizing the items
 The `SpeedDialActionItem.Builder` provides several setters to customize the aspect of one item:
 
-```java
-mSpeedDialView.addActionItem(
-        new SpeedDialActionItem.Builder(R.id.fab_custom_color, R.drawable.ic_custom_color)
-                .setFabBackgroundColor(ResourcesCompat.getColor(getResources(), R.color.material_white_1000, getTheme()))
-                .setFabImageTintColor(ResourcesCompat.getColor(getResources(), R.color.inbox_primary, getTheme()))
-                .setLabel(getString(R.string.label_custom_color))
-                .setLabelColor(Color.WHITE)
-                .setLabelBackgroundColor(ResourcesCompat.getColor(getResources(), R.color.inbox_primary, getTheme()))
-                .setLabelClickable(false)
-                .create()
-);
+```kotlin
+speedDialView.addActionItem(SpeedDialActionItem.Builder(R.id.fab_custom_color, drawable)
+        .setFabBackgroundColor(ResourcesCompat.getColor(getResources(), R.color.material_white_1000, getTheme()))
+        .setFabImageTintColor(ResourcesCompat.getColor(getResources(), R.color.inbox_primary, getTheme()))
+        .setLabel(getString(R.string.label_custom_color))
+        .setLabelColor(Color.WHITE)
+        .setLabelBackgroundColor(ResourcesCompat.getColor(getResources(), R.color.inbox_primary, getTheme()))
+        .setLabelClickable(false)
+        .create())
 ```
 Is is also possible to specify a theme to easily change the FAB background and ripple effect color:
 
-```java
-mSpeedDialView.addActionItem(
-        new SpeedDialActionItem.Builder(R.id.fab_custom_theme, R.drawable.ic_theme_white_24dp)
-                .setLabel(getString(R.string.label_custom_theme))
-                .setTheme(R.style.AppTheme_Purple)
-                .create());
+```kotlin
+speedDialView.addActionItem(SpeedDialActionItem.Builder(R.id.fab_custom_theme, R.drawable.ic_theme_white_24dp)
+        .setLabel(getString(R.string.label_custom_theme))
+        .setTheme(R.style.AppTheme_Purple)
+        .create())
 ```
 ```xml
 <style name="AppTheme.Purple" parent="AppTheme">
@@ -162,9 +153,9 @@ and then provide the instance of that layout to the `SpeedDialView`:
     app:sdOverlayLayout="@id/overlay" />
 ```
 or
-```java
-SpeedDialOverlayLayout overlayLayout = findViewById(R.id.overlay);
-mSpeedDialView.setSpeedDialOverlayLayout(overlayLayout);
+```kotlin
+val overlayLayout = findViewById<SpeedDialOverlayLayout>(R.id.overlay)
+speedDialView.setSpeedDialOverlayLayout(overlayLayout)
 ```
 
 #### Hiding the FAB when scrolling a `RecyclerView` or a `NestedScrollView`
@@ -180,20 +171,20 @@ the convenience string resource `@string/speeddial_scrolling_view_snackbar_behav
 ```
 
 Or programmatically:
-```java
-CoordinatorLayout.LayoutParams params = (CoordinatorLayout.LayoutParams) speedDialView.getLayoutParams();
-params.setBehavior(new SpeedDialView.ScrollingViewSnackbarBehavior());
-speedDialView.requestLayout();
+```kotlin
+val params = speedDialView.layoutParams as CoordinatorLayout.LayoutParams
+params.behavior = SpeedDialView.ScrollingViewSnackbarBehavior()
+speedDialView.requestLayout()
 ```
 
 NB: for the behaviors to work, `SpeedDialView` needs to be a direct child of `CoordinatorLayout`
 
 #### Disabling `SnackbarBehavior`
 Since the `SnackbarBehavior` is enabled by default and, afaik, it is not possible to remove a Behavior, simply use apply the `SpeedDialView.NoBehavior` instead:
-```java
-CoordinatorLayout.LayoutParams params = (CoordinatorLayout.LayoutParams) speedDialView.getLayoutParams();
-params.setBehavior(new SpeedDialView.NoBehavior());
-speedDialView.requestLayout();
+```kotlin
+val params = speedDialView.layoutParams as CoordinatorLayout.LayoutParams
+params.behavior = SpeedDialView.NoBehavior()
+speedDialView.requestLayout()
 ```
 
 ### Sample project
@@ -250,7 +241,7 @@ This project is based on [floating-action-menu by ArthurGhazaryan](https://githu
 
 ## Licenses
 ```
-Copyright 2018 Roberto Leinardi.
+Copyright 2019 Roberto Leinardi.
 
 Licensed to the Apache Software Foundation (ASF) under one or more contributor
 license agreements.  See the NOTICE file distributed with this work for

diff --git a/build.gradle b/build.gradle
@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 apply from: rootProject.file('versions-plugin.gradle')
+apply from: rootProject.file('detekt.gradle')
 apply plugin: "se.bjurr.violations.violation-comments-to-github-gradle-plugin"
 
 buildscript {
@@ -22,13 +23,15 @@ buildscript {
         addRepos(repositories)
     }
     dependencies {
+        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$versions.kotlin"
         classpath "com.android.tools.build:gradle:$versions.android_gradle_plugin"
         classpath "com.leinardi.android:android-checkstyle-plugin:$versions.android_checkstyle_plugin"
         classpath "com.github.dcendents:android-maven-gradle-plugin:$versions.android_maven_gradle_plugin"
         classpath "com.jfrog.bintray.gradle:gradle-bintray-plugin:$versions.gradle_bintray_plugin"
         classpath "com.github.ben-manes:gradle-versions-plugin:$versions.gradle_versions_plugin"
         classpath "se.bjurr.violations:violation-comments-to-github-gradle-plugin:$versions.violations_plugin"
         classpath "net.ltgt.gradle:gradle-errorprone-plugin:$versions.errorprone_plugin"
+        classpath "io.gitlab.arturbosch.detekt:detekt-gradle-plugin:$versions.detekt"
         // NOTE: Do not place your application dependencies here; they belong
         // in the individual module build.gradle files
     }

diff --git a/checkstyle.gradle b/checkstyle.gradle
@@ -20,5 +20,5 @@ checkstyle {
     ignoreFailures = false // Whether this task will ignore failures and continue running the build.
     configFile rootProject.file('config/checkstyle/checkstyle.xml')
     // The Checkstyle configuration file to use.
-    toolVersion = '8.16' // The version of Checkstyle you want to be used
+    toolVersion = '8.23' // The version of Checkstyle you want to be used
 }