Menus, toolbars and other features

# Create a Component class for the view, for example, TablePlotterComponent and overrde makeEditorContent method

package herschel.ia.gui.explorer.table;

import java.awt.BorderLayout;

import herschel.ia.dataset.gui.Explorer;
import herschel.ia.gui.apps.components.editor.AbstractExplorerComponent;
import herschel.ia.gui.kernel.util.IconLoader;

import javax.swing.Icon;
import javax.swing.JComponent;


public class TablePlotterComponent extends AbstractExplorerComponent {
    private static final long serialVersionUID = 1L;
    private static final Icon ICON = IconLoader.getKernelIcon("data/ImageDataset.gif");

    public TablePlotterComponent() {
	super(ICON);
    }   
    @Override
    protected boolean makeEditorContent() {
	Object o = getSelection().getValue();
	Explorer explorer = new TablePlotter();
	explorer.setObject(o);
	JComponent component = explorer.getComponent();
	add(component, BorderLayout.CENTER);
	component.addMouseListener(getArea().getMouseListener());
        return true;
    }
}

#Register the viewer (TablePlotter in init.py file)

import herschel
herschel.recursive_module_lookup(__name__,__path__,__file__)
del(herschel)
# --- End required code
from herschel.ia.gui.kernel import ExtensionRegistry, Extension
COMPONENT=ExtensionRegistry.COMPONENT
REGISTRY=ExtensionRegistry.getInstance()

print 'reading init.py'

REGISTRY.register(COMPONENT,Extension(
        "TableDataset viewer",
        "herschel.ia.gui.explorer.table.TablePlotterComponent",
        "factory.editor.variable",
        "herschel.ia.dataset.TableDataset"));

__all__=[]

#Create all.py file if it is not exist in its parent directory (explorer, for example)

 
""
Imports all ia sub packages either using "from pck.all import *"  or "from pck import *"
"""
import herschel
herschel.loadpckg(globals(),
                  "herschel.ia.gui.explorer",
                  ['table'])
del(herschel)

<--
   Some short-cuts 

 Set VIEWABLE   = Viewable
 
 Set VIEWPART   = ViewPart
 
 Set JCOMPONENT = javax.swing.JComponent
 
 Set REGISTRY   = Extension Registry
 
 Set INIT_PY    = __init__.py
 
 Set SELISTENER = SiteEventListener
 
-->

• Implement the Viewable interface by sub-classing any %JCOMPONENT% implementation.
• Register your implementation to the Extension Registry in the init.py file of your sub-system.

• The implementation requires a default, but light-weight constructor. Actual construction of a popup menu, a view menu, or a tool bar or contributions to the main tool bar or main menu (or combinations of them) should be done in the init(ViewPart part) method.

• Implement the herschel.ia.kernel.parts.Viewable interface by extended a JComponent implementation.
• Register your implementation to the herschel.ia.kernel.ExtensionRegistry in the __init__.py

Basic Steps

The aim is that your contribution is automatically picked up by the infrastructure, such that your view is added to the view menu, as shown in the picture on the right.

To make this happen, you will have to:

• Implement the herschel.ia.core.parts.Viewable interface by extended a JComponent implementation.
• Register your implementation to the herschel.ia.core.ExtensionRegistry in the __init__.py

The Viewable interface is a light-weight interface that provides the contents of a View. Your implementation should take the following into account:

• The implementation must be an extension of a swing component
• The implementation requires a default, but light-weight constructor. Actual construction of a popup menu, a view menu, or a tool bar or contributions to the main tool bar or main menu (or combinations of them) should be done in the init method.
• In principle only one instance of a view should exist.
• The ID returned by your implementation must be unique

Example

Implementation

public class MyView extends SomeSwingComponent implements Viewable {
    private ViewPart _part;

    // Viewable implementation
    public MyView() {}
    public void   dispose()  {}
    public Icon   getIcon()  { return getPart().getIcon(); }
    public String getId()    { return getPart().getId();   }
    public String getTitle() { 	return getPart().getTitle(); }
    public void   init(ViewPart part) {
	_part = part;
	makeActions();
    }

    // private stuff
    private ViewPart getPart() { return _part; }
    
    private void makeActions() {
	// create tool bars, menus and other stuff
    }
}

Registry

# import and short-cuts
from herschel.ia.core import ExtensionRegistry, Extension
VIEWABLE=ExtensionRegistry.VIEWABLE
REGISTRY=ExtensionRegistry.getInstance()

# registry
REGISTRY.register(VIEWABLE, Extension(
         "site.view.myview",                  # a unique ID, could be the same as ...
         "resides.in.java.package.MyView",    # the class holding the implementation
         "My View",                           # how it should be called in the menu
         "resides/in/java/package/myview.gif" # resource of possible icon (can be None)
         ));

# cleanup
del(ExtensionRegistry,Extension,REGISTRY,VIEWABLE)

Adding features

Trigger events

    private void somemethod() {
        :
        getPart().getEventHandler().trigger(aSiteEvent)
        :
    }

Receiving events

public class MyView extends SomeSwingComponent implements Viewable, SiteEventListener {
   
    public void init(ViewPart part) {
	:
        part.getEventHandler().addEventListener(SelectionEvent.class, this);
	:
    }


   public void selectionChanged(SiteEvent event) {
       // we *know* that we only receive a SelectionEvent, so:
       SelectionEvent selection=(SelectionEvent)event;
       :
   }

}

Menus and toolbars

<-- Author: JorgoBakker -->

Creating a View

<-- summary -->

TODO