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 - 2023 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
12: * the License. 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
17: * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
18: * specific language governing permissions and limitations under the License.
19: *
20: * *********************************************************************************************************************
21: *
22: * git clone https://bitbucket.org/tidalwave/thesefoolishthings-src
23: * git clone https://github.com/tidalwave-it/thesefoolishthings-src
24: *
25: * *********************************************************************************************************************
26: */
27: package it.tidalwave.role.ui;
28:
29: import javax.annotation.Nonnull;
30: import java.beans.PropertyChangeListener;
31: import javax.swing.Icon;
32:
33: /***********************************************************************************************************************
34: *
35: * A specialized {@link it.tidalwave.role.ui.IconProvider} which is mutable and fires {@code PropertyChangeEvent}s.
36: *
37: * @stereotype Role
38: *
39: * @author Fabrizio Giudici
40: * @it.tidalwave.javadoc.draft
41: *
42: **********************************************************************************************************************/
43: public interface MutableIconProvider extends IconProvider
44: {
45: public static final Class<MutableIconProvider> _MutableIconProvider_ = MutableIconProvider.class;
46:
47: /** The property name for icon. */
48: public static final String PROP_ICON = "icon";
49:
50: /*******************************************************************************************************************
51: *
52: * Sets the icon. Note that implementations don't actually need to do something in this method: for instance,
53: * a valid {@code MutableIconProvider} can autonomously change icon in function of time (e.g. a blinking icon) or
54: * reacting to a change in the context.
55: *
56: * @param icon the icon
57: *
58: ******************************************************************************************************************/
59: @SuppressWarnings("EmptyMethod")
60: public void setIcon (@Nonnull Icon icon);
61:
62: /*******************************************************************************************************************
63: *
64: * Registers a {@link PropertyChangeListener}.
65: *
66: * @param listener the listener
67: *
68: ******************************************************************************************************************/
69: public void addPropertyChangeListener (@Nonnull PropertyChangeListener listener);
70:
71: /*******************************************************************************************************************
72: *
73: * Unregisters a {@link PropertyChangeListener}.
74: *
75: * @param listener the listener
76: *
77: ******************************************************************************************************************/
78: public void removePropertyChangeListener (@Nonnull PropertyChangeListener listener);
79: }