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: * 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;
27:
28: import jakarta.annotation.Nonnull;
29: import it.tidalwave.ui.core.Mutable;
30: import javax.swing.Icon;
31:
32: /***************************************************************************************************************************************************************
33: *
34: * A specialized {@link it.tidalwave.ui.core.role.IconProvider} which is mutable and fires {@code PropertyChangeEvent}s.
35: *
36: * @stereotype Role
37: *
38: * @since 2.0-ALPHA-1
39: * @author Fabrizio Giudici
40: * @it.tidalwave.javadoc.draft
41: *
42: **************************************************************************************************************************************************************/
43: public interface MutableIconProvider extends IconProvider, Mutable
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: * Sets the icon. Note that implementations don't actually need to do something in this method: for instance,
52: * a valid {@code MutableIconProvider} can autonomously change icon in function of time (e.g. a blinking icon) or
53: * reacting to a change in the context.
54: *
55: * @param icon the icon
56: **********************************************************************************************************************************************************/
57: @SuppressWarnings("EmptyMethod")
58: public void setIcon (@Nonnull Icon icon);
59: }