About Isight Extensions

A standard Isight extension project in Eclipse includes the following:

  • Two source directories. One directory, called src, contains all the code for the extension. The other directory, called test, contains JUnit test code used by your specific testing suite.

  • The necessary SDK .jar files for development.

  • A metamodel.xml file. This file contains the XML definition for the entire extension. When you use the options available in Isight Developer, XML is created automatically and added to your extension’s metamodel.xml file.

You can edit this generated code directly as described in Editing the metamodel.xml File Directly. In addition, an advanced user can edit the metamodel.xml file directly to add information for aspects of the extension not yet available via Isight Developer’s options (for example, i18n information for localization). Examples of generated XML for each of the main Isight Developer tabs are described in the following sections.

Example Basic Extension Information and Requirements Code

The following code shows sample XML for the Basic Properties, Requirements, and References settings available on the Overview tab.

For more information on using the Overview tab, see Editing Basic Extension Information and Requirements.

<MetaModel xmlns=http://www.simulia.com/isight/xml/metamodel 
superversion="*.*.*" 
supername="com.engineous.system.component.Activity" 
version="1.0.0" name="com.company.component.doccomp">
   <Icon>/com/company/component/doccomp/resources/DocCompIcon.gif</Icon>
   <DisplayName>Documented Component</DisplayName>
   <Description>The Description</Description>
<Requires>
   <SystemRelease>5.0.0+</SystemRelease>
</Requires>
<SharedClassLoader>true</SharedClassLoader>
<ParentLastClassLoader>true</ParentLastClassLoader>
<Requires>
   <SystemRelease>5.0.0+</SystemRelease>
   <Reference sharedloader="true" platforms="win32" id="1.0.0"
   type="none" filename="ref.exe" name="NewReference0"/>
</Requires>
</MetaModel>

Example Java Classes Code

The following code shows sample XML for the settings available on the Contents tab.

For more information on using the Contents tab, see Defining Java Classes.

<Handler type="com.engineous.sdk.component.ComponentHandler">
   com.company.component.doccomp.DocCompHandler</Handler>
<Editor type="com.engineous.desktop.sdk.DesktopEditor">
   com.company.component.doccomp.DocCompEditor</Editor>
<Editor type="com.engineous.sdk.component.ComponentAPI">
   com.company.component.doccomp.DocCompAPI</Editor>
<Runtime type="com.engineous.sdk.runtime.Component">
   com.company.component.doccomp.DocCompExecutor</Runtime>
<PreferencesPanel 
   type="com.engineous.sdk.preferences.PreferencePanel">
   com.company.component.doccomp.DocCompPreferencePanel</PreferencesPanel>

Example Extension Parameters, Properties, and Preferences Code

The following code shows sample XML for the settings available on the Variables tab.

For more information on using the Variables tab, see Creating Extension Parameters, Properties, and Preferences and Editing Extension Parameters, Properties, and Preferences.

<Variables>
   <Variable saveToDB="true" structure="Scalar"
      type="com.engineous.datatype.Real" mode="Local" 
      name="NewVariable1"/>
   <Variable saveToDB="true" structure="Scalar"
      type="com.engineous.datatype.Real" mode="Local" 
      name="NewVariable2"/>
</Variables>
<Preferences>
   <Preference type="com.engineous.datatype.String" 
      tag="NewPreference0" name="NewPreference0"/>
</Preferences>

Example Extension Files Code

The following code shows sample XML for the settings available on the Resources tab.

For more information on using the Resources tab, see Defining Additional Extension Files.

<UserHelp type="html">/com/company/component/doccomp/resources/
   html/about.html
</UserHelp>