<change id="ViewFactory">

        <api name="DebuggerCoreSPI"/>

        <summary><code>ViewFactory</code> and <code>ViewLifecycle</code> classes added.</summary>

        <version major="2" minor="34"/>

        <date day="17" month="8" year="2012"/>

        <author login="mentlicher"/>

        <compatibility binary="compatible" source="compatible" addition="yes" semantic="compatible"/>

        <description>

            <p>

                <code>ViewFactory</code> class introduced to provide GUI views

                created from registered view models.

                <code>ViewLifecycle</code> class is a support class for a custom view

                based on registered view models.

            </p>

        </description>

        <class package="org.netbeans.spi.debugger.ui" name="ViewFactory"/>

        <class package="org.netbeans.spi.debugger.ui" name="ViewLifecycle"/>

        <issue number="198385"/>

    </change>

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 2012 Oracle and/or its affiliates. All rights reserved.

 *

 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.

 * Other names may be trademarks of their respective owners.

 *

 * The contents of this file are subject to the terms of either the GNU

 * General Public License Version 2 only ("GPL") or the Common

 * Development and Distribution License("CDDL") (collectively, the

 * "License"). You may not use this file except in compliance with the

 * License. You can obtain a copy of the License at

 * http://www.netbeans.org/cddl-gplv2.html

 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the

 * specific language governing permissions and limitations under the

 * License.  When distributing the software, include this License Header

 * Notice in each file and include the License file at

 * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the GPL Version 2 section of the License file that

 * accompanied this code. If applicable, add the following below the

 * License Header, with the fields enclosed by brackets [] replaced by

 * your own identifying information:

 * "Portions Copyrighted [year] [name of copyright owner]"

 *

 * If you wish your version of this file to be governed by only the CDDL

 * or only the GPL Version 2, indicate your decision by adding

 * "[Contributor] elects to include this software in this distribution

 * under the [CDDL or GPL Version 2] license." If you do not indicate a

 * single choice of license, a recipient has the option to distribute

 * your version of this file under either the CDDL, the GPL Version 2 or

 * to extend the choice of license to its licensees as provided above.

 * However, if you add GPL Version 2 code and therefore, elected the GPL

 * Version 2 license, then the option applies only if the new code is

 * made subject to such option by the copyright holder.

 *

 * Contributor(s):

 *

 * Portions Copyrighted 2012 Sun Microsystems, Inc.

 */

package org.netbeans.modules.debugger.ui.views;

import java.io.Serializable;

import org.netbeans.spi.debugger.ui.ViewLifecycle.ModelUpdateListener;

/**

 * Additional view for custom model set.

 * 

 * @author Martin Entlicher

 */

public class CustomView extends View {

    private transient String icon;

    private transient String displayName;

    private transient String toolTip;

    public CustomView(String icon, String name, String helpID, String propertiesHelpID,

                      String displayName, String toolTip) {

        super(icon, name, helpID, propertiesHelpID, null, null);

        this.icon = icon;

        this.displayName = displayName;

        this.toolTip = toolTip;

    }

    @Override

    public String getName() {

        return displayName;

    }

    @Override

    public String getToolTipText() {

        return toolTip;

    }

    public static ViewModelListener createViewModelService(String name,

                                                           String propertiesHelpID,

                                                           ModelUpdateListener mul) {

        return new ViewModelListener(name, propertiesHelpID, mul);

    }

    @Override

    public Object writeReplace() {

        return new ResolvableHelper(icon, name, helpID, propertiesHelpID, displayName, toolTip);

    }

    /**

     * The serializing class.

     */

    private static final class ResolvableHelper implements Serializable {

        private String[] data;

        private static final long serialVersionUID = 1L;

        ResolvableHelper(String... data) {

            this.data = data;

        }

        public ResolvableHelper() {

            // Just for the purpose of deserialization

        }

        public Object readResolve() {

            return new CustomView(data[0], data[1], data[2], data[3], data[4], data[5]);

        }

    }

}

