Difference: DpHipeTools (11 vs. 12)

Revision 122008-02-15 - NicolaDeCandussio

 			 META TOPICPARENT 
			 name="DpHipe" 
		
 Adding Tools to HIPE
- META TOPICPARENT
+ name="DpHipe"
  Modifier.
-<
<
+      One of the Modifier in the input area for the crop task:
->
>
+      The first Modifier of the input area for the crop task:
 Currently the system contains basic implementation for the simple types  Integer, Float, Long, Double so there's still a lot of space for improvements and contribution.
-<
<
+If your Task Parameter doesn't follow into the mentioned types you need to:
->
>
+If your Task Parameter isn't one of the mentioned types you need to:
  Implement a Modifier
  Register it to the system.
 


 Implement a Modifier
-<
<
+ The modifier interface consists of two explicit contracts
->
>
+ The Modifier interface consists of two explicit contracts
  Support the drag and drop features (the set/getVariableSelection)
  Support the inspection for Object (the set/getObject)
 
and two implicit contracts inherited by the ExtensionRegistry
  Signature Components
-<
<
-<
<
->
>
+In case the default input area based on Modifiers doesn't fit your needs you can just replace it by your own implementation.
    Rotate Alternative Signature:
-<
<
+For that you can implement a herschel.ia.task.gui.dialog.SignatureComponent and register it as follows (again in the __init__.py):
->
>
+If this is the case you need to: 
 Implement a Task Signature Component
  Register it to the system.
 

 Implement a Task Signature Component 

 
 The TaskSignatureComponent interface consists of four explicit contracts 
 Support the setVariableSelection for initial assignment from the Tool Window
  Assign the Signature to display ( the setSignature)
  Return a map of parameters and assigned values ( the getParameters note return value ca be simplified to  Map<TaskParameter, VariableSelection> )
  Clear and check user inputs (used by the default buttons)
 
and the two implicit contracts inherited by the ExtensionRegistry 
 Be JComponent 
  Have an empty constructor
 


 Register a Task Signature Component 

 

The registration of the Task Signature Component is done again in the __init__.py  via theExtensionRegistry with the usual syntax (please note the name of the factory: factory.editor.tool.task.signature).
     REGISTRY.register(COMPONENT,Extension(
-<
<
+        id,                           # string
        implSignatureComponent,       # string
        "factory.editor.tool.task",
        implTask));                   # string
->
>
+        "Rotate Signature",
        "herschel.ia.task.example.RotateSignatureComponent",
        "factory.editor.tool.task.signature",
        "herschel.ia.image.Rotate"))
 , where: 
 id is a unique identifier
  implSignatureComponent - implementation of SignatureComponent interface
  implTask - implementation of your task for which this input dialog applies
-<
<
+An example (which you can find in the prototype):
->
>
+ See also the Extension Registry documentation for more details.




 Task Dialogs 
Eventually, if the above options still do not accomodate you needs you can replace the the default Task Panel with your own implemetation

If this is the case you need to: 

 Implement a Task Panel 
  Register it to the system. 
 

 Implement a Task Panel 

 
 The TaskPanel interface consists of three explicit contracts 
 Support the setVariableSelection for initial assignment from the Tool Window
  Assign the Task to display ( the setTask)
  Set the SiteEvent handler for notifying request of execution  (the setSiteEventHandler)
 
and the two implicit contracts inherited by the ExtensionRegistry 
 Be JComponent 
  Have an empty constructor
 


 Register a Task Panel 

 

The registration of the Task Panel Component is done again in the __init__.py  via theExtensionRegistry with the usual syntax (please note the name of the factory: factory.editor.tool.task.signature).
     REGISTRY.register(COMPONENT,Extension(
-<
<
+        "herschel.ia.gui.components.editor.tasks.RotateSignatureComponent",
        "herschel.ia.gui.components.editor.tasks.RotateSignatureComponent",
->
>
+        "Default Task Panel",
        "herschel.ia.task.gui.dialog.JTaskPanel",
         "factory.editor.tool.task",
-<
<
+        "herschel.ia.image.Rotate"));
->
>
+        "herschel.ia.task.Task"));
->
>
+, where: 
 id is a unique identifier
  implSignatureComponent - implementation of SignatureComponent interface
  implTask - implementation of your task for which this input dialog applies
  See also the Extension Registry documentation for more details.
-<
<
+Note that your GUI component must have a default constructor!
-<
<
+ Task Dialogs 
The default dialog provided by the system is result of the composition of a main input area (TaskSignatureComponent)  and a panel containing the buttons (JTaskButtonsPanel). The main panel is based
  Task compliance 
 
 write user documentation (jtags)! That will be automatically picked up whenever a user asks the system for help on your task.

View topic | History: r113 < r112 < r111 < r110 | More topic actions...