com.vaadin.ui.ReconnectDialogConfiguration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vaadin-server Show documentation
Vaadin server
There is a newer version: 8.27.3
/*
 * Copyright (C) 2000-2024 Vaadin Ltd
 *
 * This program is available under Vaadin Commercial License and Service Terms.
 *
 * See  for the full
 * license.
 */

package com.vaadin.ui;

import java.io.Serializable;

/**
 * Provides method for configuring the reconnect dialog.
 *
 * @since 7.6
 * @author Vaadin Ltd
 */
public interface ReconnectDialogConfiguration extends Serializable {
    /**
     * Gets the text to show in the reconnect dialog when trying to re-establish
     * the server connection.
     *
     * @return the text to show in the reconnect dialog
     */
    public String getDialogText();

    /**
     * Sets the text to show in the reconnect dialog when trying to
     * re-establish. the server connection
     *
     * @param dialogText
     *            the text to show in the reconnect dialog
     */
    public void setDialogText(String dialogText);

    /**
     * Gets the text to show in the reconnect dialog after giving up trying to
     * reconnect ({@link #getReconnectAttempts()} reached).
     *
     * @return the text to show in the reconnect dialog after giving up
     */
    public String getDialogTextGaveUp();

    /**
     * Sets the text to show in the reconnect dialog after giving up trying to
     * reconnect ({@link #getReconnectAttempts()} reached).
     *
     * @param dialogTextGaveUp
     *            the text to show in the reconnect dialog after giving up
     */
    public void setDialogTextGaveUp(String dialogTextGaveUp);

    /**
     * Gets the number of times to try to reconnect to the server before giving
     * up.
     *
     * @return the number of times to try to reconnect
     */
    public int getReconnectAttempts();

    /**
     * Sets the number of times to try to reconnect to the server before giving
     * up.
     *
     * @param reconnectAttempts
     *            the number of times to try to reconnect
     */
    public void setReconnectAttempts(int reconnectAttempts);

    /**
     * Gets the interval (in milliseconds) between reconnect attempts.
     *
     * @return the interval (in ms) between reconnect attempts
     */
    public int getReconnectInterval();

    /**
     * Sets the interval (in milliseconds) between reconnect attempts.
     *
     * @param reconnectInterval
     *            the interval (in ms) between reconnect attempts
     */
    public void setReconnectInterval(int reconnectInterval);

    /**
     * Gets the timeout (in milliseconds) between noticing a loss of connection
     * and showing the dialog.
     *
     * @return the time to wait before showing a dialog
     */
    public int getDialogGracePeriod();

    /**
     * Sets the timeout (in milliseconds) between noticing a loss of connection
     * and showing the dialog.
     *
     * @param dialogGracePeriod
     *            the time to wait before showing a dialog
     */
    public void setDialogGracePeriod(int dialogGracePeriod);

    /**
     * Sets the modality of the dialog.
     * 
     * If the dialog is set to modal, it will prevent the usage of the
     * application while the dialog is being shown. If not modal, the user can
     * continue to use the application as normally and all server events will be
     * queued until connection has been re-established.
     *
     * @param dialogModal
     *            true to make the dialog modal, false otherwise
     */
    public void setDialogModal(boolean dialogModal);

    /**
     * Checks the modality of the dialog.
     * 
     *
     * @see #setDialogModal(boolean)
     * @return true if the dialog is modal, false otherwise
     */
    public boolean isDialogModal();
}

class ReconnectDialogConfigurationImpl implements ReconnectDialogConfiguration {
    private final UI ui;

    public ReconnectDialogConfigurationImpl(UI ui) {
        this.ui = ui;
    }

    @Override
    public String getDialogText() {
        return ui.getState(false).reconnectDialogConfiguration.dialogText;
    }

    @Override
    public void setDialogText(String dialogText) {
        ui.getState().reconnectDialogConfiguration.dialogText = dialogText;
    }

    @Override
    public String getDialogTextGaveUp() {
        return ui.getState(false).reconnectDialogConfiguration.dialogTextGaveUp;
    }

    @Override
    public void setDialogTextGaveUp(String dialogTextGaveUp) {
        ui.getState().reconnectDialogConfiguration.dialogTextGaveUp = dialogTextGaveUp;
    }

    @Override
    public int getReconnectAttempts() {
        return ui
                .getState(false).reconnectDialogConfiguration.reconnectAttempts;
    }

    @Override
    public void setReconnectAttempts(int reconnectAttempts) {
        ui.getState().reconnectDialogConfiguration.reconnectAttempts = reconnectAttempts;
    }

    @Override
    public int getReconnectInterval() {
        return ui
                .getState(false).reconnectDialogConfiguration.reconnectInterval;
    }

    @Override
    public void setReconnectInterval(int reconnectInterval) {
        ui.getState().reconnectDialogConfiguration.reconnectInterval = reconnectInterval;
    }

    @Override
    public int getDialogGracePeriod() {
        return ui
                .getState(false).reconnectDialogConfiguration.dialogGracePeriod;
    }

    @Override
    public void setDialogGracePeriod(int dialogGracePeriod) {
        ui.getState().reconnectDialogConfiguration.dialogGracePeriod = dialogGracePeriod;
    }

    @Override
    public boolean isDialogModal() {
        return ui.getState(false).reconnectDialogConfiguration.dialogModal;
    }

    @Override
    public void setDialogModal(boolean dialogModal) {
        ui.getState().reconnectDialogConfiguration.dialogModal = dialogModal;
    }

}