feat: return Promises for Ti.Window open()/close() methods

android/modules/android/src/java/org/appcelerator/titanium/proxy/TiActivityWindowProxy.java

@@ -9,6 +9,7 @@
 import org.appcelerator.kroll.KrollDict;
 import org.appcelerator.kroll.annotations.Kroll;
 import org.appcelerator.kroll.common.Log;
+import org.appcelerator.titanium.TiC;
 import org.appcelerator.titanium.view.TiUIActivityWindow;
 import org.appcelerator.titanium.view.TiUIView;
 
@@ -40,7 +41,7 @@ protected void handleClose(@NonNull KrollDict options)
 	{
 		Log.d(TAG, "handleClose", Log.DEBUG_MODE);
 		opened = false;
-		fireEvent("close", null);
+		fireEvent(TiC.EVENT_CLOSE, null);
 
 		if (view != null) {
 			((TiUIActivityWindow) view).close();

android/modules/ui/src/java/ti/modules/titanium/ui/NavigationWindowProxy.java

@@ -1,18 +1,22 @@
 /**
  * Appcelerator Titanium Mobile
- * Copyright (c) 2018 by Axway, Inc. All Rights Reserved.
+ * Copyright (c) 2018-2021 by Axway, Inc. All Rights Reserved.
  * Licensed under the terms of the Apache Public License
  * Please see the LICENSE included with this distribution for details.
  */
 package ti.modules.titanium.ui;
 
+import org.appcelerator.kroll.KrollDict;
+import org.appcelerator.kroll.KrollPromise;
 import org.appcelerator.kroll.annotations.Kroll;
 import org.appcelerator.titanium.TiC;
 import org.appcelerator.titanium.proxy.TiWindowProxy;
 
 import java.util.ArrayList;
 import java.util.List;
 
+import androidx.annotation.NonNull;
+
 @Kroll.proxy(creatableInModule = UIModule.class)
 public class NavigationWindowProxy extends WindowProxy
 {
@@ -27,7 +31,7 @@ public NavigationWindowProxy()
 
 	@Override
 	@Kroll.method
-	public void open(@Kroll.argument(optional = true) Object arg)
+	public KrollPromise<Void> open(@Kroll.argument(optional = true) Object arg)
 	{
 		// FIXME: Shouldn't this complain/blow up if window isn't specified?
 		if (!opened && getProperties().containsKeyAndNotNull(TiC.PROPERTY_WINDOW)) {
@@ -37,9 +41,11 @@ public void open(@Kroll.argument(optional = true) Object arg)
 				openWindow(rootView, arg);
 				fireEvent(TiC.EVENT_OPEN, null);
 			}
-			return;
+			return KrollPromise.create((promise) -> {
+				promise.resolve(null);
+			});
 		}
-		super.open(arg);
+		return super.open(arg);
 	}
 
 	@Kroll.method
@@ -52,17 +58,19 @@ public void popToRootWindow(@Kroll.argument(optional = true) Object arg)
 		}
 	}
 
-	@Override
-	@Kroll.method
-	public void close(@Kroll.argument(optional = true) Object arg)
+	protected void handleClose(@NonNull KrollDict options)
 	{
 		if (opened) {
 			opened = false;
-			popToRootWindow(arg);
-			closeWindow(windows.get(0), arg); // close the root window
+			popToRootWindow(options);
+			closeWindow(windows.get(0), options); // close the root window
 			fireEvent(TiC.EVENT_CLOSE, null);
+			if (closePromise != null) {
+				closePromise.resolve(null);
+				closePromise = null;
+			}
 		}
-		super.close(arg);
+		super.handleClose(options);
 	}
 
 	@Kroll.method

android/modules/ui/src/java/ti/modules/titanium/ui/WindowProxy.java

@@ -1,6 +1,6 @@
 /**
  * Appcelerator Titanium Mobile
- * Copyright (c) 2013 by Appcelerator, Inc. All Rights Reserved.
+ * Copyright (c) 2013-2021 by Appcelerator, Inc. All Rights Reserved.
  * Licensed under the terms of the Apache Public License
  * Please see the LICENSE included with this distribution for details.
  */
@@ -11,6 +11,7 @@
 import java.util.HashMap;
 
 import org.appcelerator.kroll.KrollDict;
+import org.appcelerator.kroll.KrollPromise;
 import org.appcelerator.kroll.annotations.Kroll;
 import org.appcelerator.kroll.common.Log;
 import org.appcelerator.titanium.TiActivity;
