<change id="tooltip-ui">

        <api name="DebuggerCoreSPI"/>

        <summary>Tooltip view added.</summary>

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

        <date day="14" month="6" year="2016"/>

        <author login="mentlicher"/>

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

        <description>

            <p>

                Tooltip view is added into APIs.

                It's accessible via <code>createToolTip</code> method in <code>ViewFactory</code>,

                or <code>AbstractExpandToolTipAction</code>.

                Default model filters are pre-registered under <code>ToolTipView</code> name

                and they define the expanded tooltip node.

            </p>

        </description>

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

        <issue number="262312"/>

    </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.models;

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

import org.netbeans.spi.debugger.DebuggerServiceRegistration;

import org.netbeans.spi.viewmodel.ModelListener;

import org.netbeans.spi.viewmodel.TreeExpansionModel;

import org.netbeans.spi.viewmodel.TreeExpansionModelFilter;

import org.netbeans.spi.viewmodel.UnknownTypeException;

/**

 * Assures that the variable in tooltip is expanded automatically.

 * 

 * @author Martin Entlicher

 */

@DebuggerServiceRegistration(path="ToolTipView",

                             types=TreeExpansionModelFilter.class,

                             position=10200)

public class ToolTipExpansionFilter implements TreeExpansionModelFilter {

    @Override

    public boolean isExpanded(TreeExpansionModel original, Object node) throws UnknownTypeException {

        if (node == ToolTipView.getVariable()) {

            return true;

        } else {

            return original.isExpanded(node);

        }

    }

    @Override

    public void nodeExpanded(Object node) {}

    @Override

    public void nodeCollapsed(Object node) {}

    @Override

    public void addModelListener(ModelListener l) {}

    @Override

    public void removeModelListener(ModelListener l) {}

}

/*

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

 *

 * Copyright 2010 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 2010 Sun Microsystems, Inc.

 */

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

import java.awt.datatransfer.Transferable;

import java.io.IOException;

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

import org.netbeans.spi.debugger.DebuggerServiceRegistration;

import org.netbeans.spi.viewmodel.ExtendedNodeModel;

import org.netbeans.spi.viewmodel.ExtendedNodeModelFilter;

import org.netbeans.spi.viewmodel.ModelListener;

import org.netbeans.spi.viewmodel.NodeModel;

import org.netbeans.spi.viewmodel.UnknownTypeException;

import org.openide.util.datatransfer.PasteType;

/**

 *

 * @author martin

 */

@DebuggerServiceRegistration(path="ToolTipView",

                             types=ExtendedNodeModelFilter.class,

                             position=10100)

public class ToolTipNodeModelFilter implements ExtendedNodeModelFilter {

    @Override

    public String getDisplayName(NodeModel original, Object node) throws UnknownTypeException {

        String dn;

        try {

            dn = original.getDisplayName(node);

        } catch (UnknownTypeException utex) {

            dn = "";

        }

        if (node == ToolTipView.getVariable() && dn.length() == 0) {

            return ToolTipView.getExpression();

        } else {

            return dn;

        }

    }

    @Override

    public String getIconBase(NodeModel original, Object node) throws UnknownTypeException {

        return original.getIconBase(node);

    }

    @Override

    public String getShortDescription(NodeModel original, Object node) throws UnknownTypeException {

        return original.getShortDescription(node);

    }

    @Override

    public void addModelListener(ModelListener l) {

    }

    @Override

    public void removeModelListener(ModelListener l) {

    }

    @Override

    public boolean canRename(ExtendedNodeModel original, Object node) throws UnknownTypeException {

        return original.canRename(node);

    }

    @Override

    public boolean canCopy(ExtendedNodeModel original, Object node) throws UnknownTypeException {

        return original.canCopy(node);

    }

    @Override

    public boolean canCut(ExtendedNodeModel original, Object node) throws UnknownTypeException {

        return original.canCut(node);

    }

