tools.aqua.bgw.dialog.Dialog.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bgw-core Show documentation
A framework for board game applications.
There is a newer version: 0.5
/*
 *    Copyright 2021 The BoardGameWork Authors
 *    SPDX-License-Identifier: Apache-2.0
 *
 *    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.
 */

@file:Suppress("unused")

package tools.aqua.bgw.dialog

/**
 * Shows a dialog containing the given [message] and [buttons].
 *
 * @constructor Internal constructor. Refer to secondary constructors.
 *
 * @param dialogType the [DialogType] of the alert. Affects the displayed icon.
 * @param title title to be shown.
 * @param header headline to be shown in the dialogs content.
 * @param message message to be shown.
 * @param exception throwable to be shown in expandable content.
 * @param buttons buttons to be shown. Standard set of buttons according to [dialogType] will be used if you don't pass
 * any [ButtonType]s.
 */
class Dialog private constructor(
	val dialogType: DialogType,
	val title: String,
	val header: String,
	val message: String,
	val exception: Throwable? = null,
	vararg val buttons: ButtonType
) {
	/**
	 * Creates a [Dialog].
	 * For exception dialogs refer to exception constructor.
	 *
	 * @param dialogType the [DialogType] of the alert. Affects the displayed icon.
	 * @param title title to be shown.
	 * @param header headline to be shown in the dialogs content.
	 * @param message message to be shown in the dialogs content.
	 * @param buttons buttons to be shown. Standard set of buttons according to [dialogType] will be used if you don't pass
	 * any [ButtonType]s.
	 */
	constructor(dialogType: DialogType, title: String, header: String, message: String, vararg buttons: ButtonType) :
			this(dialogType, title, header, message, null, *buttons) {
		require(dialogType != DialogType.EXCEPTION) {
			"To create an Exception dialog use exception dialog constructor."
		}
	}
	
	/**
	 * Creates an [exception] [Dialog].
	 * For information dialogs refer to information constructor.
	 *
	 * @param title title to be shown.
	 * @param header headline to be shown in the dialogs content.
	 * @param message message to be shown.
	 * @param exception throwable to be shown in expandable content.
	 */
	constructor(title: String, header: String, message: String, exception: Throwable) :
			this(DialogType.EXCEPTION, title, header, message, exception, ButtonType.OK)
}