<changes>

    <change>

        <api name="palette_api"/>

        <summary>Palette client support released</summary>

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

        <date day="10" month="8" year="2005"/>

        <author login="lkotouc"/>

        <compatibility addition="yes"/>

        <description>

            The first release of the Palette client support. It involves namely DTD describing item definition file format

            and some implementation addons regarding definition file parsing and custom implementation class loading.

            The palette item implementor can ither directly provide the item body 

            or her own item class implementing <code>org.openide.text.ActiveEditorDrop</code> interface.

            Lookup that holds object(s) representing the selected item then associates 

            custom item class instance with the <code>org.openide.text.ActiveEditorDrop.class</code> key and 

            the body with <code>java.lang.String</code> key.

        </description>

    </change>      

  </changes>

                    <code-name-base>org.openide.text</code-name-base>

                    <build-prerequisite/>

                    <compile-dependency/>

                    <run-dependency>

                        <specification-version>6.5</specification-version>

                    </run-dependency>

                </dependency>

                <dependency>

# Editor Palette Item parsing error messages

MSG_UnknownEditorPaletteItemVersion=Unknown editor palette item version.

MSG_UnsupportedEditorPaletteItemVersion=Unsupported editor palette item version.

/*

 *                 Sun Public License Notice

 *

 * The contents of this file are subject to the Sun Public License

 * Version 1.0 (the "License"). You may not use this file except in

 * compliance with the License. A copy of the License is available at

 * http://www.sun.com/

 *

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

 * Code is Sun Microsystems, Inc. Portions Copyright 1997-2005 Sun

 * Microsystems, Inc. All Rights Reserved.

 */

package org.netbeans.modules.palette;

import java.awt.Image;

import java.io.IOException;

import java.lang.ref.Reference;

import java.lang.ref.WeakReference;

import java.net.URL;

import java.util.ArrayList;

import org.openide.ErrorManager;

import org.openide.filesystems.FileObject;

import org.openide.loaders.DataObject;

import org.openide.loaders.Environment;

import org.openide.loaders.XMLDataObject;

import org.openide.nodes.Node;

import org.openide.text.ActiveEditorDrop;

import org.openide.util.Lookup;

import org.openide.util.NbBundle;

import org.openide.util.Utilities;

import org.openide.util.lookup.AbstractLookup;

import org.openide.util.lookup.InstanceContent;

import org.openide.util.lookup.Lookups;

import org.openide.xml.EntityCatalog;

import org.openide.xml.XMLUtil;

import org.xml.sax.SAXException;

import org.xml.sax.XMLReader;

/**

 *

 * @author Libor Kotouc

 */

public class PaletteEnvironmentProvider implements Environment.Provider {

    private static PaletteEnvironmentProvider createProvider() {

        return new PaletteEnvironmentProvider();

    }

    private PaletteEnvironmentProvider() {

    }

// ----------------   Environment.Provider ----------------------------    

    public Lookup getEnvironment(DataObject obj) {

        PaletteItemNodeFactory nodeFactory = new PaletteItemNodeFactory((XMLDataObject)obj);

        return nodeFactory.getLookup();

    }

    private static class PaletteItemNodeFactory implements InstanceContent.Convertor {

//        private static final String URL_PREFIX_INSTANCES = "PaletteItems/";

        private XMLDataObject xmlDataObject = null;

        private Lookup lookup = null;

        Reference refNode = new WeakReference(null);

        PaletteItemNodeFactory(XMLDataObject obj) {

            xmlDataObject = obj;

            InstanceContent content = new InstanceContent();

            content.add(Node.class, this);

            lookup = new AbstractLookup(content);

        }

        Lookup getLookup() {

            return lookup;

        }

        // ----------------   InstanceContent.Convertor ----------------------------    

        public Class type(Object obj) {

            return (Class)obj;

        }

        public String id(Object obj) {

            return obj.toString();

        }

        public String displayName(Object obj) {

            return ((Class)obj).getName();

        }

        public Object convert(Object obj) {

            Object o = null;

            if (obj == Node.class) {

                try {

                    o = getInstance();

                } catch (Exception ex) {

                    ErrorManager.getDefault().notify(ex);

                }

            }

            return o;

        }

        // ----------------   helper methods  ----------------------------    

