View Javadoc
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.util.ui;
27  
28  import javax.annotation.Nonnull;
29  
30  /***************************************************************************************************************************************************************
31   *
32   * A partial contract for a View that can be locked with a "Please wait..." notification.
33   *
34   * @author  Fabrizio Giudici
35   *
36   **************************************************************************************************************************************************************/
37  public interface LockableView
38    {
39      /***********************************************************************************************************************************************************
40       * Shows a "Please wait..." notification and locks the UI.
41       *
42       * @param  notification  the notification
43       **********************************************************************************************************************************************************/
44      public void lock (@Nonnull UserNotification notification);
45  
46      /***********************************************************************************************************************************************************
47       * Dismisses the waiting notification and unlocks the UI.
48       **********************************************************************************************************************************************************/
49      public void unlock();
50    }