Package: MutableIconProvider

MutableIconProvider

name	instruction	branch	complexity	line	method
static {...}	M: 3 C: 0 0%	M: 0 C: 0 100%	M: 1 C: 0 0%	M: 1 C: 0 0%	M: 1 C: 0 0%

Coverage

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;
27:
28: import javax.annotation.Nonnull;
29: import java.beans.PropertyChangeListener;
30: import javax.swing.Icon;
31:
32: /***************************************************************************************************************************************************************
33: *
34: * A specialized {@link it.tidalwave.role.ui.IconProvider} which is mutable and fires {@code PropertyChangeEvent}s.
35: *
36: * @stereotype Role
37: *
38: * @author Fabrizio Giudici
39: * @it.tidalwave.javadoc.draft
40: *
41: **************************************************************************************************************************************************************/
42: public interface MutableIconProvider extends IconProvider
43: {
44: public static final Class<MutableIconProvider> _MutableIconProvider_ = MutableIconProvider.class;
45:
46: /** The property name for icon. */
47: public static final String PROP_ICON = "icon";
48:
49: /***********************************************************************************************************************************************************
50: * Sets the icon. Note that implementations don't actually need to do something in this method: for instance,
51: * a valid {@code MutableIconProvider} can autonomously change icon in function of time (e.g. a blinking icon) or
52: * reacting to a change in the context.
53: *
54: * @param icon the icon
55: **********************************************************************************************************************************************************/
56: @SuppressWarnings("EmptyMethod")
57: public void setIcon (@Nonnull Icon icon);
58:
59: /***********************************************************************************************************************************************************
60: * Registers a {@link PropertyChangeListener}.
61: *
62: * @param listener the listener
63: **********************************************************************************************************************************************************/
64: public void addPropertyChangeListener (@Nonnull PropertyChangeListener listener);
65:
66: /***********************************************************************************************************************************************************
67: * Unregisters a {@link PropertyChangeListener}.
68: *
69: * @param listener the listener
70: **********************************************************************************************************************************************************/
71: public void removePropertyChangeListener (@Nonnull PropertyChangeListener listener);
72: }