        public PaletteItemNode getInstance() {

            synchronized (this) {

                PaletteItemNode node = (PaletteItemNode)refNode.get();

                if (node != null)

                    return node;

                FileObject file = xmlDataObject.getPrimaryFile();

                if (file.getSize() == 0L) // item file is empty

                    return null;

                PaletteItemHandler handler = new PaletteItemHandler();

                try {

                    XMLReader reader = XMLUtil.createXMLReader(true);

                    reader.setContentHandler(handler);

                    reader.setEntityResolver(EntityCatalog.getDefault());

                    String urlString = xmlDataObject.getPrimaryFile().getURL().toExternalForm();

                    reader.parse(urlString);

                }

                catch (SAXException saxe) {

                    ErrorManager.getDefault().notify(ErrorManager.INFORMATIONAL, saxe);

                } 

                catch (IOException ioe) {

                    ErrorManager.getDefault().notify(ErrorManager.INFORMATIONAL, ioe);

                }

                node = createPaletteItemNode(handler);

                refNode = new WeakReference(node);

                return node;

            }

        }

        private PaletteItemNode createPaletteItemNode(PaletteItemHandler handler) {

            String displayName = getDisplayName(handler.getBundleName(), handler.getDisplayNameKey(), handler.getInstanceName());

            String tooltip = getTooltip(handler.getBundleName(), handler.getTooltipKey(), handler.getInstanceName(), handler.getDisplayNameKey());

            Image icon16 = getIcon(handler.getIcon16URL());

            if (icon16 == null)

                icon16 = Utilities.loadImage("org/netbeans/editor/ext/palette/resources/unknown16.gif"); // NOI18N

            Image icon32 = getIcon(handler.getIcon32URL());

            if (icon32 == null)

                icon32 = Utilities.loadImage("org/netbeans/editor/ext/palette/resources/unknown32.gif"); // NOI18N

            ArrayList objectsToLookup = new ArrayList();

            ActiveEditorDrop drop = getActiveEditorDrop(handler.getInstanceName());

            if (drop != null)

                objectsToLookup.add(drop);

            if (handler.getBody() != null)

                objectsToLookup.add(handler.getBody());

            Lookup lookup = Lookups.fixed(objectsToLookup.toArray());

            PaletteItemNode node = new PaletteItemNode(displayName, tooltip, icon16, icon32, lookup);

            return node;

        }

        public String getDisplayName(

                String bundleName, 

                String displayNameKey, 

                String instanceName) 

        {

            String displayName = null;

            try {

                displayName = NbBundle.getBundle(bundleName).getString(displayNameKey);

                if (displayName == null && displayNameKey != null)

                    displayName = displayNameKey;

                if (displayName == null) {//derive name from the instance name

                    if (instanceName != null && instanceName.trim().length() > 0) {

                        int dashIndex = instanceName.lastIndexOf('-') + 1; // NOI18N

                        int dotIndex = instanceName.indexOf('.'); // NOI18N

                        displayName = instanceName.substring(dashIndex, dotIndex);

                    }

                }

                if (displayName == null) // no name derived from the item

                    displayName = xmlDataObject.getName();

            }

            catch (Exception ex) {

                ErrorManager.getDefault().notify(ErrorManager.INFORMATIONAL, ex);

            }

            return (displayName == null ? "" : displayName);

        }

        public String getTooltip(

                String bundleName, 

                String tooltipKey, 

                String instanceName, 

                String displayNameKey) 

        {

            String tooltip = null;

            try {

                tooltip = NbBundle.getBundle(bundleName).getString(tooltipKey);

                if (tooltip == null && tooltipKey != null)

                    tooltip = tooltipKey;

                if (tooltip == null) {//derive name from instance name

                    if (instanceName != null && instanceName.trim().length() > 0) {

                        int dotIndex = instanceName.indexOf('.'); // NOI18N

                        tooltip = instanceName.substring(0, dotIndex).replace('-', '.'); // NOI18N

                    }

                }

                if (tooltip == null) // no tooltip derived from the item

                    tooltip = getDisplayName(bundleName, displayNameKey, instanceName);

            }

            catch (Exception ex) {

                ErrorManager.getDefault().notify(ErrorManager.INFORMATIONAL, ex);

            }

            return (tooltip == null ? "" :  tooltip);

        }

        public Image getIcon(String iconURL) {

            Image icon = null;

            try {

                URL url = new URL(iconURL);

                icon = java.awt.Toolkit.getDefaultToolkit().getImage(url);

            }

            catch (Exception ex) {

                ErrorManager.getDefault().notify(ErrorManager.INFORMATIONAL, ex);

            }

            return icon;

        }

