<change id="NavigatorPanelWithToolbar">

        <api name="navigator_api"/>

        <summary>Added SPI interface <code>NavigatorPanelWithToolbar</code></summary>

        <version major="1" minor="25"/>

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

        <author login="jpeska"/>

        <compatibility binary="compatible" source="compatible" deprecation="no" deletion="no" addition="yes"/>

        <description>

            <p>

                Added SPI interface <code>NavigatorPanelWithToolbar</code>. Clients will implement this interface when they need a toolbar for their Navigator view/panel.

            </p>

        </description>

        <class package="org.netbeans.spi.navigator" name="NavigatorPanelWithToolbar"/>

        <issue number="217091"/>

    </change>

import org.netbeans.spi.navigator.NavigatorPanelWithToolbar;

    @Override

    public JComponent getToolbarComponent() {

        NavigatorPanel p = initialize();

        return p instanceof NavigatorPanelWithToolbar ? ((NavigatorPanelWithToolbar) p).getToolbarComponent() : null;

    }

    <AuxValue name="FormSettings_layoutCodeTarget" type="java.lang.Integer" value="1"/>

          <Properties>

            <Property name="minimumSize" type="java.awt.Dimension" editor="org.netbeans.beaninfo.editors.DimensionEditor">

              <Dimension value="[100, 20]"/>

            </Property>

          </Properties>

        <Container class="javax.swing.JPanel" name="pnlToolbar">

          <Properties>

            <Property name="opaque" type="boolean" value="false"/>

          </Properties>

          <Constraints>

            <Constraint layoutClass="org.netbeans.modules.form.compat2.layouts.DesignGridBagLayout" value="org.netbeans.modules.form.compat2.layouts.DesignGridBagLayout$GridBagConstraintsDescription">

              <GridBagConstraints gridX="-1" gridY="-1" gridWidth="-1" gridHeight="0" fill="2" ipadX="0" ipadY="0" insetsTop="0" insetsLeft="3" insetsBottom="0" insetsRight="0" anchor="13" weightX="1.5" weightY="0.0"/>

            </Constraint>

          </Constraints>

          <Layout class="org.netbeans.modules.form.compat2.layouts.DesignGridBagLayout"/>

        </Container>

import java.awt.GridBagConstraints;

import org.netbeans.spi.navigator.NavigatorPanelWithToolbar;

    /** Testing purposes - component representing selected panel toolbar */

    private JComponent toolbarComponent;

            pnlToolbar.removeAll();

            if (panel instanceof NavigatorPanelWithToolbar && ((NavigatorPanelWithToolbar)panel).getToolbarComponent() != null) {

                toolbarComponent = ((NavigatorPanelWithToolbar)panel).getToolbarComponent();

                GridBagConstraints gbc = new GridBagConstraints();

                gbc.anchor = GridBagConstraints.WEST;

                gbc.fill = GridBagConstraints.HORIZONTAL;

                gbc.weightx = 1.0;

                pnlToolbar.add(toolbarComponent, gbc);

                pnlToolbar.setVisible(true);

            } else {

                toolbarComponent = null;

                pnlToolbar.setVisible(false);

            }

    /**

     * For testing

     */

    JComponent getToolbar() {

        return toolbarComponent;

    }

        java.awt.GridBagConstraints gridBagConstraints;

        pnlToolbar = new javax.swing.JPanel();

        panelSelector.setMinimumSize(new java.awt.Dimension(100, 20));

        gridBagConstraints = new java.awt.GridBagConstraints();

        gridBagConstraints.gridwidth = java.awt.GridBagConstraints.RELATIVE;

        gridBagConstraints.gridheight = java.awt.GridBagConstraints.REMAINDER;

        gridBagConstraints.fill = java.awt.GridBagConstraints.HORIZONTAL;

        gridBagConstraints.anchor = java.awt.GridBagConstraints.WEST;

        gridBagConstraints.weightx = 1.0;

        holderPanel.add(panelSelector, gridBagConstraints);

        pnlToolbar.setOpaque(false);

        pnlToolbar.setLayout(new java.awt.GridBagLayout());

        gridBagConstraints = new java.awt.GridBagConstraints();

        gridBagConstraints.gridwidth = java.awt.GridBagConstraints.RELATIVE;

        gridBagConstraints.gridheight = java.awt.GridBagConstraints.REMAINDER;

        gridBagConstraints.fill = java.awt.GridBagConstraints.HORIZONTAL;

        gridBagConstraints.anchor = java.awt.GridBagConstraints.EAST;

        gridBagConstraints.weightx = 1.5;

        gridBagConstraints.insets = new java.awt.Insets(0, 3, 0, 0);

        holderPanel.add(pnlToolbar, gridBagConstraints);

    private javax.swing.JPanel pnlToolbar;