    @Override

    public Transferable clipboardCopy(ExtendedNodeModel original, Object node) throws IOException, UnknownTypeException {

        return original.clipboardCopy(node);

    }

    @Override

    public Transferable clipboardCut(ExtendedNodeModel original, Object node) throws IOException, UnknownTypeException {

        return original.clipboardCut(node);

    }

    @Override

    public PasteType[] getPasteTypes(ExtendedNodeModel original, Object node, Transferable t) throws UnknownTypeException {

        return original.getPasteTypes(node, t);

    }

    @Override

    public void setName(ExtendedNodeModel original, Object node, String name) throws UnknownTypeException {

        original.setName(node, name);

    }

    @Override

    public String getIconBaseWithExtension(ExtendedNodeModel original, Object node) throws UnknownTypeException {

        return original.getIconBaseWithExtension(node);

    }

}

/*

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

 *

 * Copyright 2010 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 2010 Sun Microsystems, Inc.

 */

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

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

import org.netbeans.spi.debugger.DebuggerServiceRegistration;

import org.netbeans.spi.viewmodel.ModelListener;

import org.netbeans.spi.viewmodel.TreeModel;

import org.netbeans.spi.viewmodel.TreeModelFilter;

import org.netbeans.spi.viewmodel.UnknownTypeException;

/**

 *

 * @author martin

 */

@DebuggerServiceRegistration(path="ToolTipView",

                             types=TreeModelFilter.class,

                             position=10000)

public class ToolTipTreeModelFilter implements TreeModelFilter {

    @Override

    public Object getRoot(TreeModel original) {

        return original.getRoot();

    }

    @Override

    public Object[] getChildren(TreeModel original, Object parent, int from, int to) throws UnknownTypeException {

        if (parent == TreeModel.ROOT) {

            Object tooltipVar = ToolTipView.getVariable();

            if (tooltipVar != null) {

                return new Object[] { tooltipVar };

            } else {

                return new Object[] { };

            }

        } else {

            return original.getChildren(parent, from, to);

        }

    }

    @Override

    public int getChildrenCount(TreeModel original, Object node) throws UnknownTypeException {

        return Integer.MAX_VALUE;

    }

    @Override

    public boolean isLeaf(TreeModel original, Object node) throws UnknownTypeException {

        return original.isLeaf(node);

    }

    @Override

    public void addModelListener(ModelListener l) {

    }

    @Override

    public void removeModelListener(ModelListener l) {

    }

}

/*

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

 *

 * Copyright 1997-2016 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]"

 *

 * Contributor(s):

 *

 * The Original Software is NetBeans. The Initial Developer of the Original

 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun

 * Microsystems, Inc. All Rights Reserved.

 *

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

 */

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

import java.awt.BorderLayout;

import java.awt.Color;

import java.awt.Dimension;

import java.awt.Font;

import java.awt.Insets;

import java.awt.Point;

import java.awt.event.ActionEvent;

import java.awt.event.ActionListener;

import java.awt.event.KeyEvent;

import javax.swing.AbstractAction;

import javax.swing.ActionMap;

import javax.swing.BorderFactory;

import javax.swing.BoxLayout;

import javax.swing.Icon;

import javax.swing.InputMap;

import javax.swing.JButton;

import javax.swing.JComponent;

import static javax.swing.JComponent.WHEN_FOCUSED;

import javax.swing.JPanel;

import javax.swing.JTextArea;

import javax.swing.KeyStroke;

import javax.swing.SwingUtilities;

import javax.swing.UIManager;

import javax.swing.text.BadLocationException;

import javax.swing.text.Document;

import javax.swing.text.Keymap;

import org.netbeans.spi.debugger.ui.ViewFactory;

