From 9280d8d61224fc8d65039045d9f96d25efcf0d63 Mon Sep 17 00:00:00 2001
From: lognaturel <lognaturel@gmail.com>
Date: Mon, 5 Nov 2018 10:40:22 -0800
Subject: [PATCH] Make the FormHierarchyActivity the default and remove edit

---
 collect_app/src/main/AndroidManifest.xml      |  2 +-
 .../activities/EditFormHierarchyActivity.java | 24 -------------------
 .../android/activities/FormEntryActivity.java |  4 ++--
 .../activities/FormHierarchyActivity.java     | 20 ++++++++++++++--
 4 files changed, 21 insertions(+), 29 deletions(-)
 delete mode 100644 collect_app/src/main/java/org/odk/collect/android/activities/EditFormHierarchyActivity.java

diff --git a/collect_app/src/main/AndroidManifest.xml b/collect_app/src/main/AndroidManifest.xml
index ae95c4ed85b..d3b90fff7b5 100644
--- a/collect_app/src/main/AndroidManifest.xml
+++ b/collect_app/src/main/AndroidManifest.xml
@@ -195,8 +195,8 @@ the specific language governing permissions and limitations under the License.
         <activity android:name=".activities.AboutActivity" />
         <activity android:name=".preferences.PreferencesActivity" />
         <activity android:name=".preferences.AdminPreferencesActivity" />
+        <activity android:name=".activities.FormHierarchyActivity" />
         <activity android:name=".activities.ViewFormHierarchyActivity" />
-        <activity android:name=".activities.EditFormHierarchyActivity" />
         <activity android:name=".activities.GeoPointActivity" />
         <activity
             android:name=".activities.GeoPointMapActivity"
diff --git a/collect_app/src/main/java/org/odk/collect/android/activities/EditFormHierarchyActivity.java b/collect_app/src/main/java/org/odk/collect/android/activities/EditFormHierarchyActivity.java
deleted file mode 100644
index 3c5d0c32af1..00000000000
--- a/collect_app/src/main/java/org/odk/collect/android/activities/EditFormHierarchyActivity.java
+++ /dev/null
@@ -1,24 +0,0 @@
-/*
- * Copyright (C) 2017 Shobhit
- *
- * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
- * in compliance with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under the License
- * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
- * or implied. See the License for the specific language governing permissions and limitations under
- * the License.
- */
-
-package org.odk.collect.android.activities;
-
-import android.view.KeyEvent;
-
-import org.odk.collect.android.application.Collect;
-import org.odk.collect.android.logic.FormController;
-
-public class EditFormHierarchyActivity extends FormHierarchyActivity {
-
-}
diff --git a/collect_app/src/main/java/org/odk/collect/android/activities/FormEntryActivity.java b/collect_app/src/main/java/org/odk/collect/android/activities/FormEntryActivity.java
index 6473d719e24..8631d2d6217 100644
--- a/collect_app/src/main/java/org/odk/collect/android/activities/FormEntryActivity.java
+++ b/collect_app/src/main/java/org/odk/collect/android/activities/FormEntryActivity.java
@@ -987,7 +987,7 @@ public boolean onOptionsItemSelected(MenuItem item) {
                             0, null, false, true);
                 }
 
-                Intent i = new Intent(this, EditFormHierarchyActivity.class);
+                Intent i = new Intent(this, FormHierarchyActivity.class);
                 startActivityForResult(i, RequestCodes.HIERARCHY_ACTIVITY);
                 return true;
             case R.id.menu_preferences:
@@ -2377,7 +2377,7 @@ public void denied() {
                         if (formMode == null || ApplicationConstants.FormModes.EDIT_SAVED.equalsIgnoreCase(formMode)) {
                             formController.getTimerLogger().logTimerEvent(TimerLogger.EventTypes.FORM_RESUME, 0, null, false, true);
                             formController.getTimerLogger().logTimerEvent(TimerLogger.EventTypes.HIERARCHY, 0, null, false, true);
-                            startActivity(new Intent(this, EditFormHierarchyActivity.class));
+                            startActivity(new Intent(this, FormHierarchyActivity.class));
                             return; // so we don't show the intro screen before jumping to the hierarchy
                         } else {
                             if (ApplicationConstants.FormModes.VIEW_SENT.equalsIgnoreCase(formMode)) {
diff --git a/collect_app/src/main/java/org/odk/collect/android/activities/FormHierarchyActivity.java b/collect_app/src/main/java/org/odk/collect/android/activities/FormHierarchyActivity.java
index f57eb64c4f1..ccb1a96468d 100644
--- a/collect_app/src/main/java/org/odk/collect/android/activities/FormHierarchyActivity.java
+++ b/collect_app/src/main/java/org/odk/collect/android/activities/FormHierarchyActivity.java
@@ -46,8 +46,24 @@
 
 import timber.log.Timber;
 
-public abstract class FormHierarchyActivity extends CollectAbstractActivity {
-
+/**
+ * Displays the structure of a form along with the answers for the current instance. Different form
+ * elements are displayed in the following ways:
+ * - Questions each take up a row with their full label shown and their answers below
+ * - Non-repeat groups are not represented at all
+ * - Repeat groups are initially shown as collapsed and are expanded when tapped, revealing instances
+ * of that repeat
+ * - Repeat instances are displayed with their label and a count after (e.g. My group (1))
+ *
+ * Tapping on a repeat instance shows all the questions in that repeat instance using the display
+ * rules above.
+ *
+ * Although the user gets the impression of navigating "into" a repeat, the view is refreshed in
+ * {@link #refreshView()} rather than another activity/fragment being added to the backstack.
+ *
+ * Buttons at the bottom of the screen allow users to navigate the form.
+ */
+public class FormHierarchyActivity extends CollectAbstractActivity {
     protected static final int CHILD = 1;
     protected static final int EXPANDED = 2;
     protected static final int COLLAPSED = 3;