From da31fae9e367ec4eeac95512f8dfb99e8430c7c2 Mon Sep 17 00:00:00 2001
From: pb <pb@8810af33-2d31-482b-a856-94f89814c4df>
Date: Fri, 14 Jun 2013 10:11:45 +0000
Subject: [PATCH] Ticket #1747: SecurityPropertyEditor kann jetzt
 GlobalizedMessage verarbeiten, Labels als String deprecated.

git-svn-id: https://svn.libreccm.org/ccm/trunk@2207 8810af33-2d31-482b-a856-94f89814c4df
---
 .../cms/ui/SecurityPropertyEditor.java        |  79 ++++++++-
 ccm-core/src/com/arsdigita/bebop/Label.java   |  23 ++-
 .../com/arsdigita/bebop/PropertyEditor.java   | 162 +++++++++++++++---
 3 files changed, 224 insertions(+), 40 deletions(-)

diff --git a/ccm-cms/src/com/arsdigita/cms/ui/SecurityPropertyEditor.java b/ccm-cms/src/com/arsdigita/cms/ui/SecurityPropertyEditor.java
index 427b02005..8f0c81157 100755
--- a/ccm-cms/src/com/arsdigita/cms/ui/SecurityPropertyEditor.java
+++ b/ccm-cms/src/com/arsdigita/cms/ui/SecurityPropertyEditor.java
@@ -32,6 +32,7 @@ import com.arsdigita.bebop.form.Submit;
 import com.arsdigita.cms.SecurityManager;
 import com.arsdigita.cms.dispatcher.Utilities;
 import com.arsdigita.cms.util.GlobalizationUtil;
+import com.arsdigita.globalization.GlobalizedMessage;
 import com.arsdigita.toolbox.ui.ComponentAccess;
 import com.arsdigita.util.Assert;
 
