de.carne.swt.widgets.UserInterface Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of java-swt-gtk-linux-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;

import java.util.function.Supplier;

import org.eclipse.swt.widgets.Composite;

import de.carne.swt.graphics.ResourceException;

/**
 * Base class for SWT based user interfaces.
 *
 * @param  the root widget's type.
 */
public abstract class UserInterface implements Supplier {

	private final R root;

	/**
	 * Constructs a new {@linkplain UserInterface} instance.
	 *
	 * @param root the interface's root widget.
	 */
	protected UserInterface(R root) {
		this.root = root;
	}

	/**
	 * Gets the interface's root widget.
	 *
	 * @return the interface's root widget.
	 */
	public R root() {
		return this.root;
	}

	@Override
	public R get() {
		return this.root;
	}

	/**
	 * Sets up and opens the interface.
	 *
	 * @throws ResourceException if a required resource is not available.
	 */
	public abstract void open() throws ResourceException;

}