        private ActiveEditorDrop getActiveEditorDrop(String instanceName) {

            ActiveEditorDrop drop = null;

            if (instanceName != null && instanceName.trim().length() > 0) {//we should try to instantiate item drop

                try {

//                    Repository rep = (Repository) Lookup.getDefault().lookup(Repository.class);

//                    FileObject fo = rep.getDefaultFileSystem().findResource(URL_PREFIX_INSTANCES + instanceName);

//                    DataObject _do = DataObject.find(fo);

//                    InstanceDataObject ido = (InstanceDataObject) _do;

//                    drop = (ActiveEditorDrop)ido.instanceCreate();

                    ClassLoader loader = (ClassLoader)Lookup.getDefault().lookup(ClassLoader.class);

                    if (loader == null)

                        loader = getClass ().getClassLoader ();

                    Class instanceClass = loader.loadClass (instanceName);

                    drop = (ActiveEditorDrop)instanceClass.newInstance();

                }

                catch (Exception ex) {

                    ErrorManager.getDefault().notify(ErrorManager.INFORMATIONAL, ex);

                }

            }

            return drop;

        }

    }

}

/*

 *                 Sun Public License Notice

 * 

 * The contents of this file are subject to the Sun Public License

 * Version 1.0 (the "License"). You may not use this file except in

 * compliance with the License. A copy of the License is available at

 * http://www.sun.com/

 * 

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

 * Code is Sun Microsystems, Inc. Portions Copyright 1997-2005 Sun

 * Microsystems, Inc. All Rights Reserved.

 */

package org.netbeans.modules.palette;

import java.util.LinkedList;

import org.openide.util.NbBundle;

import org.xml.sax.Attributes;

import org.xml.sax.SAXException;

import org.xml.sax.helpers.DefaultHandler;

/**

 *

 * @author Libor Kotouc

 */

public final class PaletteItemHandler extends DefaultHandler {

    private static final String XML_ROOT = "editor_palette_item"; // NOI18N

    private static final String ATTR_VERSION = "version"; // NOI18N

//    private static final String TAG_ATTRIBUTES = "attributes"; // NOI18N

//    private static final String TAG_ATTRIBUTE = "attribute"; // NOI18N

//    private static final String ATTR_ATTRIBNAME = "name"; // NOI18N

//    private static final String ATTR_ATTRIBVALUE = "value"; // NOI18N

    private static final String TAG_BODY = "body"; // NOI18N

    private static final String TAG_INSTANCE = "instance"; // NOI18N

    private static final String ATTR_INSTANCENAME = "name"; // NOI18N

    private static final String TAG_CUSTOMIZER = "customizer"; // NOI18N

    private static final String ATTR_CUSTNAME = "name"; // NOI18N

    private static final String TAG_ICON16 = "icon16"; // NOI18N

    private static final String ATTR_URL = "urlvalue"; // NOI18N

    private static final String TAG_ICON32 = "icon32"; // NOI18N

    private static final String TAG_DESCRIPTION = "description"; // NOI18N

    private static final String ATTR_BUNDLE = "localizing-bundle"; // NOI18N

    private static final String ATTR_DISPLAY_NAME_KEY = "display-name-key"; // NOI18N

    private static final String ATTR_TOOLTIP_KEY = "tooltip-key"; // NOI18N

    private LinkedList/*<String>*/ bodyLines;

    private boolean insideBody = false;

    //raw data read from the file

//    private HashMap attributeMap;

    private String body;

    private String instanceName;

    private String customizerName;

    private String icon16URL;

    private String icon32URL;

    private String bundleName;

    private String displayNameKey;

    private String tooltipKey;

//    public Map getAttributes() { return (attributeMap == null ? new HashMap() : attributeMap); }

    public String getBody() { return body; }

    public String getInstanceName() { return instanceName; }

    public String getIcon16URL() { return icon16URL; }

    public String getIcon32URL() { return icon32URL; }

    public String getBundleName() { return bundleName; }

    public String getDisplayNameKey() { return displayNameKey; }

    public String getTooltipKey() { return tooltipKey; }

    public void startElement(String uri, String localName, String qName, Attributes attributes) 

        throws SAXException 

