gui: code cleanup
[fanfix.git] / src / be / nikiroo / fanfix / reader / ui / GuiReader.java
index 576ac9cc80191c492e2e50572568ec0eaa79d9b7..55701b1ad7b727d94470c449c368569e2aac3c5f 100644 (file)
@@ -2,11 +2,14 @@ package be.nikiroo.fanfix.reader.ui;
 
 import java.awt.Desktop;
 import java.awt.EventQueue;
+import java.awt.event.WindowAdapter;
+import java.awt.event.WindowEvent;
 import java.io.File;
 import java.io.IOException;
 import java.net.URISyntaxException;
 
 import javax.swing.JEditorPane;
+import javax.swing.JFrame;
 import javax.swing.JLabel;
 import javax.swing.JOptionPane;
 import javax.swing.event.HyperlinkEvent;
@@ -19,10 +22,22 @@ import be.nikiroo.fanfix.data.Story;
 import be.nikiroo.fanfix.library.BasicLibrary;
 import be.nikiroo.fanfix.library.CacheLibrary;
 import be.nikiroo.fanfix.reader.BasicReader;
+import be.nikiroo.fanfix.reader.Reader;
 import be.nikiroo.utils.Progress;
 import be.nikiroo.utils.Version;
 import be.nikiroo.utils.ui.UIUtils;
 
