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

Timestamp:

10/02/19 14:19:48 (5 years ago)

Author:

bln4

Message:

Implementation of ProfileManager. Refactor + additional content for how new profiles are created. The refactoring split out the creation of the default profile from user profiles. Refactoring revealed a long term bug that was causing user profiles to generate with incorrect information. The additional content fixed this bug by introducing the ${USER.NAME} variable, so that the default profile frameset can specify resource locations located in the users resource directory.

org.expeditee.auth.AuthenticatorBrowser
org.expeditee.auth.account.Create
org.expeditee.gui.Browser
org.expeditee.gui.management.ProfileManager
org.expeditee.setting.DirectoryListSetting
org.expeditee.setting.ListSetting
org.expeditee.settings.UserSettings

Implementation of ResourceManager as a core location to get resources from the file system. Also the additional variable ${CURRENT_FRAMESET} to represent the current frameset, so that images can be stored in the directory of the current frameset. This increases portability of framesets.

org.expeditee.gui.FrameIO
org.expeditee.gui.management.ResourceManager
org.expeditee.gui.management.ResourceUtil
Audio:

#NB: Audio used to only operate on a single directory. This has been updated to work in a same way as images. That is: when you ask for a specific resouce, it looks to the user settings to find a sequence of directories to look at in order until it manages to find the desired resource.

There is still need however for a single(ish) source of truth for the .banks and .mastermix file. Therefore these files are now always located in resource-<username>\audio.
org.apollo.agents.MelodySearch
org.apollo.audio.structure.AudioStructureModel
org.apollo.audio.util.MultiTrackPlaybackController
org.apollo.audio.util.SoundDesk
org.apollo.gui.FrameLayoutDaemon
org.apollo.io.AudioPathManager
org.apollo.util.AudioPurger
org.apollo.widgets.FramePlayer
org.apollo.widgets.SampledTrack

Images:

org.expeditee.items.ItemUtils

Frames:

org.expeditee.gui.FrameIO

Fixed a error in the FramePlayer class caused by an incorrect use of toArray().

org.apollo.widgets.FramePlayer

Added several short cut keys to allow for the Play/Pause (Ctrl + P), mute (Ctrl + M) and volume up/down (Ctrl + +/-) when hovering over SampledTrack widgets.

org.apollo.widgets.SampledTrack

Changed the way that Authenticate.login parses the new users profile to be more consistance with other similar places in code.

org.expeditee.auth.account.Authenticate

Encapsulated _body, _surrogateItemsBody and _primaryItemsBody in Frame class. Also changed getBody function to take a boolean flag as to if it should respect the current surrogate mode. If it should then it makes sure that labels have not changed since last time getBody was called.

org.expeditee.gui.Frame

File:

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

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

@@ -20 +20 @@
 
 import java.io.File;
+import java.nio.file.Paths;
 import java.sql.Time;
 import java.util.ArrayList;
@@ -41 +42 @@
 import org.expeditee.core.bounds.PolygonBounds;
 import org.expeditee.encryption.items.EncryptionPermissionTriple;
+import org.expeditee.encryption.items.surrogates.Label;
 import org.expeditee.gio.EcosystemManager;
 import org.expeditee.gio.gesture.Gesture;
@@ -190 +192 @@
         private String _groupFrameName;
         private Frame _groupFrame = null;
+
+        private List<String> labelsOnLastBodySet;
         
         public enum BodyType {
@@ -353 +357 @@
          */
         public List<Item> getSortedItems(boolean requireVisible) {
-                ItemsList listToLoopOver = _body;
+                ItemsList listToLoopOver = getBody(true);
                 listToLoopOver.sort();
                 return getItems(requireVisible, listToLoopOver);
@@ -389 +393 @@
                         throw new NullPointerException("i");
                 }       
-                return _body.contains(i);
+                return getBody(true).contains(i);
         }
 
@@ -404 +408 @@
          * @return the list of body text items.
          */
