Package: PanelGroupProvider

PanelGroupProvider

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;
27:
28: import jakarta.annotation.Nonnull;
29: import org.apiguardian.api.API;
30: import static org.apiguardian.api.API.Status.EXPERIMENTAL;
31:
32: /***************************************************************************************************************************************************************
33: *
34: * A service that provides a piece of he User Interface together with the definition of the group in the main window where it should be made visible (left,
35: * right, center or bottom). Instances of this class are looked up and managed by {@link PanelGroupControl}.
36: *
37: * @see PanelGroupControl
38: * @since 2.0-ALPHA-3
39: * @author Fabrizio Giudici
40: *
41: **************************************************************************************************************************************************************/
42: @API(status = EXPERIMENTAL)
43: public interface PanelGroupProvider<T>
44: {
45: /***********************************************************************************************************************************************************
46: * {@return the label associated to this User Interface piece}.
47: **********************************************************************************************************************************************************/
48: @Nonnull
49: public String getLabel();
50:
51: /***********************************************************************************************************************************************************
52: * {@return the presentation associated to this provider}.
53: * @since 2.0-ALPHA-5
54: **********************************************************************************************************************************************************/
55: @Nonnull
56: public Object getPresentation();
57:
58: /***********************************************************************************************************************************************************
59: * {@return the concrete UI component associated to this provider}.
60: **********************************************************************************************************************************************************/
61: @Nonnull
62: public T getComponent();
63:
64: /***********************************************************************************************************************************************************
65: * {@return the placement of this piece of the User Interface}.
66: **********************************************************************************************************************************************************/
67: @Nonnull
68: public PanelGroupControl.Group getGroup();
69: }