+/**
+ * This class implements a graphical {@link Reader} using the Swing library from
+ * Java.
+ * <p>
+ * It can thus be themed to look native-like, or metal-like, or use any other
+ * theme you may want to try.
+ * <p>
+ * We actually try to enable native look-alike mode on start.
+ * 
+ * @author niki
+ */
 class GuiReader extends BasicReader {
        static private boolean nativeLookLoaded;
 
@@ -30,7 +45,14 @@ class GuiReader extends BasicReader {
 
        private File cacheDir;
 
+       /**
+        * Create a new graphical {@link Reader}.
+        * 
+        * @throws IOException
+        *             in case of I/O errors
+        */
        public GuiReader() throws IOException {
+               // TODO: allow different themes?
                if (!nativeLookLoaded) {
                        UIUtils.setLookAndFeel();
                        nativeLookLoaded = true;
@@ -60,14 +82,14 @@ class GuiReader extends BasicReader {
        }
 
        @Override
-       public void read() throws IOException {
+       public void read(boolean sync) throws IOException {
                MetaData meta = getMeta();
 
                if (meta == null) {
                        throw new IOException("No story to read");
                }
 
-               read(meta.getLuid(), null);
+               read(meta.getLuid(), sync, null);
        }
 
        /**
@@ -143,25 +165,45 @@ class GuiReader extends BasicReader {
                                        }
                                }
 
-                               new GuiReaderFrame(GuiReader.this, typeFinal).setVisible(true);
+                               try {
+                                       GuiReaderFrame gui = new GuiReaderFrame(GuiReader.this,
+                                                       typeFinal);
+                                       sync(gui);
+                               } catch (Exception e) {
+                                       Instance.getTraceHandler().error(e);
+                               }
                        }
                });
        }
 
        @Override
-       public void start(File target, String program) throws IOException {
-               if (program == null) {
+       public void start(File target, String program, boolean sync)
+                       throws IOException {
+
+               boolean handled = false;
+               if (program == null && !sync) {
                        try {
                                Desktop.getDesktop().browse(target.toURI());
+                               handled = true;
                        } catch (UnsupportedOperationException e) {
-                               super.start(target, program);
                        }
-               } else {
-                       super.start(target, program);
+               }
+
+               if (!handled) {
+                       super.start(target, program, sync);
                }
        }
 
-       // delete from local reader library
+       /**
+        * Delete the {@link Story} from the cache if it is present, but <b>NOT</b>
+        * from the main library.
+        * <p>
+        * The next time we try to retrieve the {@link Story}, it may be required to
+        * cache it again.
+        * 
+        * @param luid
+        *            the luid of the {@link Story}
+        */
        void clearLocalReaderCache(String luid) {
                try {
                        cacheLib.clearFromCache(luid);
@@ -170,7 +212,15 @@ class GuiReader extends BasicReader {
                }
        }
 
-       // delete from main library
+       /**
+        * Forward the delete operation to the main library.
+        * <p>
+        * The {@link Story} will be deleted from the main library as well as the
+        * cache if present.
+        * 
+        * @param luid
+        *            the {@link Story} to delete
+        */
        void delete(String luid) {
                try {
                        cacheLib.delete(luid);
@@ -179,19 +229,128 @@ class GuiReader extends BasicReader {
                }
        }
 
-       // open the given book
-       void read(String luid, Progress pg) throws IOException {
+       /**
+        * "Open" the given {@link Story}. It usually involves starting an external
+        * program adapted to the given file type.
+        * <p>
+        * Asynchronous method.
+        * 
+        * @param luid
+        *            the luid of the {@link Story} to open
+        * @param sync
+        *            execute the process synchronously (wait until it is terminated
+        *            before returning)
+        * @param pg
+        *            the optional progress (we may need to prepare the
+        *            {@link Story} for reading
+        * 
+        * @throws IOException
+        *             in case of I/O errors
+        */
+       void read(String luid, boolean sync, Progress pg) throws IOException {
                File file = cacheLib.getFile(luid, pg);
 
                // TODO: show a special page for the chapter?
-               openExternal(getLibrary().getInfo(luid), file);
+               // We could also implement an internal viewer, both for image and
+               // non-image documents
+               openExternal(getLibrary().getInfo(luid), file, sync);
        }
 
-       void changeType(String luid, String newSource) {
+       /**
+        * Change the source of the given {@link Story} (the source is the main
+        * information used to group the stories together).
+        * <p>
+        * In other words, <b>move</b> the {@link Story} into other source.
+        * <p>
+        * The source can be a new one, it needs not exist before hand.
+        * 
+        * @param luid
+        *            the luid of the {@link Story} to move
+        * @param newSource
+        *            the new source
+        */
+       void changeSource(String luid, String newSource) {
                try {
                        cacheLib.changeSource(luid, newSource, null);
                } catch (IOException e) {
                        Instance.getTraceHandler().error(e);
                }
        }
+
+       /**
+        * Change the title of the given {@link Story}.
+        * 
+        * @param luid
+        *            the luid of the {@link Story} to change
+        * @param newTitle
+        *            the new title
+        */
+       void changeTitle(String luid, String newTitle) {
+               try {
+                       cacheLib.changeTitle(luid, newTitle, null);
+               } catch (IOException e) {
+                       Instance.getTraceHandler().error(e);
+               }
+       }
+
+       /**
+        * Change the author of the given {@link Story}.
+        * <p>
+        * The author can be a new one, it needs not exist before hand.
+        * 
+        * @param luid
+        *            the luid of the {@link Story} to change
+        * @param newAuthor
+        *            the new author
+        */
+       void changeAuthor(String luid, String newAuthor) {
+               try {
+                       cacheLib.changeAuthor(luid, newAuthor, null);
+               } catch (IOException e) {
+                       Instance.getTraceHandler().error(e);
+               }
+       }
+
+       /**
+        * Start a frame and wait until it is closed before returning.
+        * 
+        * @param frame
+        *            the frame to start
+        */
+       static private void sync(final JFrame frame) {
+               final Boolean[] done = new Boolean[1];
+               done[0] = false;
+
+               try {
+                       EventQueue.invokeLater(new Runnable() {
+                               @Override
+                               public void run() {
+                                       try {
+                                               frame.addWindowListener(new WindowAdapter() {
+                                                       @Override
+                                                       public void windowClosing(WindowEvent e) {
+                                                               super.windowClosing(e);
+                                                               done[0] = true;
+                                                       }
+                                               });
+
+                                               frame.setVisible(true);
+                                       } catch (Exception e) {
+                                               done[0] = true;
+                                       }
+                               }
+                       });
+               } catch (Exception e) {
+                       Instance.getTraceHandler().error(e);
+                       done[0] = true;
+               }
+
+               // This action must be synchronous, so wait until the frame is closed
+               while (!done[0]) {
+                       try {
+                               Thread.sleep(100);
+                       } catch (InterruptedException e) {
+                       }
+               }
+       }
 }