it.tidalwave.util.ui.LockableView Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of it-tidalwave-util Show documentation
There is a newer version: 3.2-ALPHA-23
/*
 * *********************************************************************************************************************
 *
 * TheseFoolishThings: Miscellaneous utilities
 * http://tidalwave.it/projects/thesefoolishthings
 *
 * Copyright (C) 2009 - 2023 by Tidalwave s.a.s. (http://tidalwave.it)
 *
 * *********************************************************************************************************************
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * 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 CONDITIONS OF ANY KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations under the License.
 *
 * *********************************************************************************************************************
 *
 * git clone https://bitbucket.org/tidalwave/thesefoolishthings-src
 * git clone https://github.com/tidalwave-it/thesefoolishthings-src
 *
 * *********************************************************************************************************************
 */
package it.tidalwave.util.ui;

import javax.annotation.Nonnull;

/***********************************************************************************************************************
 *
 * A partial contract for a View that can be locked with a "Please wait..." notification.
 *
 * @author  Fabrizio Giudici
 *
 **********************************************************************************************************************/
public interface LockableView
  {
    /*******************************************************************************************************************
     *
     * Shows a "Please wait..." notification and locks the UI.
     *
     * @param  notification  the notification
     *
     ******************************************************************************************************************/
    public void lock (@Nonnull UserNotification notification);

    /*******************************************************************************************************************
     *
     * Dismisses the waiting notification and unlocks the UI.
     *
     ******************************************************************************************************************/
    public void unlock();
  }