Changeset 877 for trunk/src/org/expeditee/actions

Timestamp:

02/11/14 01:27:13 (10 years ago)

Author:

ngw8

Message:

Updating the design of the Exploratory Search overlays, along with a few related fixes.

Added the FontAwesome font (used for the ES Back/Forward/Home buttons). Copying and pasting the symbol characters from ​http://fortawesome.github.io/Font-Awesome/cheatsheet/ to an Expeditee text item with "family: fontawesome" set is the easiest way to use it.

Added image-based buttons with icons for the main Exploratory Search actions. The label part of the buttons are still Expeditee text, but I wasn't able to simply use FontAwesome text items for the icon part, as this meant hovering over a button gave two distinct clickable regions (even when the text and the icon were positioned at the same coord, unless the icon item was loaded to the frame's list of items after the label), which seemed like it might be confusing to the user. Instead the icons are just part of the bitmaps, so it's a little harder to change the icon (setting the icon as a layer mask on the base button image in GIMP or Photoshop is the best way).

Changed the JFXBrowser initialization code so that the initial URL (grabbed from the text item source) is passed through the navigate() method, so search queries or URLs without a protocol can be used as the intial value.

Modified ExploratorySearchActions so that the startBrowserSession() action can be called from items that aren't text (needed so that it could be used on the image buttons). Also changed it so that the widget itself isn't created when the action is run, just its source text item, since the widget gets created automatically when the new frame is opened (and creating it in the action causes some issues with loading the initial page).

With the updated overlays, you'll need to re-copy the resources folder across to your local .expeditee folder.
I haven't changed the positioning of the @ao and @old tags in the ES stuff, so that might need to be adjusted.

File:

• trunk/src/org/expeditee/actions/ExploratorySearchActions.java (modified) (4 diffs)

trunk/src/org/expeditee/actions/ExploratorySearchActions.java

@@ -7 +7 @@
 import org.expeditee.gui.FrameMouseActions;
 import org.expeditee.gui.FreeItems;
-import org.expeditee.gui.MessageBay;
 import org.expeditee.items.Item;
 import org.expeditee.items.Text;
-import org.expeditee.items.widgets.InteractiveWidget;
-import org.expeditee.items.widgets.JfxBrowser;
 import org.expeditee.settings.exploratorysearch.ExploratorySearchSettings;
 import org.expeditee.settings.network.NetworkSettings;
@@ -23 +20 @@
         /**
          * Adds a text item to the cursor which is linked to a new frame with the web browser active overlay and a JavaFX browser.
-         * @param text The text item attached to the cursor.
+         * @param caller The item that the action is called from
          */
-        public static void startBrowserSession(Text text) {
+        public static void startBrowserSession(Item caller) { 
                 try {
-                        if (!(text instanceof Text)) {
-                                MessageBay.errorMessage("Must be a text item.");
-                                return;
+                        String url;
+                        
+                        Text urlItem = FreeItems.getTextAttachedToCursor();
+                        
+                        // If there is a text item attached to the cursor, use it as the URL to load
+                        if (urlItem != null) {
+                                url = urlItem.getText();
+                                
+                                // Remove the item, since the link to the browser session will added to the cursor
+                                urlItem.delete();
+                        } else {
+                                // Otherwise use the home page specified in the settings
+                                url = NetworkSettings.HomePage.get();
                         }
                         
-                        if(text.getLink() != null) {                                            // text item can't already have a link
-                                MessageBay.errorMessage("Text item already has link.");
-                                return;
-                        }
-                        
-                        String url = "";
-                        
-                        // If no text with url is passed to action create a new text item
-                        if(!FreeItems.textOnlyAttachedToCursor()) {
-                                url = NetworkSettings.HomePage.get();                   // use home page specified by settings
-                                text = DisplayIO.getCurrentFrame().addText(FrameMouseActions.getX(), FrameMouseActions.getY(), 
-                                                "Web Browser Session", null);
-                                text.setParent(DisplayIO.getCurrentFrame());
-                                FrameMouseActions.pickup(text);
-                        } else {
-                                url = text.getText();                                                   // get url from text attached to cursor if possible
-                        }
-                        
-                        // Set text to session id. TODO: set session id.
-                        text.setText("Web Browser Session");
+                        Item linkToBrowserSession = DisplayIO.getCurrentFrame().addText(FrameMouseActions.getX(), FrameMouseActions.getY(), "Web Browser Session", null);
+                        linkToBrowserSession.setParent(DisplayIO.getCurrentFrame());
+                        FrameMouseActions.pickup(linkToBrowserSession);
                         
                         // Create new frame
-                        Frame frame = FrameIO.CreateNewFrame(text);
-                        text.setLink("" + frame.getNumber());                           // link this text item to new frame
+                        Frame frame = FrameIO.CreateNewFrame(linkToBrowserSession);
+                        
+                        // link this text item to new frame
+                        linkToBrowserSession.setLink("" + frame.getNumber());
                         
                         // Remove everything from new frame
@@ -76 +68 @@
                         // Start Browser in fullscreen or default, depending on settings
                         if(ExploratorySearchSettings.BrowserFullScreen.get()) {
-                                wt = frame.addText(0 + lm, 70 + tm, "@iw: org.expeditee.items.widgets.JfxBrowser " 
+                                wt = frame.addText(144 + lm, 0 + tm, "@iw: org.expeditee.items.widgets.JfxBrowser " 
                                                 + ("--anchorLeft " + lm + " --anchorRight " + rm + " --anchorTop " + (tm + ExploratorySearchSettings.BROWSER_VERT_OFFSET) + " --anchorBottom " + bm + " ")
                                                 + (Browser._theBrowser.getContentPane().getWidth() - lm - rm) + " " 
@@ -82 +74 @@
                                 System.err.println(wt.getText());
                         } else {
-                                wt = frame.addText(0 + lm, 70 + tm, "@iw: org.expeditee.items.widgets.JfxBrowser " + 
+                                wt = frame.addText(144 + lm, 0 + tm, "@iw: org.expeditee.items.widgets.JfxBrowser " + 
                                                 (ExploratorySearchSettings.BrowserDefaultWidth.get() - lm - rm) + " " + 
                                                 (ExploratorySearchSettings.BrowserDefaultHeight.get() - tm - bm) + " : " + url, null);
                         }
-                        
-                        // Create widget via text annotation
-                        InteractiveWidget.createWidget(wt);
                         
                         FrameIO.SaveFrame(frame);                                                       // save frame to disk