Dialog.java

/*
 * The MIT License
 *
 * Copyright 2014 noko
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package net.nokok.twitduke.core.view.dialog;

import net.nokok.twitduke.core.Disposable;
import net.nokok.twitduke.core.Visible;

/**
 * 表示可能なダイアログで必要なメソッドを定義するインターフェースです。
 * 実際の処理はDialogResultListenerインターフェース実装クラスに委譲します。
 *
 * @param <T> DialogResultListener#okButtonPushedメソッドの引数で使用される型
 *
 * @see net.nokok.twitduke.components.DialogResultListener
 */
public interface Dialog<T> extends Visible, Disposable {

    /**
     * ダイアログを表示します
     */
    @Override
    void show();

    /**
     * ダイアログを破棄します。このメソッドを実行後はダイアログが利用できなくなります。
     */
    @Override
    void dispose();

    /**
     * ダイアログで行う実際の処理の委譲先をセットします
     *
     * @param dialogResultListener ダイアログの操作結果を受け取るリスナー
     */
    void setDialogResultListener(DialogResultListener<T> dialogResultListener);
}