[REFACTOR] [#28] Renamed the position layout to base layout.

[ADDED] Documentation for the base activity.

Fixes #28

Author: hossain-khan

app/src/main/AndroidManifest.xml

@@ -17,8 +17,8 @@
                 <category android:name="android.intent.category.LAUNCHER" />
             </intent-filter>
         </activity>
-        <activity android:name=".layoutpositioning.LayoutPositioningDemoActivity" />
-        <activity android:name=".layoutpositioning.LayoutVisibilityGoneActivity"></activity>
+        <activity android:name=".layoutpreview.LayoutPreviewBaseActivity" />
+        <activity android:name=".layoutpreview.LayoutVisibilityGoneActivity"></activity>
     </application>
 
 </manifest>

app/src/main/java/com/hossainkhan/android/demo/browse/MainActivity.kt

@@ -19,13 +19,11 @@ package com.hossainkhan.android.demo.browse
 import android.support.v7.app.AppCompatActivity
 import android.os.Bundle
 import android.support.v7.widget.GridLayoutManager
-import android.support.v7.widget.LinearLayoutManager
 import android.support.v7.widget.RecyclerView
-import android.view.View
 import com.hossainkhan.android.demo.R
 import com.hossainkhan.android.demo.data.AppDataStore
-import com.hossainkhan.android.demo.layoutpositioning.LayoutPositioningDemoActivity
-import com.hossainkhan.android.demo.layoutpositioning.LayoutVisibilityGoneActivity
+import com.hossainkhan.android.demo.layoutpreview.LayoutPreviewBaseActivity
+import com.hossainkhan.android.demo.layoutpreview.LayoutVisibilityGoneActivity
 import dagger.android.AndroidInjection
 import timber.log.Timber
 import javax.inject.Inject
@@ -73,7 +71,7 @@ class MainActivity : AppCompatActivity() {
                         .createStartIntent(this))
             }
             else -> {
-                startActivity(LayoutPositioningDemoActivity
+                startActivity(LayoutPreviewBaseActivity
                         .createStartIntent(this, layoutResId))
             }
         }

app/src/main/java/com/hossainkhan/android/demo/dagger/ActivityBindingModule.kt

@@ -16,8 +16,8 @@
 
 package com.hossainkhan.android.demo.dagger
 
-import com.hossainkhan.android.demo.layoutpositioning.LayoutPositioningDemoActivity
-import com.hossainkhan.android.demo.layoutpositioning.LayoutVisibilityGoneActivity
+import com.hossainkhan.android.demo.layoutpreview.LayoutPreviewBaseActivity
+import com.hossainkhan.android.demo.layoutpreview.LayoutVisibilityGoneActivity
 import dagger.Module
 import dagger.android.ContributesAndroidInjector
 