import org.openide.util.ImageUtilities;

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

    public static final String TOOLTIP_VIEW_NAME = "ToolTipView";               // NOI18N

    private static final String TOOLTIP_HELP_ID = "NetbeansDebuggerToolTipNode";// NOI18N

    private static volatile String expression;

    private static volatile Object variable;

    private transient JComponent contentComponent;

    private ToolTipView(String expression, Object v, String icon) {

        ToolTipView.expression = expression;

        variable = v;

        JComponent c = ViewFactory.getDefault().createViewComponent(

                icon,

                ToolTipView.TOOLTIP_VIEW_NAME,

                TOOLTIP_HELP_ID,

                null);

        setLayout (new BorderLayout ());

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

    }

    public static String getExpression() {

        return expression;

    }

    public static Object getVariable() {

        return variable;

    }

    @Override

    public void removeNotify() {

        super.removeNotify();

        variable = null;

    }

    // <RAVE>

    // Implement getHelpCtx() with the correct help ID

    @Override

    public org.openide.util.HelpCtx getHelpCtx() {

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

    }

    // </RAVE>

    @Override

    public boolean requestFocusInWindow () {

        super.requestFocusInWindow ();

        if (contentComponent == null) {

            return false;

        }

        return contentComponent.requestFocusInWindow ();

    }

    /** Creates the view. */

    public static synchronized ToolTipView createToolTipView(String expression, Object variable) {

        return new ToolTipView(

                expression,

                variable,

                "org/netbeans/modules/debugger/resources/localsView/local_variable_16.png"

        );

    }

    public static class ExpandableTooltip extends JPanel {

        private static final String UI_PREFIX = "ToolTip"; // NOI18N

        private JButton expButton;

        private JButton pinButton;

        private JComponent textToolTip;

        private boolean widthCheck = true;

        private boolean sizeSet = false;

        public ExpandableTooltip(String toolTipText, boolean expandable, boolean pinnable) {

            Font font = UIManager.getFont(UI_PREFIX + ".font");                 // NOI18N

            Color backColor = UIManager.getColor(UI_PREFIX + ".background");    // NOI18N

            Color foreColor = UIManager.getColor(UI_PREFIX + ".foreground");    // NOI18N

            if (backColor != null) {

                setBackground(backColor);

            }

            setOpaque(true);

            setBorder(BorderFactory.createCompoundBorder(

                BorderFactory.createLineBorder(getForeground()),

                BorderFactory.createEmptyBorder(0, 3, 0, 3)

            ));

            setLayout(new BoxLayout(this, BoxLayout.X_AXIS));

            if (pinnable) {

                pinButton = new JButton(ImageUtilities.loadImageIcon("org/netbeans/editor/resources/pin.png", false));

                pinButton.setBorder(new javax.swing.border.EmptyBorder(0, 3, 0, 0));

                pinButton.setBorderPainted(false);

                pinButton.setContentAreaFilled(false);

                add(pinButton);

            }

            if (expandable) {

                Icon expIcon = UIManager.getIcon ("Tree.collapsedIcon");        // NOI18N

                expButton = new JButton(expIcon);

                expButton.setBorder(new javax.swing.border.EmptyBorder(0, 0, 0, 5));

                expButton.setBorderPainted(false);

                expButton.setContentAreaFilled(false);

                add(expButton);

            }

            //JLabel l = new JLabel(toolTipText);

            // Multi-line tooltip:

            JTextArea l = createMultiLineToolTip(toolTipText, true);

            if (font != null) {

                l.setFont(font);

            }

            if (foreColor != null) {

                l.setForeground(foreColor);

            }

            if (backColor != null) {

                l.setBackground(backColor);

            }

            l.setBorder(new javax.swing.border.EmptyBorder(0, 3, 0, 3));

            textToolTip = l;

            add(l);

            if (expandable || pinnable) {

                InputMap im = new InputMap();

                im.setParent(getInputMap());

                setInputMap(WHEN_FOCUSED, im);

                ActionMap am = new ActionMap();

                am.setParent(getActionMap());

                setActionMap(am);

                im.put(KeyStroke.getKeyStroke(KeyEvent.VK_SPACE, 0), "expand"); // NOI18N

                im.put(KeyStroke.getKeyStroke(KeyEvent.VK_ENTER, 0), "pin");    // NOI18N

                if (expandable) {

                    am.put("expand", new AbstractAction() {                     // NOI18N

                        @Override

                        public void actionPerformed(ActionEvent e) {

                            expButton.doClick();

                        }

                    });

                }

                if (pinnable) {

                    am.put("pin", new AbstractAction() {                        // NOI18N

                        @Override

                        public void actionPerformed(ActionEvent e) {

                            SwingUtilities.invokeLater(() -> pinButton.doClick());

                        }

                    });

                }

            }

        }

        public void addExpansionListener(ActionListener treeExpansionListener) {

            expButton.addActionListener(treeExpansionListener);

        }

        public void addPinListener(ActionListener treeExpansionListener) {

            pinButton.addActionListener(treeExpansionListener);

        }

        public void setWidthCheck(boolean widthCheck) {

            this.widthCheck = widthCheck;

        }

        @Override

        public Dimension getPreferredSize() {

            if (!sizeSet) {

                // Be big enough initially.

                return new Dimension(Integer.MAX_VALUE, Integer.MAX_VALUE);

            }

            Dimension preferredSize = super.getPreferredSize();

            // Let the width be as long as it can be

            return new Dimension(Integer.MAX_VALUE, preferredSize.height);

        }

        @Override

        public void setSize(int width, int height) {

            Dimension prefSize = getPreferredSize();

            Dimension button1Size = (expButton != null) ? expButton.getPreferredSize() : new Dimension(0, 0);

            Dimension button2Size = pinButton.getPreferredSize();

            if (widthCheck) {

                Insets insets = getInsets();

                int textWidth = width - insets.left - button1Size.width - button2Size.width - insets.right;

                height = Math.max(Math.max(height, button1Size.height), button2Size.height);

                textToolTip.setSize(textWidth, height);

                Dimension textPreferredSize = textToolTip.getPreferredSize();

                super.setSize(

                        insets.left + button1Size.width + button2Size.width + textPreferredSize.width + insets.right,

                        insets.top + Math.max(Math.max(button1Size.height, textPreferredSize.height), button2Size.height) + insets.bottom);

            } else {

                if (height >= prefSize.height) { // enough height

                    height = prefSize.height;

                }

                super.setSize(width, height);

            }

            sizeSet = true;

        }

        private static JTextArea createMultiLineToolTip(String toolTipText, boolean wrapLines) {

            JTextArea ta = new TextToolTip(wrapLines);

            ta.setText(toolTipText);

            return ta;

        }

        private static class TextToolTip extends JTextArea {

            private static final String ELIPSIS = "..."; //NOI18N

            private final boolean wrapLines;

            public TextToolTip(boolean wrapLines) {

                this.wrapLines = wrapLines;

                setLineWrap(false); // It's necessary to have a big width of preferred size first.

            }

            public @Override void setSize(int width, int height) {

                Dimension prefSize = getPreferredSize();

                if (width >= prefSize.width) {

                    width = prefSize.width;

                } else { // smaller available width

                    // Set line wrapping and do super.setSize() to determine

                    // the real height (it will change due to line wrapping)

                    if (wrapLines) {

                        setLineWrap(true);

                        setWrapStyleWord(true);

                    }

                    super.setSize(width, Integer.MAX_VALUE); // the height is unimportant

                    prefSize = getPreferredSize(); // re-read new pref width

                }

                if (height >= prefSize.height) { // enough height

                    height = prefSize.height;

                } else { // smaller available height

                    // Check how much can be displayed - cannot rely on line count

                    // because line wrapping may display single physical line

                    // into several visual lines

                    // Before using viewToModel() a setSize() must be called

                    // because otherwise the viewToModel() would return -1.

                    super.setSize(width, Integer.MAX_VALUE);

                    int offset = viewToModel(new Point(0, height));

                    Document doc = getDocument();

                    try {

                        if (offset > ELIPSIS.length()) {

                            offset -= ELIPSIS.length();

                            doc.remove(offset, doc.getLength() - offset);

                            doc.insertString(offset, ELIPSIS, null);

                        }

                    } catch (BadLocationException ble) {

                        // "..." will likely not be displayed but otherwise should be ok

                    }

                    // Recalculate the prefSize as it may be smaller

                    // than the present preferred height

                    height = Math.min(height, getPreferredSize().height);

                }

                super.setSize(width, height);

            }

            @Override

            public void setKeymap(Keymap map) {

                //#181722: keymaps are shared among components with the same UI

                //a default action will be set to the Keymap of this component below,

                //so it is necessary to use a Keymap that is not shared with other JTextAreas

                super.setKeymap(addKeymap(null, map));

            }

        }

    }

}

