• Set OBJECT_OUTLINE = ObjectOutline

• Implement the OutlineComponent interface by extending a javax.swing.JComponent.

Editor components are editors (optionally read-only) of data contents of a specific variable that is selected within in the HIPE session.
They are triggered by double-clicking on a variable, or through the open with menu. Editor components are opened in the editor area.

• __init__.py - how the above get registered.

Component Registry

Editor components need to be registered for telling the types they are interested in. This is to be done within your __init__.py:

# Register to the editor component factory
REGISTRY.register(COMPONENT,Extension(
                 "Some editor",
                 "herschel.your.module.views.SomeEditorComponent",
                 "factory.editor.variable",
                 "herschel.your.module.SomeType"))

• Set ABSTRACT_EDITOR_COMPONENT = AbstractEditorComponent

• Implement the EditorComponent interface by extending AbstractEditorComponent or one of its subclasses.
• Register your implementation to the Extension Registry in the __init__.py.

• ListEditorComponent a simple viewer of lists - here a link to its implementation.
• DefaultFileEditorComponent a simple viewer of a file - here a link to its implementation.

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

 Set VARIABLES_VIEW    = VariablesView
 
 Set OUTLINE_VIEW      = OutlineView
 
 Set OUTLINE_COMPONENT = OutlineComponent
 
 Set EDITOR_COMPONENT  = EditorComponent
 
 Set SELECTION_EVENT   = SelectionEvent
 
 Set FINE_TIME         = FineTime
 
 Set EXPLORER          = Explorer
 
-->

• Implement the OutlineComponent interface by extending a %JCOMPONENT%
• Register your implementation to the Extension Registry in the __init__.py

Source Code of Basic implementations

The ia_gui_apps contains some basic implementations for OutlineComponents:

• ArrayDataOutline - a simple outline for any array data
• DatasetOutline - a simple outline for any dataset
• ProductOutline - a simple outline for any product
• __init__.py - how the above get registered

• Implement the EditorComponent interface by extending a %JCOMPONENT%
• Register your implementation to the Extension Registry in the __init__.py

Simple Example Code

Source Code of Basic implementations

The ia_gui_apps contains some basic implementations for EditorComponents:

• MetaDataComponent a simple viewer of meta-data
• ProductComponent a simple viewer of a product
• __init__.py - how the above get registered

Your Explorer Implementation

You may have created an implementation of the former Explorer interface which is used by the dataset inspector (and is registered within that inspector).

If you do not expect that your explorer needs to talk to other parts within the HIPE application, you can simply extend the abstract AbstractExplorerComponent class:

public class ArrayDataComponent extends AbstractExplorerComponent {
    private static final Icon ICON = ...

    public ArrayDataComponent() {
	super(ICON);
    }   
}

<-- JorgoBakker -->

• Implement the herschel.ia.kernel.EditorComponent interface by extending a javax.swing.JComponent
• Register your implementation to the herschel.ia.kernel.ExtensionRegistry in the __init__.py

Here we explain how you can contribute to the outline view and the editor area.

public interface EditorComponent {

    boolean init(Selection selection, EditorPart editorPart);
    boolean aboutToClose();

    Icon getComponentIcon();
    String getName();   
    Selection getSelection();

}

Adding Components to existing Views

<-- summary -->

Outline View

<-- If you follow the contract on outline components -->

• Implement the herschel.ia.gui.views.OutlineComponent interface by extending a javax.swing.JComponent
• Register your implementation to the herschel.ia.core.ExtensionRegistry in the __init__.py

An example:

Suppose you would like to create an outline for herschel.share.fltdyn.time.FineTime and you would like to show the contents in the outline view whenever a session variable of that type is selected by the user.

Component Implementation

public class FineTimeOutline extends JLabel implements OutlineComponent {

    public boolean setOutline(Selection selection, OutlineView view) {
	VariableSelection var=(VariableSelection)selection;
        setText(var.getValue().toString());

	return true;
    }

}

Component Registry

# convenience short-cuts
from herschel.ia.core import ExtensionRegistry, Extension
FACTORY=ExtensionRegistry.FACTORY
COMPONENT=ExtensionRegistry.COMPONENT
REGISTRY=ExtensionRegistry.getInstance()

# Register to the variable outline factory
REGISTRY.register(COMPONENT,Extension(
		"My FineTime Outline",
		"resides.in.java.package.FineTimeOutline",
		"factory.outline.variable",
		"herschel.share.fltdyn.time.FineTime"))

# clean-up
del(FACTORY,COMPONENT,REGISTRY)

More information about the extension registry can be found in its Java API (herschel.ia.core.ExtensionRegistry).

Editor Area

Editor components are browsers or editors of data contents of a specific variable that is selected in the HIPE session.

• Implement the herschel.ia.core.EditorComponent interface by extending a javax.swing.JComponent
• Register your implementation to the herschel.ia.core.ExtensionRegistry in the __init__.py

TODO: Example