import java.awt.Image;

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 2012 Oracle and/or its affiliates. All rights reserved.

 *

 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.

 * Other names may be trademarks of their respective owners.

 *

 * The contents of this file are subject to the terms of either the GNU

 * General Public License Version 2 only ("GPL") or the Common

 * Development and Distribution License("CDDL") (collectively, the

 * "License"). You may not use this file except in compliance with the

 * License. You can obtain a copy of the License at

 * http://www.netbeans.org/cddl-gplv2.html

 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the

 * specific language governing permissions and limitations under the

 * License.  When distributing the software, include this License Header

 * Notice in each file and include the License file at

 * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the GPL Version 2 section of the License file that

 * accompanied this code. If applicable, add the following below the

 * License Header, with the fields enclosed by brackets [] replaced by

 * your own identifying information:

 * "Portions Copyrighted [year] [name of copyright owner]"

 *

 * If you wish your version of this file to be governed by only the CDDL

 * or only the GPL Version 2, indicate your decision by adding

 * "[Contributor] elects to include this software in this distribution

 * under the [CDDL or GPL Version 2] license." If you do not indicate a

 * single choice of license, a recipient has the option to distribute

 * your version of this file under either the CDDL, the GPL Version 2 or

 * to extend the choice of license to its licensees as provided above.

 * However, if you add GPL Version 2 code and therefore, elected the GPL

 * Version 2 license, then the option applies only if the new code is

 * made subject to such option by the copyright holder.

 *

 * Contributor(s):

 *

 * Portions Copyrighted 2012 Sun Microsystems, Inc.

 */

package org.netbeans.modules.debugger.ui.views;

import java.awt.BorderLayout;

import javax.swing.JComponent;

import javax.swing.JToolBar;

import javax.swing.UIManager;

import org.openide.util.HelpCtx;

import org.openide.util.ImageUtilities;

/**

 *

 * @author Martin Entlicher

 */

public class ViewComponent extends JComponent implements org.openide.util.HelpCtx.Provider {

    private String icon;

    private String name;

    private String helpID;

    private String propertiesHelpID;

    private transient JComponent contentComponent;

    private ViewModelListener viewModelListener;

    public ViewComponent(String icon, String name, String helpID, String propertiesHelpID) {

        this.icon = icon;

        this.name = name;

        this.helpID = helpID;

        this.propertiesHelpID = propertiesHelpID;

        initComponents();

    }

    private void initComponents() {

        setLayout (new BorderLayout ());

        contentComponent = new javax.swing.JPanel(new BorderLayout ());

        add (contentComponent, BorderLayout.CENTER);  //NOI18N

        JToolBar toolBar = new JToolBar(JToolBar.VERTICAL);

        toolBar.setFloatable(false);

        toolBar.setRollover(true);

        toolBar.setBorderPainted(true);

        if( "Aqua".equals(UIManager.getLookAndFeel().getID()) ) { //NOI18N

            toolBar.setBackground(UIManager.getColor("NbExplorerView.background")); //NOI18N

        }

        toolBar.setBorder(javax.swing.BorderFactory.createCompoundBorder(

                javax.swing.BorderFactory.createMatteBorder(0, 0, 0, 1,

                javax.swing.UIManager.getDefaults().getColor("Separator.background")),

                javax.swing.BorderFactory.createMatteBorder(0, 0, 0, 1,

                javax.swing.UIManager.getDefaults().getColor("Separator.foreground"))));

        add(toolBar, BorderLayout.WEST);

        JComponent buttonsPane = toolBar;

        viewModelListener = new ViewModelListener (

            name,

            contentComponent,

            buttonsPane,

            propertiesHelpID,

            ImageUtilities.loadImage(icon)

        );

    }

    @Override

    public void removeNotify() {

        if (viewModelListener != null) {

            viewModelListener.destroy ();

        }

    }

    @Override

    public HelpCtx getHelpCtx() {

        return new org.openide.util.HelpCtx(helpID);

    }

}

