Package: LockableView

LockableView

Coverage

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
12: * the License. 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
17: * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
18: * specific language governing permissions and limitations under the License.
19: *
20: * *********************************************************************************************************************
21: *
22: * git clone https://bitbucket.org/tidalwave/thesefoolishthings-src
23: * git clone https://github.com/tidalwave-it/thesefoolishthings-src
24: *
25: * *********************************************************************************************************************
26: */
27: package it.tidalwave.util.ui;
28:
29: import javax.annotation.Nonnull;
30:
31: /***********************************************************************************************************************
32: *
33: * A partial contract for a View that can be locked with a "Please wait..." notification.
34: *
35: * @author Fabrizio Giudici
36: *
37: **********************************************************************************************************************/
38: public interface LockableView
39: {
40: /*******************************************************************************************************************
41: *
42: * Shows a "Please wait..." notification and locks the UI.
43: *
44: * @param notification the notification
45: *
46: ******************************************************************************************************************/
47: public void lock (@Nonnull UserNotification notification);
48:
49: /*******************************************************************************************************************
50: *
51: * Dismisses the waiting notification and unlocks the UI.
52: *
53: ******************************************************************************************************************/
54: public void unlock();
55: }