fix(text): Allow -1 to be a valid binding value for text views (NativeScript#5563)

shiv19 · Alexander Vakrilov · commit 7cd8e7ef54e7 · 2018-03-21T11:37:30.000+01:00
* fix(android/text ios/text): allow -1 to be a valid binding value Instead of using -1 as special value, use Symbol(-1) so that it can't be reset accidentally Closes issue NativeScript#5559 * renamed the symbol
diff --git a/tns-core-modules/ui/editable-text-base/editable-text-base-common.ts b/tns-core-modules/ui/editable-text-base/editable-text-base-common.ts
@@ -1,5 +1,5 @@
 &#65279;import { EditableTextBase as EditableTextBaseDefinition, KeyboardType, ReturnKeyType, UpdateTextTrigger, AutocapitalizationType } from ".";
-import { TextBase, Property, CssProperty, Style, Color, booleanConverter, makeValidator, makeParser } from "../text-base";
+import { TextBase, Property, CssProperty, Style, Color, booleanConverter, makeValidator, makeParser, resetSymbol } from "../text-base";
 
 export * from "../text-base";
 
diff --git a/tns-core-modules/ui/editable-text-base/editable-text-base.android.ts b/tns-core-modules/ui/editable-text-base/editable-text-base.android.ts
@@ -1,7 +1,7 @@
 &#65279;import {
     EditableTextBase as EditableTextBaseCommon, keyboardTypeProperty,
     returnKeyTypeProperty, editableProperty,
-    autocapitalizationTypeProperty, autocorrectProperty, hintProperty,
+    autocapitalizationTypeProperty, autocorrectProperty, hintProperty, resetSymbol,
     textProperty, placeholderColorProperty, Color, textTransformProperty, maxLengthProperty
 } from "./editable-text-base-common";
 
@@ -241,13 +241,13 @@ export abstract class EditableTextBase extends EditableTextBaseCommon {
         }
     }
 
-    [textProperty.getDefault](): number {
-        return -1;
+    [textProperty.getDefault](): number | symbol {
+        return resetSymbol;
     }
-    [textProperty.setNative](value: string | number) {
+    [textProperty.setNative](value: string | number | symbol) {
         try {
             this._changeFromCode = true;
-            this._setNativeText(value === -1);
+            this._setNativeText(value === resetSymbol);
         } finally {
             this._changeFromCode = false;
         }
diff --git a/tns-core-modules/ui/text-base/text-base-common.ts b/tns-core-modules/ui/text-base/text-base-common.ts
@@ -213,3 +213,5 @@ letterSpacingProperty.register(Style);
 
 export const lineHeightProperty = new CssProperty<Style, number>({ name: "lineHeight", cssName: "line-height", affectsLayout: isIOS, valueConverter: v => parseFloat(v) });
 lineHeightProperty.register(Style);
+
+export const resetSymbol = Symbol("textPropertyDefault");
diff --git a/tns-core-modules/ui/text-base/text-base.android.ts b/tns-core-modules/ui/text-base/text-base.android.ts
@@ -5,7 +5,7 @@ import {
     TextBaseCommon, formattedTextProperty, textAlignmentProperty, textDecorationProperty, fontSizeProperty,
     textProperty, textTransformProperty, letterSpacingProperty, colorProperty, fontInternalProperty,
     paddingLeftProperty, paddingTopProperty, paddingRightProperty, paddingBottomProperty, Length,
-    whiteSpaceProperty, lineHeightProperty, FormattedString, layout, Span, Color, isBold
+    whiteSpaceProperty, lineHeightProperty, FormattedString, layout, Span, Color, isBold, resetSymbol
 } from "./text-base-common";
 
 export * from "./text-base-common";
@@ -97,12 +97,12 @@ export class TextBase extends TextBaseCommon {
         this._maxHeight = this._maxLines = undefined;
     }
 
-    [textProperty.getDefault](): number {
-        return -1;
+    [textProperty.getDefault](): symbol | number {
+        return resetSymbol;
     }
 
-    [textProperty.setNative](value: string | number) {
-        const reset = value === -1;
+    [textProperty.setNative](value: string | number | symbol) {
+        const reset = value === resetSymbol;
         if (!reset && this.formattedText) {
             return;
         }
diff --git a/tns-core-modules/ui/text-base/text-base.d.ts b/tns-core-modules/ui/text-base/text-base.d.ts
@@ -123,3 +123,5 @@ export const letterSpacingProperty: CssProperty<Style, number>;
 
 //Used by tab view
 export function getTransformedText(text: string, textTransform: TextTransform): string;
+
+export const resetSymbol: symbol;
diff --git a/tns-core-modules/ui/text-base/text-base.ios.ts b/tns-core-modules/ui/text-base/text-base.ios.ts
@@ -3,7 +3,7 @@ import { Font } from "../styling/font";
 import {
     TextBaseCommon, textProperty, formattedTextProperty, textAlignmentProperty, textDecorationProperty,
     textTransformProperty, letterSpacingProperty, colorProperty, fontInternalProperty, lineHeightProperty,
-    FormattedString, Span, Color, isBold
+    FormattedString, Span, Color, isBold, resetSymbol
 } from "./text-base-common";
 
 export * from "./text-base-common";
@@ -12,11 +12,11 @@ export class TextBase extends TextBaseCommon {
 
     public nativeViewProtected: UITextField | UITextView | UILabel | UIButton;
 
-    [textProperty.getDefault](): number {
-        return -1;
+    [textProperty.getDefault](): number | symbol {
+        return resetSymbol;
     }
-    [textProperty.setNative](value: string | number) {
-        const reset = value === -1;
+    [textProperty.setNative](value: string | number | symbol) {
+        const reset = value === resetSymbol;
         if (!reset && this.formattedText) {
             return;
         }

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`import {`
`2`	`2`	`EditableTextBase as EditableTextBaseCommon, keyboardTypeProperty,`
`3`	`3`	`returnKeyTypeProperty, editableProperty,`
`4`		`- autocapitalizationTypeProperty, autocorrectProperty, hintProperty,`
	`4`	`+ autocapitalizationTypeProperty, autocorrectProperty, hintProperty, resetSymbol,`
`5`	`5`	`textProperty, placeholderColorProperty, Color, textTransformProperty, maxLengthProperty`
`6`	`6`	`} from "./editable-text-base-common";`
`7`	`7`
`@@ -241,13 +241,13 @@ export abstract class EditableTextBase extends EditableTextBaseCommon {`
`241`	`241`	`}`
`242`	`242`	`}`
`243`	`243`
`244`		`- [textProperty.getDefault](): number {`
`245`		`- return -1;`
	`244`	`+ [textProperty.getDefault](): number \| symbol {`
	`245`	`+ return resetSymbol;`
`246`	`246`	`}`
`247`		`- [textProperty.setNative](value: string \| number) {`
	`247`	`+ [textProperty.setNative](value: string \| number \| symbol) {`
`248`	`248`	`try {`
`249`	`249`	`this._changeFromCode = true;`
`250`		`- this._setNativeText(value === -1);`
	`250`	`+ this._setNativeText(value === resetSymbol);`
`251`	`251`	`} finally {`
`252`	`252`	`this._changeFromCode = false;`
`253`	`253`	`}`