Changeset 1102 for trunk/src/org/expeditee/items/widgets/HeavyDutyInteractiveWidget.java

Timestamp:

05/10/18 16:04:51 (6 years ago)

Author:

davidb

Message:

Reworking of the code-base to separate logic from graphics. This version of Expeditee now supports a JFX graphics as an alternative to SWING

File:

• trunk/src/org/expeditee/items/widgets/HeavyDutyInteractiveWidget.java (modified) (18 diffs)

trunk/src/org/expeditee/items/widgets/HeavyDutyInteractiveWidget.java

@@ -19 +19 @@
 package org.expeditee.items.widgets;
 
-import java.awt.Color;
 import java.awt.Font;
 import java.awt.FontMetrics;
@@ -33 +32 @@
 import javax.swing.SwingUtilities;
 
+import org.expeditee.core.Colour;
+import org.expeditee.gio.swing.SwingConversions;
+import org.expeditee.gio.swing.SwingGraphicsManager;
+import org.expeditee.gio.swing.SwingMiscManager;
 import org.expeditee.gui.Browser;
-import org.expeditee.gui.DisplayIO;
-import org.expeditee.gui.FrameGraphics;
+import org.expeditee.gui.DisplayController;
 import org.expeditee.gui.FreeItems;
 import org.expeditee.items.Item;
@@ -53 +55 @@
  * until expeditee allocates a thread to begin loading. The swing component is set as not-visible.
  * 
- * At the the loading stage, a loadable widget proccesses its load task and renders a
+ * At the the loading stage, a loadable widget processes its load task and renders a
  * load message/bar.
  * 
@@ -59 +61 @@
  * 
  * When a HeavyDutyInteractiveWidget becomes visible / is anchored, it will register itself for saving at the next
- * save point according to SaveEntityManager. Heavey duty widgets will only save at the save points 
+ * save point according to SaveEntityManager. Heavy duty widgets will only save at the save points 
  * if the widget still belongs to a frame (i.e. is not removed) and is anchored.
  * 
- * Heavey duty widgets can also have an expiry on how long they should stay cached for. If they do have an 
+ * Heavy duty widgets can also have an expiry on how long they should stay cached for. If they do have an 
  * expiry then it they unload once expired, and will re-load once in view again. Must take care for
  * unloadable widgets because you must check your unloadable elements to whether they are unloaded or not
- * every time your widget accessess them.
+ * every time your widget accesses them.
  * 
  * When a heavy duty widget is deleted - any data consuming memory can be dumped temporarily if needed.
@@ -72 +74 @@
  *
  */