@@ -113,12 +114,28 @@ public class SecurityPropertyEditor extends PropertyEditor {
      *    for this <code>PropertyEditor</code>
      * @param label The label for the link
      * @param ca    The component access
+     * @deprecated use addComponent(String,GlobalizedMessage,ComponentAccess) 
+     *             instead.
      */
     public void addComponent(String key, String label, ComponentAccess ca) {
         addComponent(key, ca);
         getLabelsMap().put(key, label);
     }
 
+    /**
+     * Add a component to the list of links. It is up to the
+     * component to correctly call showDisplayPane when it's done.
+     *
+     * @param key   The symbolic key for the component;  must be unique
+     *    for this <code>PropertyEditor</code>
+     * @param label The label for the link
+     * @param ca    The component access
+     */
+    public void addComponent(String key, GlobalizedMessage label, ComponentAccess ca) {
+        addComponent(key, ca);
+        getLabelsMap().put(key, label);
+    }
+
     /**
      * Specify a new {@link ComponentAccess} for a component which has already
      * been added to the <code>SecurityPropertyEditor</code>.
@@ -142,10 +159,12 @@ public class SecurityPropertyEditor extends PropertyEditor {
      * Add a form to the set of forms which could be used to edit the
      * properties.
      *
-     * @param key The symbolic key for the form;  must be unique
-     *    for this <code>PropertyEditor</code>
-     * @param label The label for the link
-     * @param ca  The form ComponentAccess
+     * @param key   The symbolic key for the form;  must be unique
+     *              for this <code>PropertyEditor</code>
+     * @param label The label for the link to access the form
+     * @param ca    The form ComponentAccess
+     * 
+     * @deprecated use add(String,GlobalizedMessage,ComponentAccess)
      */
     public void add(String key, String label, ComponentAccess ca) {
         Component c = ca.getComponent();
@@ -165,15 +184,45 @@ public class SecurityPropertyEditor extends PropertyEditor {
         }
     }
 
+    /**
+     * Add a form to the set of forms which could be used to edit the
+     * properties.
+     *
+     * @param key   The symbolic key for the form;  must be unique
+     *              for this <code>PropertyEditor</code>
+     * @param label The label for the link to access the form
+     * @param ca    The form ComponentAccess
+     */
+    public void add(String key, GlobalizedMessage label, ComponentAccess ca) {
+        Component c = ca.getComponent();
+        if (c instanceof Form) {
+            Form form = (Form) c;
+            m_accessChecks.put(key, ca);
+            add(key, label, form);
+            addSecurityListener(form);
+        } else if (c instanceof FormSection) {
+            FormSection section = (FormSection) ca.getComponent();
+            m_accessChecks.put(key, ca);
+            add(key, label, section);
+            addSecurityListener(section);
+        } else {
+            throw new IllegalArgumentException(
+                  "The ComponentAccess object did not contain a form section.");
+        }
+    }
+
     /**
      * Add a form to the set of forms which could be used to edit the
      * properties
      *
      * @param key   The symbolic key for the form; must be unique
-     *    for this <code>PropertyEditor</code>
-     * @param label The label for the link
-     * @param ca  The form ComponentAccess
+     *              for this <code>PropertyEditor</code>
+     * @param label The label for the link to access the form.
+     * @param ca    The form ComponentAccess
      * @param cancelButton The Cancel button on the form.
+     * 
+     * @deprecated use add(String,GlobalizedMessage,ComponentAccess,Submit)
+     *             instead
      */
     public void add(String key, String label,
                     ComponentAccess ca, Submit cancelButton) {
@@ -181,6 +230,22 @@ public class SecurityPropertyEditor extends PropertyEditor {
         addCancelListener((FormSection) ca.getComponent(), cancelButton);
     }
 
+    /**
+     * Add a form to the set of forms which could be used to edit the
+     * properties
+     *
+     * @param key   The symbolic key for the form; must be unique
+     *              for this <code>PropertyEditor</code>
+     * @param label The label for the link to access the form.
+     * @param ca    The form ComponentAccess
+     * @param cancelButton The Cancel button on the form.
+     */
+    public void add(String key, GlobalizedMessage label,
+                    ComponentAccess ca, Submit cancelButton) {
+        add(key, label, ca);
+        addCancelListener((FormSection) ca.getComponent(), cancelButton);
+    }
+
     /**
      * Add a submission listener to the form that will hide all components
      * and show the display pane. This method should be used to add
diff --git a/ccm-core/src/com/arsdigita/bebop/Label.java b/ccm-core/src/com/arsdigita/bebop/Label.java
index 1bd75b9c6..b09da3f38 100755
--- a/ccm-core/src/com/arsdigita/bebop/Label.java
+++ b/ccm-core/src/com/arsdigita/bebop/Label.java
@@ -59,18 +59,20 @@ public class Label extends BlockStylable implements Cloneable {
      * <code>Label</code> with the specified text.
      *
      * @param label the text to display
+     * 
+     * @deprecated  refactor to use Label(GlobalizedMessage label) instad
      */
     public Label(String label) {
         this(label, true);
     }
 
     /**
-     * Creates a new
-     * <code>Label</code> with the specified text and output escaping turned on
-     * if
+     * Creates a new <code>Label</code> with the specified text and 
+     * output escaping turned on if
      * <code>escaping</code> is
-     * <code>true</code>. The setting foroutput escaping affects how markup in
-     * the
+     * <code>true</code>. 
+     * 
+     * The setting foroutput escaping affects how markup in the
      * <code>label</code> is handled. For example: <UL><LI>If output escaping is
      * in effect, &lt;b>text&lt;/b> will appear literally.</LI> <LI>If output
      * escaping is disabled, &lt;b>text&lt;/b> appears as the word "text" in
@@ -79,6 +81,9 @@ public class Label extends BlockStylable implements Cloneable {
      * @param label the text to display
      * @param <code>true</code> if output escaping will be in effect;
      * <code>false</code> if output escaping will be disabled
+     * 
+     * @deprecated  refactor to Label(GlobalizedMessage label, boolean escaping) 
+     *              instead
      */
     public Label(String label, boolean escaping) {
         setLabel(label);
@@ -109,8 +114,8 @@ public class Label extends BlockStylable implements Cloneable {
     }
 
     /**
-     * Creates a new
-     * <code>Label</code> that uses the print listener to generate output.
+     * Creates a new <code>Label</code> that uses the print listener to 
+     * generate output.
      *
      * @param l the print listener used to produce output
      */
@@ -124,6 +129,10 @@ public class Label extends BlockStylable implements Cloneable {
      *
      * @param label The text to display
      * @param fontWeight The fontWeight e.g., Label.BOLD
+     * 
+     * @deprecated  without dir3ect replacement. Refactor to use
+     *              Label(GlobalizedMEssage) instead and modify the theme to
+     *              use proper text marking.
      */
     public Label(String label, String fontWeight) {
         this(label, true);
diff --git a/ccm-core/src/com/arsdigita/bebop/PropertyEditor.java b/ccm-core/src/com/arsdigita/bebop/PropertyEditor.java
index 102d6d040..9e7bf0ca7 100755
--- a/ccm-core/src/com/arsdigita/bebop/PropertyEditor.java
+++ b/ccm-core/src/com/arsdigita/bebop/PropertyEditor.java
@@ -27,13 +27,13 @@ import com.arsdigita.bebop.event.FormSubmissionListener;
 import com.arsdigita.bebop.list.DefaultListCellRenderer;
 import com.arsdigita.bebop.list.ListModelBuilder;
 import com.arsdigita.bebop.list.ListModel;
-import com.arsdigita.bebop.List;
 import com.arsdigita.util.Assert;
 import com.arsdigita.util.LockableImpl;
 import com.arsdigita.util.SequentialMap;
 import com.arsdigita.bebop.event.FormSectionEvent;
 import com.arsdigita.bebop.form.FormErrorDisplay;
 import com.arsdigita.bebop.form.Submit;
+import com.arsdigita.globalization.GlobalizedMessage;
 
 import java.util.ArrayList;
 import java.util.Iterator;
@@ -228,14 +228,17 @@ public class PropertyEditor extends SimpleContainer {
         setModelBuilder(new DefaultModelBuilder());
 
         m_model = new RequestLocal() {
+                @Override
                 protected Object initialValue(PageState s) {
                     return getModelBuilder().makeModel(PropertyEditor.this, s);
                 }
             };
     }
 
-    // Set the display component visible by default, and the
-    // form(s) invisible by default
+    /** Set the display component visible by default, and the
+     *  form(s) invisible by default.
+     */
+    @Override
     public void register(Page p) {
         Assert.exists(m_display, "display component");
 
@@ -319,15 +322,30 @@ public class PropertyEditor extends SimpleContainer {
     }
 
     /**
-     * Adds a component to the list of links. It is up to the
-     * component to correctly call {@link #showDisplayPane(PageState)} when it is done.
+     * Adds a component to the list of links. It is up to the component to
+     * correctly call {@link #showDisplayPane(PageState)} when it is done.
      *
      * @param key   the symbolic key for the component (must be unique
-     *    for this <code>PropertyEditor</code>)
+     *              for this <code>PropertyEditor</code>)
+     * @param label the label for the link
+     * @param c     the component
+     * @deprecated use addComponent(String,GlobalizedMessage,Component) instead
+     */
+    public void addComponent(String key, String label, Component c) {
+        addComponent(key, c);
+        m_labels.put(key, label);
+    }
+
+    /**
+     * Adds a component to the list of links. It is up to the component to
+     * correctly call {@link #showDisplayPane(PageState)} when it is done.
+     *
+     * @param key   the symbolic key for the component (must be unique
+     *              for this <code>PropertyEditor</code>)
      * @param label the label for the link
      * @param c     the component
      */
-    public void addComponent(String key, String label, Component c) {
+    public void addComponent(String key, GlobalizedMessage label, Component c) {
         addComponent(key, c);
         m_labels.put(key, label);
     }
@@ -337,11 +355,26 @@ public class PropertyEditor extends SimpleContainer {
      * properties.
      *
      * @param key   the symbolic key for the form (must be unique
-     *    for this <code>PropertyEditor</code>)
+     *              for this <code>PropertyEditor</code>)
+     * @param label the label for the link
+     * @param form  the form component
+     * @deprecated use add(String,GlobalizedMessage,Form) instead.
+     */
+    public void add(String key, String label, Form form) {
+        addComponent(key, label, form);
+        addProcessListener(form);
+    }
+
+    /**
+     * Adds a form to the set of forms that can be used to edit the
+     * properties.
+     *
+     * @param key   the symbolic key for the form (must be unique
+     *              for this <code>PropertyEditor</code>)
      * @param label the label for the link
      * @param form  the form component
      */
-    public void add(String key, String label, Form form) {
+    public void add(String key, GlobalizedMessage label, Form form) {
         addComponent(key, label, form);
         addProcessListener(form);
     }
@@ -355,6 +388,7 @@ public class PropertyEditor extends SimpleContainer {
      * @param label the label for the link
      * @param form the form component
      * @param cancelButton the Cancel button on the form
+     * @deprecated use add(String,GlobalizedMessage,Form,Submit) instead.
      */
     public void add(String key, String label, Form form, Submit cancelButton) {
         add(key, label, form);
@@ -368,9 +402,25 @@ public class PropertyEditor extends SimpleContainer {
      * @param key   the symbolic key for the form (must be unique
      *    for this <code>PropertyEditor</code>)
      * @param label the label for the link
-     * @param formSection  the form component
+     * @param form the form component
+     * @param cancelButton the Cancel button on the form
+     */
+    public void add(String key, GlobalizedMessage label, Form form, Submit cancelButton) {
+        add(key, label, form);
+        addListeners(form, cancelButton);
+    }
+
+    /**
+     * Adds a form to the set of forms that can be used to edit the
+     * properties.
      *
+     * @param key   the symbolic key for the form (must be unique
+     *              for this <code>PropertyEditor</code>)
+     * @param label the label for the link
+     * @param formSection  the form component
+     * 
      * @pre !(formSection instanceof Form)
+     * @deprecated use add(String,GlobalizedMessage,FormSection) instead.
      */
     public void add(String key, String label, FormSection formSection) {
         if (formSection instanceof Form) {
@@ -389,10 +439,34 @@ public class PropertyEditor extends SimpleContainer {
      * properties.
      *
      * @param key   the symbolic key for the form (must be unique
-     *    for this <code>PropertyEditor</code>)
+     *              for this <code>PropertyEditor</code>)
+     * @param label the label for the link
+     * @param formSection  the form component
+     *
+     * @pre !(formSection instanceof Form)
+     */
+    public void add(String key, GlobalizedMessage label, FormSection formSection) {
+        if (formSection instanceof Form) {
+            throw new IllegalArgumentException("formSection is an instance of Form");
+        }
+        Form form = new Form("property" + key);
+        form.add(new FormErrorDisplay(form), ColumnPanel.FULL_WIDTH | ColumnPanel.LEFT);
+        form.add(formSection);
+        form.setMethod(Form.POST);
+        form.setEncType("multipart/form-data");
+        add(key, label , form);
+    }
+
+    /**
+     * Adds a form to the set of forms that can be used to edit the
+     * properties.
+     *
+     * @param key   the symbolic key for the form (must be unique
+     *              for this <code>PropertyEditor</code>)
      * @param label the label for the link
      * @param formSection the form component
      * @param cancelButton the Cancel button on the form
+     * @deprecated use add(String,GlobalizedMessage,FormSection,Submit) instead.
      */
     public void add(String key,
                     String label,
@@ -406,13 +480,35 @@ public class PropertyEditor extends SimpleContainer {
         add(key, label , form, cancelButton);
     }
 
+    /**
+     * Adds a form to the set of forms that can be used to edit the
+     * properties.
+     *
+     * @param key   the symbolic key for the form (must be unique
+     *              for this <code>PropertyEditor</code>)
+     * @param label the label for the link as a GlobalizedMessage
+     * @param formSection the form component
+     * @param cancelButton the Cancel button on the form
+     */
+    public void add(String key,
+                    GlobalizedMessage label,
+                    FormSection formSection,
+                    Submit cancelButton) {
+        Form form = new Form("property" + key);
+        form.add(new FormErrorDisplay(form), ColumnPanel.FULL_WIDTH | ColumnPanel.LEFT);
+        form.add(formSection);
+        form.setMethod(Form.POST);
+        form.setEncType("multipart/form-data");
+        add(key, label , form, cancelButton);
+    }
+
     /**
      * Retrieves the component at the specified key.
      *
      * @param key the key of the component to retrieve
-     * @return a component that has been added to this
-     *   <code>PropertyEditor</code> at the specified key, or null
-     *   if no such component exists.
+     * @return    a component that has been added to this
+     *            <code>PropertyEditor</code> at the specified key, or null
+     *            if no such component exists.
      */
     public Component getComponent(String key) {
         return (Component)m_forms.get(key);
@@ -482,11 +578,11 @@ public class PropertyEditor extends SimpleContainer {
      * if the {@link ActionLink} that is supposed to show the component is
      * buried somewhere deep within the UI.
      *
-     * @param l the {@link ActionLink}
+     * @param l   the {@link ActionLink}
      * @param key the key of the component that will be shown when the link
-     *   is clicked, as specified in the {@link #addComponent(String, Component)}
-     *   method
-     * @see #addComponent(String, Component)
+     *             is clicked, as specified in the 
+     *             {@link #addComponent(String, Component)}  method
+     * @see       #addComponent(String, Component)
      */
     public void addVisibilityListener(ActionLink l, String key) {
         final String t_key = key;
@@ -567,6 +663,7 @@ public class PropertyEditor extends SimpleContainer {
     /**
      * Locks this component.
      */
+    @Override
     public void lock() {
         getModelBuilder().lock();
         super.lock();
@@ -577,6 +674,7 @@ public class PropertyEditor extends SimpleContainer {
      */
     protected static class IdentityCellRenderer extends DefaultListCellRenderer {
 
+        @Override
         public Component getComponent(List list, PageState state, Object value,
                                       String key, int index, boolean isSelected) {
             return (Component)value;
@@ -614,12 +712,11 @@ public class PropertyEditor extends SimpleContainer {
     }
 
     /**
-     * Default implementation of the {@link PropertyEditorModel}.
-     * Takes in an iterator of key->label pairs, and constructs a ControlLink for each
-     * label.
+     * Internal class with default implementation of the {@link PropertyEditorModel}.
+     * Takes in an iterator of key->label pairs, and constructs a ControlLink 
+     * for each label.
      */
-    protected static class DefaultModel
-        implements PropertyEditorModel {
+    protected static class DefaultModel implements PropertyEditorModel {
 
         protected Iterator m_iter;
         protected Map.Entry m_entry;
@@ -638,11 +735,24 @@ public class PropertyEditor extends SimpleContainer {
             return true;
         }
 
+        /**
+         * Actually retrieve action link and label. Will be executed at each
+         * request to ensure proper localization.
+         * @return 
+         */
         public Component getComponent() {
             Assert.exists(m_entry);
-            ControlLink l = new ControlLink(new Label((String)m_entry.getValue()));
-            l.setClassAttr("actionLink");
-            return l;
+            if ( m_entry.getValue() instanceof GlobalizedMessage ) {
+                ControlLink l = new ControlLink(new 
+                                    Label((GlobalizedMessage)m_entry.getValue()));
+                l.setClassAttr("actionLink");
+                return l;
+            } else {
+                ControlLink l = new ControlLink(new Label((String)m_entry.getValue()));                
+                
+                l.setClassAttr("actionLink");
+                return l;
+            }
         }
 
         public Object getKey() {