-        public List<Text> getBodyTextItems(boolean includeAnnotations)
-        {
+        public List<Text> getBodyTextItems(boolean includeAnnotations) {
+                ensureBody();
+                
                 List<Text> bodyTextItems = new ArrayList<Text>();
                 
@@ -467 +472 @@
          *         found.
          */
-        public Item getItemWithID(int id)
-        {
-                for (Item i : _body) {
+        public Item getItemWithID(int id) {
+                for (Item i : getAllFrameItemsRaw()) {
                         if (i.getID() == id) {
                                 return i;
@@ -761 +765 @@
                 _permissionTriple = new PermissionTriple(permission);
 
-                if (_body.size() > 0) {
+                if (getBody(false).size() > 0) {
                         refreshItemPermissions(permission.getPermission(_owner, groupMembers));
                 }
@@ -787 +791 @@
                 _creationDate = date;
                 _modifiedDate = date;
-                for (Item i : _body) {
+                for (Item i : getAllFrameItemsRaw()) {
                         i.setDateCreated(date);
                 }
@@ -855 +859 @@
 
         public void invalidateSorted() {
-                _body.invalidateSorted();
+                getBody(false).invalidateSorted();
         }
 
@@ -871 +875 @@
                 if (item == null) { return; }
                 
-                addItem(item, recalculate, _body);
+                addItem(item, recalculate, getBody(false));
                 if (item.isSurrogate()) {
-                        addItem(item, recalculate, _surrogateItemsBody);
+                        addItem(item, recalculate, getSurrogateBody());
                 } else {
-                        addItem(item, recalculate, _primaryItemsBody);
+                        addItem(item, recalculate, getPrimaryBody());
                 }
         }
@@ -988 +992 @@
 
         public void addAllItems(Collection<Item> toAdd) {
-                addAllItems(toAdd, _body);
-                addAllItems(toAdd, _primaryItemsBody);
+                addAllItems(toAdd, getBody(false));
+                addAllItems(toAdd, getPrimaryBody());
         }
         
@@ -1018 +1022 @@
 
         public void removeItem(Item item, boolean recalculate) {
-                removeItem(item, recalculate, _body);
+                removeItem(item, recalculate, getBody(false));
                 if (item.isSurrogate()) {
-                        removeItem(item, recalculate, _surrogateItemsBody);
+                        removeItem(item, recalculate, getSurrogateBody());
                         Set<Item> primariesSurrogates = item.getPrimary().getSurrogates();
                         primariesSurrogates.remove(item);
                 } else {
-                        removeItem(item, recalculate, _primaryItemsBody);
+                        removeItem(item, recalculate, getPrimaryBody());
                 }
         }
@@ -1075 +1079 @@
         }
 
-        public void undo()
-        {
-                boolean bReparse = false;
-                boolean bRecalculate = false;
+        public void undo() {
+                boolean reparse = false;
+                boolean recalculate = false;
 
                 if (_undo.size() <= 0) {
@@ -1092 +1095 @@
                         _redo.push(undo);
                 for(Item i : undo.items) {
-                        _body.add(i);
-                                bReparse |= i.hasOverlay();
-                                bRecalculate |= i.recalculateWhenChanged();
+                        this.addItem(i);
+                                reparse |= i.hasOverlay();
+                                recalculate |= i.recalculateWhenChanged();
                                 if (i instanceof Line) {
                                         Line line = (Line) i;
@@ -1105 +1108 @@
                 break;
                 case movement:
-                        ItemsList changed = new ItemsList(_body);
-                        changed.retainHistory(undo.items);
+                        ItemsList body = getBody(true);
+                        ItemsList changed = new ItemsList(body);
+                        changed.retainAll(undo.items);
                         _redo.push(new History(changed, History.Type.movement));
                         for(Item i : undo.items) {
                                 int index;
-                                if(i.isVisible() && (index = _body.indexOf(i)) != -1) {
-                                        _body.set(index, i);
+                                if(i.isVisible() && (index = body.indexOf(i)) != -1) {
+                                        body.set(index, i);
                                 }
                 }
@@ -1121 +1125 @@
                 StandardGestureActions.refreshHighlights();
                 
-                if (bReparse) {
+                if (reparse) {
                         FrameUtils.Parse(this, false, false);
                 } else {
-                        notifyObservers(bRecalculate);
+                        notifyObservers(recalculate);
                 }
                 
@@ -1152 +1156 @@
                         _undo.push(redo);
                 for(Item i : redo.items) {
-                        _body.remove(i);
+                        this.removeItem(i);
+                        //_body.remove(i);
                                 bReparse |= i.hasOverlay();
                                 bRecalculate |= i.recalculateWhenChanged();
@@ -1165 +1170 @@
                 break;
                 case movement:
-                        ItemsList changed = new ItemsList(_body);
-                        changed.retainHistory(redo.items);
+                        ItemsList body = getBody(true);
+                        ItemsList changed = new ItemsList(body);
+                        changed.retainAll(redo.items);
                         _undo.push(new History(changed, History.Type.movement));
                         for(Item i : redo.items) {
                                 int index;
-                                if(i.isVisible() && (index = _body.indexOf(i)) != -1) {
-                                        _body.set(index, i);
+                                if(i.isVisible() && (index = body.indexOf(i)) != -1) {
+                                        body.set(index, i);
                                 }
                 }
@@ -1335 +1341 @@
                 // s.append(String.format("Last Mod. User: %s%n", _modifiedUser));
                 // s.append(String.format("Last Mod. Date: %s%n", _modifiedDate));
-                s.append(String.format("Items: %d%n", _body.size()));
+                s.append(String.format("Items: %d%n", getAllFrameItemsRaw().size()));
                 return s.toString();
         }
@@ -1379 +1385 @@
         {
                 // Check that this item is on the current frame
-                if (!_body.contains(from)) {
+                if (!getBody(true).contains(from)) {
                         return null;
                 }
@@ -1789 +1795 @@
          * Removes all non-title non-annotation items from this Frame. All removed
          * items are added to the backup-stack.
-         */
-        public void clear(boolean keepAnnotations)
+         */ 
+        @Deprecated
+        public void clearDeprecated(boolean keepAnnotations)
         {
                 ItemsList newBody = new ItemsList();
@@ -1814 +1821 @@
                 change();
 
+                if (!keepAnnotations && _annotations != null) {
+                        _annotations.clear();
+                }
+        }
+        
+        /**
+         * Removes all items from the Frame except the Title Item and optionally the annotations.
+         * All removed items are added to the backup-stack.
+         * 
+         * @param keepAnnotations true is annotations are not to be removed from the frame.
+         */
+        public void clear(boolean keepAnnotations) {
+                ItemsList body = getBody(true);
+                ItemsList deleted = new ItemsList();
+                
+                for (Item bodyItem: body) {
+                        boolean isAnnotationToKeep = bodyItem.isAnnotation() && keepAnnotations;
+                        boolean isFrameTitle = bodyItem.isFrameTitle();
+                        boolean isToBeRetained = isFrameTitle || isAnnotationToKeep;
+                        if (isToBeRetained) {
+                                continue;
+                        }
+                        
+                        this.removeItem(bodyItem);
+                        deleted.add(bodyItem);
+                }
+                
+                addToUndoDelete(deleted);
+                change();
+                
                 if (!keepAnnotations && _annotations != null) {
                         _annotations.clear();
@@ -1950 +1987 @@
          */
         public String getFramesetPath() {
-                return this.getPath() + File.separator + this.getFramesetName() + File.separator;
+                return Paths.get(this.getPath()).resolve(this.getFramesetName()).toString() + File.separator;
         }
 
@@ -2290 +2327 @@
 
                 for (Overlay o : getOverlays()) {
-                        for(Item i : o.Frame._body) {
+                        for(Item i : o.Frame.getBody(false)) {
                                 i.setOverlayPermission(o.permission);
                         }
@@ -2568 +2605 @@
         }
         
+        /**
+         * Returns a list of items for the specified BodyType.
+         * 
+         * Asking for the primary or surrogate items gives you exactly those.
+         * 
+         * Asking for the body items is a weird case because the body list is
+         * transitory.  Therefore, when asking for the body items, this
+         * function assumes that you want all items, reguardless of if they
+         * are primaries or surrogates.  As of 20/08/2019, there are no places
+         * in the code that asks for the body items to save.
+         * @param type
+         * @return
+         */
         public List<Item> getItemsToSave(BodyType type) {
                 assert(!type.equals(BodyType.BodyDisplay));
@@ -2574 +2624 @@
                         return getItemsToSave(_surrogateItemsBody);
                 case BodyDisplay:
-                        return getItemsToSave(_body);
+                        return getItemsToSave(new ItemsList(getAllFrameItemsRaw()));
                 case PrimaryBody:
                 default:
@@ -2632 +2682 @@
 
         public Collection<Item> getAllItems() {
-                ItemsList allItems = new ItemsList(_body);
+                ItemsList allItems = new ItemsList(getBody(true));
                 
                 allItems.addAll(_overlayItems);
@@ -2721 +2771 @@
         }
 
-        public void dispose()
-        {
+        @Deprecated
+        public void disposeDeprecated() {
                 clearObservers();
                 
@@ -2732 +2782 @@
                 _body = null;
                 _frameName = null;
+        }
+        
+        /**
+         * Disposes off all references associated with this frame.  
+         * This operation is NOT REVERSEABLE through the history.
+         */
+        public void dispose() {
+                clearObservers();
+                
+                List<Item> allFrameItems = getAllFrameItemsRaw();
+                
+                for (Item i: allFrameItems) {
+                        i.dispose();
+                }
+
+                _frameName.dispose();
+                _frameName = null;
+                getBody(false).clear();
+                getPrimaryBody().clear();
+                getSurrogateBody().clear();
         }
 
@@ -2800 +2870 @@
         
         public void moveItemToBodyHiddenDueToPermission(final Item i) {
-                _body.remove(i);
+                getBody(true).remove(i);
                 _bodyHiddenDueToPermissions.add(i);
         }
@@ -2808 +2878 @@
                         _bodyHiddenDueToPermissions.remove(i);
                         i.setPermission(newPermission);
-                        _body.add(i);
+                        getBody(true).add(i);
                 }
         }
@@ -2821 +2891 @@
                 }
 
-                for (Item i : _body) {
+                for (Item i : getBody(false)) {
                         if (i == null) {
                                 continue;
@@ -2950 +3020 @@
         }
 
-        public ItemsList getBody() {
+        public ItemsList getBody(boolean respectSurrogateMode) {
+                if (respectSurrogateMode) { ensureBody(); }             
                 return _body;
         }
+
+        private void ensureBody() {
+                List<String> accessibleLabelsNames = Label.getAccessibleLabelsNames(getPrimaryBody());
+                if (!accessibleLabelsNames.equals(labelsOnLastBodySet)) {
+                        this.parse();
+                }
+        }
+        
+        protected void setBody(List<Item> newBody, List<String> labelsOnSet) {
+                _body.clear();
+                _body.addAll(newBody);
+                this.labelsOnLastBodySet = labelsOnSet;
+        }
+        
         protected ItemsList getPrimaryBody() {
                 return _primaryItemsBody;
@@ -2959 +3044 @@
                 return _surrogateItemsBody;
         }
+        
+
+        /**
+         * Gets all the items on the frame, regardless of whether they are primary or surrogate items.
+         * 
+         * Bryce says: This function will likely only ever be used inside Frame itself, as callers from
+         * outside Frame should care about what the state of the Frame.
+         * @return
+         */
+        private List<Item> getAllFrameItemsRaw() {
+                Collection<Item> primaries = getPrimaryBody().underlying();
+                Collection<Item> surrogateBody = getSurrogateBody().underlying();
+                primaries.addAll(surrogateBody);
+                List<Item> allFrameItems = primaries.stream().distinct().collect(Collectors.toList());
+                return allFrameItems;
+        }
 }