Visibility.java

  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.  *
  29.  * The role of an object that can be visible or not.
  30.  *
  31.  * @stereotype  Role
  32.  * @since       2.0-ALPHA-1
  33.  * @author      Fabrizio Giudici
  34.  *
  35.  **************************************************************************************************************************************************************/
  36. @FunctionalInterface
  37. public interface Visibility
  38.   {
  39.     /** Shortcut for {@link it.tidalwave.util.As}. */
  40.     public static final Class<Visibility> _Visibility_ = Visibility.class;

  41.     /***********************************************************************************************************************************************************
  42.      * A role that is always visible.
  43.      **********************************************************************************************************************************************************/
  44.     public static final Visibility VISIBLE = () -> true;

  45.     /***********************************************************************************************************************************************************
  46.      * A role that is always invisible.
  47.      **********************************************************************************************************************************************************/
  48.     public static final Visibility INVISIBLE = () -> false;

  49.     /***********************************************************************************************************************************************************
  50.      * Returns the current visibility status.
  51.      *
  52.      * @return            {@code true} if the object is visible
  53.      **********************************************************************************************************************************************************/
  54.     @SuppressWarnings("UnusedReturnValue")
  55.     public boolean isVisible();
  56.   }