/*

 * 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.*;

import java.awt.event.*;

import java.beans.*;

import java.util.*;

import java.util.List;

import javax.swing.*;

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.*;

import org.opensolaris.os.vp.panel.swing.action.SwingStructuredAction;

import org.opensolaris.os.vp.panel.swing.view.UITransitionManager;

import org.opensolaris.os.vp.util.misc.*;

import org.opensolaris.os.vp.util.swing.*;

public class SwingControl<P extends PanelDescriptor, C extends Component>

    extends DefaultControl<P> implements HasComponent<C>,

    PropertyChangeListener {

    //

    // Instance data

    //

    private ManagedObject propSource;

    private String[] propNames;

    private boolean ignorePropChange;

    private C comp;

    private ComponentStack stack;

    private JDialog childDialog;

    private List<Control> dialogChildren = new ArrayList<Control>();

    private SwingStructuredAction<Object, Object, Object> resetAction =

	new SwingStructuredAction<Object, Object, Object>(null, null, null,

	    this) {

	    @Override

	    public Object workBusy(Object pInput, Object rtInput)

		throws ActionAbortedException, ActionFailedException,

		ActionUnauthorizedException {

		resetAll();

		return null;

	    }

	};

    private SwingStructuredAction<Object, Object, Object> saveAction =

	new SwingStructuredAction<Object, Object, Object>(null, null, null,

	    this) {

	    @Override

	    public Object workBusy(Object pInput, Object rtInput)

		throws ActionAbortedException, ActionFailedException,

		ActionUnauthorizedException {

		saveAll();

		return null;

	    }

	};

    //

    // Constructors

    //

    public SwingControl(String id, String name, ClientContext context) {

	super(id, name, context);

    }

    public SwingControl(String id, String name, P descriptor) {

	super(id, name, descriptor);

    }

    //

    // HasComponent methods

    //

    /**

     * Gets the {@code Component} for this {@code SwingControl}.

     *

     * @return	    a {@code Component}, or {@code null} if this {@code

     *		    SwingControl} has no {@code Component}.

     *

     * @see	    #setComponent

     */

    @Override

    public C getComponent() {

	return comp;

    }

    //

    // PropertyChangeListener methods

    //

    /**

     * Convenience implementation that calls {@link #initComponentOnEventThread}

     * if property changes are not temporarilty being {@link

     * #getPropertyChangeIgnore ignored}.  If this {@link SwingControl}'s

     * component displayed the properties of a {@link ManagedObject}, for

     * example, it may make sense to add this {@code SwingControl} as a {@code

     * PropertyListener} to that object.

     */

    @Override

    public void propertyChange(PropertyChangeEvent event) {

	if (!ignorePropChange && getComponent() != null) {

	    initComponentOnEventThread();

	}

    }

    //

    // Control methods

    //

    @Override

    public void childStarted(final Control child) {

	super.childStarted(child);

	assert childDialog == null;

	if (dialogChildren.contains(child)) {

	    Component comp = getComponent();

	    final Window owner = SwingUtilities.getWindowAncestor(comp);

	    childDialog = new JDialog(owner,

		Dialog.ModalityType.DOCUMENT_MODAL);

	    Container cont = childDialog.getContentPane();

	    cont.setLayout(new BorderLayout());

	    Component cComp = ((SwingControl)child).getComponent();

	    cont.add(cComp, BorderLayout.CENTER);

	    if (child instanceof HasImages) {

		List<? extends Image> images = ((HasImages)child).getImages();

		childDialog.setIconImages(images);

	    }

	    childDialog.setTitle(child.getName());

	    childDialog.setDefaultCloseOperation(

		WindowConstants.DISPOSE_ON_CLOSE);

	    childDialog.pack();

	    childDialog.addWindowListener(

		new WindowAdapter() {

		    @Override

		    public void windowClosing(WindowEvent e) {

			childDialog.removeWindowListener(this);

			child.doCancel();

		    }

		});

	    // Show the window after navigation has completed

	    getNavigator().asyncExec(

		new Runnable() {

		    @Override

		    public void run() {

			EventQueue.invokeLater(

			    new Runnable() {

				@Override

				public void run() {

				    childDialog.setLocationRelativeTo(owner);

				    childDialog.setVisible(true);

				}

			    });

		    }

		});

	}

    }

    @Override

    public void childStopped(Control child) {

	super.childStopped(child);

	if (childDialog != null) {

	    childDialog.dispose();

	    childDialog = null;

	}

    }

    /**

     * If a) this {@code SwingControl} defines a {@link #getComponentStack

     * ComponentStack}, b) the just-started {@link Control} implements {@link

     * HasComponent}, and c) its {@code Component} does not yet have a parent,

     * this method adds that {@code Component} to the stack.

     */

    @Override

    public void descendantStarted(Control[] path) {

	super.descendantStarted(path);

	final ComponentStack stack = getComponentStack();

	if (stack != null) {

	    Control control = path[path.length - 1];

	    if (control instanceof HasComponent) {

		final Component comp = ((HasComponent)control).getComponent();

		if (comp != null && comp.getParent() == null) {

		    GUIUtil.invokeAndWait(

			new Runnable() {

			    @Override

			    public void run() {

				stack.push(comp);

			    }

			});

		}

	    }

	}

    }

    /**

     * If a) this {@code SwingControl} defines a {@link #getComponentStack

     * ComponentStack}, b) the just-stopped {@link Control} implements {@link

     * HasComponent}, and c) its {@code Component} is at the top of the stack,

     * this method removes that {@code Component} from the stack.

     */

    @Override

    public void descendantStopped(Control[] path) {

	super.descendantStopped(path);

	final ComponentStack stack = getComponentStack();

	if (stack != null) {

	    Control control = path[path.length - 1];

	    if (control instanceof HasComponent) {

		final Component comp = ((HasComponent)control).getComponent();

		if (comp != null) {

		    GUIUtil.invokeAndWait(

			new Runnable() {

			    @Override

			    public void run() {

				StackUtil.popIfAtTop(stack, comp);

			    }

			});

		}

	    }

	}

    }

    /**

     * Gets a {@link SwingStructuredAction} that invokes {@link #resetAll},

     * displaying errors.

     */

    @Override

    public SwingStructuredAction<?, ?, ?> getResetAction() {

	return resetAction;

    }

    /**

     * Gets a {@link SwingStructuredAction} that invokes {@link #saveAll},

     * displaying errors and prompting for login on {@code

     * ActionUnauthorizedException}s.

     */

    @Override

    public SwingStructuredAction<?, ?, ?> getSaveAction() {

	return saveAction;

    }

    /**

     * If this {@code SwingControl} has a {@link #getChangeableAggregator

     * ChangeableAggregator}, returns the value from the aggregator's {@link

     * ChangeableAggregator#isChanged isChanged} method.  Otherwise, returns

     * {@code false}.

     */

    @Override

    protected boolean isSaveNeeded() {

	ChangeableAggregator aggregator = getChangeableAggregator();

	if (aggregator != null) {

	    return aggregator.isChanged();

	}

	return false;

    }

    /**

     * If this {@code SwingControl} has a {@link #getChangeableAggregator

     * ChangeableAggregator}, calls its {@link ChangeableAggregator#reset}

     * method on the AWT event thread and waits for its completion.

     */

    @Override

    protected void reset() throws ActionAbortedException, ActionFailedException

    {

	final ChangeableAggregator aggregator = getChangeableAggregator();

	if (aggregator != null) {

	    GUIUtil.invokeAndWait(

		new Runnable() {

		    @Override

		    public void run() {

			aggregator.reset();

		    }

		});

	}

    }

    /**

     * If this {@code SwingControl} has a {@link #getChangeableAggregator

     * ChangeableAggregator}, calls its {@link ChangeableAggregator#save}

     * method on the AWT event thread and waits for its completion.

     */

    @Override

    protected void save() throws ActionAbortedException, ActionFailedException,

	ActionUnauthorizedException {

	final ChangeableAggregator aggregator = getChangeableAggregator();

	if (aggregator != null) {

	    GUIUtil.invokeAndWait(

		new Runnable() {

		    @Override

		    public void run() {

			aggregator.save();

		    }

		});

	}

    }

    /**

     * Calls the superclass implementation, {@link #getComponentCreate creates}

     * this {@code SwingControl}'s {@code Component} if necessary, then

     * {@link #initComponentOnEventThread initializes} it.

     */

    @Override

    public void start(Navigator navigator, Map<String, String> parameters)

	throws NavigationAbortedException, InvalidParameterException {

	super.start(navigator, parameters);

	if (propSource != null) {

	    if (propNames == null) {

		propSource.addPropertyChangeListener(this);

	    } else {

		for (String propName : propNames) {

		    propSource.addPropertyChangeListener(propName, this);

		}

	    }

	}

	Component comp = getComponentCreate();

	if (comp != null) {

	    initComponentOnEventThread();

	}

    }

    /**

     * Calls the superclass implementation, then {@link

     * #deinitComponentOnEventThread deinitializes} this {@code SwingControl}'s

     * {@code Component}.

     *

     * @exception   NavigationAbortedException

     *		    if the navigation is cancelled, or a save fails

     */

    @Override

    public void stop(boolean isCancel) throws NavigationAbortedException {

	super.stop(isCancel);

	Component comp = getComponent();

	if (comp != null) {

	    deinitComponentOnEventThread();

	}

	if (propSource != null) {

	    propSource.removePropertyChangeListener(this);

	    propSource = null;

	    propNames = null;

	}

    }

    //

    // DefaultControl methods

    //

    @Override

    protected void removeChild(int index) {

	synchronized (children) {

	    Control child = children.get(index);

	    children.remove(index);

	    dialogChildren.remove(child);

	}

    }

    //

    // SwingControl methods

    //

    /**

     * Calls {@link DefaultControl#addChildren addChildren} with the given

     * controls.  When a child in the given list is started, it will

     * automatically be placed in a modal dialog that corresponds to the child's

     * lifecycle.

     */

    public void addDialogChildren(Control... controls) {

	super.addChildren(controls);

	for (Control child : controls) {

	    dialogChildren.add(child);

	}

    }

    /**

     * Configures the just-{@code #createComponent created} {@code Component}

     * for this {@code SwingControl}.  This method is called automatically just

     * after {@code createComponent}.

     * This default implementation does nothing.  Most subclasses can do all

     * configuration in {@link #createComponent}.  Only implementors that wish

     * to provide a common configuration for all {@code Component}s created by

     * their subclasses need to implement this method.

     *

     * @param	    comp

     *		    the newly-created {@code Component}

     */

    protected void configComponent(C comp) {

    }

    /**

     * Creates the {@code Component} for this {@code SwingControl}.

     * This default implementation does nothing and returns {@code null}.

     *

     * @return	    the newly-created {@code Component}

     */

    protected C createComponent() {

	return null;

    }

    /**

     * De-initializes the {@code Component} for this {@code SwingControl}.  This

     * method is called automatically when this {@code Control} is stopped.

     * This default implementation does nothing.

     */

    protected void deinitComponent() {

    }

    /**

     * Calls {@link #deinitComponent} on the event queue thread and waits until

     * it has completed.  This method is called automatically when this {@code