io.github.jonestimd.swing.action.BackgroundAction Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of swing-extensions Show documentation

Extensions for Java Swing

There is a newer version: 1.4.5

// The MIT License (MIT)
//
// Copyright (c) 2017 Timothy D. Jones
//
// 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 io.github.jonestimd.swing.action;

import java.awt.Component;
import java.awt.event.ActionEvent;
import java.util.ResourceBundle;

import io.github.jonestimd.swing.BackgroundTask;

/**
 * An abstract action for performing a task on a background thread.
 */
public abstract class BackgroundAction extends MnemonicAction {
    private final Component owner;
    private final String statusMessage;

    protected BackgroundAction(Component owner, ResourceBundle bundle, String resourcePrefix) {
        super(bundle, resourcePrefix);
        this.owner = owner;
        statusMessage = bundle.containsKey(resourcePrefix + ".status.initialize") ?
                bundle.getString(resourcePrefix + ".status.initialize") : null;
    }

    public final void actionPerformed(ActionEvent event) {
        if (confirmAction(event)) {
            BackgroundTask.task(statusMessage, this::performTask, this::updateUI).run(owner);
        }
    }

    protected abstract boolean confirmAction(ActionEvent event);

    protected abstract T performTask();

    protected abstract void updateUI(T result);

    protected boolean handleException(Throwable th) {
        return false;
    }
}