MutableIconProviderSupport.java

  1. /*
  2.  * *************************************************************************************************************************************************************
  3.  *
  4.  * SteelBlue: DCI User Interfaces
  5.  * http://tidalwave.it/projects/steelblue
  6.  *
  7.  * Copyright (C) 2015 - 2025 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/steelblue-src
  22.  * git clone https://github.com/tidalwave-it/steelblue-src
  23.  *
  24.  * *************************************************************************************************************************************************************
  25.  */
  26. package it.tidalwave.ui.core.role.spi;

  27. import jakarta.annotation.Nonnull;
  28. import java.beans.PropertyChangeSupport;
  29. import it.tidalwave.ui.core.role.MutableIconProvider;
  30. import it.tidalwave.ui.core.role.impl.MutableListenerSupport;
  31. import javax.swing.Icon;
  32. import lombok.experimental.Delegate;

  33. /***************************************************************************************************************************************************************
  34.  *
  35.  * A convenient support for implementing a {@link it.tidalwave.ui.core.role.MutableIconProvider}.
  36.  *
  37.  * @since   2.0-ALPHA-1
  38.  * @author  Fabrizio Giudici
  39.  *
  40.  **************************************************************************************************************************************************************/
  41. @SuppressWarnings("this-escape")
  42. public abstract class MutableIconProviderSupport implements MutableIconProvider
  43.   {
  44.     @Delegate
  45.     private final PropertyChangeSupport pcs = new PropertyChangeSupport(this);

  46.     @Delegate
  47.     private final MutableListenerSupport mls = new MutableListenerSupport(pcs);

  48.     /***********************************************************************************************************************************************************
  49.      * {@inheritDoc}
  50.      *
  51.      * FIXME: this method does nothing. Probably this is inconsistent with DefaultMutableDisplayable? But that is
  52.      * a Default*, we're just a *Support...
  53.      **********************************************************************************************************************************************************/
  54.     @Override
  55.     public void setIcon (@Nonnull final Icon icon)
  56.       {
  57.       }

  58.     /***********************************************************************************************************************************************************
  59.      * Fires the event notifying that {@link #PROP_ICON} has been changed.
  60.      *
  61.      * @param  oldIcon   the old value of the property
  62.      * @param  newIcon   the new value of the property
  63.      **********************************************************************************************************************************************************/
  64.     protected void fireIconChange (@Nonnull final Icon oldIcon, @Nonnull final Icon newIcon)
  65.       {
  66.         pcs.firePropertyChange(PROP_ICON, oldIcon, newIcon); // FIXME: should be in the EDT?
  67.       }
  68.   }