Add navigation notification to CMS View.

[lgpl/argeo-commons.git] / org.argeo.cms.ui / src / org / argeo / cms / ui / CmsView.java

diff --git a/org.argeo.cms.ui/src/org/argeo/cms/ui/CmsView.java b/org.argeo.cms.ui/src/org/argeo/cms/ui/CmsView.java
index 51f6acc8cb770e37be2c353123b2368fb701c8d1..d57f20bed897a626da6e4d584180b7a7f6471f9e 100644 (file)
--- a/org.argeo.cms.ui/src/org/argeo/cms/ui/CmsView.java
+++ b/org.argeo.cms.ui/src/org/argeo/cms/ui/CmsView.java
@@ -1,11 +1,21 @@
 package org.argeo.cms.ui;
 
+import java.security.PrivilegedAction;
+import java.util.HashMap;
+import java.util.Map;
+
 import javax.security.auth.login.LoginContext;
 
-import org.argeo.cms.auth.CmsAuthenticated;
+import org.eclipse.swt.widgets.Control;
+import org.eclipse.swt.widgets.Shell;
+
+/** Provides interaction with the CMS system. */
+public interface CmsView {
+       final static String CMS_VIEW_UID_PROPERTY = "argeo.cms.view.uid";
+       // String KEY = "org.argeo.cms.ui.view";
+
+       String getUid();
 
-/** Provides interaction with the CMS system. UNSTABLE API at this stage. */
-public interface CmsView extends CmsAuthenticated {
        UxContext getUxContext();
 
        // NAVIGATION
@@ -15,11 +25,64 @@ public interface CmsView extends CmsAuthenticated {
        void authChange(LoginContext loginContext);
 
        void logout();
-       
-//     void registerCallbackHandler(CallbackHandler callbackHandler);
+
+       // void registerCallbackHandler(CallbackHandler callbackHandler);
 
        // SERVICES
        void exception(Throwable e);
 
        CmsImageManager getImageManager();
+
+       boolean isAnonymous();
+
+       /**
+        * Send an event to this topic. Does noothing by default., but if implemented it
+        * MUST set the {@link #CMS_VIEW_UID_PROPERTY} in the properties.
+        */
+       default void sendEvent(String topic, Map<String, Object> properties) {
+
+       }
+
+       /**
+        * Convenience methods for when {@link #sendEvent(String, Map)} only requires
+        * one single parameter.
+        */
+       default void sendEvent(String topic, String param, Object value) {
+               Map<String, Object> properties = new HashMap<>();
+               properties.put(param, value);
+               sendEvent(topic, properties);
+       }
+
+       default void applyStyles(Object widget) {
+
+       }
+
+       default <T> T doAs(PrivilegedAction<T> action) {
+               throw new UnsupportedOperationException();
+       }
+       
+       default void stateChanged(String state, String title) {
+       }
+
+       static CmsView getCmsView(Control parent) {
+               // find parent shell
+               Shell topShell = parent.getShell();
+               while (topShell.getParent() != null)
+                       topShell = (Shell) topShell.getParent();
+               return (CmsView) topShell.getData(CmsView.class.getName());
+       }
+
+       static void registerCmsView(Shell shell, CmsView view) {
+               // find parent shell
+               Shell topShell = shell;
+               while (topShell.getParent() != null)
+                       topShell = (Shell) topShell.getParent();
+               // check if already set
+               if (topShell.getData(CmsView.class.getName()) != null) {
+                       CmsView registeredView = (CmsView) topShell.getData(CmsView.class.getName());
+                       throw new IllegalArgumentException("Cms view " + registeredView + " already registered in this shell");
+               }
+               shell.setData(CmsView.class.getName(), view);
+       }
+
 }