-public abstract class HeavyDutyInteractiveWidget extends InteractiveWidget implements LoadableEntity, SaveableEntity {
+public abstract class HeavyDutyInteractiveWidget extends SwingWidget implements LoadableEntity, SaveableEntity {
         
         /** load finished */
@@ -90 +92 @@
         private static final String PENDING_MESSAGE = "Pending";
         
-        private static final Color LOAD_BAR_PROGRESS_COLOR = new Color(103, 171, 203);
-        private static final Color LOAD_BAR_INDETERM_COLOR = Color.ORANGE;
-        private static final Color LOAD_BAR_HIGHLIGHT_COLOR = new Color(240, 240, 240);
-        private static final Color LOAD_SCREEN_COLOR = Color.LIGHT_GRAY;
-        private static final Color LOAD_SCREEN_COLOR_FREESPACE = FREESPACE_BACKCOLOR;
+        private static final Colour LOAD_BAR_PROGRESS_COLOR = Colour.FromRGB255(103, 171, 203);
+        private static final Colour LOAD_BAR_INDETERM_COLOR = Colour.ORANGE;
+        private static final Colour LOAD_BAR_HIGHLIGHT_COLOR = Colour.FromRGB255(240, 240, 240);
+        private static final Colour LOAD_SCREEN_COLOR = Colour.LIGHT_GREY;
+        private static final Colour LOAD_SCREEN_COLOR_FREESPACE = FREESPACE_BACKCOLOR;
         
         private static final Font LOAD_NORMAL_FONT = new Font("Arial", Font.BOLD, 12);
@@ -140 +142 @@
          */
         protected HeavyDutyInteractiveWidget(Text source, JComponent component,
-                        int minWidth, int maxWidth, int minHeight, int maxHeight, int cacheDepth, boolean skipLoad) {
+                        int minWidth, int maxWidth, int minHeight, int maxHeight, int cacheDepth, boolean skipLoad)
+        {
                 super(source, component, minWidth, maxWidth, minHeight, maxHeight);
                 
@@ -173 +176 @@
          * 
          * @param percent 
-         *              Must be between 0.0 and 1.0 inclusive for percentage. Or neagtive if indeterminant.
+         *              Must be between 0.0 and 1.0 inclusive for percentage. Or negative if indeterminate.
          * 
          * @throws IllegalArgumentException
@@ -182 +185 @@
          *              
          */
-        protected final void updateLoadPercentage(float percent) {
+        protected final void updateLoadPercentage(float percent)
+        {
                 if (percent > 1.0f) 
                         throw new IllegalArgumentException("loadState is larger than 1.0");
@@ -199 +203 @@
          * @return The current load state.
          */
-        protected float getLoadState() {
+        protected float getLoadState()
+        {
                 return loadState;
         }
@@ -206 +211 @@
          * @return True if in a loading phase.
          */
-        protected boolean isInLoadProgress() {
+        protected boolean isInLoadProgress()
+        {
                 return loadState <= 1.0f;
         }
@@ -226 +232 @@
                 
                 // Re-render loading state
-                FrameGraphics.invalidateArea(_swingComponent.getBounds());
-                FrameGraphics.requestRefresh(true);
+                DisplayController.invalidateArea(getBounds());
+                DisplayController.requestRefresh(true);
         }
         
         @Override
-        public void paintInFreeSpace(Graphics g) {
-                if (loadState == LOAD_STATE_COMPLETED) super.paintInFreeSpace(g);
-                else paintLoadScreen(g, LOAD_SCREEN_COLOR_FREESPACE);
+        public void paintInFreeSpace() {
+                if (loadState == LOAD_STATE_COMPLETED) super.paintInFreeSpace();
+                else paintLoadScreen(LOAD_SCREEN_COLOR_FREESPACE);
         }
 
         @Override
-        public void paint(Graphics g) {
+        protected final void paintSwingWidget(Graphics2D g)
+        {
                 if (loadState == LOAD_STATE_COMPLETED) {
-                        super.paint(g);
+                        paintHeavyDutyWidget(g);
                 } else {
-                        paintLoadScreen(g, LOAD_SCREEN_COLOR);
-                        this.paintLink((Graphics2D)g);
-                }
-                
-        }
-        
-        /**
-         * Rendersthe load bar / load messages
+                        paintLoadScreen(LOAD_SCREEN_COLOR);
+                }
+                
+        }
+        
+        /** Can be overridden to provide custom drawing. */
+        protected void paintHeavyDutyWidget(Graphics2D g)
+        {
+                super.paintSwingWidget(g);
+        }
+        
+        /**
+         * Renders the load bar / load messages
          * 
          * @param g
          */
-        private void paintLoadScreen(Graphics g, Color backgroundColor) {
+        private void paintLoadScreen(Colour backgroundColor) {
 
                 if (Browser._theBrowser == null) return;
                 
+                SwingGraphicsManager manager = SwingMiscManager.getIfUsingSwingGraphicsManager();
+                Graphics g = manager.getCurrentSurface();
+                
                 // Render shaded window over widget
-                g.setColor(backgroundColor);
+                g.setColor(SwingConversions.toSwingColor(backgroundColor));
                 g.fillRect(getX(), getY(), getWidth(), getHeight());
                 
@@ -291 +306 @@
                 Rectangle tmpClip = (clipBackUp != null) ? clipBackUp.getBounds() : 
                         new Rectangle(0, 0, 
-                                        Browser._theBrowser.getContentPane().getWidth(), 
-                                        Browser._theBrowser.getContentPane().getHeight());
-                        
-                g.setClip(tmpClip.intersection(getBounds()));
+                                        manager.getContentPane().getWidth(), 
+                                        manager.getContentPane().getHeight());
+                        
+                g.setClip(tmpClip.intersection(SwingConversions.toSwingRectangle(getBounds())));
         
                 
@@ -300 +315 @@
 
                         GradientPaint gp = new GradientPaint(
-                                        0, barY + (int)(BAR_HEIGHT * 0.8), LOAD_BAR_INDETERM_COLOR,
-                                        0, barY, LOAD_BAR_HIGHLIGHT_COLOR);
+                                        0, barY + (int)(BAR_HEIGHT * 0.8), SwingConversions.toSwingColor(LOAD_BAR_INDETERM_COLOR),
+                                        0, barY, SwingConversions.toSwingColor(LOAD_BAR_HIGHLIGHT_COLOR));
                         ((Graphics2D)g).setPaint(gp);
                 
@@ -311 +326 @@
                         
                         GradientPaint gp = new GradientPaint(
-                                        0, barY + (int)(BAR_HEIGHT * 0.8), LOAD_BAR_PROGRESS_COLOR,
-                                        0, barY, LOAD_BAR_HIGHLIGHT_COLOR);
+                                        0, barY + (int)(BAR_HEIGHT * 0.8), SwingConversions.toSwingColor(LOAD_BAR_PROGRESS_COLOR),
+                                        0, barY, SwingConversions.toSwingColor(LOAD_BAR_HIGHLIGHT_COLOR));
                         ((Graphics2D)g).setPaint(gp);
                         
@@ -319 +334 @@
                 } 
                 
-                g.setColor(Color.DARK_GRAY);
+                g.setColor(SwingConversions.toSwingColor(Colour.DARK_GREY));
                 g.drawRect(barX, barY, barWidth, BAR_HEIGHT);
                 
                 if (loadState == LOAD_STATE_FAILED) 
-                        g.setColor(Color.RED);
-                
-                else g.setColor(Color.BLACK);
+                        g.setColor(SwingConversions.toSwingColor(Colour.RED));
+                
+                else g.setColor(SwingConversions.toSwingColor(Colour.BLACK));
                 
 
@@ -638 +653 @@
                         // Re-render loading state - if not expired
                         if (!expired) {
-                                FrameGraphics.invalidateArea(new Rectangle(getX(), getY(), getWidth(), getHeight()));
-                                FrameGraphics.requestRefresh(true);
+                                DisplayController.invalidateArea(getBounds());
+                                DisplayController.requestRefresh(true);
                         }
                 }
@@ -680 +695 @@
                         
                         // Only load if in view
-                        if (!isFloating() && getParentFrame() != DisplayIO.getCurrentFrame())
+                        if (!isFloating() && getParentFrame() != DisplayController.getCurrentFrame())
                                 return;