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 /***************************************************************************************************************************************************************
29 *
30 * The role of an object that can be visible or not.
31 *
32 * @stereotype Role
33 * @author Fabrizio Giudici
34 * @since 3.2-ALPHA-7
35 *
36 **************************************************************************************************************************************************************/
37 @FunctionalInterface
38 public interface Visible
39 {
40 public static final Class<Visible> _Visible_ = Visible.class;
41
42 /***********************************************************************************************************************************************************
43 * A role that is always visible.
44 **********************************************************************************************************************************************************/
45 public static final Visible VISIBLE = () -> true;
46
47 /***********************************************************************************************************************************************************
48 * A role that is always invisible.
49 **********************************************************************************************************************************************************/
50 public static final Visible INVISIBLE = () -> false;
51
52 /***********************************************************************************************************************************************************
53 * Returns the current visibility status.
54 *
55 * @return {@code true} if the object is visible
56 **********************************************************************************************************************************************************/
57 @SuppressWarnings("UnusedReturnValue")
58 public boolean isVisible();
59 }