Changeset 5626

Timestamp:

09/24/08 16:36:58 (2 months ago)

Author:

will

Message:

Lock, currently for display only (doesn't prevent editing)

Location:

trunk/SRC/org/openmicroscopy/shoola/agents/editor

Files:

• IconManager.java (modified) (3 diffs)
• browser/FieldPanel.java (modified) (7 diffs)
• browser/FieldRenderer.java (modified) (1 diff)
• browser/TreeOutlineCellRenderer.java (modified) (1 diff)
• graphx/nuvola_encrypted16.png (added)
• graphx/nuvola_encrypted_red16.png (added)
• model/Field.java (modified) (3 diffs)
• model/FieldNode.java (modified) (2 diffs)
• model/IField.java (modified) (1 diff)
• model/Lock.java (added)
• model/TreeModelFactory.java (modified) (2 diffs)

trunk/SRC/org/openmicroscopy/shoola/agents/editor/IconManager.java

@@ -231 +231 @@
     public  static int                  INDENT_LEFT = 54;
     
+    /** The <code>Template locked</code> icon. */
+    public  static int                  TEMPLATE_LOCK = 55;
+    
+    /** The <code>Fully locked</code> icon. */
+    public  static int                  FULL_LOCK = 56;
+    
     
     /** 
@@ -236 +242 @@
      * Allows to correctly build arrays for direct indexing. 
      */
-    private static int          MAX_ID = 54;
+    private static int          MAX_ID = 56;
     
     /** Paths of the icon files. */
@@ -303 +309 @@
         relPaths[INDENT_RIGHT] = "nuvola_indent_right16.png";
         relPaths[INDENT_LEFT] = "nuvola_indent_left16.png";
+        relPaths[TEMPLATE_LOCK] = "nuvola_encrypted16.png";
+        relPaths[FULL_LOCK] = "nuvola_encrypted_red16.png";
     }
     

trunk/SRC/org/openmicroscopy/shoola/agents/editor/browser/FieldPanel.java

@@ -59 +59 @@
 import org.openmicroscopy.shoola.agents.editor.browser.paramUIs.TableEditor;
 import org.openmicroscopy.shoola.agents.editor.model.Field;
+import org.openmicroscopy.shoola.agents.editor.model.FieldNode;
 import org.openmicroscopy.shoola.agents.editor.model.IAttributes;
 import org.openmicroscopy.shoola.agents.editor.model.IField;
+import org.openmicroscopy.shoola.agents.editor.model.Lock;
 import org.openmicroscopy.shoola.agents.editor.model.params.IParam;
 import org.openmicroscopy.shoola.agents.editor.uiComponents.CustomButton;
@@ -144 +146 @@
          * Used eg. to set the selected field to this node with undo/redo
          */
-        private DefaultMutableTreeNode  treeNode;
+        private FieldNode                               treeNode;
         
         
@@ -233 +235 @@
                 nameLabel.setBackground(null);
                 nameLabel.setOpaque(false);
+                
+                if (field.isFieldLocked()) {
+                        Icon lockIcon = null;
+                        Lock lock = field.getLock();
+                        switch (lock.getLockLevel()) {
+                        case Lock.FULLY_LOCKED:
+                                lockIcon = iconManager.getIcon(IconManager.FULL_LOCK);
+                                break;
+                        case Lock.TEMPLATE_LOCKED:
+                                lockIcon = iconManager.getIcon(IconManager.TEMPLATE_LOCK);
+                                break;
+                        }
+                        nameLabel.setIcon(lockIcon);
+                        nameLabel.setToolTipText(lock.toString());
+                }
                 
                 // A description label displays description below the field.
@@ -438 +455 @@
                 String description = field.getAttribute(
                                 Field.FIELD_DESCRIPTION);
-                boolean showDescription = 
-                        "true".equals(field.getDisplayAttribute("descVisible"));
+                boolean showDescription = treeNode.getDescriptionVisisibility();
                 
                 if ((description != null) && (description.trim().length() > 0)) {
@@ -573 +589 @@
                 this.field = field;
                 this.tree = tree;
-                this.treeNode = treeNode;
+                this.treeNode = (FieldNode)treeNode;
                 this.controller = controller;
                 
@@ -674 +690 @@
         }
         
