Serialization part 1: implement kotlinx-serializable, use serialized AddedViews

build.gradle

@@ -2,6 +2,7 @@
 
 buildscript {
     ext.kotlinVersion = '1.3.61'
+    ext.serializationVersion = '0.14.0'
     repositories {
         google()
         jcenter()
@@ -10,6 +11,7 @@ buildscript {
     dependencies {
         classpath 'com.android.tools.build:gradle:3.5.1'
         classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlinVersion"
+        classpath "org.jetbrains.kotlin:kotlin-serialization:$kotlinVersion"
         classpath 'com.automattic.android:fetchstyle:1.1'
         classpath 'io.sentry:sentry-android-gradle-plugin:1.7.27'
         // NOTE: Do not place your application dependencies here; they belong

photoeditor/build.gradle

@@ -2,6 +2,7 @@ apply plugin: 'com.android.library'
 apply plugin: 'kotlin-android'
 apply plugin: 'kotlin-android-extensions'
 apply plugin: 'kotlin-kapt'
+apply plugin: 'kotlinx-serialization'
 
 android {
     compileSdkVersion rootProject.compileSdkVersion
@@ -36,6 +37,7 @@ android {
 dependencies {
     implementation fileTree(dir: 'libs', include: ['*.jar'])
     implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlinVersion"
+    implementation "org.jetbrains.kotlinx:kotlinx-serialization-runtime:$serializationVersion"
 
     implementation "androidx.appcompat:appcompat:$appCompatVersion"
     implementation "androidx.core:core-ktx:$coreVersion"

photoeditor/proguard-rules.pro

@@ -19,3 +19,12 @@
 # If you keep the line number information, uncomment this to
 # hide the original source file name.
 #-renamesourcefileattribute SourceFile
+-keepattributes *Annotation*, InnerClasses
+-dontnote kotlinx.serialization.SerializationKt
+-keep,includedescriptorclasses class com.automattic.photoeditor.**$$serializer { *; } # <-- change package name to your app's
+-keepclassmembers class com.automattic.photoeditor.** { # <-- change package name to your app's
+    *** Companion;
+}
+-keepclasseswithmembers class com.automattic.photoeditor.** { # <-- change package name to your app's
+    kotlinx.serialization.KSerializer serializer(...);
+}

photoeditor/src/main/java/com/automattic/photoeditor/PhotoEditor.kt

@@ -35,6 +35,7 @@ import com.automattic.photoeditor.views.ViewType
 import com.automattic.photoeditor.views.ViewType.EMOJI
 import com.automattic.photoeditor.views.ViewType.TEXT
 import com.automattic.photoeditor.views.added.AddedView
+import com.automattic.photoeditor.views.added.AddedViewInfo
 import com.automattic.photoeditor.views.added.AddedViewList
 import com.automattic.photoeditor.views.brush.BrushDrawingView
 import com.automattic.photoeditor.views.brush.BrushViewChangeListener
@@ -52,8 +53,8 @@ import kotlinx.android.synthetic.main.view_photo_editor_emoji.view.*
 import kotlinx.android.synthetic.main.view_photo_editor_text.view.*
 import java.io.File
 import java.io.FileInputStream
-import java.util.ArrayList
 import java.lang.ref.WeakReference
+import java.util.ArrayList
 
 /**
  *
@@ -233,9 +234,16 @@ class PhotoEditor private constructor(builder: Builder) :
      * @param colorCodeTextView text color to be displayed
      */
     @SuppressLint("ClickableViewAccessibility")
-    fun addText(text: String, colorCodeTextView: Int, textTypeface: Typeface? = null, fontSizeSp: Float = 18f) {
+    fun addText(
+        text: String,
+        colorCodeTextView: Int,
+        textTypeface: Typeface? = null,
+        fontSizeSp: Float = 18f,
+        isViewReadd: Boolean = false
+    ): View? {
         brushDrawingView.brushDrawingMode = false
-        getLayout(ViewType.TEXT)?.apply {
+        val view: View?
+        view = getLayout(ViewType.TEXT)?.apply {
             val textInputTv = findViewById<TextView>(R.id.tvPhotoEditorText)
 
             textInputTv.text = text
@@ -262,13 +270,14 @@ class PhotoEditor private constructor(builder: Builder) :
             setOnTouchListener(multiTouchListenerInstance)
             addViewToParent(this, ViewType.TEXT)
 
-            // now open TextEditor right away
-            if (mOnPhotoEditorListener != null) {
+            // now open TextEditor right away if this is new text being added
+            if (mOnPhotoEditorListener != null && !isViewReadd) {
                 val textInput = textInputTv.text.toString()
                 val currentTextColor = textInputTv.currentTextColor
                 mOnPhotoEditorListener?.onEditTextChangeListener(this, textInput, currentTextColor, true)
             }
         }
+        return view
     }
 
     /**
@@ -300,7 +309,9 @@ class PhotoEditor private constructor(builder: Builder) :
             inputTextView.setTextColor(colorCode)
             parentView.updateViewLayout(view, view.layoutParams)
             val i = addedViews.indexOfView(view)
-            if (i > -1) addedViews[i] = AddedView(view, addedViews[i].viewType)
+            if (i > -1) {
+                addedViews[i] = AddedView.buildAddedViewFromView(view, addedViews[i].viewType)
+            }
         }
     }
 
@@ -310,8 +321,8 @@ class PhotoEditor private constructor(builder: Builder) :
      *
      * @param emojiName unicode in form of string to display emoji
      */
-    fun addEmoji(emojiName: String) {
-        addEmoji(null, emojiName)
+    fun addEmoji(emojiName: String): View? {
+        return addEmoji(null, emojiName)
     }
 
     /**
@@ -321,9 +332,10 @@ class PhotoEditor private constructor(builder: Builder) :
      * @param emojiTypeface typeface for custom font to show emoji unicode in specific font
      * @param emojiName unicode in form of string to display emoji
      */
-    fun addEmoji(emojiTypeface: Typeface?, emojiName: String) {
+    fun addEmoji(emojiTypeface: Typeface?, emojiName: String): View? {
         brushDrawingView.brushDrawingMode = false
-        getLayout(ViewType.EMOJI)?.apply {
+        val view = getLayout(ViewType.EMOJI)
+        view?.apply {
             val emojiTextView = findViewById<TextView>(R.id.tvPhotoEditorEmoji)
 
             if (emojiTypeface != null) {
@@ -366,6 +378,7 @@ class PhotoEditor private constructor(builder: Builder) :
             // setOnTouchListener(multiTouchListenerInstance)
             addViewToParent(this, ViewType.EMOJI)
         }
+        return view
     }
 
     /**
@@ -379,11 +392,55 @@ class PhotoEditor private constructor(builder: Builder) :
         )
         params.addRule(RelativeLayout.CENTER_IN_PARENT, RelativeLayout.TRUE)
         parentView.addView(rootView, params)
-        addedViews.add(AddedView(rootView, viewType, sourceUri))
+        addedViews.add(AddedView.buildAddedViewFromView(rootView, viewType, sourceUri))
         mOnPhotoEditorListener?.onAddViewListener(viewType, addedViews.size)
     }
 
-    fun addViewToParentWithTouchListener(rootView: View, viewType: ViewType, sourceUri: Uri? = null) {
+    fun addViewToParentWithTouchListener(addedView: AddedView) {
+        addedView.view?.let {
+            addViewToParentWithTouchListener(it, addedView.viewType, addedView.uri)
+        } ?: buildViewFromAddedViewInfo(addedView.viewInfo, addedView.viewType)
+    }
+
+    private fun buildViewFromAddedViewInfo(addedViewInfo: AddedViewInfo, viewType: ViewType): View? {
+        var view: View? = null
+        when (viewType) {
+            EMOJI -> {
+                // create emoji view layout
+                view = addEmoji(addedViewInfo.addedViewTextInfo.text)
+                // apply specific TextView parameters for emoji (fontsize)
+                val emojiTextView = view?.findViewById<TextView>(R.id.tvPhotoEditorEmoji)
+                // the actual calculated text size as obtained from the view is expressed in px.
+                emojiTextView?.setTextSize(TypedValue.COMPLEX_UNIT_PX, addedViewInfo.addedViewTextInfo.fontSizePx)
+            }
+            TEXT -> {
+                // create TEXT view layout
+                view = addText(
+                    text = addedViewInfo.addedViewTextInfo.text,
+                    colorCodeTextView = addedViewInfo.addedViewTextInfo.textColor,
+                    isViewReadd = true
+                )
+                // apply specific TextView parameters for text (fontsize, text color)
+                val normalTextView = view?.findViewById<TextView>(R.id.tvPhotoEditorText)
+                // the actual calculated text size as obtained from the view is expressed in px.
+                normalTextView?.setTextSize(TypedValue.COMPLEX_UNIT_PX, addedViewInfo.addedViewTextInfo.fontSizePx)
+                normalTextView?.setTextColor(addedViewInfo.addedViewTextInfo.textColor)
+            }
+        }
+
+        // now apply all common parameters to newly created view object
+        view?.let {
+            it.rotation = addedViewInfo.rotation
+            it.translationX = addedViewInfo.translationX
+            it.translationY = addedViewInfo.translationY
+            it.scaleX = addedViewInfo.scale
+            it.scaleY = addedViewInfo.scale
+        }
+
+        return view
+    }
+
+    private fun addViewToParentWithTouchListener(rootView: View, viewType: ViewType, sourceUri: Uri? = null) {
         val multiTouchListenerInstance = getNewMultitouchListener(rootView) // newMultiTouchListener
         when {
             viewType == EMOJI -> {
@@ -544,7 +601,7 @@ class PhotoEditor private constructor(builder: Builder) :
                 redoViews.add(removeView)
             }
             mOnPhotoEditorListener?.onRemoveViewListener(addedViews.size)
-            val viewTag = removeView.view.tag
+            val viewTag = removeView.view?.tag
             (viewTag as? ViewType)?.let {
                 mOnPhotoEditorListener?.onRemoveViewListener(it, addedViews.size)
             }
@@ -567,7 +624,7 @@ class PhotoEditor private constructor(builder: Builder) :
                 parentView.addView(redoView.view)
                 addedViews.add(redoView)
             }
-            val viewTag = redoView.view.tag
+            val viewTag = redoView.view?.tag
             if (viewTag != null && viewTag is ViewType) {
                 mOnPhotoEditorListener?.onAddViewListener(viewTag, addedViews.size)
             }
@@ -585,7 +642,9 @@ class PhotoEditor private constructor(builder: Builder) :
      */
     fun clearAllViews() {
         for (addedView in addedViews) {
-            parentView.removeView(addedView.view)
+            addedView.view?.let {
+                parentView.removeView(it)
+            }
         }
 
         if (addedViews.containsView(brushDrawingView)) {
@@ -735,9 +794,9 @@ class PhotoEditor private constructor(builder: Builder) :
             val viewPositionInfo = ViewPositionInfo(
                 originalCanvasWidth,
                 originalCanvasHeight,
-                v.view.width,
-                v.view.height,
-                v.view.matrix
+                requireNotNull(v.view).width,
+                requireNotNull(v.view).height,
+                requireNotNull(v.view).matrix
             )
             when (v.viewType) {
                 ViewType.STICKER_ANIMATED -> {
@@ -887,9 +946,9 @@ class PhotoEditor private constructor(builder: Builder) :
             val viewPositionInfo = ViewPositionInfo(
                 widthParent,
                 heightParent,
-                v.view.width,
-                v.view.height,
-                v.view.matrix
+                requireNotNull(v.view).width,
+                requireNotNull(v.view).height,
+                requireNotNull(v.view).matrix
             )
             when (v.viewType) {
                 ViewType.STICKER_ANIMATED -> {
@@ -975,15 +1034,17 @@ class PhotoEditor private constructor(builder: Builder) :
         if (redoViews.size > 0) {
             redoViews.removeAt(redoViews.size - 1)
         }
-        addedViews.add(AddedView(brushDrawingView, ViewType.BRUSH_DRAWING))
+        addedViews.add(AddedView.buildAddedViewFromView(brushDrawingView, ViewType.BRUSH_DRAWING))
         mOnPhotoEditorListener?.onAddViewListener(ViewType.BRUSH_DRAWING, addedViews.size)
     }
 
     override fun onViewRemoved(brushDrawingView: BrushDrawingView) {
         if (addedViews.size > 0) {
             val removeView = addedViews.removeAt(addedViews.size - 1)
-            if (removeView.view !is BrushDrawingView) {
-                parentView.removeView(removeView.view)
+            removeView.view?.let {
+                if (it !is BrushDrawingView) {
+                    parentView.removeView(it)
+                }
             }
             redoViews.add(removeView)
         }

photoeditor/src/main/java/com/automattic/photoeditor/views/ViewType.kt

@@ -1,5 +1,7 @@
 package com.automattic.photoeditor.views
 
+import kotlinx.serialization.Serializable
+
 /**
  *
  *
@@ -10,6 +12,7 @@ package com.automattic.photoeditor.views
  * @version 0.1.1
  * @since 18/01/2017.
  */
+@Serializable
 enum class ViewType {
     BRUSH_DRAWING,
     TEXT,

photoeditor/src/main/java/com/automattic/photoeditor/views/added/AddedView.kt

@@ -2,6 +2,91 @@ package com.automattic.photoeditor.views.added
 
 import android.net.Uri
 import android.view.View
+import android.widget.TextView
+import com.automattic.photoeditor.R
 import com.automattic.photoeditor.views.ViewType
+import com.automattic.photoeditor.views.ViewType.EMOJI
+import com.automattic.photoeditor.views.ViewType.TEXT
+import kotlinx.serialization.Transient
+import kotlinx.serialization.Decoder
+import kotlinx.serialization.Encoder
+import kotlinx.serialization.KSerializer
+import kotlinx.serialization.Serializable
+import kotlinx.serialization.Serializer
 
-class AddedView(val view: View, val viewType: ViewType, val uri: Uri? = null)
+@Serializable
+class AddedView(
+    @Transient val view: View? = null,
+    val viewType: ViewType,
+    var viewInfo: AddedViewInfo,
+    @Serializable(with = UriSerializer::class)
+    val uri: Uri? = null
+) {
+    companion object {
+        fun buildAddedViewFromView(
+            view: View,
+            viewType: ViewType,
+            uri: Uri? = null
+        ): AddedView {
+            return AddedView(
+                view,
+                viewType,
+                buildViewInfoFromView(
+                    view,
+                    getTextInfoFromActualView(view, viewType)
+                ),
+                uri
+            )
+        }
+
+        fun getTextInfoFromActualView(view: View, viewType: ViewType): AddedViewTextInfo {
+            val txtView: TextView
+            when (viewType) {
+                EMOJI -> {
+                    txtView = view.findViewById(R.id.tvPhotoEditorEmoji)
+                }
+                TEXT -> {
+                    txtView = view.findViewById(R.id.tvPhotoEditorText)
+                }
+                else -> {
+                    // default text
+                    txtView = view.findViewById(R.id.tvPhotoEditorText)
+                }
+            }
+            return AddedViewTextInfo(txtView.text.toString(), txtView.textSize, txtView.currentTextColor)
+        }
+
+        fun buildViewInfoFromView(view: View, addedViewText: AddedViewTextInfo): AddedViewInfo {
+            return AddedViewInfo(
+                view.rotation,
+                view.translationX,
+                view.translationY,
+                view.scaleX,
+                addedViewText
+            )
+        }
+    }
+
+    fun update() {
+        view?.let {
+            viewInfo = AddedViewInfo(
+                it.rotation,
+                it.translationX,
+                it.translationY,
+                it.scaleX,
+                getTextInfoFromActualView(view, viewType)
+            )
+        }
+    }
+
+    @Serializer(forClass = Uri::class)
+    object UriSerializer : KSerializer<Uri> {
+        override fun deserialize(input: Decoder): Uri {
+            return Uri.parse(input.decodeString())
+        }
+
+        override fun serialize(output: Encoder, obj: Uri) {
+            output.encodeString(obj.toString())
+        }
+    }
+}