Created a mechanism for dispatching notifications to user interface

elements when the client enters and leaves a place. git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@394 542714f4-19e9-0310-aa3c-eee0fc999fb1
2001-10-04 20:02:49 +00:00
parent 20b6650dad
commit 64e66dc98a
2 changed files with 143 additions and 0 deletions
@@ -0,0 +1,85 @@
+//
+// $Id: PlaceViewUtil.java,v 1.1 2001/10/04 20:02:49 mdb Exp $
+
+package com.threerings.cocktail.party.util;
+
+import java.awt.Component;
+import java.awt.Container;
+
+import com.threerings.cocktail.party.Log;
+import com.threerings.cocktail.party.data.PlaceObject;
+
+/**
+ * Provides a mechanism for dispatching notifications to all user
+ * interface elements in a hierarchy that implement the {@link PlaceView}
+ * interface. Look at the documentation for {@link PlaceView} for more
+ * explanation.
+ */
+public class PlaceViewUtil
+{
+    /**
+     * Dispatches a call to {@link PlaceView#willEnterPlace} to all UI
+     * elements in the hierarchy rooted at the component provided via the
+     * <code>root</code> parameter.
+     *
+     * @param root the component at which to start traversing the UI
+     * hierarchy.
+     * @param plobj the place object that is about to be entered.
+     */
+    public static void dispatchWillEnterPlace (
+        Component root, PlaceObject plobj)
+    {
+        // dispatch the call on this component if it implements PlaceView
+        if (root instanceof PlaceView) {
+            try {
+                ((PlaceView)root).willEnterPlace(plobj);
+            } catch (Exception e) {
+                Log.warning("Component choked on willEnterPlace() " +
+                            "[component=" + root + ", plobj=" + plobj + "].");
+                Log.logStackTrace(e);
+            }
+        }
+
+        // now traverse all of this component's children
+        if (root instanceof Container) {
+            Container cont = (Container)root;
+            int ccount = cont.getComponentCount();
+            for (int i = 0; i < ccount; i++) {
+                dispatchWillEnterPlace(cont.getComponent(i), plobj);
+            }
+        }
+    }
+
+    /**
+     * Dispatches a call to {@link PlaceView#didLeavePlace} to all UI
+     * elements in the hierarchy rooted at the component provided via the
+     * <code>root</code> parameter.
+     *
+     * @param root the component at which to start traversing the UI
+     * hierarchy.
+     * @param plobj the place object that is about to be entered.
+     */
+    public static void dispatchDidLeavePlace (
+        Component root, PlaceObject plobj)
+    {
+        // dispatch the call on this component if it implements PlaceView
+        if (root instanceof PlaceView) {
+            try {
+                ((PlaceView)root).didLeavePlace(plobj);
+            } catch (Exception e) {
+                Log.warning("Component choked on didLeavePlace() " +
+                            "[component=" + root + ", plobj=" + plobj + "].");
+                Log.logStackTrace(e);
+            }
+        }
+
+        // now traverse all of this component's children
+        if (root instanceof Container) {
+            Container cont = (Container)root;
+            int ccount = cont.getComponentCount();
+            for (int i = 0; i < ccount; i++) {
+                dispatchDidLeavePlace(cont.getComponent(i), plobj);
+            }
+        }
+    }
+}