GrxBasePlugin.java

Go to the documentation of this file.

/*
 * Copyright (c) 2008, AIST, the University of Tokyo and General Robotix Inc.
 * All rights reserved. This program is made available under the terms of the
 * Eclipse Public License v1.0 which accompanies this distribution, and is
 * available at http://www.eclipse.org/legal/epl-v10.html
 * Contributors:
 * General Robotix Inc.
 * National Institute of Advanced Industrial Science and Technology (AIST)
 */
/*
 *  GrxBasePlugin.java
 *
 *  Copyright (C) 2007 GeneralRobotix, Inc.
 *  All Rights Reserved
 *
 *  @author Yuichiro Kawasumi (General Robotix, Inc.)
 */
package com.generalrobotix.ui;

import java.io.File;
import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.Enumeration;
import java.util.ListIterator;
import java.util.Vector;

import org.eclipse.jface.action.Action;
import org.eclipse.jface.action.MenuManager;
import org.eclipse.jface.dialogs.InputDialog;
import org.eclipse.jface.resource.ImageDescriptor;
import org.eclipse.jface.resource.ImageRegistry;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.widgets.Display;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;

import com.generalrobotix.ui.grxui.Activator;
import com.generalrobotix.ui.grxui.PreferenceConstants;
import com.generalrobotix.ui.item.GrxProjectItem;
import com.generalrobotix.ui.util.GrxConfigBundle;
import com.generalrobotix.ui.util.GrxXmlUtil;
import com.generalrobotix.ui.util.MessageBundle;

@SuppressWarnings("serial") //$NON-NLS-1$
public class GrxBasePlugin extends GrxConfigBundle {
        private String name_;
        private String oldName_;
        protected GrxPluginManager manager_;
        private String url_;
        private boolean selected_ = true;
        private boolean isExclusive_= false;

        private ImageRegistry ireg_;
        private String iconName_;

        private Vector<Action> menu_ = new Vector<Action>();
        private Vector<MenuManager> subMenu_ = new Vector<MenuManager>();
        private String[] menuPath_;

        protected Document doc_;
        protected Element element_;

    protected final static String ITEM_TAG = "item"; //$NON-NLS-1$
    protected final static String VIEW_TAG = "view"; //$NON-NLS-1$
    protected final static String PROPERTY_TAG = "property"; //$NON-NLS-1$
    protected final static String INDENT4 = "    "; //$NON-NLS-1$
    
    protected static final String[] booleanComboItem_ = new String[] {"true", "false" };
    
    private ArrayList<GrxObserver> observers_ = new ArrayList<GrxObserver>();

        protected GrxBasePlugin(String name, GrxPluginManager manager) {
                manager_ = manager;
                setName(name);
                ireg_ = new ImageRegistry();
                // menu item : restore Properties
                Action a = new Action(){
                        public String getText(){
                                return MessageBundle.get("GrxBasePlugin.menu.restoreProperties"); //$NON-NLS-1$
                        }
                        public void run(){
                                restoreProperties();
                        }
                };
                setMenuItem(a);

                // menu item : rename
                Action item = new Action(){
                                public String getText(){
                                        return MessageBundle.get("GrxBasePlugin.menu.rename"); //$NON-NLS-1$
                                }
                                public void run(){
                                        InputDialog dialog = new InputDialog( null, getText(),
                                                        MessageBundle.get("GrxBasePlugin.dialog.message.input"), getName(),null); //$NON-NLS-1$
                                        if ( dialog.open() == InputDialog.OK && dialog.getValue() != null)
                                                rename( dialog.getValue() );
                                }
                        };
                setMenuItem(item);
        }

        public void restoreProperties() {
                if (element_ == null) {
                        return;
                }
                clear();
                if(url_!=null)  
                        setProperty("url", url_);
                if(name_!=null)
                        setProperty("name", name_);
                NodeList props = element_.getElementsByTagName(PROPERTY_TAG);
                for (int j = 0; j < props.getLength(); j++) {
                        Element propEl = (Element) props.item(j);
                        String key = propEl.getAttribute("name"); //$NON-NLS-1$
                        String val = propEl.getAttribute("value"); //$NON-NLS-1$
                        if (!propertyChanged(key, val)){
                                setProperty(key, val);
                        }
                }
        }

        public Element storeProperties() {
                if (doc_ == null)
                        return null;

                if (element_ != null) {
                        Node n = element_.getParentNode();
                        if (n != null)
                                n.removeChild(element_);
                }

                String tag = (this instanceof GrxBaseItem) ? ITEM_TAG:VIEW_TAG;
                element_ = doc_.createElement(tag);

                element_.setAttribute("class",getClass().getName()); //$NON-NLS-1$
                element_.setAttribute("name", getName()); //$NON-NLS-1$
                element_.setAttribute("select", String.valueOf(isSelected())); //$NON-NLS-1$
                if (url_ != null)
                        element_.setAttribute("url", GrxXmlUtil.replaceEnvVal(new File(url_))); //$NON-NLS-1$
                element_.appendChild(doc_.createTextNode("\n")); //$NON-NLS-1$

                Enumeration<?> keys = propertyNames();
                while (keys.hasMoreElements()) {
                        String key = (String)keys.nextElement();
                        String val = getProperty(key);
                        if (key == null || val == null || key.equals("name") || key.equals("url"))
                                continue;
                        
                        if(key.equals("setupDirectory"))
                                val = GrxXmlUtil.replaceEnvVal(new File(GrxXmlUtil.expandEnvVal(val)));
                        if(key.equals("setupCommand")){
                                String s = Activator.getDefault().getPreferenceStore().getString(PreferenceConstants.BIN_SFX);
                                val = val.replace(s, "$(BIN_SFX)");
                        }
                        Element propEl = doc_.createElement(GrxProjectItem.PROPERTY_TAG);
                        propEl.setAttribute("name",  key); //$NON-NLS-1$
                        propEl.setAttribute("value", val); //$NON-NLS-1$

                        element_.appendChild(doc_.createTextNode(INDENT4+INDENT4+INDENT4));
                        element_.appendChild(propEl);
                        element_.appendChild(doc_.createTextNode("\n")); //$NON-NLS-1$
                }
                element_.appendChild(doc_.createTextNode(INDENT4+INDENT4));

                return element_;
        }

