Samplespath

From Aptana Development

Contents

samplespath extension point

  • Extension point contained located at com.aptana.ide.samples/schema/samplespath.exsd

Internal Examples

  • com.aptana.ide.documentation
    • Contributes JavaScript Toolkits samples
  • com.aptana.ide.framework.apollo
    • Contributes Adobe AIR samples

Extension point syntax

<extension point="com.aptana.ide.samples.samplespath">
   <samplesinfo
         directory="samples"
         iconFile="icons/mysamples.png"
         infoFile="samples/index.html"
         name="My Samples"
         projectHandler="com.xyz.MySampleHandler"
         previewHandler="com.xyz.MyPreviewHandler">
         <nature id="com.xyz.my.nature"/>
   </samplesinfo>
</extension>
  • samplesinfo - root element for contributing samples. Each element of this type will appear as a top-level node in the Samples view with the attribute 'name' as the label
  • directory - directory containing the actual samples. Each directory directly under this attribute will be treated a sample node in the Samples view.
  • iconFile - icon to display in the Samples View
  • infoFile - Optional help file that will load in the internal Aptana browser
  • name - label that will appear as a top-level element in the Samples view
  • projectHandler - Class that must implement com.aptana.ide.samples.handlers.IProjectCreationHandler and must have a public default constructor. An instance of this class will be called each time a project is creating around one of the samples for this entry.
  • previewHandler - Class that must implement com.aptana.ide.samples.handlers.IPreviewHandler and must have a default public constructor. An instance of this class will be called each time a preview is requested for one of the samples in this entry.
  • nature - one or more nature ids that will be set on the project created in this samples entry.

Important notes

  • Both the project creation handler and the preview handler should catch errors internally and present any error information to the user.