PAINTROID-445

Rewrote some parts of switchTool structure in order to highlight(set the color border to orange) the box (of BaseToolWithRectangleShape) for 300 milliseconds before actually switching the tool.

Author: Electronix1337

Paintroid/src/androidTest/java/org/catrobat/paintroid/test/espresso/MainActivityIntegrationTest.java

@@ -109,7 +109,7 @@ public void init() {
 		CountingIdlingResource idlingResource = launchActivityRule.getActivity().getIdlingResource();
 		presenter = new MainActivityPresenter(launchActivityRule.getActivity(), view, model, workspace, navigator,
 				interactor, topBarViewHolder, bottomBarViewHolder, drawerLayoutViewHolder, bottomNavigationViewHolder,
-				commandFactory, commandManager, perspective, toolController, sharedPreferences, idlingResource, context, internalMemoryPath);
+				commandFactory, commandManager, perspective, toolController, sharedPreferences, idlingResource, context, internalMemoryPath, launchActivityRule.getActivity());
 	}
 
 	@Test

Paintroid/src/androidTest/java/org/catrobat/paintroid/test/espresso/dialog/ColorDialogIntegrationTest.java

@@ -736,7 +736,7 @@ public void alphaValueIsSetInSliderWhenChangedInSeekBar() {
 				.onPositiveButton()
 				.perform(click());
 		onToolProperties()
-				.checkMatchesColor(Color.parseColor("#80000000"));
+				.checkMatchesColor(Color.parseColor("#7F000000"));
 		IdlingRegistry.getInstance().unregister(idlingResource);
 	}
 

Paintroid/src/androidTest/java/org/catrobat/paintroid/test/espresso/tools/ClippingToolIntegrationTest.kt

@@ -207,7 +207,7 @@ class ClippingToolIntegrationTest {
             .performOpen()
             .performClose()
 
-        val bitmapColor = workspace.bitmapOfCurrentLayer?.getPixel(middle.x.toInt(), middle.y.toInt())
+        val bitmapColor = workspace.bitmapOfCurrentLayer?.getPixel(middleTop.x.toInt(), middleTop.y.toInt())
         assertEquals(bitmapColor, Color.BLACK)
     }
 

Paintroid/src/main/java/org/catrobat/paintroid/MainActivity.kt

@@ -475,7 +475,8 @@ class MainActivity : AppCompatActivity(), MainView, CommandListener {
             preferences,
             idlingResource,
             context,
-            filesDir
+            filesDir,
+            this
         )
         FileIO.navigator = navigator
         defaultToolController.setOnColorPickedListener(PresenterColorPickedListener(presenterMain))

Paintroid/src/main/java/org/catrobat/paintroid/controller/DefaultToolController.kt

@@ -33,7 +33,6 @@ import org.catrobat.paintroid.tools.ToolPaint
 import org.catrobat.paintroid.tools.ToolReference
 import org.catrobat.paintroid.tools.ToolType
 import org.catrobat.paintroid.tools.Workspace
-import org.catrobat.paintroid.tools.implementation.BaseToolWithShape
 import org.catrobat.paintroid.tools.implementation.ClippingTool
 import org.catrobat.paintroid.tools.implementation.ImportTool
 import org.catrobat.paintroid.tools.implementation.LineTool
@@ -103,8 +102,8 @@ class DefaultToolController(
         this.onColorPickedListener = onColorPickedListener
     }
 
