src/be/nikiroo/fanfix/reader/GuiReaderBook.java

   1 package be.nikiroo.fanfix.reader;
   2
   3 import java.awt.BorderLayout;
   4 import java.awt.Color;
   5 import java.awt.Graphics;
   6 import java.awt.Graphics2D;
   7 import java.awt.Polygon;
   8 import java.awt.Rectangle;
   9 import java.awt.event.MouseEvent;
  10 import java.awt.event.MouseListener;
  11 import java.awt.image.BufferedImage;
  12 import java.io.ByteArrayInputStream;
  13 import java.io.ByteArrayOutputStream;
  14 import java.io.IOException;
  15 import java.io.InputStream;
  16 import java.net.MalformedURLException;
  17 import java.util.ArrayList;
  18 import java.util.Date;
  19 import java.util.EventListener;
  20 import java.util.List;
  21
  22 import javax.imageio.ImageIO;
  23 import javax.swing.ImageIcon;
  24 import javax.swing.JLabel;
  25 import javax.swing.JPanel;
  26
  27 import be.nikiroo.fanfix.Instance;
  28 import be.nikiroo.fanfix.data.MetaData;
  29 import be.nikiroo.fanfix.data.Story;
  30 import be.nikiroo.utils.IOUtils;
  31 import be.nikiroo.utils.ui.UIUtils;
  32
  33 /**
  34  * A book item presented in a {@link GuiReaderFrame}.
  35  *
  36  * @author niki
  37  */
  38 class GuiReaderBook extends JPanel {
  39         /**
  40          * Action on a book item.
  41          *
  42          * @author niki
  43          */
  44         interface BookActionListener extends EventListener {
  45                 /**
  46                  * The book was selected (single click).
  47                  *
  48                  * @param book
  49                  *            the {@link GuiReaderBook} itself
  50                  */
  51                 public void select(GuiReaderBook book);
  52
  53                 /**
  54                  * The book was double-clicked.
  55                  *
  56                  * @param book
  57                  *            the {@link GuiReaderBook} itself
  58                  */
  59                 public void action(GuiReaderBook book);
  60
  61                 /**
  62                  * A popup menu was requested for this {@link GuiReaderBook}.
  63                  *
  64                  * @param book
  65                  *            the {@link GuiReaderBook} itself
  66                  * @param e
  67                  *            the {@link MouseEvent} that generated this call
  68                  */
  69                 public void popupRequested(GuiReaderBook book, MouseEvent e);
  70         }
  71
  72         private static final long serialVersionUID = 1L;
  73
  74         // TODO: export some of the configuration options?
  75         private static final int COVER_WIDTH = 100;
  76         private static final int COVER_HEIGHT = 150;
  77         private static final int SPINE_WIDTH = 5;
  78         private static final int SPINE_HEIGHT = 5;
  79         private static final int HOFFSET = 20;
  80         private static final Color SPINE_COLOR_BOTTOM = new Color(180, 180, 180);
  81         private static final Color SPINE_COLOR_RIGHT = new Color(100, 100, 100);
  82         private static final int TEXT_WIDTH = COVER_WIDTH + 40;
  83         private static final int TEXT_HEIGHT = 50;
  84         private static final String AUTHOR_COLOR = "#888888";
  85         private static final Color BORDER = Color.black;
  86         private static final long doubleClickDelay = 200; // in ms
  87         //
  88
  89         private JLabel icon;
  90         private JLabel title;
  91         private boolean selected;
  92         private boolean hovered;
  93         private Date lastClick;
  94
  95         private List<BookActionListener> listeners;
  96         private MetaData meta;
  97         private boolean cached;
  98
  99         /**
 100          * Create a new {@link GuiReaderBook} item for the given {@link Story}.
 101          *
 102          * @param meta
 103          *            the story {@link MetaData}
 104          * @param cached
 105          *            TRUE if it is locally cached
 106          * @param seeWordCount
 107          *            TRUE to see word counts, FALSE to see authors
 108          */
 109         public GuiReaderBook(MetaData meta, boolean cached, boolean seeWordCount) {
 110                 this.cached = cached;
 111                 this.meta = meta;
 112
 113                 String optSecondary = meta.getAuthor();
 114                 if (seeWordCount) {
 115                         if (meta.getWords() >= 4000) {
 116                                 optSecondary = (meta.getWords() / 1000) + "k words";
 117                         } else if (meta.getWords() > 0) {
 118                                 optSecondary = meta.getWords() + " words";
 119                         } else {
 120                                 optSecondary = "";
 121                         }
 122                 }
 123
 124                 if (optSecondary != null && !optSecondary.isEmpty()) {
 125                         optSecondary = "(" + optSecondary + ")";
 126                 }
 127
 128                 icon = new JLabel(generateCoverIcon(meta));
 129                 title = new JLabel(
 130                                 String.format(
 131                                                 "<html>"
 132                                                                 + "<body style='width: %d px; height: %d px; text-align: center'>"
 133                                                                 + "%s" + "<br>" + "<span style='color: %s;'>"
 134                                                                 + "%s" + "</span>" + "</body>" + "</html>",
 135                                                 TEXT_WIDTH, TEXT_HEIGHT, meta.getTitle(), AUTHOR_COLOR,
 136                                                 optSecondary));
 137
 138                 setLayout(new BorderLayout(10, 10));
 139                 add(icon, BorderLayout.CENTER);
 140                 add(title, BorderLayout.SOUTH);
 141
 142                 setupListeners();
 143         }
 144
 145         /**
 146          * The book current selection state.
 147          *
 148          * @return the selection state
 149          */
 150         public boolean isSelected() {
 151                 return selected;
 152         }
 153
 154         /**
 155          * The book current selection state.
 156          *
 157          * @param selected
 158          *            TRUE if it is selected
 159          */
 160         public void setSelected(boolean selected) {
 161                 if (this.selected != selected) {
 162                         this.selected = selected;
 163                         repaint();
 164                 }
 165         }
 166
 167         /**
 168          * The item mouse-hover state.
 169          *
 170          * @param hovered
 171          *            TRUE if it is mouse-hovered
 172          */
 173         private void setHovered(boolean hovered) {
 174                 if (this.hovered != hovered) {
 175                         this.hovered = hovered;
 176                         repaint();
 177                 }
 178         }
 179
 180         /**
 181          * Setup the mouse listener that will activate {@link BookActionListener}
 182          * events.
 183          */
 184         private void setupListeners() {
 185                 listeners = new ArrayList<GuiReaderBook.BookActionListener>();
 186                 addMouseListener(new MouseListener() {
 187                         public void mouseReleased(MouseEvent e) {
 188                                 if (e.isPopupTrigger()) {
 189                                         popup(e);
 190                                 }
 191                         }
 192
 193                         public void mousePressed(MouseEvent e) {
 194                                 if (e.isPopupTrigger()) {
 195                                         popup(e);
 196                                 }
 197                         }
 198
 199                         public void mouseExited(MouseEvent e) {
 200                                 setHovered(false);
 201                         }
 202
 203                         public void mouseEntered(MouseEvent e) {
 204                                 setHovered(true);
 205                         }
 206
 207                         public void mouseClicked(MouseEvent e) {
 208                                 if (isEnabled()) {
 209                                         Date now = new Date();
 210                                         if (lastClick != null
 211                                                         && now.getTime() - lastClick.getTime() < doubleClickDelay) {
 212                                                 click(true);
 213                                         } else {
 214                                                 click(false);
 215                                         }
 216
 217                                         lastClick = now;
 218                                 }
 219                         }
 220
 221                         private void click(boolean doubleClick) {
 222                                 for (BookActionListener listener : listeners) {
 223                                         if (doubleClick) {
 224                                                 listener.action(GuiReaderBook.this);
 225                                         } else {
 226                                                 listener.select(GuiReaderBook.this);
 227                                         }
 228                                 }
 229                         }
 230
 231                         private void popup(MouseEvent e) {
 232                                 for (BookActionListener listener : listeners) {
 233                                         listener.select((GuiReaderBook.this));
 234                                         listener.popupRequested(GuiReaderBook.this, e);
 235                                 }
 236                         }
 237                 });
 238         }
 239
 240         /**
 241          * Add a new {@link BookActionListener} on this item.
 242          *
 243          * @param listener
 244          *            the listener
 245          */
 246         public void addActionListener(BookActionListener listener) {
 247                 listeners.add(listener);
 248         }
 249
 250         /**
 251          * The Library {@link MetaData} of the book represented by this item.
 252          *
 253          * @return the meta
 254          */
 255         public MetaData getMeta() {
 256                 return meta;
 257         }
 258
 259         /**
 260          * This item {@link GuiReader} library cache state.
 261          *
 262          * @return TRUE if it is present in the {@link GuiReader} cache
 263          */
 264         public boolean isCached() {
 265                 return cached;
 266         }
 267
 268         /**
 269          * This item {@link GuiReader} library cache state.
 270          *
 271          * @param cached
 272          *            TRUE if it is present in the {@link GuiReader} cache
 273          */
 274         public void setCached(boolean cached) {
 275                 if (this.cached != cached) {
 276                         this.cached = cached;
 277                         repaint();
 278                 }
 279         }
 280
 281         /**
 282          * Paint the item, then call {@link GuiReaderBook#paintOverlay(Graphics)}.
 283          */
 284         @Override
 285         public void paint(Graphics g) {
 286                 super.paint(g);
 287                 paintOverlay(g);
 288         }
 289
 290         /**
 291          * Draw a partially transparent overlay if needed depending upon the
 292          * selection and mouse-hover states on top of the normal component, as well
 293          * as a possible "cached" icon if the item is cached.
 294          *
 295          * @param g
 296          *            the {@link Graphics} to paint onto
 297          */
 298         public void paintOverlay(Graphics g) {
 299                 Rectangle clip = g.getClipBounds();
 300                 if (clip.getWidth() <= 0 || clip.getHeight() <= 0) {
 301                         return;
 302                 }
 303
 304                 int h = COVER_HEIGHT;
 305                 int w = COVER_WIDTH;
 306                 int xOffset = (TEXT_WIDTH - COVER_WIDTH) - 1;
 307                 int yOffset = HOFFSET;
 308
 309                 if (BORDER != null) {
 310                         if (BORDER != null) {
 311                                 g.setColor(BORDER);
 312                                 g.drawRect(xOffset, yOffset, COVER_WIDTH, COVER_HEIGHT);
 313                         }
 314
 315                         xOffset++;
 316                         yOffset++;
 317                 }
 318
 319                 int[] xs = new int[] { xOffset, xOffset + SPINE_WIDTH,
 320                                 xOffset + w + SPINE_WIDTH, xOffset + w };
 321                 int[] ys = new int[] { yOffset + h, yOffset + h + SPINE_HEIGHT,
 322                                 yOffset + h + SPINE_HEIGHT, yOffset + h };
 323                 g.setColor(SPINE_COLOR_BOTTOM);
 324                 g.fillPolygon(new Polygon(xs, ys, xs.length));
 325                 xs = new int[] { xOffset + w, xOffset + w + SPINE_WIDTH,
 326                                 xOffset + w + SPINE_WIDTH, xOffset + w };
 327                 ys = new int[] { yOffset, yOffset + SPINE_HEIGHT,
 328                                 yOffset + h + SPINE_HEIGHT, yOffset + h };
 329                 g.setColor(SPINE_COLOR_RIGHT);
 330                 g.fillPolygon(new Polygon(xs, ys, xs.length));
 331
 332                 Color color = new Color(255, 255, 255, 0);
 333                 if (!isEnabled()) {
 334                 } else if (selected && !hovered) {
 335                         color = new Color(80, 80, 100, 40);
 336                 } else if (!selected && hovered) {
 337                         color = new Color(230, 230, 255, 100);
 338                 } else if (selected && hovered) {
 339                         color = new Color(200, 200, 255, 100);
 340                 }
 341
 342                 g.setColor(color);
 343                 g.fillRect(clip.x, clip.y, clip.width, clip.height);
 344
 345                 if (cached) {
 346                         UIUtils.drawEllipse3D(g, Color.green.darker(), COVER_WIDTH
 347                                         + HOFFSET + 30, 10, 20, 20);
 348                 }
 349         }
 350
 351         /**
 352          * Generate a cover icon based upon the given {@link MetaData}.
 353          *
 354          * @param meta
 355          *            the {@link MetaData} about the target {@link Story}
 356          *
 357          * @return the icon
 358          */
 359         private ImageIcon generateCoverIcon(MetaData meta) {
 360                 String id = meta.getUuid() + ".thumb_" + SPINE_WIDTH + "x"
 361                                 + COVER_WIDTH + "+" + SPINE_HEIGHT + "+" + COVER_HEIGHT + "@"
 362                                 + HOFFSET;
 363                 BufferedImage resizedImage = null;
 364
 365                 InputStream in = Instance.getCache().getFromCache(id);
 366                 if (in != null) {
 367                         try {
 368                                 resizedImage = IOUtils.toImage(in);
 369                                 in.close();
 370                                 in = null;
 371                         } catch (IOException e) {
 372                                 Instance.syserr(e);
 373                         }
 374                 }
 375
 376                 if (resizedImage == null) {
 377                         try {
 378                                 BufferedImage cover = Instance.getLibrary().getCover(
 379                                                 meta.getLuid());
 380
 381                                 resizedImage = new BufferedImage(SPINE_WIDTH + COVER_WIDTH,
 382                                                 SPINE_HEIGHT + COVER_HEIGHT + HOFFSET,
 383                                                 BufferedImage.TYPE_4BYTE_ABGR);
 384                                 Graphics2D g = resizedImage.createGraphics();
 385                                 g.setColor(Color.white);
 386                                 g.fillRect(0, HOFFSET, COVER_WIDTH, COVER_HEIGHT);
 387                                 if (cover != null) {
 388                                         g.drawImage(cover, 0, HOFFSET, COVER_WIDTH, COVER_HEIGHT,
 389                                                         null);
 390                                 } else {
 391                                         g.setColor(Color.black);
 392                                         g.drawLine(0, HOFFSET, COVER_WIDTH, HOFFSET + COVER_HEIGHT);
 393                                         g.drawLine(COVER_WIDTH, HOFFSET, 0, HOFFSET + COVER_HEIGHT);
 394                                 }
 395                                 g.dispose();
 396
 397                                 ByteArrayOutputStream out = new ByteArrayOutputStream();
 398                                 ImageIO.write(resizedImage, "png", out);
 399                                 byte[] imageBytes = out.toByteArray();
 400                                 in = new ByteArrayInputStream(imageBytes);
 401                                 Instance.getCache().addToCache(in, id);
 402                                 in.close();
 403                                 in = null;
 404                         } catch (MalformedURLException e) {
 405                                 Instance.syserr(e);
 406                         } catch (IOException e) {
 407                                 Instance.syserr(e);
 408                         }
 409                 }
 410
 411                 return new ImageIcon(resizedImage);
 412         }
 413 }