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