View Javadoc
1   /*
2    * *************************************************************************************************************************************************************
3    *
4    * TheseFoolishThings: Miscellaneous utilities
5    * http://tidalwave.it/projects/thesefoolishthings
6    *
7    * Copyright (C) 2009 - 2024 by Tidalwave s.a.s. (http://tidalwave.it)
8    *
9    * *************************************************************************************************************************************************************
10   *
11   * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
12   * You may obtain a copy of the License at
13   *
14   *     http://www.apache.org/licenses/LICENSE-2.0
15   *
16   * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
17   * CONDITIONS OF ANY KIND, either express or implied.  See the License for the specific language governing permissions and limitations under the License.
18   *
19   * *************************************************************************************************************************************************************
20   *
21   * git clone https://bitbucket.org/tidalwave/thesefoolishthings-src
22   * git clone https://github.com/tidalwave-it/thesefoolishthings-src
23   *
24   * *************************************************************************************************************************************************************
25   */
26  package it.tidalwave.role.ui.spi;
27  
28  import javax.annotation.Nonnull;
29  import java.beans.PropertyChangeListener;
30  import java.beans.PropertyChangeSupport;
31  import javax.swing.Icon;
32  import it.tidalwave.role.ui.MutableIconProvider;
33  
34  /***************************************************************************************************************************************************************
35   *
36   * A convenient support for implementing a {@link it.tidalwave.role.ui.MutableIconProvider}.
37   *
38   * @author  Fabrizio Giudici
39   * @it.tidalwave.javadoc.draft
40   *
41   **************************************************************************************************************************************************************/
42  public abstract class MutableIconProviderSupport implements MutableIconProvider
43    {
44      private final PropertyChangeSupport pcs = new PropertyChangeSupport(this);
45  
46      /***********************************************************************************************************************************************************
47       * {@inheritDoc}
48       **********************************************************************************************************************************************************/
49      @Override
50      public void addPropertyChangeListener (@Nonnull final PropertyChangeListener listener)
51        {
52          pcs.addPropertyChangeListener(listener);
53        }
54  
55      /***********************************************************************************************************************************************************
56       * {@inheritDoc}
57       **********************************************************************************************************************************************************/
58      @Override
59      public void removePropertyChangeListener (@Nonnull final PropertyChangeListener listener)
60        {
61          pcs.removePropertyChangeListener(listener);
62        }
63  
64      /***********************************************************************************************************************************************************
65       * {@inheritDoc}
66       *
67       * FIXME: this method does nothing. Probably this is inconsistent with DefaultMutableDisplayable? But that is
68       * a Default*, we're just a *Support...
69       **********************************************************************************************************************************************************/
70      @Override
71      public void setIcon (@Nonnull final Icon icon)
72        {
73        }
74  
75      /***********************************************************************************************************************************************************
76       * Fires the event notifying that {@link #PROP_ICON} has been changed.
77       *
78       * @param  oldIcon   the old value of the property
79       * @param  newIcon   the new value of the property
80       **********************************************************************************************************************************************************/
81      protected void fireIconChange (@Nonnull final Icon oldIcon, @Nonnull final Icon newIcon)
82        {
83          pcs.firePropertyChange(PROP_ICON, oldIcon, newIcon); // FIXME: should be in the EDT?
84        }
85    }