import org.netbeans.spi.debugger.ui.ViewLifecycle.ModelUpdateListener;

    private ModelUpdateListener mul;

    ViewModelListener(String viewType, String propertiesHelpID, ModelUpdateListener mul) {

        this.viewType = viewType;

        this.propertiesHelpID = propertiesHelpID;

        this.mul = mul;

        setUp();

    }

    private void initView() {

        // To have reasonable preferred size

        view.add(Models.createView(Models.EMPTY_MODEL));

    }

        viewPreferences = NbPreferences.forModule(ContextProvider.class).node(VIEW_PREFERENCES_NAME).node(viewType);

            mul = null;

        if (mul != null) {

            mul.modelUpdated(newModel, e);

        }

        if (view == null) {

            return;

        }

        private DebuggerEngine e;

        ModelsChangeRefresher(DebuggerEngine e) {

            this.e = e;

        }

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 2012 Oracle and/or its affiliates. All rights reserved.

 *

 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.

 * Other names may be trademarks of their respective owners.

 *

 * The contents of this file are subject to the terms of either the GNU

 * General Public License Version 2 only ("GPL") or the Common

 * Development and Distribution License("CDDL") (collectively, the

 * "License"). You may not use this file except in compliance with the

 * License. You can obtain a copy of the License at

 * http://www.netbeans.org/cddl-gplv2.html

 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the

 * specific language governing permissions and limitations under the

 * License.  When distributing the software, include this License Header

 * Notice in each file and include the License file at

 * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the GPL Version 2 section of the License file that

 * accompanied this code. If applicable, add the following below the

 * License Header, with the fields enclosed by brackets [] replaced by

 * your own identifying information:

 * "Portions Copyrighted [year] [name of copyright owner]"

 *

 * If you wish your version of this file to be governed by only the CDDL

 * or only the GPL Version 2, indicate your decision by adding

 * "[Contributor] elects to include this software in this distribution

 * under the [CDDL or GPL Version 2] license." If you do not indicate a

 * single choice of license, a recipient has the option to distribute

 * your version of this file under either the CDDL, the GPL Version 2 or

 * to extend the choice of license to its licensees as provided above.

 * However, if you add GPL Version 2 code and therefore, elected the GPL

 * Version 2 license, then the option applies only if the new code is

 * made subject to such option by the copyright holder.

 *

 * Contributor(s):

 *

 * Portions Copyrighted 2012 Sun Microsystems, Inc.

 */

package org.netbeans.spi.debugger.ui;

import javax.swing.JComponent;

import org.netbeans.modules.debugger.ui.views.CustomView;

import org.netbeans.modules.debugger.ui.views.ViewComponent;

import org.netbeans.modules.debugger.ui.views.ViewModelListener;

import org.openide.windows.TopComponent;

/**

 * Factory that produces debugger views created from registered view models

 * (see {@link org.netbeans.spi.viewmodel.Model} and it's extension interfaces).

 * 

 * @author Martin Entlicher

 * @since 2.34

 */

public class ViewFactory {

    private static ViewFactory vf;

    private ViewFactory() {}

    /**

     * Get the default implementation of view factory.

     * 

     * @return The view factory.

     */

    public static synchronized ViewFactory getDefault() {

        if (vf == null) {

            vf = new ViewFactory();

        }

        return vf;

    }

    /**

     * Create {@link TopComponent} view from models registered under 'name' path.

     * @param icon The icon resource of the TopComponent

     * @param name Name of the view, under which are the models registered

     * @param helpID The helpID of the created TopComponent

     * @param propertiesHelpID The helpID of properties displayed in the view

     * @param displayName Display name of the view

     * @param toolTip Tooltip of the view

     * @return TopComponent containing the view created from registered models.

     */

    public TopComponent createViewTC(String icon, String name, String helpID, String propertiesHelpID,

                                     String displayName, String toolTip) {

        CustomView v = new CustomView(icon, name, helpID, propertiesHelpID, displayName, toolTip);

        return v;

    }

    /**

     * Create {@link JComponent} view from models registered under 'name' path.

     * @param icon The icon resource, possibly used by the button toolbar in the view

     * @param name Name of the view, under which are the models registered

     * @param helpID The helpID of the created TopComponent

     * @param propertiesHelpID The helpID of properties displayed in the view

     * @return Component containing the view created from registered models.

     */

    public JComponent createViewComponent(String icon, String name, String helpID, String propertiesHelpID) {

        JComponent c = new ViewComponent(icon, name, helpID, propertiesHelpID);

        return c;

    }

    /**

     * Create a support for a custom view based on models registered under 'name' path.

     * @param name Name of the view, under which are the models registered

     * @param propertiesHelpID The helpID of properties displayed in the view

     * @return ViewLifecycle support object for the custom view

     */