+        /**
+         * Handles the actions of several buttons that could appear in 
+         * this panel. 
+         * 
+         * @see ActionListener#actionPerformed(ActionEvent)
+         */
         public void actionPerformed(ActionEvent e) {
                 
@@ -682 +704 @@
                 
                 else if (TOGGLE_DESCRIPTION_CMD.equals(cmd)) {
-                        boolean visible = 
-                                "true".equals(field.getDisplayAttribute("descVisible"));
-                        visible = ! visible;
-                        field.setDisplayAttribute("descVisible", visible + "");
+                        treeNode.toggleDescriptionVisibility();
                         refreshEditingOfPanel();
                 }

trunk/SRC/org/openmicroscopy/shoola/agents/editor/browser/FieldRenderer.java

@@ -101 +101 @@
                                 IField field = (IField)object;
                                 
-                                toolTipText = field.getDisplayAttribute(Field.TOOL_TIP_TEXT);
+                                toolTipText = field.getToolTipText();
                                 
                                 FieldPanel fieldPanel = new FieldPanel(field, tree, 

trunk/SRC/org/openmicroscopy/shoola/agents/editor/browser/TreeOutlineCellRenderer.java

@@ -83 +83 @@
                         if (object instanceof IField) {
                                 IField field = (IField)object;
-                                toolTipText = field.getDisplayAttribute(Field.TOOL_TIP_TEXT);
+                                toolTipText = field.getToolTipText();
                                 
                                 if (field.getParamCount() < 1) {

trunk/SRC/org/openmicroscopy/shoola/agents/editor/model/Field.java

@@ -89 +89 @@
          */
         private List<IParam>                    fieldParams;
+        
+        /**
+         * A reference to a lock that may be applied to this field to prevent
+         * editing of some attributes or parameters. 
+         */
+        private Lock                                    fieldLock;
 
         /**
@@ -292 +298 @@
          * @return              see above.
          */
-        private String getToolTipText() 
+        public String getToolTipText() 
         {
                 String desc = getAttribute(FIELD_DESCRIPTION);
@@ -313 +319 @@
                 return toolTipText;
         }
+        
+        /**
+         * Sets a lock on this field to prevent editing. 
+         * @see #fieldLock
+         * 
+         * @param lock
+         */
+        public void setLock(Lock lock)
+        {
+                fieldLock = lock;
+        }
+        
+        /**
+         * Returns this field's lock (or null if no lock).
+         * 
+         * @return              see above
+         */
+        public Lock getLock() { return fieldLock; }
+
+        /**
+         * Implemented as specified by the {@link IField} interface.
+         * 
+         * @see IField#isFieldLocked()
+         */
+        public boolean isFieldLocked() {
+                if (fieldLock == null)  return false;
+        
+                return (! (fieldLock.getLockLevel() == Lock.NOT_LOCKED));
+        }
 }

trunk/SRC/org/openmicroscopy/shoola/agents/editor/model/FieldNode.java

@@ -46 +46 @@
  */
 public class FieldNode 
-        extends DefaultMutableTreeNode {
+        extends DefaultMutableTreeNode 
+{
 
-        private boolean nodeExpanded;
+        private boolean                 descriptionVisible;
         
         public FieldNode(IField newField) {
@@ -54 +55 @@
         }
 
-        public void setExpanded(boolean expanded) {
-                nodeExpanded = expanded;
+        /**
+         * Sets the visibility of the the description. 
+         * 
+         * @param visible
+         */
+        public void setDescriptionVisible(boolean visible)
+        {
+                descriptionVisible = visible;
         }
         
+        /**
+         * Toggles the boolean {@link #descriptionVisible} and returns
+         * the new value.
+         *      
+         * @return              The new (toggled) value of {@link #descriptionVisible}
+         */
+        public boolean toggleDescriptionVisibility() 
+        {
+                descriptionVisible = !descriptionVisible;
+                
+                return descriptionVisible;
+        }
+        
+        /**
+         * Gets the boolean {@link #descriptionVisible}
+         *      
+         * @return              The value of {@link #descriptionVisible}
+         */
+        public boolean getDescriptionVisisibility()
+        {
+                return descriptionVisible;
+        }
 }

trunk/SRC/org/openmicroscopy/shoola/agents/editor/model/IField.java

@@ -95 +95 @@
          */
         public boolean isFieldFilled();
-
-        /**
-         * UI classes may want to set display attributes that do not affect
-         * the data (eg collapsed state, description visible). 
-         * 
-         * @param name  The name of the display attribute. 
-         * @param value         The new value of the attribute
-         */
-        public void setDisplayAttribute(String name, String value);
-        
         
         /**
-         * UI classes may want to get display attributes that do not affect
-         * the data (eg collapsed state, description visible). 
+         * Returns a String containing the field description, plus the 
+         * tool-tip-text from it's parameters. 
          * 
-         * @param name          The named attribute
-         * @return                      The value of the attribute
+         * @return              see above.
          */
-        public String getDisplayAttribute(String name);
+        public String getToolTipText();
         
+        /**
+         * Returns true if the is a lock on this field.
+         * 
+         * @return              see above
+         */
+        public boolean isFieldLocked();
+        
+        /**
+         * Returns this field's lock (or null if no lock).
+         * 
+         * @return              see above
+         */
+        public Lock getLock();
 }

trunk/SRC/org/openmicroscopy/shoola/agents/editor/model/TreeModelFactory.java

@@ -206 +206 @@
                  
                  // Create a new field and set it's attributes.
-                 IField field = new Field();
+                 Field field = new Field();
                  
                  field.setAttribute(Field.FIELD_NAME, fieldName);
@@ -212 +212 @@
                  field.setAttribute(Field.FIELD_URL, url);
                  field.setAttribute(Field.BACKGROUND_COLOUR, colour);
+                 
+                 // Field lock
+                 String lockLevel = allAttributes.get(DataFieldConstants.LOCK_LEVEL);
+                 if (lockLevel != null) {
+                         String userName = allAttributes.get
+                                        (DataFieldConstants.LOCKED_FIELD_USER_NAME);
+                         int locking;
+                         if (lockLevel.equals(DataFieldConstants.LOCKED_TEMPLATE)) {
+                                 locking = Lock.TEMPLATE_LOCKED;
+                         } else {
+                                 locking = Lock.FULLY_LOCKED;
+                         }
+                         Lock lock = new Lock(locking, userName);
+                         
+                         String utc = allAttributes.get(DataFieldConstants.LOCKED_FIELD_UTC);
+                         lock.setTimeStamp(utc);
+                         
+                         field.setLock(lock);
+                 }
+                 
                  
                  // Field will have 0 or 1 "parameters", depending on type