/*

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

 *

 * Copyright 2016 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 2016 Sun Microsystems, Inc.

 */

package org.netbeans.spi.debugger.ui;

import java.awt.event.ActionEvent;

import java.beans.PropertyChangeEvent;

import java.beans.PropertyChangeListener;

import javax.swing.AbstractAction;

import javax.swing.Action;

import javax.swing.Icon;

import javax.swing.JEditorPane;

import javax.swing.UIManager;

import org.netbeans.editor.EditorUI;

import org.netbeans.editor.Utilities;

import org.netbeans.editor.ext.ToolTipSupport;

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

/**

 * A base class for an action that shows an expanded tooltip.

 * It can be used as a

 * {@link PinWatchUISupport.ValueProvider#getHeadActions(org.netbeans.api.debugger.Watch) head action}

 * for a pin watch to display the structured value of a watch.

 * 

 * @since 2.54

 * @author Martin Entlicher

 */

public abstract class AbstractExpandToolTipAction extends AbstractAction {

    private final Icon toExpandIcon = UIManager.getIcon ("Tree.collapsedIcon"); // NOI18N

    private final Icon toCollapsIcon = UIManager.getIcon ("Tree.expandedIcon"); // NOI18N

    private boolean expanded;

    /**

     * Create a new expand tooltip action.

     */

