Difference between revisions of "Developing Plugin Programs"

From MIPAV
Jump to: navigation, search
m
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
In this chapter. . .
 
In this chapter. . .
*[[Understanding plug-in programs|"Understanding plug-in programs" ]]
+
*[[Understanding plug-in programs]]
*[[Using the API documentation|"Using the API documentation"]]
+
*[[Using the API documentation]]
*[[Developing plug-in programs| "Developing plug-in programs"]]
+
*[[Developing plug-in programs]]
*[[Creating a self-contained plug-in frame|"Creating a self-contained plug-in frame" ]]
+
*[[Creating a self-contained plug-in frame]]
 +
*[[Installing a plug-in]]
 
*[[Examples of MIPAV plug-ins]]
 
*[[Examples of MIPAV plug-ins]]
 
**[[Plug-in CT_MD, a typical plug-in program]]
 
**[[Plug-in CT_MD, a typical plug-in program]]
Line 9: Line 10:
 
***[[Plug-in CT_MD.java]]
 
***[[Plug-in CT_MD.java]]
  
Users who know how to program in Java can write a <span style="font-weight: normal; text-decoration: none; text-transform: none; vertical-align: baseline">''<font color="#000000">plug-in program</font>''</span> that adds support for a new file format, creates a new view, or applies a new algorithm to an image. <span style="font-weight: normal; text-decoration: none; text-transform: none; vertical-align: baseline">''<font color="#000000">This chapter does not intended to explain how to write a Java program; rather it presents information to help users who are writing plug-in programs to customize MIPAV. </font>''</span>You can find in this chapter how to:
+
== Developing and using plug-in programs ==
  
<div style="font-style: normal; font-weight: normal; margin-bottom: 0pt; margin-left: 24pt; margin-right: 0pt; margin-top: 5pt; text-align: left; text-decoration: none; text-indent: -24pt; text-transform: none; vertical-align: baseline"><font color="#000000">  Gain access to and use the online MIPAV application programming interface (API) documentation<br /></font></div><div style="font-style: normal; font-weight: normal; margin-bottom: 0pt; margin-left: 24pt; margin-right: 0pt; margin-top: 5pt; text-align: left; text-decoration: none; text-indent: -24pt; text-transform: none; vertical-align: baseline"><font color="#000000">  Determine which version of Java to use<br /></font></div><div style="font-style: normal; font-weight: normal; margin-bottom: 0pt; margin-left: 24pt; margin-right: 0pt; margin-top: 5pt; text-align: left; text-decoration: none; text-indent: -24pt; text-transform: none; vertical-align: baseline"><font color="#000000">  Select one of the three plug-in types<br /></font></div><div style="font-style: normal; font-weight: normal; margin-bottom: 0pt; margin-left: 24pt; margin-right: 0pt; margin-top: 5pt; text-align: left; text-decoration: none; text-indent: -24pt; text-transform: none; vertical-align: baseline"><font color="#000000">  Include mandatory lines of code in plug-in programs so that they interface correctly with MIPAV <br /></font></div><div style="font-style: normal; font-weight: normal; margin-bottom: 0pt; margin-left: 24pt; margin-right: 0pt; margin-top: 5pt; text-align: left; text-decoration: none; text-indent: -24pt; text-transform: none; vertical-align: baseline"><font color="#000000">  Install plug-in programs<br /></font></div>
+
A ''plug-in'' program allows you to add customized functionality to MIPAV. Before you create a plug-in, you should have a strong understanding of the underlying structure of MIPAV's software design and data structure. Because plug-ins are written in Java, you should also have a basic understanding of that programming language. After you create the plug-in, you must then install it. Once it is installed, you can access it from the Plug-Ins menu in the main MIPAV window.
 +
 
 +
Users who know how to program in Java can write a ''plug-in program'' that adds support for a new file format, creates a new view, or applies a new algorithm to an image.
 +
 
 +
This chapter does not intended to explain how to write a Java program; rather it presents information to help users who are writing plug-in programs to customize MIPAV.
 +
 
 +
You can find in this chapter how to:
 +
*Gain access to and use the online MIPAV application programming interface (API) documentation<br />
 +
*Determine which version of Java to use<br />
 +
*Select one of the three plug-in types<br />
 +
*Include mandatory lines of code in plug-in programs so that they interface correctly with MIPAV <br />

Latest revision as of 12:08, 24 June 2013

In this chapter. . .

Developing and using plug-in programs

A plug-in program allows you to add customized functionality to MIPAV. Before you create a plug-in, you should have a strong understanding of the underlying structure of MIPAV's software design and data structure. Because plug-ins are written in Java, you should also have a basic understanding of that programming language. After you create the plug-in, you must then install it. Once it is installed, you can access it from the Plug-Ins menu in the main MIPAV window.

Users who know how to program in Java can write a plug-in program that adds support for a new file format, creates a new view, or applies a new algorithm to an image.

This chapter does not intended to explain how to write a Java program; rather it presents information to help users who are writing plug-in programs to customize MIPAV.

You can find in this chapter how to:

  • Gain access to and use the online MIPAV application programming interface (API) documentation
  • Determine which version of Java to use
  • Select one of the three plug-in types
  • Include mandatory lines of code in plug-in programs so that they interface correctly with MIPAV