io.github.jonestimd.swing.dialog.FormDialog 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) 2019 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.dialog;

import java.awt.Window;
import java.util.ResourceBundle;

import io.github.jonestimd.swing.validation.FieldChangeTracker;

/**
 * A dialog with save and cancel buttons and a validation status area.  The save action is disabled unless there are unsaved changes.
 */
public class FormDialog extends ValidatedDialog {
    private final FieldChangeTracker changeTracker;

    /**
     * Create a document modal dialog.
     */
    public FormDialog(Window owner, String title, ResourceBundle bundle) {
        this(owner, title, ModalityType.DOCUMENT_MODAL, bundle);
    }

    public FormDialog(Window owner, String title, ModalityType modalityType, ResourceBundle bundle) {
        super(owner, title, modalityType, bundle);
        changeTracker = FieldChangeTracker.install(this::fieldsChanged, getFormPanel());
        addSaveCondition(changeTracker::isChanged);
    }

    /**
     * Called when a component value changes.
     * @param changed true if any fields have been modified from their original value
     */
    protected void fieldsChanged(boolean changed) {
        updateSaveEnabled();
    }

    /**
     * Clear the change state for all components in the dialog.
     */
    protected void resetChanges() {
        changeTracker.resetChanges();
    }
}