/*

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

import javax.swing.JComponent;

/** Description of navigation view with a toolbar component on top of basic

 * NavigatorPanel and NavigatorPanelWithUndo features.

 *

 * Clients will implement this interface when they need a toolbar for their Navigator view/panel.

 *

 * Implementors of this interface will be plugged into Navigator UI.

 * @see NavigatorPanel.Registration

 *

 * @since 1.25

 *

 * @author jpeska

 */

public interface NavigatorPanelWithToolbar extends NavigatorPanel {

    /** Returns a JComponent which represents panel toolbar.

     *

     * It allows clients to display a toolbar on top of the Navigator window, next to the panel chooser (ComboBox).

     *

     * @return Instance of JComponent.

     */

    public JComponent getToolbarComponent();

}

import org.netbeans.spi.navigator.NavigatorPanelWithToolbar;

    public void testFeature217091_Toolbar () throws Exception {

        System.out.println("Testing feature #217091, providing Toolbar...");

        InstanceContent ic = getInstanceContent();

        TestLookupHint toolbarHint = new TestLookupHint("toolbar/tester");

        ic.add(toolbarHint);

        NavigatorTC navTC = NavigatorTC.getInstance();

        NavigatorTCHandle navTCH = new NavigatorTCHandle(navTC);

        try {

            navTCH.open();

            waitForProviders(navTC);

            NavigatorPanel selPanel = navTC.getSelectedPanel();

            assertNotNull("Selected panel should not be null", navTC.getSelectedPanel());

            assertTrue("Panel class not expected", selPanel instanceof ToolbarProvider);

            ToolbarProvider provider = (ToolbarProvider)selPanel;

            JComponent toolbarProvider = provider.getToolbarComponent();

            JComponent toolbarTC = navTC.getToolbar();

            assertTrue("Expected toolbar " + toolbarProvider + ", but got " + toolbarTC, toolbarProvider == toolbarTC);

        } finally {

            // cleanup

            navTCH.close();

            ic.remove(toolbarHint);

        }

    }

    public static final class ToolbarProvider implements NavigatorPanelWithToolbar {

        private JComponent toolbar;

        @Override

        public JComponent getToolbarComponent() {

            if (toolbar == null) {

                toolbar = new JLabel("dummy toolbar");

            }

            return toolbar;

        }

        public String getDisplayName() {

            return "Toolbar provider";

        }

        public String getDisplayHint() {

            return null;

        }

        public JComponent getComponent() {

            return new JLabel("dummy component");

        }

        public void panelActivated(Lookup context) {

            // no operation

        }

        public void panelDeactivated() {

            // no operation

        }

        public Lookup getLookup() {

            return null;

        }

    }

    <!-- provider for testing Toolbar component -->

    <folder name="Navigator">

        <folder name="Panels">

            <folder name="toolbar">

                <folder name="tester">

                    <file name="org-netbeans-modules-navigator-NavigatorTCTest$ToolbarProvider.instance"/>

                </folder>

            </folder>

        </folder>

    </folder>