    {

        if (XML_ROOT.equals(qName)) {

            String version = attributes.getValue(ATTR_VERSION);

            if (version == null) {

                String message = NbBundle.getBundle(PaletteItemHandler.class)

                    .getString("MSG_UnknownEditorPaletteItemVersion"); // NOI18N

                throw new SAXException(message);

            } else if (!version.equals("1.0")) { // NOI18N

                String message = NbBundle.getBundle(PaletteItemHandler.class)

                    .getString("MSG_UnsupportedEditorPaletteItemVersion"); // NOI18N

                throw new SAXException(message);

            }

//        } else if (TAG_ATTRIBUTES.equals(qName)) {

//            attributeMap = new HashMap();

//        } else if (TAG_ATTRIBUTE.equals(qName)) {

//            String name = attributes.getValue(ATTR_ATTRIBNAME);

//            String value = attributes.getValue(ATTR_ATTRIBVALUE);

//            attributeMap.put(name, value);

        } else if (TAG_BODY.equals(qName)) {

            bodyLines = new LinkedList();

            insideBody = true;

        } else if (TAG_INSTANCE.equals(qName)) {

            instanceName = attributes.getValue(ATTR_INSTANCENAME);

        } else if (TAG_ICON16.equals(qName)) {

            icon16URL = attributes.getValue(ATTR_URL);

            // TODO support also class resource name for icons

        } else if (TAG_ICON32.equals(qName)) {

            icon32URL = attributes.getValue(ATTR_URL);

            // TODO support also class resource name for icons

        } else if (TAG_DESCRIPTION.equals(qName)) {

            bundleName = attributes.getValue(ATTR_BUNDLE);

            displayNameKey = attributes.getValue(ATTR_DISPLAY_NAME_KEY);

            tooltipKey = attributes.getValue(ATTR_TOOLTIP_KEY);

        }

    }

    public void endElement(String uri, String localName, String qName) throws SAXException {

        if (TAG_BODY.equals(qName)) {

            insideBody = false;

            body = trimSurroundingLines(bodyLines);

        }

    }

    public void characters(char buf[], int offset, int len)

        throws SAXException

    {

        if (insideBody) {

            String chars = new String(buf, offset, len).trim();

            bodyLines.add(chars + "\n");

        }

    }

    /**

     * Trims empty lines from the beginning and the end of the line list

     */

    private String trimSurroundingLines(LinkedList/*<String>*/ lines) {

        int nlines = lines.size();

        int firstNonEmpty = nlines;

        //going from the beginning and skipping empty lines until the first nonempty line occurs

        for (int i = 0; i < firstNonEmpty; i++) {

            String line = (String)lines.get(i);

            if (line.trim().length() != 0)

                firstNonEmpty = i;

        }

        int lastNonEmpty = -1;

        //going from the end and skipping empty lines until the first nonempty line occurs

        for (int i = nlines - 1; i > lastNonEmpty; i--) {

            String line = (String)lines.get(i);

            if (line.trim().length() != 0)

                lastNonEmpty = i;

        }

        StringBuffer sb = new StringBuffer();

        for (int i = firstNonEmpty; i <= lastNonEmpty; i++)

            sb.append((String)lines.get(i));

        String body = sb.toString();

        return body;

    }

}

/*

 *                 Sun Public License Notice

 * 

 * The contents of this file are subject to the Sun Public License

 * Version 1.0 (the "License"). You may not use this file except in

 * compliance with the License. A copy of the License is available at

 * http://www.sun.com/

 * 

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

 * Code is Sun Microsystems, Inc. Portions Copyright 1997-2005 Sun

 * Microsystems, Inc. All Rights Reserved.

 */

package org.netbeans.modules.palette;

import java.awt.Image;

import java.awt.datatransfer.Transferable;

import java.beans.BeanInfo;

import java.io.IOException;

import javax.swing.text.BadLocationException;

import javax.swing.text.Caret;

import javax.swing.text.Document;

import javax.swing.text.JTextComponent;

import org.openide.nodes.AbstractNode;

import org.openide.nodes.Children;

import org.openide.nodes.Node;

import org.openide.text.ActiveEditorDrop;

import org.openide.util.Lookup;

import org.openide.util.datatransfer.ExTransferable;

/**

 *

 * @author Libor Kotouc

 */

public final class PaletteItemNode extends AbstractNode {

    private static final Node.PropertySet[] NO_PROPERTIES = new Node.PropertySet[0];

    String displayName;

    String description;

    Image icon16;

    Image icon32;

    PaletteItemNode(String displayName, String description, Image icon16, Image icon32, Lookup lookup) {

        super(Children.LEAF, lookup);

        this.displayName = displayName;

        this.description = description;

        this.icon16 = icon16;

        this.icon32 = icon32;

    }

