Changeset 5546

Timestamp:

07/23/08 15:32:07 (5 weeks ago)

Author:

will

Message:

Actions and UndoableEdit? framework setup.
Can open Beta 3.0 XML files (not all fields rendered yet)

Location:

branches/OmeroEditor/src

Files:

• fields/AbstractParam.java (moved) (moved from branches/OmeroEditor/src/fields/AbstractValueObject.java) (3 diffs)
• fields/DateTimeParam.java (moved) (moved from branches/OmeroEditor/src/fields/DateTimeValueObject.java) (4 diffs)
• fields/Field.java (modified) (5 diffs)
• fields/FieldPanel.java (modified) (9 diffs)
• fields/FieldParamsFactory.java (moved) (moved from branches/OmeroEditor/src/fields/FieldValueFactory.java) (3 diffs)
• fields/IAttributes.java (added)
• fields/IField.java (modified) (2 diffs)
• fields/IFieldValue.java (deleted)
• fields/IParam.java (added)
• fields/NoParam.java (moved) (moved from branches/OmeroEditor/src/fields/NoValue.java) (2 diffs)
• fields/SingleParam.java (added)
• fields/TextValueObject.java (deleted)
• tree/DataField.java (modified) (1 diff)
• treeEditingComponents/DateTimeField.java (modified) (6 diffs)
• treeEditingComponents/EditingComponentFactory.java (modified) (4 diffs)
• treeEditingComponents/TextBoxEditor.java (added)
• treeEditingComponents/TextFieldEditor.java (modified) (2 diffs)
• treeIO (added)
• treeIO/TreeModelFactory.java (added)
• treeModel/DefaultFieldEditor.java (moved) (moved from branches/OmeroEditor/src/fields/DefaultFieldEditor.java) (1 diff)
• treeModel/ITreeEditor.java (modified) (2 diffs)
• treeModel/TreeEditor.java (deleted)
• treeModel/TreeEditorComponent.java (modified) (4 diffs)
• treeModel/TreeEditorControl.java (modified) (3 diffs)
• treeModel/TreeEditorFactory.java (modified) (4 diffs)
• treeModel/TreeEditorModel.java (moved) (moved from branches/OmeroEditor/src/treeModel/TreeModel.java) (2 diffs)
• treeModel/TreeEditorUI.java (modified) (4 diffs)
• treeModel/TreeUI.java (modified) (4 diffs)
• treeModel/editActions/AbstractEditorAction.java (added)
• treeModel/editActions/DeleteFields.java (deleted)
• treeModel/editActions/DeleteFieldsAction.java (added)
• treeModel/editActions/RedoEditAction.java (added)
• treeModel/editActions/UndoEditAction.java (added)
• treeModel/editActions/UndoRedoListener.java (added)
• treeModel/editActions/UndoRedoObservable.java (added)
• treeModel/undoableTreeEdits (added)
• treeModel/undoableTreeEdits/DeleteFieldsEdit.java (added)
• treeModel/undoableTreeEdits/ObservableUndoManager.java (added)
• treeModel/undoableTreeEdits/TreeModelMethods.java (moved) (moved from branches/OmeroEditor/src/treeModel/editActions/TreeModelMethods.java) (6 diffs)
• treeModel/undoableTreeEdits/UndoableTreeEdit.java (added)
• ui/components/AttributeEditorListeners.java (modified) (3 diffs)
• ui/components/AttributeTextAreaEditor.java (modified) (5 diffs)

branches/OmeroEditor/src/fields/AbstractParam.java

@@ -23 +23 @@
 package fields;
 
-import java.util.HashMap;
-
-import tree.DataFieldConstants;
 
 //Java imports
+import java.util.HashMap;
 
 //Third-party libraries
@@ -33 +31 @@
 //Application-internal dependencies
 
+import tree.DataFieldConstants;
+
+
 /** 
- * 
+ * An abstract example
  *
  * @author  William Moore     
@@ -44 +45 @@
  * @since OME3.0
  */