    public ViewLifecycle createAbstractView(String name, String propertiesHelpID) {

        ViewLifecycle.CompoundModelUpdateListener cmul = new ViewLifecycle.CompoundModelUpdateListener();

        ViewModelListener vml = CustomView.createViewModelService(name, propertiesHelpID, cmul);

        return new ViewLifecycle(vml, cmul);

    }

}

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 2012 Oracle and/or its affiliates. All rights reserved.

 *

 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.

 * Other names may be trademarks of their respective owners.

 *

 * The contents of this file are subject to the terms of either the GNU

 * General Public License Version 2 only ("GPL") or the Common

 * Development and Distribution License("CDDL") (collectively, the

 * "License"). You may not use this file except in compliance with the

 * License. You can obtain a copy of the License at

 * http://www.netbeans.org/cddl-gplv2.html

 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the

 * specific language governing permissions and limitations under the

 * License.  When distributing the software, include this License Header

 * Notice in each file and include the License file at

 * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the GPL Version 2 section of the License file that

 * accompanied this code. If applicable, add the following below the

 * License Header, with the fields enclosed by brackets [] replaced by

 * your own identifying information:

 * "Portions Copyrighted [year] [name of copyright owner]"

 *

 * If you wish your version of this file to be governed by only the CDDL

 * or only the GPL Version 2, indicate your decision by adding

 * "[Contributor] elects to include this software in this distribution

 * under the [CDDL or GPL Version 2] license." If you do not indicate a

 * single choice of license, a recipient has the option to distribute

 * your version of this file under either the CDDL, the GPL Version 2 or

 * to extend the choice of license to its licensees as provided above.

 * However, if you add GPL Version 2 code and therefore, elected the GPL

 * Version 2 license, then the option applies only if the new code is

 * made subject to such option by the copyright holder.

 *

 * Contributor(s):

 *

 * Portions Copyrighted 2012 Sun Microsystems, Inc.

 */

package org.netbeans.spi.debugger.ui;

import java.util.LinkedList;

import java.util.List;

import org.netbeans.api.debugger.DebuggerEngine;

import org.netbeans.modules.debugger.ui.views.ViewModelListener;

import org.netbeans.spi.viewmodel.Models;

import org.netbeans.spi.viewmodel.Models.CompoundModel;

/**

 * Support class for a custom view based on registered view models.

 * 

 * @author Martin Entlicher

 * @since 2.34

 */

public final class ViewLifecycle {

    private ViewModelListener vml;

    private final CompoundModelUpdateListener cmul;

    ViewLifecycle(ViewModelListener vml, CompoundModelUpdateListener cmul) {

        this.vml = vml;

        this.cmul = cmul;

    }

    /**

     * Get the current compound model, that can be used to construct the custom

     * view.

     * @return The current compound model

     */

    public Models.CompoundModel getModel() {

        return cmul.getCurrentModel();

    }

    /**

     * Add a listener, which is called with the updated compound model.

     * @param mul The model update listener

     */

    public void addModelUpdateListener(ModelUpdateListener mul) {

        cmul.addModelUpdateListener(mul);

    }

    /**

     * Remove a model update listener

     * @param mul The model update listener

     */

    public void removeModelUpdateListener(ModelUpdateListener mul) {

        cmul.removeModelUpdateListener(mul);

    }

    /**

     * Destroy the underlying data, call this method when the view is closed.

     * Model updates will no longer be received after this method is called.

     */

    public void destroy() {

        vml.destroy();

    }

    /**

     * Model update listener, notified with updated compound model.

     */

    public static interface ModelUpdateListener {

        /**

         * Called when compound model is updated.

         * 

         * @param compoundModel The new compound model

         * @param de The associated debugger engine, whose models were used to create the

         * compound model. Can be <code>null</code>, when no active debugger engine

         * was found.

         */

        public void modelUpdated(Models.CompoundModel compoundModel, DebuggerEngine de);

    }

    static class CompoundModelUpdateListener implements ModelUpdateListener {

        private final List<ModelUpdateListener> muls = new LinkedList<ModelUpdateListener>();

        private CompoundModel currentCompoundModel;

        public void addModelUpdateListener(ModelUpdateListener mul) {

            synchronized(muls) {

                muls.add(mul);

            }

        }

        public void removeModelUpdateListener(ModelUpdateListener mul) {

            synchronized(muls) {

                muls.remove(mul);

            }

        }

        public CompoundModel getCurrentModel() {

            return currentCompoundModel;

        }

        @Override

        public void modelUpdated(CompoundModel compoundModel, DebuggerEngine de) {

            List<ModelUpdateListener> muls2;

            synchronized(muls) {

                currentCompoundModel = compoundModel;

                muls2 = new LinkedList<ModelUpdateListener>(muls);

            }

            for (ModelUpdateListener mul : muls2) {

                mul.modelUpdated(compoundModel, de);

            }

        }

    }

}