        public void setName(String name) {
                oldName_ = name_;
                name_ = name;
                setProperty("name", name); //$NON-NLS-1$
        }

        public final String getName() {
                return name_;
        }

        public final String toString() {
                return name_;
        }

        public String getOldName(){
                return oldName_;
        }
        
        public void setDocument(Document doc) {
                doc_ = doc;
        }

        public void setElement(Element element) {
                element_ = element;
                doc_ = element.getOwnerDocument();
        }

        public Element getElement() {
                return element_;
        }

        public void setSelected(boolean b) {
                selected_ = b;
        }

        public boolean isSelected() {
                return selected_;
        }

        public void setExclusive(boolean b) {
                isExclusive_ = b;
        }

        public boolean isExclusive() {
                return isExclusive_;
        }

        protected void setIcon(String iconName) {
                iconName_ = iconName;
                if( ireg_.get( iconName_ ) == null )
                        ireg_.put( iconName_, ImageDescriptor.createFromURL( getClass().getResource( "/resources/images/"+iconName_ ) ) ); //$NON-NLS-1$
                //icon_ = icon;
        }

        public Image getIcon() {
                return ireg_.get( iconName_ );
        }

        public void setMenuItem( Action a ) {
                menu_.add(a);
        }
        
        public void setSubMenu( MenuManager m ) {
                subMenu_.add(m);
        }

        public Vector<Action> getMenu() {
                return menu_;
        }

        public Vector<MenuManager> getSubMenu() {
                return subMenu_;
        }
        
        protected void setMenuPath(String[] path) {
                menuPath_ = path;
        }

    protected boolean syncExec(Runnable r) {
        Display display = Display.getDefault();
        if (display != null && !display.isDisposed()) {
            display.syncExec(r);
            return true;
        } else
        return false;
    }
    
        public String[] getMenuPath() {
                return menuPath_;
        };

        public boolean equals(Object obj) {

                return this == obj;
        }

        public String getURL(boolean expand) {
                if (expand)
                        return GrxXmlUtil.expandEnvVal(url_);
                else
                        return url_;
        }

        public void setURL(String url) {
                url = url.replace('\\','/');
                setProperty("url", url); //$NON-NLS-1$
                url_ =url;
        }

        public void rename(String newName) {
                manager_.renamePlugin(this, newName);
        };

    public static Object getField(Class<? extends GrxBasePlugin> cls, String field, Object defaultValue) {
                try {
                        Field f = cls.getField(field);
                        return (Object)f.get(new Object());
                } catch (Exception e) {
                        //GrxDebugUtil.println(cls.getName() + ": " + field + " not defined");
                }
                return defaultValue;
    }

        public void shutdown() {

        }
        
        public void unregisterCORBA() {

        }

    public boolean registerCORBA() {
        return true;
    }
        
        public GrxBasePlugin clone(){
                GrxBasePlugin ret = (GrxBasePlugin) super.clone();
                
                
        ret.setName(name_);
        ret.setURL(url_);
        
/*      
 *              Deep copy suspension list

        private ImageRegistry ireg_;
        private String iconName_;

        private Vector<Action> menu_ = new Vector<Action>();
        private String[] menuPath_;

        private Document doc_;
        protected Element element_;
*/
        
        return ret;
        }

        public boolean propertyChanged(String property, String value) {
                if (property.equals("name")){ //$NON-NLS-1$
                        rename(value);
                        return true;
                }
                return false;
        }
        

        public Object setProperty(String key, String value){
                //System.out.println("GrxBasePlugin.setProperty("+key+","+value+")");
                Object o = super.setProperty(key, value);
                notifyObservers("PropertyChange", key, value); //$NON-NLS-1$
                return o;
        }
        
        public void setFocused(boolean b){
        }
        
        public void addObserver(GrxObserver v){
                observers_.add(v);
        }
        
        public void deleteObserver(GrxObserver v){
                observers_.remove(v);
        }

        public ArrayList<GrxObserver> getObserver(){
                return observers_;
        }
        
        public void notifyObservers(Object... arg) { 
        ListIterator<GrxObserver> it = observers_.listIterator();
        while (it.hasNext()) {
            GrxObserver observer = it.next();
            observer.update(this, arg);
        }
    }

    public ValueEditType GetValueEditType(String key) {
        return new ValueEditText();
    }
        
    public class ValueEditType{
        private ValueEditType(){}
    }
    public class ValueEditText extends ValueEditType{
        public ValueEditText(){}
    }
    public class ValueEditCombo extends ValueEditType{
        private String[] items_;
        public ValueEditCombo(String[] items){
            items_ = items;
        }
        public String[] GetItems(){ return items_; }
    }
}