de.carne.swt.widgets.aboutinfo.AboutInfoDialog Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-swt-cocoa-macosx-x86_64 Show documentation
Common SWT code shared between my projects
The newest version!
/*
 * Copyright (c) 2007-2020 Holger de Carne and contributors, All Rights Reserved.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package de.carne.swt.widgets.aboutinfo;

import java.net.URL;
import java.util.ArrayList;
import java.util.List;

import org.eclipse.jdt.annotation.Nullable;
import org.eclipse.swt.SWT;
import org.eclipse.swt.widgets.Dialog;
import org.eclipse.swt.widgets.Shell;

import de.carne.swt.graphics.ResourceException;
import de.carne.util.ManifestInfos;

/**
 * Dialog for display of version and copyright information.
 */
public class AboutInfoDialog extends Dialog {

	private final ManifestInfos moduleInfos;
	private @Nullable URL logoUrl = null;
	private List copyrightUrls = new ArrayList<>();

	private AboutInfoDialog(Shell parent, ManifestInfos moduleInfos) {
		super(parent, SWT.DIALOG_TRIM | SWT.RESIZE | SWT.APPLICATION_MODAL);
		this.moduleInfos = moduleInfos;
	}

	/**
	 * Convenience function for starting a {@linkplain AboutInfoDialog} setup.
	 *
	 * @param parent the dialog's parent.
	 * @param moduleInfos the module manifest information to display.
	 * @return the created {@linkplain AboutInfoDialog} instance for chaining.
	 * @see ManifestInfos
	 */
	public static AboutInfoDialog build(Shell parent, ManifestInfos moduleInfos) {
		return new AboutInfoDialog(parent, moduleInfos);
	}

	/**
	 * Sets the dialog's logo.
	 *
	 * @param logo the {@linkplain URL} of the logo to display.
	 * @return the updated {@linkplain AboutInfoDialog} instance for chaining.
	 */
	public AboutInfoDialog withLogo(URL logo) {
		this.logoUrl = logo;
		return this;
	}

	/**
	 * Adds a copyright info.
	 * 
	 * The first line of the copyright info is used as a copyright title the remaining lines are used as the actual
	 * copyright info.
	 *
	 * @param copyright the {@linkplain URL} of the copyright info to display.
	 * @return the updated {@linkplain AboutInfoDialog} instance for chaining.
	 */
	public AboutInfoDialog withCopyright(URL copyright) {
		this.copyrightUrls.add(copyright);
		return this;
	}

	/**
	 * Opens and runs the dialog.
	 *
	 * @throws ResourceException if a required resource is not available.
	 */
	public void open() throws ResourceException {
		AboutInfoUI userInterface = new AboutInfoUI(new Shell(getParent(), getStyle()), this.moduleInfos, this.logoUrl,
				this.copyrightUrls);

		userInterface.open();
		userInterface.run();
	}

}