    protected AbstractExpandToolTipAction() {

        putValue(Action.SMALL_ICON, toExpandIcon);

        putValue(Action.LARGE_ICON_KEY, toExpandIcon);

    }

    /**

     * Open a tooltip view.

     * Call {@link #openTooltipView(java.lang.String, java.lang.Object)} method

     * to open the tooltip view.

     */

    protected abstract void openTooltipView();

    /**

     * Open a tooltip view for the expression and variable the expression evaluates to.

     * @param expression the tooltip's expression

     * @param var the evaluated variable

     * @return An instance of tooltip support that allows to control the display

     * of the tooltip, or <code>null</code> when it's not possible to show it.

     * It can be used e.g. to close the tooltip when it's no longer applicable,

     * when the debugger resumes, etc.

     */

    protected final ToolTipSupport openTooltipView(String expression, Object var) {

        ToolTipView toolTipView = ToolTipView.createToolTipView(expression, var);

        JEditorPane currentEditor = EditorContextDispatcher.getDefault().getMostRecentEditor();

        EditorUI eui = Utilities.getEditorUI(currentEditor);

        if (eui != null) {

            final ToolTipSupport toolTipSupport = eui.getToolTipSupport();

            toolTipSupport.setToolTipVisible(true, false);

            toolTipSupport.setToolTip(toolTipView);

            toolTipSupport.addPropertyChangeListener(new PropertyChangeListener() {

                @Override

                public void propertyChange(PropertyChangeEvent evt) {

                    if (ToolTipSupport.PROP_STATUS.equals(evt.getPropertyName())) {

                        if (!toolTipSupport.isToolTipVisible()) {

                            expanded = false;

                            putValue(Action.SMALL_ICON, toExpandIcon);

                            putValue(Action.LARGE_ICON_KEY, toExpandIcon);

                            toolTipSupport.removePropertyChangeListener(this);

                        }

                    }

                }

            });

            return toolTipSupport;

        } else {

            return null;

        }

    }

