ui/ListModel.java

   1 package be.nikiroo.utils.ui;
   2
   3 import java.awt.Component;
   4 import java.awt.Point;
   5 import java.awt.Window;
   6 import java.awt.event.MouseAdapter;
   7 import java.awt.event.MouseEvent;
   8 import java.util.ArrayList;
   9 import java.util.Collection;
  10 import java.util.List;
  11
  12 import javax.swing.JList;
  13 import javax.swing.JPopupMenu;
  14 import javax.swing.ListCellRenderer;
  15 import javax.swing.SwingWorker;
  16
  17 import be.nikiroo.utils.compat.DefaultListModel6;
  18 import be.nikiroo.utils.compat.JList6;
  19 import be.nikiroo.utils.compat.ListCellRenderer6;
  20
  21 /**
  22  * A {@link javax.swing.ListModel} that can maintain 2 lists; one with the
  23  * actual data (the elements), and a second one with the items that are
  24  * currently displayed (the items).
  25  * <p>
  26  * It also offers filter options, supports hovered changes and some more utility
  27  * functions.
  28  *
  29  * @author niki
  30  *
  31  * @param <T>
  32  *            the type of elements and items (the same type)
  33  */
  34 public class ListModel<T> extends DefaultListModel6<T> {
  35         private static final long serialVersionUID = 1L;
  36
  37         /** How long to wait before displaying a tooltip, in milliseconds. */
  38         private static final int DELAY_TOOLTIP_MS = 1000;
  39
  40         /**
  41          * A filter interface, to check for a condition (note that a Predicate class
  42          * already exists in Java 1.8+, and is compatible with this one if you
  43          * change the signatures -- but I support java 1.6+).
  44          *
  45          * @author niki
  46          *
  47          * @param <T>
  48          *            the type of elements and items (the same type)
  49          */
  50         public interface Predicate<T> {
  51                 /**
  52                  * Check if an item or an element pass a filter.
  53                  *
  54                  * @param item
  55                  *            the item to test
  56                  *
  57                  * @return TRUE if the test passed, FALSE if not
  58                  */
  59                 public boolean test(T item);
  60         }
  61
  62         /**
  63          * A simple interface your elements must implement if you want to use
  64          * {@link ListModel#generateRenderer(ListModel)}.
  65          *
  66          * @author niki
  67          */
  68         public interface Hoverable {
  69                 /**
  70                  * The element is currently selected.
  71                  *
  72                  * @param selected
  73                  *            TRUE for selected, FALSE for unselected
  74                  */
  75                 public void setSelected(boolean selected);
  76
  77                 /**
  78                  * The element is currently under the mouse cursor.
  79                  *
  80                  * @param hovered
  81                  *            TRUE if it is, FALSE if not
  82                  */
  83                 public void setHovered(boolean hovered);
  84         }
  85
  86         /**
  87          * An interface required to support tooltips on this {@link ListModel}.
  88          *
  89          * @author niki
  90          *
  91          * @param <T>
  92          *            the type of elements and items (the same type)
  93          */
  94         public interface TooltipCreator<T> {
  95                 /**
  96                  * Generate a tooltip {@link Window} for this element.
  97                  * <p>
  98                  * Note that the tooltip can be of two modes: undecorated or standalone.
  99                  * An undecorated tooltip will be taken care of by this
 100                  * {@link ListModel}, but a standalone one is supposed to be its own
 101                  * Dialog or Frame (it won't be automatically closed).
 102                  *
 103                  * @param t
 104                  *            the element to generate a tooltip for
 105                  * @param undecorated
 106                  *            TRUE for undecorated tooltip, FALSE for standalone
 107                  *            tooltips
 108                  *
 109                  * @return the generated tooltip or NULL for none
 110                  */
 111                 public Window generateTooltip(T t, boolean undecorated);
 112         }
 113
 114         private int hoveredIndex;
 115         private List<T> items = new ArrayList<T>();
 116         private boolean keepSelection = true;
 117
 118         private TooltipCreator<T> tooltipCreator;
 119         private Window tooltip;
 120
 121         @SuppressWarnings("rawtypes") // JList<?> not compatible Java 1.6
 122         private JList list;
 123
 124         /**
 125          * Create a new {@link ListModel}.
 126          *
 127          * @param list
 128          *            the {@link JList6} we will handle the data of (cannot be NULL)
 129          */
 130         @SuppressWarnings("rawtypes") // JList<?> not compatible Java 1.6
 131         public ListModel(JList6<T> list) {
 132                 this((JList) list);
 133         }
 134
 135         /**
 136          * Create a new {@link ListModel}.
 137          *
 138          * @param list
 139          *            the {@link JList6} we will handle the data of (cannot be NULL)
 140          * @param popup
 141          *            the popup to use and keep track of (can be NULL)
 142          */
 143         @SuppressWarnings("rawtypes") // JList<?> not compatible Java 1.6
 144         public ListModel(JList6<T> list, JPopupMenu popup) {
 145                 this((JList) list, popup);
 146         }
 147
 148         /**
 149          * Create a new {@link ListModel}.
 150          *
 151          * @param list
 152          *            the {@link JList6} we will handle the data of (cannot be NULL)
 153          * @param tooltipCreator
 154          *            use this if you want the list to display tooltips on hover
 155          *            (can be NULL)
 156          */
 157         @SuppressWarnings("rawtypes") // JList<?> not compatible Java 1.6
 158         public ListModel(JList6<T> list, TooltipCreator<T> tooltipCreator) {
 159                 this((JList) list, null, tooltipCreator);
 160         }
 161
 162         /**
 163          * Create a new {@link ListModel}.
 164          *
 165          * @param list
 166          *            the {@link JList6} we will handle the data of (cannot be NULL)
 167          * @param popup
 168          *            the popup to use and keep track of (can be NULL)
 169          * @param tooltipCreator
 170          *            use this if you want the list to display tooltips on hover
 171          *            (can be NULL)
 172          */
 173         @SuppressWarnings("rawtypes") // JList<?> not compatible Java 1.6
 174         public ListModel(JList6<T> list, JPopupMenu popup,
 175                         TooltipCreator<T> tooltipCreator) {
 176                 this((JList) list, popup, tooltipCreator);
 177         }
 178
 179         /**
 180          * Create a new {@link ListModel}.
 181          * <p>
 182          * Note that you must take care of passing a {@link JList} that only handles
 183          * elements of the type of this {@link ListModel} -- you can also use
 184          * {@link ListModel#ListModel(JList6)} instead.
 185          *
 186          * @param list
 187          *            the {@link JList} we will handle the data of (cannot be NULL,
 188          *            must only contain elements of the type of this
 189          *            {@link ListModel})
 190          */
 191         @SuppressWarnings("rawtypes") // JList<?> not compatible Java 1.6
 192         public ListModel(JList list) {
 193                 this(list, null, null);
 194         }
 195
 196         /**
 197          * Create a new {@link ListModel}.
 198          * <p>
 199          * Note that you must take care of passing a {@link JList} that only handles
 200          * elements of the type of this {@link ListModel} -- you can also use
 201          * {@link ListModel#ListModel(JList6, JPopupMenu)} instead.
 202          *
 203          * @param list
 204          *            the {@link JList} we will handle the data of (cannot be NULL,
 205          *            must only contain elements of the type of this
 206          *            {@link ListModel})
 207          * @param popup
 208          *            the popup to use and keep track of (can be NULL)
 209          */
 210         @SuppressWarnings("rawtypes") // JList<?> not in Java 1.6
 211         public ListModel(JList list, JPopupMenu popup) {
 212                 this(list, popup, null);
 213         }
 214
 215         /**
 216          * Create a new {@link ListModel}.
 217          * <p>
 218          * Note that you must take care of passing a {@link JList} that only handles
 219          * elements of the type of this {@link ListModel} -- you can also use
 220          * {@link ListModel#ListModel(JList6, JPopupMenu)} instead.
 221          *
 222          * @param list
 223          *            the {@link JList} we will handle the data of (cannot be NULL,
 224          *            must only contain elements of the type of this
 225          *            {@link ListModel})
 226          * @param tooltipCreator
 227          *            use this if you want the list to display tooltips on hover
 228          *            (can be NULL)
 229          */
 230         @SuppressWarnings("rawtypes") // JList<?> not in Java 1.6
 231         public ListModel(JList list, TooltipCreator<T> tooltipCreator) {
 232                 this(list, null, tooltipCreator);
 233         }
 234
 235         /**
 236          * Create a new {@link ListModel}.
 237          * <p>
 238          * Note that you must take care of passing a {@link JList} that only handles
 239          * elements of the type of this {@link ListModel} -- you can also use
 240          * {@link ListModel#ListModel(JList6, JPopupMenu)} instead.
 241          *
 242          * @param list
 243          *            the {@link JList} we will handle the data of (cannot be NULL,
 244          *            must only contain elements of the type of this
 245          *            {@link ListModel})
 246          * @param popup
 247          *            the popup to use and keep track of (can be NULL)
 248          * @param tooltipCreator
 249          *            use this if you want the list to display tooltips on hover
 250          *            (can be NULL)
 251          */
 252         @SuppressWarnings({ "unchecked", "rawtypes" }) // JList<?> not in Java 1.6
 253         public ListModel(final JList list, final JPopupMenu popup,
 254                         TooltipCreator<T> tooltipCreator) {
 255                 this.list = list;
 256                 this.tooltipCreator = tooltipCreator;
 257
 258                 list.setModel(this);
 259
 260                 final DelayWorker tooltipWatcher = new DelayWorker(DELAY_TOOLTIP_MS);
 261                 if (tooltipCreator != null) {
 262                         tooltipWatcher.start();
 263                 }
 264
 265                 list.addMouseMotionListener(new MouseAdapter() {
 266                         @Override
 267                         public void mouseMoved(final MouseEvent me) {
 268                                 if (popup != null && popup.isShowing())
 269                                         return;
 270
 271                                 Point p = new Point(me.getX(), me.getY());
 272                                 final int index = list.locationToIndex(p);
 273                                 if (index != hoveredIndex) {
 274                                         int oldIndex = hoveredIndex;
 275                                         hoveredIndex = index;
 276                                         fireElementChanged(oldIndex);
 277                                         fireElementChanged(index);
 278
 279                                         Window oldTooltip = tooltip;
 280                                         tooltip = null;
 281                                         if (oldTooltip != null) {
 282                                                 oldTooltip.setVisible(false);
 283                                         }
 284
 285                                         if (ListModel.this.tooltipCreator != null) {
 286                                                 tooltipWatcher.delay("tooltip",
 287                                                                 new SwingWorker<Void, Void>() {
 288                                                                         @Override
 289                                                                         protected Void doInBackground()
 290                                                                                         throws Exception {
 291                                                                                 return null;
 292                                                                         }
 293
 294                                                                         @Override
 295                                                                         protected void done() {
 296                                                                                 if (index < 0
 297                                                                                                 || index != hoveredIndex) {
 298                                                                                         return;
 299                                                                                 }
 300
 301                                                                                 if (popup != null
 302                                                                                                 && popup.isShowing()) {
 303                                                                                         return;
 304                                                                                 }
 305
 306                                                                                 tooltip = newTooltip(index, me);
 307                                                                         }
 308                                                                 });
 309                                         }
 310                                 }
 311                         }
 312                 });
 313
 314                 list.addMouseListener(new MouseAdapter() {
 315                         @Override
 316                         public void mousePressed(MouseEvent e) {
 317                                 check(e);
 318                         }
 319
 320                         @Override
 321                         public void mouseReleased(MouseEvent e) {
 322                                 check(e);
 323                         }
 324
 325                         @Override
 326                         public void mouseExited(MouseEvent e) {
 327                                 if (popup != null && popup.isShowing())
 328                                         return;
 329
 330                                 if (hoveredIndex > -1) {
 331                                         int oldIndex = hoveredIndex;
 332                                         hoveredIndex = -1;
 333                                         fireElementChanged(oldIndex);
 334                                 }
 335                         }
 336
 337                         private void check(MouseEvent e) {
 338                                 if (popup == null) {
 339                                         return;
 340                                 }
 341
 342                                 if (e.isPopupTrigger()) {
 343                                         if (list.getSelectedIndices().length <= 1) {
 344                                                 list.setSelectedIndex(
 345                                                                 list.locationToIndex(e.getPoint()));
 346                                         }
 347
 348                                         Window oldTooltip = tooltip;
 349                                         tooltip = null;
 350                                         if (oldTooltip != null) {
 351                                                 oldTooltip.setVisible(false);
 352                                         }
 353
 354                                         popup.show(list, e.getX(), e.getY());
 355                                 }
 356                         }
 357
 358                 });
 359         }
 360
 361         /**
 362          * (Try and) keep the elements that were selected when filtering.
 363          * <p>
 364          * This will use toString on the elements to identify them, and can be a bit
 365          * resource intensive.
 366          *
 367          * @return TRUE if we do
 368          */
 369         public boolean isKeepSelection() {
 370                 return keepSelection;
 371         }
 372
 373         /**
 374          * (Try and) keep the elements that were selected when filtering.
 375          * <p>
 376          * This will use toString on the elements to identify them, and can be a bit
 377          * resource intensive.
 378          *
 379          * @param keepSelection
 380          *            TRUE to try and keep them selected
 381          */
 382         public void setKeepSelection(boolean keepSelection) {
 383                 this.keepSelection = keepSelection;
 384         }
 385
 386         /**
 387          * Check if this element is currently under the mouse.
 388          *
 389          * @param element
 390          *            the element to check
 391          *
 392          * @return TRUE if it is
 393          */
 394         public boolean isHovered(T element) {
 395                 return indexOf(element) == hoveredIndex;
 396         }
 397
 398         /**
 399          * Check if this element is currently under the mouse.
 400          *
 401          * @param index
 402          *            the index of the element to check
 403          *
 404          * @return TRUE if it is
 405          */
 406         public boolean isHovered(int index) {
 407                 return index == hoveredIndex;
 408         }
 409
 410         /**
 411          * Add an item to the model.
 412          *
 413          * @param item
 414          *            the new item to add
 415          */
 416         public void addItem(T item) {
 417                 items.add(item);
 418         }
 419
 420         /**
 421          * Add items to the model.
 422          *
 423          * @param items
 424          *            the new items to add
 425          */
 426         public void addAllItems(Collection<T> items) {
 427                 this.items.addAll(items);
 428         }
 429
 430         /**
 431          * Removes the first occurrence of the specified element from this list, if
 432          * it is present (optional operation).
 433          *
 434          * @param item
 435          *            the item to remove if possible (can be NULL)
 436          *
 437          * @return TRUE if one element was removed, FALSE if not found
 438          */
 439         public boolean removeItem(T item) {
 440                 return items.remove(item);
 441         }
 442
 443         /**
 444          * Remove the items that pass the given filter (or all items if the filter
 445          * is NULL).
 446          *
 447          * @param filter
 448          *            the filter (if the filter returns TRUE, the item will be
 449          *            removed)
 450          *
 451          * @return TRUE if at least one item was removed
 452          */
 453         public boolean removeItemIf(Predicate<T> filter) {
 454                 boolean changed = false;
 455                 if (filter == null) {
 456                         changed = !items.isEmpty();
 457                         clearItems();
 458                 } else {
 459                         for (int i = 0; i < items.size(); i++) {
 460                                 if (filter.test(items.get(i))) {
 461                                         items.remove(i--);
 462                                         changed = true;
 463                                 }
 464                         }
 465                 }
 466
 467                 return changed;
 468         }
 469
 470         /**
 471          * Removes all the items from this model.
 472          */
 473         public void clearItems() {
 474                 items.clear();
 475         }
 476
 477         /**
 478          * Filter the current elements.
 479          * <p>
 480          * This method will clear all the elements then look into all the items:
 481          * those that pass the given filter will be copied as elements.
 482          *
 483          * @param filter
 484          *            the filter to select which elements to keep; an item that pass
 485          *            the filter will be copied as an element (can be NULL, in that
 486          *            case all items will be copied as elements)
 487          */
 488         @SuppressWarnings("unchecked") // JList<?> not compatible Java 1.6
 489         public void filter(Predicate<T> filter) {
 490                 ListSnapshot snapshot = null;
 491
 492                 if (keepSelection)
 493                         snapshot = new ListSnapshot(list);
 494
 495                 clear();
 496                 for (T item : items) {
 497                         if (filter == null || filter.test(item)) {
 498                                 addElement(item);
 499                         }
 500                 }
 501
 502                 if (keepSelection)
 503                         snapshot.apply();
 504
 505                 list.repaint();
 506         }
 507
 508         /**
 509          * Return the currently selected elements.
 510          *
 511          * @return the selected elements
 512          */
 513         public List<T> getSelectedElements() {
 514                 List<T> selected = new ArrayList<T>();
 515                 for (int index : list.getSelectedIndices()) {
 516                         selected.add(get(index));
 517                 }
 518
 519                 return selected;
 520         }
 521
 522         /**
 523          * Return the selected element if <b>one</b> and <b>only one</b> element is
 524          * selected. I.E., if zero, two or more elements are selected, NULL will be
 525          * returned.
 526          *
 527          * @return the element if it is the only selected element, NULL otherwise
 528          */
 529         public T getUniqueSelectedElement() {
 530                 List<T> selected = getSelectedElements();
 531                 if (selected.size() == 1) {
 532                         return selected.get(0);
 533                 }
 534
 535                 return null;
 536         }
 537
 538         /**
 539          * Notify that this element has been changed.
 540          *
 541          * @param index
 542          *            the index of the element
 543          */
 544         public void fireElementChanged(int index) {
 545                 if (index >= 0) {
 546                         fireContentsChanged(this, index, index);
 547                 }
 548         }
 549
 550         /**
 551          * Notify that this element has been changed.
 552          *
 553          * @param element
 554          *            the element
 555          */
 556         public void fireElementChanged(T element) {
 557                 int index = indexOf(element);
 558                 if (index >= 0) {
 559                         fireContentsChanged(this, index, index);
 560                 }
 561         }
 562
 563         @SuppressWarnings("unchecked") // JList<?> not compatible Java 1.6
 564         @Override
 565         public T get(int index) {
 566                 return (T) super.get(index);
 567         }
 568
 569         private Window newTooltip(final int index, final MouseEvent me) {
 570                 final T value = ListModel.this.get(index);
 571
 572                 final Window newTooltip = tooltipCreator.generateTooltip(value, true);
 573
 574                 if (newTooltip != null) {
 575                         newTooltip.addMouseListener(new MouseAdapter() {
 576                                 @Override
 577                                 public void mouseClicked(MouseEvent e) {
 578
 579                                         Window promotedTooltip = tooltipCreator
 580                                                         .generateTooltip(value, false);
 581                                         promotedTooltip.setLocation(newTooltip.getLocation());
 582                                         newTooltip.setVisible(false);
 583                                         promotedTooltip.setVisible(true);
 584                                 }
 585                         });
 586                         newTooltip.setLocation(me.getXOnScreen(), me.getYOnScreen());
 587
 588                         newTooltip.setVisible(true);
 589                 }
 590
 591                 return newTooltip;
 592         }
 593
 594         /**
 595          * Generate a {@link ListCellRenderer} that supports {@link Hoverable}
 596          * elements.
 597          *
 598          * @param <T>
 599          *            the type of elements and items (the same type), which should
 600          *            implement {@link Hoverable} (it will not cause issues if not,
 601          *            but then, it will be a default renderer)
 602          * @param model
 603          *            the model to use
 604          *
 605          * @return a suitable, {@link Hoverable} compatible renderer
 606          */
 607         static public <T extends Component> ListCellRenderer6<T> generateRenderer(
 608                         final ListModel<T> model) {
 609                 return new ListCellRenderer6<T>() {
 610                         @Override
 611                         public Component getListCellRendererComponent(JList6<T> list,
 612                                         T item, int index, boolean isSelected,
 613                                         boolean cellHasFocus) {
 614                                 if (item instanceof Hoverable) {
 615                                         Hoverable hoverable = (Hoverable) item;
 616                                         hoverable.setSelected(isSelected);
 617                                         hoverable.setHovered(model.isHovered(index));
 618                                 }
 619
 620                                 return item;
 621                         }
 622                 };
 623         }
 624 }