Changeset 67 for trunk/src/org/expeditee/gui/Frame.java

Timestamp:

05/19/08 12:03:18 (16 years ago)

Author:

ra33

Message:

Fixed a bunch of problems with rectangles and resizing the window, as well as adding some more unit tests etc.

File:

• trunk/src/org/expeditee/gui/Frame.java (modified) (28 diffs)

trunk/src/org/expeditee/gui/Frame.java

@@ -41 +41 @@
 
         // The various attributes of this Frame
-        /**
-         * TODO: Change these to non-string attributes (where applicable). All
-         * processing to\from Java types should be done in KMSReader and KMSWriter.
-         */
         private String _frameset = null;
 
         private int _number = -1;
 
-        private int _version = 1;
-
-        private int _fversion = -1;
+        private int _version = 0;
 
         private String _protection = null;
@@ -90 +84 @@
 
         public static List<Item> FreeItems = new ArrayList<Item>();
-        
+
         // for drawing purposes
         private List<InteractiveWidget> _iWidgets = new ArrayList<InteractiveWidget>();
@@ -101 +95 @@
         private Text _frameName = null;
 
-        // private Text _template = UserSettings.ItemTemplate.copy();
-
         private List<Overlay> _overlays = new ArrayList<Overlay>();
 
@@ -122 +114 @@
         public void setBuffer(VolatileImage newBuffer) {
                 _buffer = newBuffer;
-                // setBufferValid(true);
         }
 
         public boolean isBufferValid() {
-                if (_buffer != null && _buffer.contentsLost())
+                if (_buffer == null || _buffer.contentsLost())
                         return false;
 
@@ -132 +123 @@
         }
 
-        public void setBufferValid(boolean newValue) {
+        private void setBufferValid(boolean newValue) {
                 _validBuffer = newValue;
         }
@@ -147 +138 @@
                                 i.setID(++_lineCount);
         }
