1 /*
2  * ApplicationView.java
3  *
4  * Copyright (C) 2021 by RStudio, PBC
5  *
6  * Unless you have received this program directly from RStudio pursuant
7  * to the terms of a commercial license agreement with RStudio, then
8  * this program is licensed to you under the terms of version 3 of the
9  * GNU Affero General Public License. This program is distributed WITHOUT
10  * ANY EXPRESS OR IMPLIED WARRANTY, INCLUDING THOSE OF NON-INFRINGEMENT,
11  * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Please refer to the
12  * AGPL (http://www.gnu.org/licenses/agpl-3.0.txt) for more details.
13  *
14  */
15 
16 package org.rstudio.studio.client.application;
17 
18 import com.google.gwt.user.client.ui.Widget;
19 import org.rstudio.core.client.widget.AriaLiveStatusReporter;
20 import org.rstudio.studio.client.application.events.AriaLiveStatusEvent.Severity;
21 
22 public interface ApplicationView extends AriaLiveStatusReporter
23 {
24    // set current main view for application
showWorkbenchView(Widget widget)25    void showWorkbenchView(Widget widget);
26 
27    // toolbar
showToolbar(boolean showToolbar, boolean announce)28    void showToolbar(boolean showToolbar, boolean announce);
isToolbarShowing()29    boolean isToolbarShowing();
focusToolbar()30    void focusToolbar();
31 
32    // application exit states
showApplicationQuit()33    void showApplicationQuit();
showApplicationMultiSessionQuit()34    void showApplicationMultiSessionQuit();
showApplicationSuicide(String reason)35    void showApplicationSuicide(String reason);
showApplicationDisconnected()36    void showApplicationDisconnected();
showApplicationOffline()37    void showApplicationOffline();
showApplicationUpdateRequired()38    void showApplicationUpdateRequired();
39 
40    // error messages
showSessionAbendWarning()41    void showSessionAbendWarning();
42 
43    // status or alert message for screen reader users,
44    @Override
reportStatus(String message, int delayMs, Severity severity)45    void reportStatus(String message, int delayMs, Severity severity);
46 
47    // progress
showSerializationProgress(String message, boolean modal, int delayMs, int timeoutMs)48    void showSerializationProgress(String message,
49                                   boolean modal,
50                                   int delayMs,
51                                   int timeoutMs);
hideSerializationProgress()52    void hideSerializationProgress();
53 
getWidget()54    Widget getWidget();
55 
showLicenseWarning(boolean severe, String message)56    void showLicenseWarning(boolean severe, String message);
showWarning(boolean severe, String message)57    void showWarning(boolean severe, String message);
hideWarning()58    void hideWarning();
59 }
60 
61