@@ -47,7 +47,7 @@ abstract class ActivityBindingModule {
      */
     @ActivityScope
     @ContributesAndroidInjector
-    abstract fun layoutPositioningActivity(): LayoutPositioningDemoActivity
+    abstract fun layoutPositioningActivity(): LayoutPreviewBaseActivity
 
     @ActivityScope
     @ContributesAndroidInjector

…tioning/LayoutPositioningDemoActivity.kt …youtpreview/LayoutPreviewBaseActivity.ktapp/src/main/java/com/hossainkhan/android/demo/layoutpositioning/LayoutPositioningDemoActivity.kt renamed to app/src/main/java/com/hossainkhan/android/demo/layoutpreview/LayoutPreviewBaseActivity.kt app/src/main/java/com/hossainkhan/android/demo/layoutpositioning/LayoutPositioningDemoActivity.kt renamed to app/src/main/java/com/hossainkhan/android/demo/layoutpreview/LayoutPreviewBaseActivity.kt

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package com.hossainkhan.android.demo.layoutpositioning
+package com.hossainkhan.android.demo.layoutpreview
 
 import android.content.Context
 import android.content.Intent
@@ -34,14 +34,18 @@ import timber.log.Timber
 import javax.inject.Inject
 
 /**
- * Relative positioning is one of the basic building block of creating layouts in ConstraintLayout.
- * Those constraints allow you to position a given widget relative to another one.
- * You can constrain a widget on the horizontal and vertical axis.
+ * This the the **base** activity for previewing different constraint layout features.
+ *
+ * Currently, the activity does following basic actions:
+ * 1. Inject necessary dependencies required for all activities.
+ * 1. Load and populate [LayoutInformation] for currently viewing layout.
+ * 1. Shows tooltip with layout details for the first time only.
+ * 1. Loads layout XML source code from Github.
  */
-open class LayoutPositioningDemoActivity : AppCompatActivity() {
+open class LayoutPreviewBaseActivity : AppCompatActivity() {
 
     companion object {
-        private const val BUNDLE_KEY_LAYOUT_RESID = "KEY_LAYOUT_RESOURCE_ID"
+        internal const val BUNDLE_KEY_LAYOUT_RESID = "KEY_LAYOUT_RESOURCE_ID"
 
         /**
          * Creates an intent with required information to start this activity.
@@ -50,7 +54,7 @@ open class LayoutPositioningDemoActivity : AppCompatActivity() {
          * @param layoutResourceId The layout resource ID to load into the view.
          */
         fun createStartIntent(context: Context, @LayoutRes layoutResourceId: Int): Intent {
-            val intent = Intent(context, LayoutPositioningDemoActivity::class.java)
+            val intent = Intent(context, LayoutPreviewBaseActivity::class.java)
             intent.putExtra(BUNDLE_KEY_LAYOUT_RESID, layoutResourceId)
             return intent
         }
@@ -67,9 +71,8 @@ open class LayoutPositioningDemoActivity : AppCompatActivity() {
         super.onCreate(savedInstanceState)
 
         val layoutResourceId = intent.getIntExtra(BUNDLE_KEY_LAYOUT_RESID, -1)
-        val resourceName = appDataStore.layoutStore.getLayoutUrl(layoutResourceId)
         layoutInformation = appDataStore.layoutStore.layoutsInfos[layoutResourceId]!!
-        Timber.d("Loading layout: %s, info: %s", resourceName, layoutInformation)
+        Timber.d("Loading layout: %s", layoutInformation)
 
         setContentView(layoutResourceId)
 

…itioning/LayoutVisibilityGoneActivity.kt …tpreview/LayoutVisibilityGoneActivity.ktapp/src/main/java/com/hossainkhan/android/demo/layoutpositioning/LayoutVisibilityGoneActivity.kt renamed to app/src/main/java/com/hossainkhan/android/demo/layoutpreview/LayoutVisibilityGoneActivity.kt app/src/main/java/com/hossainkhan/android/demo/layoutpositioning/LayoutVisibilityGoneActivity.kt renamed to app/src/main/java/com/hossainkhan/android/demo/layoutpreview/LayoutVisibilityGoneActivity.kt

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package com.hossainkhan.android.demo.layoutpositioning
+package com.hossainkhan.android.demo.layoutpreview
 
 import android.content.Context
 import android.content.Intent
@@ -23,16 +23,13 @@ import android.view.View
 import android.widget.Button
 import com.hossainkhan.android.demo.R
 
-class LayoutVisibilityGoneActivity : LayoutPositioningDemoActivity() {
+class LayoutVisibilityGoneActivity : LayoutPreviewBaseActivity() {
 
     companion object {
-        private const val BUNDLE_KEY_LAYOUT_RESID = "KEY_LAYOUT_RESOURCE_ID"
-
         /**
          * Creates an intent with required information to start this activity.
          *
          * @param context Activity context.
-         * @param layoutResourceId The layout resource ID to load into the view.
          */
         fun createStartIntent(context: Context): Intent {
             val intent = Intent(context, LayoutVisibilityGoneActivity::class.java)
@@ -44,6 +41,7 @@ class LayoutVisibilityGoneActivity : LayoutPositioningDemoActivity() {
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
 
+        // Setup additional view that is only available in this screen.
         val toggleButton = findViewById<Button>(R.id.toggle_view_visibility_button)
         val firstView = findViewById<View>(R.id.visibility_behaviour_box_start)
 

app/src/main/res/layout/preview_positioning_centered.xml

@@ -22,7 +22,7 @@
     android:layout_height="match_parent"
     android:foreground="@drawable/ic_grid_overlay"
     android:foregroundTint="@color/grid_tint"
-    tools:context=".layoutpositioning.LayoutPositioningDemoActivity">
+    tools:context=".layoutpreview.LayoutPreviewBaseActivity">
 
 
     <!--

app/src/main/res/layout/preview_positioning_top_left.xml

@@ -21,7 +21,7 @@
     android:layout_height="match_parent"
     android:foreground="@drawable/ic_grid_overlay"
     android:foregroundTint="@color/grid_tint"
-    tools:context=".layoutpositioning.LayoutPositioningDemoActivity">
+    tools:context=".layoutpreview.LayoutPreviewBaseActivity">
 
 
     <!--