@@ -105,7 +106,7 @@ public TiUIView createView(Activity activity)
 	}
 
 	@Override
-	public void open(@Kroll.argument(optional = true) Object arg)
+	public KrollPromise<Void> open(@Kroll.argument(optional = true) Object arg)
 	{
 		HashMap<String, Object> option = null;
 		if (arg instanceof HashMap) {
@@ -127,16 +128,7 @@ public void open(@Kroll.argument(optional = true) Object arg)
 		properties.remove(TiC.PROPERTY_BOTTOM);
 		properties.remove(TiC.PROPERTY_LEFT);
 		properties.remove(TiC.PROPERTY_RIGHT);
-		super.open(arg);
-	}
-
-	@Override
-	public void close(@Kroll.argument(optional = true) Object arg)
-	{
-		if (!(opened || opening)) {
-			return;
-		}
-		super.close(arg);
+		return super.open(arg);
 	}
 
 	@Override

android/titanium/src/java/org/appcelerator/titanium/proxy/TiWindowProxy.java

@@ -1,6 +1,6 @@
 /**
  * Appcelerator Titanium Mobile
- * Copyright (c) 2009-2013 by Appcelerator, Inc. All Rights Reserved.
+ * Copyright (c) 2009-2021 by Appcelerator, Inc. All Rights Reserved.
  * Licensed under the terms of the Apache Public License
  * Please see the LICENSE included with this distribution for details.
  */
@@ -12,6 +12,7 @@
 import java.util.List;
 
 import org.appcelerator.kroll.KrollDict;
+import org.appcelerator.kroll.KrollPromise;
 import org.appcelerator.kroll.KrollProxy;
 import org.appcelerator.kroll.annotations.Kroll;
 import org.appcelerator.kroll.common.Log;
@@ -72,6 +73,8 @@ public abstract class TiWindowProxy extends TiViewProxy
 	protected boolean windowActivityCreated = false;
 	protected List<Pair<View, String>> sharedElementPairs;
 	public TiWindowProxy navigationWindow;
+	protected KrollPromise openPromise;
+	protected KrollPromise closePromise;
 
 	public interface PostOpenListener {
 		void onPostOpen(TiWindowProxy window);
@@ -98,34 +101,39 @@ public TiUIView createView(Activity activity)
 
 	@Kroll.method
 	@SuppressWarnings("unchecked")
-	public void open(@Kroll.argument(optional = true) Object arg)
+	public KrollPromise<Void> open(@Kroll.argument(optional = true) Object arg)
 	{
 		if (opened || opening) {
-			return;
+			return KrollPromise.create((promise) -> {
+				promise.reject(new Throwable("Window is already opened or opening."));
+			});
 		}
-
-		waitingForOpen = new WeakReference<TiWindowProxy>(this);
 		opening = true;
-		KrollDict options = null;
-		TiAnimation animation = null;
+		waitingForOpen = new WeakReference<TiWindowProxy>(this);
+
+		openPromise = KrollPromise.create((promise) -> {
+			KrollDict options = null;
+			TiAnimation animation = null;
 
-		if (arg != null) {
-			if (arg instanceof KrollDict) {
-				options = (KrollDict) arg;
+			if (arg != null) {
+				if (arg instanceof KrollDict) {
+					options = (KrollDict) arg;
 
-			} else if (arg instanceof HashMap<?, ?>) {
-				options = new KrollDict((HashMap<String, Object>) arg);
+				} else if (arg instanceof HashMap<?, ?>) {
+					options = new KrollDict((HashMap<String, Object>) arg);
 
-			} else if (arg instanceof TiAnimation) {
+				} else if (arg instanceof TiAnimation) {
+					options = new KrollDict();
+					options.put("_anim", animation);
+				}
+
+			} else {
 				options = new KrollDict();
-				options.put("_anim", animation);
 			}
 
-		} else {
-			options = new KrollDict();
-		}
-
-		handleOpen(options);
+			handleOpen(options);
+		});
+		return openPromise;
 	}
 
 	@Kroll.getProperty(name = "closed")
@@ -142,27 +150,36 @@ public boolean isFocused()
 
 	@SuppressWarnings("unchecked")
 	@Kroll.method
-	public void close(@Kroll.argument(optional = true) Object arg)
+	public KrollPromise<Void> close(@Kroll.argument(optional = true) Object arg)
 	{
-		// TODO: if not opened, ignore? We do this in WindowProxy subclass, but not the other two...
-		KrollDict options = null;
-		TiAnimation animation = null;
+		if (!(opened || opening)) {
+			return KrollPromise.create((promise) -> {
+				promise.reject(new Throwable("Window is not open or opening, so cannot be closed."));
+			});
+		}
+
+		// FIXME: Can we "cancel" the open() promise if it's not finished?
+		closePromise = KrollPromise.create((promise) -> {
+			KrollDict options = null;
+			TiAnimation animation = null;
 
-		if (arg != null) {
-			if (arg instanceof HashMap<?, ?>) {
-				options = new KrollDict((HashMap<String, Object>) arg);
+			if (arg != null) {
+				if (arg instanceof HashMap<?, ?>) {
+					options = new KrollDict((HashMap<String, Object>) arg);
 
-			} else if (arg instanceof TiAnimation) {
+				} else if (arg instanceof TiAnimation) {
+					options = new KrollDict();
+					options.put("_anim", animation);
+				}
+
+			} else {
 				options = new KrollDict();
-				options.put("_anim", animation);
 			}
 
-		} else {
-			options = new KrollDict();
-		}
-
-		handleClose(options);
-		// FIXME: Maybe fire the close event here and set opened to false as well, rather than leaving to subclasses?
+			handleClose(options);
+			// FIXME: Maybe fire the close event here and set opened to false as well, rather than leaving to subclasses?
+		});
+		return closePromise;
 	}
 
 	public void closeFromActivity(boolean activityIsFinishing)
@@ -189,6 +206,10 @@ public void closeFromActivity(boolean activityIsFinishing)
 		// And it will dispose the handler of the window in the JS if the activity
 		// is not forced to destroy.
 		fireSyncEvent(TiC.EVENT_CLOSE, data);
+		if (closePromise != null) {
+			closePromise.resolve(null);
+			closePromise = null; // FIXME: call release() first?
+		}
 	}
 
 	public void addProxyWaitingForActivity(KrollProxy waitingProxy)
@@ -505,6 +526,11 @@ public void run()
 		if (nativeView != null) {
 			nativeView.postInvalidate();
 		}
+
+		if (openPromise != null) {
+			openPromise.resolve(null);
+			openPromise = null;
+		}
 	}
 
 	protected void fillIntent(Activity activity, Intent intent)

apidoc/Titanium/UI/Window.yml

@@ -478,6 +478,12 @@ methods:
         summary: Animation or display properties to use when closing the window.
         type: [Titanium.UI.Animation, Dictionary<Titanium.UI.Animation>, closeWindowParams]
         optional: true
+    returns:
+      type: Promise<any>
+      summary: |
+          Starting in SDK 10.0.0, this method returns a `Promise` that will be resolved once the window is closed,
+          akin to adding a one-time listener for the `close` event. If the window fails to close (for example, because
+          it was not yet open) the `Promise` will be rejected.
 
   - name: hideNavBar
     summary: Hides the navigation bar.
@@ -509,6 +515,12 @@ methods:
         summary: Animation or display properties to use when opening the window.
         type: openWindowParams
         optional: true
+    returns:
+      type: Promise<any>
+      summary: |
+          Starting in SDK 10.0.0, this method returns a `Promise` that will be resolved once the window is opened,
+          akin to adding a one-time listener for the `open` event. If the window fails to open (for example, because
+          it is already opened or opening) the `Promise` will be rejected.
 
   - name: removeAllSharedElements
     summary: Clears all added shared elements.

common/Resources/ti.internal/extensions/ti/ui/tabgroup.js

@@ -75,7 +75,7 @@ if (OS_ANDROID) {
 	TabGroup.prototype.open = function (options) {
 
 		if (this.currentState === this.state.opened) {
-			return;
+			return Promise.reject(new Error('Window is already opened or opening.'));
 		}
 
 		this.currentState = this.state.opening;
@@ -104,9 +104,10 @@ if (OS_ANDROID) {
 		if (this._activeTab !== -1) {
 			this.setActiveTab(this._activeTab);
 		}
-		_open.call(this, options);
+		const result = _open.call(this, options);
 
 		this.currentState = this.state.opened;
+		return result;
 	};
 
 	const _addTab = TabGroup.prototype.addTab;

common/Resources/ti.internal/extensions/ti/ui/window.js

@@ -63,7 +63,7 @@ if (OS_ANDROID) {
 			}
 		});
 
-		_open.call(this, options);
+		return _open.call(this, options);
 	};
 
 	const _add = Window.prototype.add;