-    override fun switchTool(toolType: ToolType, backPressed: Boolean) {
-        switchTool(createAndSetupTool(toolType), backPressed)
+    override fun switchTool(toolType: ToolType) {
+        switchTool(createAndSetupTool(toolType))
     }
 
     override fun hideToolOptionsView() {
@@ -125,20 +124,12 @@ class DefaultToolController(
         toolReference.tool?.resetInternalState(StateChange.NEW_IMAGE_LOADED)
     }
 
-    private fun switchTool(tool: Tool, backPressed: Boolean) {
+    private fun switchTool(tool: Tool) {
         val currentTool = toolReference.tool
         val currentToolType = currentTool?.toolType
-        if (toolList.contains(currentToolType)) {
-            if (!backPressed) {
-                val toolToApply = currentTool as BaseToolWithShape
-                toolToApply.onClickOnButton()
-            }
-        } else if (currentToolType == ToolType.CLIP) {
-            adjustClippingTool(backPressed)
-        }
         currentToolType?.let { hidePlusIfShown(it) }
 
-        if (currentTool?.toolType == tool.toolType) {
+        if (currentToolType == tool.toolType) {
             val toolBundle = Bundle()
             currentTool.onSaveInstanceState(toolBundle)
             tool.onRestoreInstanceState(toolBundle)
@@ -147,7 +138,7 @@ class DefaultToolController(
         workspace.invalidate()
     }
 
-    private fun adjustClippingTool(backPressed: Boolean) {
+    override fun adjustClippingToolOnBackPressed(backPressed: Boolean) {
         val clippingTool = currentTool as ClippingTool
         if (backPressed) {
             if (clippingTool.areaClosed) {

Paintroid/src/main/java/org/catrobat/paintroid/controller/ToolController.kt

@@ -31,7 +31,7 @@ interface ToolController {
 
     fun setOnColorPickedListener(onColorPickedListener: OnColorPickedListener)
 
-    fun switchTool(toolType: ToolType, backPressed: Boolean)
+    fun switchTool(toolType: ToolType)
 
     fun hideToolOptionsView()
 
@@ -54,4 +54,6 @@ interface ToolController {
     fun hasToolOptionsView(): Boolean
 
     fun setBitmapFromSource(bitmap: Bitmap?)
+
+    fun adjustClippingToolOnBackPressed(backPressed: Boolean)
 }

Paintroid/src/main/java/org/catrobat/paintroid/presenter/LayerPresenter.kt

@@ -194,7 +194,7 @@ class LayerPresenter(
         drawingSurface?.refreshDrawingSurface()
         getDestinationLayer(position, false)?.let { layer ->
             if (model.currentLayer == layer) {
-                defaultToolController?.switchTool(ToolType.HAND, false)
+                defaultToolController?.switchTool(ToolType.HAND)
                 bottomNavigationViewHolder?.showCurrentTool(ToolType.HAND)
             }
         }
@@ -205,7 +205,7 @@ class LayerPresenter(
         getDestinationLayer(position, true)?.let { layer ->
             viewHolder.updateImageView(layer.bitmap)
             if (model.currentLayer == layer) {
-                defaultToolController?.switchTool(ToolType.BRUSH, false)
+                defaultToolController?.switchTool(ToolType.BRUSH)
                 bottomNavigationViewHolder?.showCurrentTool(ToolType.BRUSH)
             }
         }

Paintroid/src/main/java/org/catrobat/paintroid/presenter/MainActivityPresenter.kt

@@ -39,8 +39,12 @@ import android.util.Log
 import android.view.Gravity
 import android.view.Menu
 import android.widget.Toast
+import androidx.annotation.ColorRes
+import androidx.core.content.ContextCompat
 import androidx.core.view.GravityCompat
 import androidx.test.espresso.idling.CountingIdlingResource
+import kotlinx.coroutines.delay
+import kotlinx.coroutines.runBlocking
 import org.catrobat.paintroid.FileIO
 import org.catrobat.paintroid.MainActivity
 import org.catrobat.paintroid.R
@@ -85,12 +89,17 @@ import org.catrobat.paintroid.model.CommandManagerModel
 import org.catrobat.paintroid.tools.Tool
 import org.catrobat.paintroid.tools.ToolType
 import org.catrobat.paintroid.tools.Workspace
+import org.catrobat.paintroid.tools.implementation.BaseToolWithRectangleShape
+import org.catrobat.paintroid.tools.implementation.BaseToolWithShape
 import org.catrobat.paintroid.tools.implementation.ClippingTool
 import org.catrobat.paintroid.tools.implementation.LineTool
 import org.catrobat.paintroid.ui.LayerAdapter
 import org.catrobat.paintroid.ui.Perspective
 import java.io.File
 
+private const val HIGHLIGHT_RECTANGLE_SHRINKING = 5
+private const val HIGHLIGHT_RECTANGLE_300_MILLISECONDS = 300L
+
 @SuppressWarnings("LongParameterList", "LargeClass", "ThrowingExceptionsWithoutMessageOrCause")
 open class MainActivityPresenter(
     override val fileActivity: Activity?,
@@ -110,7 +119,8 @@ open class MainActivityPresenter(
     private val sharedPreferences: UserPreferences,
     private val idlingResource: CountingIdlingResource,
     override val context: Context,
-    private val internalMemoryPath: File
+    private val internalMemoryPath: File,
+    private val mainActivity: MainActivity
 ) : MainActivityContracts.Presenter, SaveImageCallback, LoadImageCallback, CreateFileCallback {
     private var layerAdapter: LayerAdapter? = null
     private var resetPerspectiveAfterNextCommand = false
@@ -137,6 +147,14 @@ open class MainActivityPresenter(
             return sharedPreferences.preferenceImageNumber
         }
 
+    private val toolList =
+        hashSetOf(
+            ToolType.TEXT,
+            ToolType.TRANSFORM,
+            ToolType.IMPORTPNG,
+            ToolType.SHAPE
+        )
+
     var clippingToolInUseAndUndoRedoClicked = false
     var clippingToolPaint = Paint()
 
@@ -420,7 +438,7 @@ open class MainActivityPresenter(
                     return
                 }
                 setTool(ToolType.IMPORTPNG)
-                toolController.switchTool(ToolType.IMPORTPNG, false)
+                toolController.switchTool(ToolType.IMPORTPNG)
                 interactor.loadFile(
                     this,
                     LOAD_IMAGE_IMPORT_PNG,
@@ -532,7 +550,8 @@ open class MainActivityPresenter(
         } else if (model.isFullscreen) {
             exitFullscreenClicked()
         } else if (!toolController.isDefaultTool) {
-            switchTool(ToolType.BRUSH, true)
+            if (toolController.currentTool?.toolType == ToolType.CLIP) toolController.adjustClippingToolOnBackPressed(true)
+            switchTool(ToolType.BRUSH)
         } else {
             showSecurityQuestionBeforeExit()
         }
@@ -757,16 +776,36 @@ open class MainActivityPresenter(
         if (toolController.toolType === toolType && toolController.hasToolOptionsView()) {
             toolController.toggleToolOptionsView()
         } else {
+            checkForImplicitToolApplication()
             switchTool(toolType)
         }
         idlingResource.decrement()
     }
 
-    private fun switchTool(type: ToolType, backPressed: Boolean = false) {
+    private fun checkForImplicitToolApplication() {
+        val currentTool = toolController.currentTool
+        val currentToolType = currentTool?.toolType
+        if (toolList.contains(currentToolType)) {
+            val toolToApply = currentTool as BaseToolWithShape
+            val toolToHighlight = currentTool as BaseToolWithRectangleShape
+            @ColorRes val colorId = R.color.pocketpaint_main_rectangle_tool_highlight_color
+            toolToHighlight.secondaryShapeColor = ContextCompat.getColor(context, colorId)
+            toolToHighlight.rectangleShrinkingOnHighlight = HIGHLIGHT_RECTANGLE_SHRINKING
+            workspace.invalidate()
+            mainActivity.runOnUiThread {
+                runBlocking {
+                    delay(HIGHLIGHT_RECTANGLE_300_MILLISECONDS)
+                }
+                toolToApply.onClickOnButton()
+            }
+        } else if (currentToolType == ToolType.CLIP) (currentTool as ClippingTool).onClickOnButton()
+    }
+
+    private fun switchTool(type: ToolType) {
         navigator.setMaskFilterToNull()
         view.hideKeyboard()
         setTool(type)
-        toolController.switchTool(type, backPressed)
+        toolController.switchTool(type)
         if (type === ToolType.IMPORTPNG) {
             showImportDialog()
         } else if (type == ToolType.CLIP) {
@@ -799,7 +838,7 @@ open class MainActivityPresenter(
         when (requestCode) {
             LOAD_IMAGE_IMPORT_PNG -> {
                 setTool(ToolType.IMPORTPNG)
-                toolController.switchTool(ToolType.IMPORTPNG, false)
+                toolController.switchTool(ToolType.IMPORTPNG)
                 interactor.loadFile(
                     this,
                     LOAD_IMAGE_IMPORT_PNG,

Paintroid/src/main/java/org/catrobat/paintroid/ui/LayerAdapter.kt

@@ -115,7 +115,7 @@ class LayerAdapter(val presenter: LayerContracts.Presenter) : BaseAdapter(), Lay
 
         override fun setSelected(position: Int, bottomNavigationViewHolder: BottomNavigationViewHolder?, defaultToolController: DefaultToolController?) {
             if (!layerPresenter.getLayerItem(position).isVisible) {
-                defaultToolController?.switchTool(ToolType.HAND, false)
+                defaultToolController?.switchTool(ToolType.HAND)
                 bottomNavigationViewHolder?.showCurrentTool(ToolType.HAND)
             }
             layerBackground.setBackgroundColor(Color.BLUE)

Paintroid/src/test/java/org/catrobat/paintroid/test/presenter/MainActivityPresenterTest.java

@@ -143,7 +143,7 @@ public void setUp() {
 		presenter = new MainActivityPresenter(activity, view, model, workspace, navigator,
 				interactor, topBarViewHolder, bottomBarViewHolder, drawerLayoutViewHolder,
 				bottomNavigationViewHolder, commandFactory, commandManager, perspective,
-				toolController, sharedPreferences, idlingResource, context, internalMemoryPath);
+				toolController, sharedPreferences, idlingResource, context, internalMemoryPath, activity);
 	}
 
 	@Test