-public abstract class AbstractValueObject 
+public abstract class AbstractParam 
         implements
-        IFieldValue {
+        IParam {
         
-        private String fieldType;
+        public static final String PARAM_TYPE = "paramType";
+        
+        public static final String PARAM_NAME = "paramName";
+        
         
         private HashMap<String, String> valueAttributesMap;
 
         
-        public AbstractValueObject(String fieldType) {
-                this.fieldType = fieldType;
+        public AbstractParam(String fieldType) {
                 valueAttributesMap = new HashMap<String, String>();
+                valueAttributesMap.put(PARAM_TYPE, fieldType);
         }
         
+        /**
+         * This method returns a list of the names of attributes. 
+         * These attributes represent the experimental "value" of this
+         * parameter (rather than other attributes such as name or default
+         * values that represent the "template" part of the parameter. 
+         * This method is used for eg. clearing the value of a parameter by 
+         * setting all value attributes to null. 
+         */
         public abstract String[] getValueAttributes();
 
-        public abstract boolean isFieldFilled();
-
         /**
-         * A convenience method to test whether the attribute is included in
-         * the list of value attributes. 
+         * Unless specified by subclasses, parameter has no default values.
+         * If a list of default values is given, these should be given in the 
+         * same order as the value attributes to which they apply 
          * 
-         * @param attributeName         The name of the attribute to test. 
-         * @return              True if the attribute is a value attribute. 
+         * @see getValueAttributes();
          */
-        public boolean isValueAttribute(String attributeName) {
-                
-                if (attributeName == null) return false;
-                
-                String[] attributes = getValueAttributes();
-                for (int i=0; i<attributes.length; i++) {
-                        if (attributeName.equals(attributes[i]))
-                                return true;
-                }
-                return false;
+        public String[] getDefaultAttributes() {
+                return new String[] {};
         }
         
+        public abstract boolean isParamFilled();
+
+        
+        
         public String getFieldType() {
-                return fieldType;
+                return getAttribute(PARAM_TYPE);
         }
         

branches/OmeroEditor/src/fields/DateTimeParam.java

@@ -32 +32 @@
 
 /** 
- * 
+ * An experimental parameter that represents a Date (with optional Time).
+ * Also an optional Alarm time can be set (in seconds before 
+ * (negative value) or after the Date/Time).
  *
  * @author  William Moore     
@@ -42 +44 @@
  * @since OME3.0
  */
-public class DateTimeValueObject extends AbstractValueObject {
+public class DateTimeParam extends AbstractParam {
 
         public static final String DATE_ATTRIBUTE = DataFieldConstants.UTC_MILLISECS;
         
         public static final String TIME_ATTRIBUTE = DataFieldConstants.SECONDS;
+        
+        public static final String ALARM_SECONDS = DataFieldConstants.ALARM_SECONDS;
         
         /**
@@ -53 +57 @@
          * @param fieldType             The String defining the field type
          */
-        public DateTimeValueObject(String fieldType) {
+        public DateTimeParam(String fieldType) {
                 super(fieldType);
         }
@@ -64 +68 @@
                 
                 return new String[] {DATE_ATTRIBUTE, 
-                                TIME_ATTRIBUTE};
+                                TIME_ATTRIBUTE, ALARM_SECONDS};
         }
 
         /**
-         * This field is filled if the value isn't null, and 
+         * This field is filled if the DATE value isn't null, and 
          * is not an empty string. 
          */
-        public boolean isFieldFilled() {
-                String timeValue = getAttribute(getValueAttributes()[0]);
+        public boolean isParamFilled() {
+                String dateValue = getAttribute(DATE_ATTRIBUTE);
                 
-                return (timeValue != null && timeValue.length() > 0);
+                return (dateValue != null && dateValue.length() > 0);
         }
 

branches/OmeroEditor/src/fields/Field.java

@@ -24 +24 @@
 package fields;
 
+import java.util.ArrayList;
 import java.util.HashMap;
+import java.util.List;
 
 import tree.DataFieldConstants;
 
-
+/**
+ * 
+ * 
+ * @author  William Moore     
+ * <a href="mailto:will@lifesci.dundee.ac.uk">will@lifesci.dundee.ac.uk</a>
+ * @version 3.0
+ * <small>
+ * (<b>Internal version:</b> $Revision: $Date: $)
+ * </small>
+ * @since OME3.0
+ */
 public class Field 
         implements IField {
+        
+        public static final String FIELD_NAME = "fieldName";
+        
+        public static final String FIELD_DESCRIPTION = "fieldDescription";
+        
+        public static final String FIELD_URL = "fieldUrl";
+        
+        
+        private List<IParam> fieldParams;
 
         HashMap<String, String> allAttributesMap;
@@ -40 +61 @@
          * field. 
          */
-        private IFieldValue fieldValue;
+        //private IFieldValue fieldValue;
         
         public Field() {
-                this("untitled", null, DataFieldConstants.FIXED_PROTOCOL_STEP);
+                this("untitled");
         }
         
-        public Field(String name, String value, String fieldType) {
+        public Field(String name) {
                 
                 allAttributesMap = new HashMap<String, String>();
+                fieldParams = new ArrayList<IParam>();
                 
-                fieldValue = FieldValueFactory.getFieldValue(fieldType);
+                setAttribute(FIELD_NAME, name);
                 
-                setAttribute(DataFieldConstants.ELEMENT_NAME, name);
-                setAttribute(DataFieldConstants.VALUE, value);
         }
         
         public String getAttribute(String name) {
                 //System.out.println("Field getAttribute()");
-                if (fieldValue.isValueAttribute(name)) {
-                        return fieldValue.getAttribute(name);
-                }
                 
                 return allAttributesMap.get(name);
@@ -66 +83 @@
         
         public void setAttribute(String name, String value) {
-                System.out.println("Field setAttribute() " + name + " = " + value);
-                if (fieldValue.isValueAttribute(name)) {
-                        fieldValue.setAttribute(name, value);
-                }
+                
                 allAttributesMap.put(name, value);
         }
         
         public String toString() {
-                return getAttribute(DataFieldConstants.ELEMENT_NAME) + ": " + 
-                getAttribute(DataFieldConstants.VALUE);
+                return getAttribute(DataFieldConstants.ELEMENT_NAME);
         }
 
+        
         public boolean isAttributeTrue(String attributeName) {
                 String value = getAttribute(attributeName);
@@ -83 +97 @@
         }
         
-        public IFieldValue getValueObject() {
-                return fieldValue;
-        }
-        
-        /**
-         * Gets the names of the attributes where this field stores its "value"s.
-         * This is used eg. (if a single value is returned)
-         * as the destination to copy the default value when defaults are loaded.
-         * Also used by EditClearFields to set all values back to null. 
-         * This method delegates to the Value object for this field.
-         *  
-         * @return      the names of the attributes that holds the "value" of this field
-         */
-        public String[] getValueAttributes() {
-                return fieldValue.getValueAttributes();
-        }
+
         
         /**
@@ -113 +112 @@
          */
         public boolean isFieldFilled() {
-                return fieldValue.isFieldFilled();
+                
+                for (IParam param : fieldParams) {
+                        if (! param.isParamFilled()) {
+                                return false;
+                        }
+                }
+                return true;
+        }
+
+        public int getParamCount() {
+                return fieldParams.size();
+        }
+
+        public IParam getParamAt(int index) {
+                return fieldParams.get(index);
+        }
+
+        public void addParam(IParam param) {
+                fieldParams.add(param);
+        }
+
+        public boolean removeParam(IParam param) {
+                return fieldParams.remove(param);
         }
 }

branches/OmeroEditor/src/fields/FieldPanel.java

@@ -204 +204 @@
         Border imageBorderHighlight;
         
-        /**
-         * A flag used to toggle the display of the description. 
-         */
-        boolean showDescription = false;
-        
         
         /**
@@ -259 +254 @@
                 descriptionButton.addActionListener(new ActionListener(){
                         public void actionPerformed(ActionEvent event) {
-                                showDescription = !showDescription;
-                                descriptionLabel.setVisible(showDescription);
+                                // TODO
+                                // Need to set an attribute in the dataField such as 
+                                // descriptionVisible = true / false
                         }
                 });
@@ -326 +322 @@
                 horizontalBox.add(defaultButton);
                 horizontalBox.add(requiredFieldButton);
+                horizontalBox.add(descriptionLabel);
                 horizontalBox.add(Box.createHorizontalStrut(10));
                 
@@ -337 +334 @@
                 contentsPanel.add(nameLabel, BorderLayout.WEST);
                 contentsPanel.add(horizontalBox, BorderLayout.CENTER);
-                contentsPanel.add(descriptionLabel, BorderLayout.SOUTH);
+                //contentsPanel.add(descriptionLabel, BorderLayout.SOUTH);
                 
                 contentsPanel.setBorder(imageBorder);
@@ -349 +346 @@
                  */
                 setNameText(addHtmlTagsForNameLabel(
-                                dataField.getAttribute(DataFieldConstants.ELEMENT_NAME)));
+                                dataField.getAttribute(Field.FIELD_NAME)));
                 setDescriptionText(
-                                dataField.getAttribute(DataFieldConstants.DESCRIPTION));
-                setURL(dataField.getAttribute(DataFieldConstants.URL));
+                                dataField.getAttribute(Field.FIELD_DESCRIPTION));
+                setURL(dataField.getAttribute(Field.FIELD_URL));
                 
                 refreshBackgroundColour();
@@ -358 +355 @@
                 refreshDefaultValue();
                 
-                /*
-                 * Add additional UI components for editing the value of this field.
-                 * Use a Factory to create the UI components, depending on the value type
-                 */
-                IFieldValue valueObject = ((Field)field).getValueObject();
-                JComponent edit = EditingComponentFactory.getEditingComponent(valueObject);
-                addFieldComponent(edit);
+                buildParamComponents();
+        }
+        
+        /**
+         * Add additional UI components for editing the value of this field.
+         * Use a Factory to create the UI components, depending on the value type
+         */
+        public void buildParamComponents() {
+
+                int paramCount = dataField.getParamCount();
+                
+                for (int i=0; i<paramCount; i++) {
+                        IParam param = dataField.getParamAt(i);
+                        JComponent edit = EditingComponentFactory.getEditingComponent(param);
+                        if (edit != null)
+                                addFieldComponent(edit);
+                }
+                
         }
         
@@ -440 +448 @@
         }
         
+
+        
         public void setDescriptionText(String description) {
                 if ((description != null) && (description.trim().length() > 0)) {
@@ -445 +455 @@
                         descriptionButton.setToolTipText(htmlDescription);
                         descriptionButton.setVisible(true);
-                        descriptionLabel.setVisible(showDescription);
+                        // TODO setVisibility of label based on dataField attribute 
+                        //descriptionLabel.setVisible(showDescription);
                         descriptionLabel.setFont(XMLView.FONT_TINY);
                         descriptionLabel.setText(htmlDescription);
@@ -552 +563 @@
 
 
+        /**
+         * If the size of a sub-component of this panel changes, 
+         * the JTree in which it is contained must be required to 
+         * re-draw the panel. 
+         */
         public void propertyChange(PropertyChangeEvent evt) {
                 
                 if (SIZE_CHANGED_PROPERTY.equals(evt.getPropertyName())) {
                 
-                        if ((tree != null) && (treeNode !=null)) {
-                                
-                                TreePath path = new TreePath(treeNode.getPath());
-                                
-                                tree.getUI().startEditingAtPath(tree, path);
-                        }
-                }
-        }
-
+                        refreshSizeOfPanel();
+                }
+        }
+
+        
+        /**
+         * This method is used to refresh the size of this panel in the JTree.
+         * It must also remain in the editing mode, otherwise the user who
+         * is currently editing it will be required to click again to 
+         * continue editing.
+         * This can be achieved by calling startEditingAtPath(tree, path)
+         */
+        public void refreshSizeOfPanel() {
+                if ((tree != null) && (treeNode !=null)) {
+                        
+                        TreePath path = new TreePath(treeNode.getPath());
+                        
+                        tree.getUI().startEditingAtPath(tree, path);
+                }
+        }
         
 

branches/OmeroEditor/src/fields/FieldParamsFactory.java

@@ -23 +23 @@
 package fields;
 
-import tree.DataFieldConstants;
-import ui.fieldEditors.FieldEditorCheckBox;
-import ui.fieldEditors.FieldEditorCustom;
-import ui.fieldEditors.FieldEditorDate;
-import ui.fieldEditors.FieldEditorDateTime;
-import ui.fieldEditors.FieldEditorDropDown;
-import ui.fieldEditors.FieldEditorFixed;
-import ui.fieldEditors.FieldEditorMemo;
-import ui.fieldEditors.FieldEditorNumber;
-import ui.fieldEditors.FieldEditorOLS;
-import ui.fieldEditors.FieldEditorObservation;
-import ui.fieldEditors.FieldEditorProtocol;
-import ui.fieldEditors.FieldEditorTable;
-import ui.fieldEditors.FieldEditorText;
-import ui.fieldEditors.FieldEditorTime;
-
 //Java imports
 
@@ -44 +28 @@
 
 //Application-internal dependencies
+
+import tree.DataFieldConstants;
 
 /** 
@@ -56 +42 @@
  * @since OME3.0
  */
-public class FieldValueFactory {
+public class FieldParamsFactory {
         
-        public static IFieldValue getFieldValue(String inputType) {
+        public static IParam getFieldParam(String paramType) {
                 
-                IFieldValue fieldValue = null;
+                IParam fieldValue = null;
                 
-                if (inputType == null) {
-                        fieldValue = new NoValue(DataFieldConstants.FIXED_PROTOCOL_STEP);
+                if (paramType == null) {
+                        fieldValue = new NoParam(DataFieldConstants.FIXED_PROTOCOL_STEP);
                 }
-                else if (inputType.equals(DataFieldConstants.TEXT_ENTRY_STEP)) {
-                        fieldValue = new TextValueObject(DataFieldConstants.TEXT_ENTRY_STEP);
+                else if (paramType.equals(DataFieldConstants.TEXT_ENTRY_STEP)) {
+                        fieldValue = new SingleParam(DataFieldConstants.TEXT_ENTRY_STEP);
                 }
-                else if (inputType.equals(DataFieldConstants.FIXED_PROTOCOL_STEP)) {
-                        fieldValue = new NoValue(DataFieldConstants.FIXED_PROTOCOL_STEP);
+                else if (paramType.equals(DataFieldConstants.FIXED_PROTOCOL_STEP)) {
+                        fieldValue = new NoParam(DataFieldConstants.FIXED_PROTOCOL_STEP);
                 }
-                else if (inputType.equals(DataFieldConstants.DATE_TIME_FIELD)) {
-                        fieldValue = new DateTimeValueObject(DataFieldConstants.DATE_TIME_FIELD);
+                else if (paramType.equals(DataFieldConstants.DATE_TIME_FIELD)) {
+                        fieldValue = new DateTimeParam(DataFieldConstants.DATE_TIME_FIELD);
                 }
                 

branches/OmeroEditor/src/fields/IField.java

@@ -30 +30 @@
 
 /** 
- * This interface specifies the minimum methods needed to save and 
- * retrieve data. 
- * It also has a convenience method for querying boolean attributes. 
+ * This interface specifies methods of a Field, which corresponds to a node