-        
+
         /**
          * 
          * @return The interactive widgets that are currently ancored in this frame.
-         * Hence it exlcudes free-widgets. Returns a copy
+         *         Hence it exlcudes free-widgets. Returns a copy
          */
         public List<InteractiveWidget> getInteractiveWidgets() {
@@ -181 +172 @@
                 _change = value;
 
-                if (_change){
+                if (_change) {
                         setBufferValid(false);
                         _saved = false;
@@ -204 +195 @@
                         _sorted = true;
                 }
-                
+
                 List<Item> visibleItems = new ArrayList<Item>();
-                
-                for(Item i: _body) {
+
+                for (Item i : _body) {
                         if (i.isVisible())
                                 visibleItems.add(i);
                 }
-                
+
                 return visibleItems;
         }
-        
-        /**
-         * @param i Item to check if contained in this frame
+
+        /**
+         * @param i
+         *            Item to check if contained in this frame
          * @return True if this frame contains i.
          */
         public boolean containsItem(Item i) {
-                if (i == null) throw new NullPointerException("i"); 
+                if (i == null)
+                        throw new NullPointerException("i");
                 return _body.contains(i);
         }
@@ -234 +227 @@
                 for (Item i : getItems()) {
                         // only add up normal body text items
-                        if ((i instanceof Text) && 
-                                        (includeAnnotations || !i.isAnnotation())) {
+                        if ((i instanceof Text)
+                                        && (includeAnnotations || !i.isAnnotation())) {
                                 bodyTextItems.add((Text) i);
                         }
@@ -241 +234 @@
                 bodyTextItems.remove(getTitle());
 
-                return bodyTextItems;           
+                return bodyTextItems;
         }
 
@@ -316 +309 @@
                                 frameTitle.stripFirstWord();
                 }
-                //TODO Widgets... check this out
-                // Brook: Cannot figure what is going on above... widget  annot titles should be stripped always
-                if (ItemUtils.isTag(frameTitle, ItemUtils.GetTag(ItemUtils.TAG_IWIDGET))) {
+                // TODO Widgets... check this out
+                // Brook: Cannot figure what is going on above... widget annot titles
+                // should be stripped always
+                if (ItemUtils
+                                .isTag(frameTitle, ItemUtils.GetTag(ItemUtils.TAG_IWIDGET))) {
                         frameTitle.stripFirstWord();
                 }
@@ -425 +420 @@
 
                 for (Item i : _body)
-                        if (i.isVisible() /*&& i != _frameName*/ && i.intersects(poly)) {
+                        if (i.isVisible() /* && i != _frameName */&& i.intersects(poly)) {
                                 if (!results.contains(i))
                                         results.add(i);
@@ -462 +457 @@
          */
         public void setFrameNumber(int number) {
+                assert (number >= 0);
+
+                if (_number == number)
+                        return;
+
                 _number = number;
                 boolean oldchange = _change;
@@ -469 +469 @@
                 if (_frameName != null) {
                         id = _frameName.getID();
-                } else{
+                } else {
                         id = -1 * getNextItemID();
                 }
@@ -493 +493 @@
 
         /**
-         * Sets the version of this Frame to the given String.
+         * Increments the version of this Frame to the given String.
          * 
          * @param version
@@ -500 +500 @@
         public void setVersion(int version) {
                 _version = version;
-        }
-
-        /**
-         * Sets the format version of this Frame to the given String.
-         * 
-         * @param version
-         *            The format version to use for this Frame.
-         */
-        public void setFormatVersion(int version) {
-                _fversion = version;
         }
 
@@ -593 +583 @@
                 if (item != null) {
                         if (_body.contains(item)) {
-                                //System.out.println("Item (" + item.getClass().getSimpleName()
-                                //              + ") with ID " + item.getID() + " already in body.");
+                                // System.out.println("Item (" + item.getClass().getSimpleName()
+                                // + ") with ID " + item.getID() + " already in body.");
                                 return;
                         }
@@ -600 +590 @@
                         if (item instanceof Line)
                                 _lineCount++;
-                        
+
                         _itemCount = Math.max(_itemCount, item.getID());
 
@@ -609 +599 @@
 
                         item.setMaxSize(FrameGraphics.getMaxFrameSize());
-                        //add widget items to the list of widgets
+                        // add widget items to the list of widgets
                         if (item instanceof WidgetCorner) {
-                                InteractiveWidget iw = ((WidgetCorner)item).getWidgetSource();
-                                if (!this._iWidgets.contains(iw)) { // A set would have been best
-                                        _iWidgets.add(iw); 
+                                InteractiveWidget iw = ((WidgetCorner) item).getWidgetSource();
+                                if (!this._iWidgets.contains(iw)) { // A set would have been
+                                                                                                        // best
+                                        _iWidgets.add(iw);
                                 }
                         }
-                        
-                        item.onParentStateChanged(new ItemParentStateChangedEvent(
-                                        this, ItemParentStateChangedEvent.EVENT_TYPE_ADDED));
+
+                        item.onParentStateChanged(new ItemParentStateChangedEvent(this,
+                                        ItemParentStateChangedEvent.EVENT_TYPE_ADDED));
 
                         change();
@@ -648 +639 @@
 
         public void removeItem(Item item) {
-                if (_body.remove(item))
+                if (_body.remove(item)) {
                         change();
-                
-                // Remove widgets from the widget list
-                if (item != null) {
-                        item.onParentStateChanged(new ItemParentStateChangedEvent(
-                                        this, ItemParentStateChangedEvent.EVENT_TYPE_REMOVED));
-                        if (item instanceof WidgetCorner) {
-                                _iWidgets.remove(((WidgetCorner)item).getWidgetSource()); 
-                        }
-                }
-                
+                        // Remove widgets from the widget list
+                        if (item != null) {
+                                item.onParentStateChanged(new ItemParentStateChangedEvent(this,
+                                                ItemParentStateChangedEvent.EVENT_TYPE_REMOVED));
+                                if (item instanceof WidgetCorner) {
+                                        _iWidgets.remove(((WidgetCorner) item).getWidgetSource());
+                                }
+                        }
+                }
         }
 
@@ -760 +750 @@
          * @return The version of this Frame.
          */
+        public int getVersion(boolean increment) {
+                // System.out.println("Version: " + _version);
+                if (increment)
+                        _version++;
+                return _version;
+        }
+
         public int getVersion() {
-                return _version;
-        }
-
-        public int getFormatVersion() {
-                return _fversion;
+                return getVersion(true);
         }
 
@@ -843 +836 @@
                 s += "Name: " + _frameset + _number + "\n";
                 s += "Version: " + _version + "\n";
-                s += "Format Version: " + _fversion + "\n";
                 s += "Protection: " + _protection + "\n";
                 s += "Owner: " + _owner + "\n";
@@ -935 +927 @@
          * @param overlay
          *            The Frame to add
-         *            
+         * 
          * @throws NullPointerException
-         *            If overlay is null.
+         *             If overlay is null.
          */
         public void addOverlay(Overlay overlay) {
-                if (overlay == null) throw new NullPointerException("overlay");
-                if (_overlays.contains(overlay)) return;
-                
+                if (overlay == null)
+                        throw new NullPointerException("overlay");
+                // make sure we dont add this frame as an overlay of itself
+                if (overlay.Frame == this)
+                        return;
+
+                if (_overlays.contains(overlay))
+                        return;
+
                 _overlays.add(overlay);
-                
-                // Items must be notified that they have been added to this frame via the overlay...
+
+                // Items must be notified that they have been added to this frame via
+                // the overlay...
                 List<Item> items = new LinkedList<Item>();
-                FrameGraphics.AddAllOverlayItems(items, overlay.Frame, new LinkedList<Frame>());
+                FrameGraphics.AddAllOverlayItems(items, overlay.Frame,
+                                new LinkedList<Frame>());
                 for (Item i : items) {
-                        i.onParentStateChanged(new ItemParentStateChangedEvent(
-                                        this, 
-                                        ItemParentStateChangedEvent.EVENT_TYPE_ADDED_VIA_OVERLAY, 
+                        i.onParentStateChanged(new ItemParentStateChangedEvent(this,
+                                        ItemParentStateChangedEvent.EVENT_TYPE_ADDED_VIA_OVERLAY,
                                         overlay.Level));
                 }
@@ -957 +956 @@
 
         /**
-         * Removes the given overlay from the list of overlays being drawn with this Frame.
+         * Removes the given overlay from the list of overlays being drawn with this
+         * Frame.
          * 
          * @param overlay
          *            The overlay to remove
-         *            
+         * 
          * @throws NullPointerException
-         *            If overlay is null.
+         *             If overlay is null.
          */
         public void removeOverlay(Overlay overlay) {
-                if (overlay == null) throw new NullPointerException("overlay");
-        
+                if (overlay == null)
+                        throw new NullPointerException("overlay");
+
                 this._overlays.remove(overlay);
-                
-                // Items must be notified that they have been removed from this frame via the overlay...
+
+                // Items must be notified that they have been removed from this frame
+                // via the overlay...
                 List<Item> items = new LinkedList<Item>();
-                FrameGraphics.AddAllOverlayItems(items, overlay.Frame, new LinkedList<Frame>());
+                FrameGraphics.AddAllOverlayItems(items, overlay.Frame,
+                                new LinkedList<Frame>());
                 for (Item i : items) {
-                        i.onParentStateChanged(new ItemParentStateChangedEvent(
-                                        this, 
-                                        ItemParentStateChangedEvent.EVENT_TYPE_REMOVED_VIA_OVERLAY, 
+                        i.onParentStateChanged(new ItemParentStateChangedEvent(this,
+                                        ItemParentStateChangedEvent.EVENT_TYPE_REMOVED_VIA_OVERLAY,
                                         overlay.Level));
                 }
         }
-        
-        /**
-         * Removes the given Frame from the list of overlayed Frames being drawn with
-         * this Frame.
+
+        /**
+         * Removes the given Frame from the list of overlayed Frames being drawn
+         * with this Frame.
          * 
          * @param overlayedFrame
          *            The Frame to remove
-         *            
+         * 
          * @throws NullPointerException
-         *            If overlayedFrame is null.
+         *             If overlayedFrame is null.
          */
         public void removeOverlay(Frame overlayedFrame) {
-                if (overlayedFrame == null) throw new NullPointerException("overlay");
-                
+                if (overlayedFrame == null)
+                        throw new NullPointerException("overlay");
+
                 // Locate the oveylay(s) that match this
                 List<Overlay> overlaysToRemove = new LinkedList<Overlay>();
                 for (Overlay o : _overlays) {
-                        if (overlayedFrame.equals(o.Frame)) overlaysToRemove.add(o);
-                }
-                for (Overlay o : overlaysToRemove) { // must be enumerated seperate to above...
+                        if (overlayedFrame.equals(o.Frame))
+                                overlaysToRemove.add(o);
+                }
+                for (Overlay o : overlaysToRemove) { // must be enumerated seperate
+                                                                                                // to above...
                         removeOverlay(o);
                 }
-                
+
         }
 
@@ -1010 +1015 @@
                 return l;
         }
-        
-        /**
-         * @return All overlays seen by this frame (including its overlays' overlays).
+
+        /**
+         * @return All overlays seen by this frame (including its overlays'
+         *         overlays).
          */
         public List<Overlay> getOverlaysDeep() {
@@ -1019 +1025 @@
                 return l;
         }
-        
-        private boolean getOverlaysDeep(List<Overlay> overlays, Frame overlay, List<Frame> seenOverlays) {
-
-                        if (seenOverlays.contains(overlay))
-                                return false;
-
-                        seenOverlays.add(overlay);
-
-                        for (Overlay o : overlay.getOverlays()) {
-                                if (getOverlaysDeep(overlays, o.Frame, seenOverlays)) {
-                                        overlays.add(o);
-                                }
-                        }
-                        
-                        return true;
-        }
-        
+
+        private boolean getOverlaysDeep(List<Overlay> overlays, Frame overlay,
+                        List<Frame> seenOverlays) {
+
+                if (seenOverlays.contains(overlay))
+                        return false;
+
+                seenOverlays.add(overlay);
+
+                for (Overlay o : overlay.getOverlays()) {
+                        if (getOverlaysDeep(overlays, o.Frame, seenOverlays)) {
+                                overlays.add(o);
+                        }
+                }
+
+                return true;
+        }
+
         /**
          * Gets the overlay on this frame which owns the given item.
-         * @param item The item - must not be null.
-         * @return The overlay that contains the itm. Null if no overlay owns the item.
+         * 
+         * @param item
+         *            The item - must not be null.
+         * @return The overlay that contains the itm. Null if no overlay owns the
+         *         item.
          */
         public Overlay getOverlayOwner(Item item) {
-                if (item == null) throw new NullPointerException("item");
+                if (item == null)
+                        throw new NullPointerException("item");
                 List<Overlay> overlays = getOverlaysDeep();
                 for (Overlay l : overlays) {
-                        //if (l.Frame.containsItem(item)) return l;
-                        if (item.getParent() == l.Frame) return l;
-                }
-                
+                        // if (l.Frame.containsItem(item)) return l;
+                        if (item.getParent() == l.Frame)
+                                return l;
+                }
+
                 return null;
         }
@@ -1089 +1101 @@
                 List<Item> copies = ItemUtils.CopyItems(toMergeWith.getItems());
                 copies.remove(toMergeWith.getFrameNameItem());
-                
+
                 for (Item i : copies) {
                         if (i.getID() >= 0) {
@@ -1143 +1155 @@
         /**
          * Creates a new text item with the given text.
+         * 
          * @param text
          * @return