    public String getDisplayName() {

        return displayName;

    }

    public String getShortDescription() {

        return description;

    }

    public Image getIcon(int type) {

        Image icon = icon16;

        if (type == BeanInfo.ICON_COLOR_32x32 || type == BeanInfo.ICON_MONO_32x32)

            icon = icon32;

        return icon;

    }

    public boolean canRename() {

        return false;

    }

    // TODO properties

    public Node.PropertySet[] getPropertySets() {

        return NO_PROPERTIES;

    }

    public Transferable clipboardCopy() throws IOException {

        ExTransferable t = ExTransferable.create( super.clipboardCopy() );

        Lookup lookup = getLookup();

        ActiveEditorDrop drop = (ActiveEditorDrop) lookup.lookup(ActiveEditorDrop.class);

        if (drop == null) {

            String body = (String)lookup.lookup(String.class);

            drop = new ActiveEditorDropDefault(body);

        }

        ActiveEditorDropTransferable s = new ActiveEditorDropTransferable(drop);

        t.put(s);

        return t;

    }

    private static class ActiveEditorDropTransferable extends ExTransferable.Single {

        private ActiveEditorDrop drop;

        ActiveEditorDropTransferable(ActiveEditorDrop drop) {

            super(ActiveEditorDrop.FLAVOR);

            this.drop = drop;

        }

        public Object getData () {

            return drop;

        }

    }

    private static class ActiveEditorDropDefault implements ActiveEditorDrop {

        String body;

        public ActiveEditorDropDefault(String body) {

            this.body = body;

        }

        public boolean handleTransfer(JTextComponent targetComponent) {

            if (targetComponent == null)

                return false;

            try {

                Document doc = targetComponent.getDocument();

                Caret caret = targetComponent.getCaret();

                int p0 = Math.min(caret.getDot(), caret.getMark());

                int p1 = Math.max(caret.getDot(), caret.getMark());

                doc.remove(p0, p1 - p0);

                //replace selected text by the inserted one

                int start = caret.getDot();

                doc.insertString(start, body, null);

            }

            catch (BadLocationException ble) {

                return false;

            }

            return true;

        }

    }

}

<?xml version="1.0" encoding="UTF-8"?>

<!--

                Sun Public License Notice

The contents of this file are subject to the Sun Public License

Version 1.0 (the "License"). You may not use this file except in

compliance with the License. A copy of the License is available at

http://www.sun.com/

The Original Code is NetBeans. The Initial Developer of the Original

Code is Sun Microsystems, Inc. Portions Copyright 1997-2005 Sun

Microsystems, Inc. All Rights Reserved.

-->

<!--- Editor Palette Item -->

<!ELEMENT editor_palette_item ((instance|body),icon16,icon32,description)>

<!ATTLIST editor_palette_item

    version CDATA #REQUIRED

>

<!ELEMENT instance EMPTY>

<!ATTLIST instance 

    name CDATA #REQUIRED

>

<!ELEMENT body (#PCDATA)>

<!ELEMENT icon16 EMPTY>

<!ATTLIST icon16 

    urlvalue CDATA #REQUIRED

>

<!ELEMENT icon32 EMPTY>

<!ATTLIST icon32 

    urlvalue CDATA #REQUIRED

>

<!ELEMENT description EMPTY>

<!ATTLIST description 

    localizing-bundle CDATA #REQUIRED

    display-name-key CDATA #REQUIRED

    tooltip-key CDATA #REQUIRED

>

    <folder name="xml">

        <folder name="entities">

            <folder name="NetBeans" >

                <file name="Editor_Palette_Item_1_0" url="editor-palette-item-1_0.dtd">

                    <attr name="hint.originalPublicID" stringvalue="-//NetBeans//Editor Palette Item 1.0//EN"/>

                </file>

            </folder>

        </folder>

        <folder name="lookups">

            <folder name="NetBeans">

                <file name="Editor_Palette_Item_1_0.instance">

                    <attr name="instanceClass" stringvalue="org.netbeans.modules.palette.PaletteEnvironmentProvider"/>

                    <attr name="instanceOf" stringvalue="org.openide.loaders.Environment.Provider"/>

                    <attr name="instanceCreate" methodvalue="org.netbeans.modules.palette.PaletteEnvironmentProvider.createProvider"/>

                </file>

            </folder>

        </folder>

    </folder>