    @Override

    public final void actionPerformed(ActionEvent e) {

        expanded = !expanded;

        if (expanded) {

            openTooltipView();

            putValue(Action.SMALL_ICON, toCollapsIcon);

            putValue(Action.LARGE_ICON_KEY, toCollapsIcon);

        } else {

            hideTooltipView();

            putValue(Action.SMALL_ICON, toExpandIcon);

            putValue(Action.LARGE_ICON_KEY, toExpandIcon);

        }

    }

    private void hideTooltipView() {

        JEditorPane currentEditor = EditorContextDispatcher.getDefault().getMostRecentEditor();

        EditorUI eui = Utilities.getEditorUI(currentEditor);

        if (eui != null) {

            eui.getToolTipSupport().setToolTipVisible(false, false);

        }

    }

}

/*

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

 *

 * Copyright 2016 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 2016 Sun Microsystems, Inc.

 */

package org.netbeans.spi.debugger.ui;

import java.awt.Point;

import java.awt.event.ActionEvent;

import java.awt.event.ActionListener;

import javax.swing.BorderFactory;

import javax.swing.JEditorPane;

import javax.swing.SwingUtilities;

import javax.swing.text.Document;

import org.netbeans.api.debugger.DebuggerManager;

import org.netbeans.api.debugger.Watch;

import org.netbeans.editor.BaseDocument;

import org.netbeans.editor.EditorUI;

import org.netbeans.editor.PopupManager;

import org.netbeans.editor.Utilities;

import org.netbeans.editor.ext.ToolTipSupport;

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

import org.netbeans.modules.debugger.ui.views.ToolTipView.ExpandableTooltip;

import org.openide.filesystems.FileObject;

import org.openide.loaders.DataObject;

import org.openide.util.Exceptions;

/**

 * A representation of a tooltip with actions.

 * The actions are described by {@link Expandable} and {@link Pinnable} classes.

 * 

 * @since 2.54

 * @author Martin Entlicher

 */

public final class ToolTipUI {

    private final ExpandableTooltip et;

    private JEditorPane editorPane; // Editor pane the tooltip is showing on

    ToolTipUI(String toolTipText, Expandable expandable, Pinnable pinnable) {

        et = new ExpandableTooltip(toolTipText, expandable != null, pinnable != null);

        if (expandable != null) {

            et.addExpansionListener(new ExpansionListener(expandable));

        }

        if (pinnable != null) {

            et.addPinListener(new PinListener(pinnable));

        }

    }

    /**

     * Show the tooltip on the given editor pane.

     * @param editorPane The editor pane to show the tooltip on.

     * @return An instance of tooltip support that allows to control the display

     * of the tooltip, or <code>null</code> when it's not possible to show the

     * tooltip on the editor pane.

     * It can be used e.g. to close the tooltip when it's no longer applicable,

     * when the debugger resumes, etc.

     */

    public ToolTipSupport show(JEditorPane editorPane) {

        EditorUI eui = Utilities.getEditorUI(editorPane);

        if (eui != null) {

            eui.getToolTipSupport().setToolTip(et);

            this.editorPane = editorPane;

            return eui.getToolTipSupport();

        } else {

            return null;

        }

    }

    /**

     * Description of an expandable tooltip.

     * The expanded tooltip is a view created from models registered under

     * <code>ToolTipView</code> name. Default model filters are provided, which define

     * the expanded first node with <code>expression</code> name and <code>variable</code>

     * being the node's value.

     */

    public static final class Expandable {

