swing/control/SwingSettingsControl.java

/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */

/*
 * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */

package org.opensolaris.os.vp.panel.swing.control;

import java.awt.event.*;
import org.opensolaris.os.vp.panel.common.ClientContext;
import org.opensolaris.os.vp.panel.common.action.*;
import org.opensolaris.os.vp.panel.common.control.*;
import org.opensolaris.os.vp.panel.common.model.PanelDescriptor;
import org.opensolaris.os.vp.panel.swing.view.SettingsPanel;
import org.opensolaris.os.vp.util.misc.ChangeableAggregator;

/**
 * {@code SwingSettingsControl} extends class {@link SwingControl} to provide
 * support for {@link SettingsPanel}s.
 */
public class SwingSettingsControl<P extends PanelDescriptor,
    C extends SettingsPanel> extends SwingControl<P, C> {

    //
    // Constructors
    //

    public SwingSettingsControl(String id, String name, ClientContext context) {
	super(id, name, context);
    }

    public SwingSettingsControl(String id, String name, P descriptor) {
	super(id, name, descriptor);
    }

    //
    // SwingControl methods
    //

    /**
     * Returns {@code getComponent().getChangeableAggregator()}.
     */
    @Override
    public ChangeableAggregator getChangeableAggregator() {
	C comp = getComponent();
	if (comp != null) {
	    return comp.getChangeableAggregator();
	}
	return null;
    }

    //
    // SwingSettingsControl methods
    //

    /**
     * Adds a listener to the given {@link SettingsPanel}'s
     * <strong>Apply</strong> button to invoke this {@link Control}'s save
     * action.
     */
    protected void addDefaultApplyAction(SettingsPanel panel) {
	panel.getButtonBar().getApplyButton().addActionListener(
	    new ActionListener() {
		@Override
		public void actionPerformed(ActionEvent e) {
		    getSaveAction().asyncInvoke();
		}
	    });
    }

    /**
     * Adds a listener to the given {@link SettingsPanel}'s
     * <strong>Back</strong> button to navigate up one level in the navigation
     * stack.
     */
    protected void addDefaultBackAction(SettingsPanel panel) {
	panel.getButtonBar().getBackButton().addActionListener(
	    new ActionListener() {
		@Override
		public void actionPerformed(ActionEvent e) {
		    getNavigator().goToAsync(false, SwingSettingsControl.this,
			Navigator.PARENT_NAVIGABLE);
		}
	    });
    }

    /**
     * Adds a listener to the given {@link SettingsPanel}'s
     * <strong>Cancel</strong> button to call {@link #doQuit}, if {@code quit}
     * is {@code true}, or {@link #doCancel}, if {@code quit} is {@code false}.
     */
    protected void addDefaultCancelAction(final SettingsPanel panel,
	final boolean quit) {

	panel.getButtonBar().getCancelButton().addActionListener(
	    new ActionListener() {
		@Override
		public void actionPerformed(ActionEvent e) {
		    if (quit) {
			doQuit();
		    } else {
			doCancel();
		    }
		}
	    });
    }

    /**
     * Adds a listener to the given {@link SettingsPanel}'s
     * <strong>Close</strong> button to call {@link #doSaveAndQuit}, if {@code
     * quit} is {@code true}, or {@link #doOkay}, if {@code quit} is {@code
     * false}.
     */
    protected void addDefaultCloseAction(final SettingsPanel panel,
	final boolean quit) {

	panel.getButtonBar().getCloseButton().addActionListener(
	    new ActionListener() {
		@Override
		public void actionPerformed(ActionEvent e) {
		    if (quit) {
			doSaveAndQuit();
		    } else {
			doOkay();
		    }
		}
	    });
    }

    /**
     * Adds a listener to the given {@link SettingsPanel}'s
     * <strong>Help</strong> button to {@link DefaultControl#loadHelpURL show}
     * this {@code DefaultControl}'s {@link DefaultControl#getHelpURL help}.
     */
    protected void addDefaultHelpAction(SettingsPanel panel) {
	panel.getButtonBar().getHelpButton().addActionListener(
	    new ActionListener() {
		@Override
		public void actionPerformed(ActionEvent e) {
		    loadHelpURL();
		}
	    });
    }

    /**
     * Adds a listener to the given {@link SettingsPanel}'s
     * <strong>Okay</strong> button to call {@link #doSaveAndQuit}, if {@code
     * quit} is {@code true}, or {@link #doOkay}, if {@code quit} is {@code
     * false}.
     */
    protected void addDefaultOkayAction(final SettingsPanel panel,
	final boolean quit) {

	panel.getButtonBar().getOkayButton().addActionListener(
	    new ActionListener() {
		@Override
		public void actionPerformed(ActionEvent e) {
		    if (quit) {
			doSaveAndQuit();
		    } else {
			doOkay();
		    }
		}
	    });
    }

    /**
     * Adds a listener to the given {@link SettingsPanel}'s
     * <strong>Quit</strong> button to close this instance.
     */
    protected void addDefaultQuitAction(SettingsPanel panel) {
	panel.getButtonBar().getQuitButton().addActionListener(
	    new ActionListener() {
		@Override
		public void actionPerformed(ActionEvent e) {
		    doQuit();
		}
	    });
    }

    /**
     * Adds a listener to the given {@link SettingsPanel}'s
     * <strong>Reset</strong> button to invoke this {@link Control}'s reset
     * action.
     */
    protected void addDefaultResetAction(SettingsPanel panel) {
	panel.getButtonBar().getResetButton().addActionListener(
	    new ActionListener() {
		@Override
		public void actionPerformed(ActionEvent e) {
		    getResetAction().asyncInvoke();
		}
	    });
    }

    /**
     * Asynchronously closes this instance.
     */
    public void doQuit() {
	final StructuredAction<?, ?, ?> resetAction = getResetAction();
	resetAction.asyncExec(
	    new Runnable() {
		@Override
		public void run() {
		    try {
			getClientContext().closeInstance(true);
		    } catch (ActionException ignore) {
		    }
		}
	    });
    }

    /**
     * Asynchronously invokes this {@link Control}'s save action, then closes
     * this instance.
     */
    public void doSaveAndQuit() {
	final StructuredAction<?, ?, ?> saveAction = getSaveAction();
	saveAction.asyncExec(
	    new Runnable() {
		@Override
		public void run() {
		    try {
			saveAction.invoke();
			getClientContext().closeInstance(false);
		    } catch (ActionException ignore) {
		    }
		}
	    });
    }
}