Changeset 5105

Timestamp:

2003-08-07T12:18:41+12:00 (21 years ago)

Author:

mdewsnip

Message:

Added some comments so I might understand this when I look at it next.

File:

• trunk/gli/src/org/greenstone/gatherer/valuetree/GValueTree.java (modified) (1 diff)

trunk/gli/src/org/greenstone/gatherer/valuetree/GValueTree.java

@@ -73 +73 @@
 
 
+    /**
+     * This class is a little bit complex, a little bit subtle, and a little bit odd.
+     * The strange interaction model is due to the fact that it is very tightly
+     * coupled to the MetaEditPane.
+     *
+     * The interaction is complex because there are three separate controls that the
+     * user may interact with, each of which can affect the other two. The three
+     * controls are:
+     *   - The "assigned metadata" table, at the top right of the meta edit pane.
+     *   - The "metadata value" text field, where users can type in new values.
+     *   - The "metadata value tree", which shows other values that have been
+     *     assigned to the selected metadata element.
+     *
+     * The interactions are:
+     *   - The "assigned metadata" table
+     *     Users may select one (and only one) row in this table. Selecting a row
+     *     chooses one metadata element. The text field will be set to the current
+     *     value of the metadata element. This value will also be selected in the
+     *     metadata value tree.
+     *
+     *   - The "metadata value" text field
+     *     If the value the user has typed in this is a prefix of an entry in the
+     *     value tree, this value will be selected in the value tree. In this case,
+     *     pressing "Enter" will complete the value (ie. make the value in the text
+     *     field the same as the value in the tree). This is to allow users to
+     *     quickly and easily assign existing metadata values to new documents.
+     *
+     *   - The "metadata value tree"
+     *     Selecting a value in the tree will set the text field to this value.
+     */
     public GValueTree(MetaEditPane metaedit, int width, int height, JButton add, JButton update, JButton remove, JButton expand) {
     super();