        private final String expression;

        private final Object variable;

        /**

         * Create a description of expandable tooltip.

         * @param expression the tooltip's expression

         * @param variable the evaluated variable

         */

        public Expandable(String expression, Object variable) {

            this.expression = expression;

            this.variable = variable;

        }

    }

    /**

     * Description of a pinnable watch.

     * The pin watch is created from the provided parameters.

     */

    public static final class Pinnable {

        private final String expression;

        private final int line;

        private final String valueProviderId;

        /**

         * Create a description of pin watch

         * @param expression The pin watch expression

         * @param line Line to create the pin watch at

         * @param valueProviderId ID of the registered {@link PinWatchUISupport.ValueProvider value provider}

         */

        public Pinnable(String expression, int line, String valueProviderId) {

            this.expression = expression;

            this.line = line;

            this.valueProviderId = valueProviderId;

        }

    }

    private class ExpansionListener implements ActionListener {

        private final Expandable expandable;

        ExpansionListener(Expandable expandable) {

            this.expandable = expandable;

        }

        @Override

        public void actionPerformed(ActionEvent e) {

            et.setBorder(BorderFactory.createLineBorder(et.getForeground()));

            et.removeAll();

            et.setWidthCheck(false);

            final ToolTipView ttView = ToolTipView.createToolTipView(

                    expandable.expression,

                    expandable.variable);

            et.add(ttView);

            et.revalidate();

            et.repaint();

            SwingUtilities.invokeLater(() -> {

                EditorUI eui = Utilities.getEditorUI(editorPane);

                if (eui != null) {

                    eui.getToolTipSupport().setToolTip(et, PopupManager.ViewPortBounds,

                                                       PopupManager.AbovePreferred, 0, 0,

                                                       ToolTipSupport.FLAGS_HEAVYWEIGHT_TOOLTIP);

                } else {

                    throw new IllegalStateException("Have no EditorUI for "+editorPane);

                }

            });

        }

    }

    private class PinListener implements ActionListener {

        private final Pinnable pinnable;

        public PinListener(Pinnable pinnable) {

            this.pinnable = pinnable;

        }

        @Override

        public void actionPerformed(ActionEvent e) {

            EditorUI eui = Utilities.getEditorUI(editorPane);

            Point location = et.getLocation();

            location = eui.getStickyWindowSupport().convertPoint(location);

            eui.getToolTipSupport().setToolTipVisible(false);

            DebuggerManager dbMgr = DebuggerManager.getDebuggerManager();

            BaseDocument document = Utilities.getDocument(editorPane);

            DataObject dobj = (DataObject) document.getProperty(Document.StreamDescriptionProperty);

            FileObject fo = dobj.getPrimaryFile();

            Watch.Pin pin = new EditorPin(fo, pinnable.line, location);

            final Watch w = dbMgr.createPinnedWatch(pinnable.expression, pin);

            SwingUtilities.invokeLater(() -> {

                try {

                    PinWatchUISupport.getDefault().pin(w, pinnable.valueProviderId);

                } catch (IllegalArgumentException ex) {

                    Exceptions.printStackTrace(ex);

                }

            });

        }

    }

}

    /**

     * Create a tooltip with additional actions.

     * The tooltip can be expandable to a structured tooltip view, or pinnable as a pin watch.

     * @param toolTipText The text to display as a tooltip

     * @param expandable Description of an expanded tooltip,

     *                   or <code>null</code> when the tooltip is not expandable

     * @param pinnable Description of a pin watch created from this tooltip,

     *                 or <code>null</code> when the tooltip is not pinnable

     * @return A tooltip UI to be shown.

     * @since 2.54

     */

    public ToolTipUI createToolTip(String toolTipText,

                                   ToolTipUI.Expandable expandable,

                                   ToolTipUI.Pinnable pinnable) {

        return new ToolTipUI(toolTipText, expandable, pinnable);

    }