Loading

Plugin API

From Showit Desktop Manual

(Redirected from API)

A plugin is any Flash SWF file that is intended to have special interaction and features within Showit.

Specifically, a plugin has adjustable parameters that allow it to be customized to the end users preferences.

A plugin should implement the IPlugin interface or extend the BasePlugin class which already implements IPlugin.

Showit Components

Showit is comprised of two separate but intermingled components, a Builder and a Player. There a subtle differences in how plugins are handled by each, so they will be referred to throughout the wiki by these names.

  • The Builder is the Adobe AIR application where users create and manage their websites.
  • The Player is the component that actually displays the final website inside of the browser, but it is also used to preview sites from within the Builder.

Plugin Requirements

  • Plugins must use Actionscript 3 and be Flash Player 9 compatible.

Plugin General Guidelines

  • Plugins should be designed to update when different parameters are changed from within the Builder. For best performance however, a complete update may not be necessary. For example, when a gallery border color is changed there is no need to refresh the images that are being displayed.
  • Plugins should have minimal motion and maintain their original size while inside the Builder. Auto hiding functionality or any motion that causes a display object to move outside the original size of the plugin should be avoided.
  • Plugins designed in the Flash IDE with display objects already on the stage should make sure that all display objects fit within the original expected size of the stage. Objects in the display list but off stage, will affect the size of the plugin when it is originally added to Showit.
  • Plugins designed in the Flash IDE with display objects already on the stage should always maintain the upper left corner of their stage as X:0 and Y:0. For example, if a plugin has a 100 x 100 square located on the stage, but that square is located at X:50 and Y:50, it will not display properly.
  • Plugin animations will play at the frame rate of 25.

IPlugin

The IPlugin interface is the primary interface that a plugin should extend in order to be fully compatible with the Plugin API. It contains all of the methods that Showit will call on the plugin.

Alternatively, the BasePlugin class can be downloaded and extended by your plugin. The BasePlugin class already implements all of the IPlugin interface. It also contains properties and helper methods that make using the Plugin API easier. It is highly recommended to extend the BasePlugin class for plugins based primarily in Actionscript.

IPluginManager

The IPluginManager interface is an interface that Showit implements in both the Builder and Player. It contains all of the methods that plugins are allowed to call into Showit with. Some of these include methods for linking to a page within the site and getting a text box with the proper styling.

If you extend the BasePlugin class the plugin manager is handled within this class. You can simply reference the pluginManager and call the IPluginManager methods.

PluginConstants

The PluginConstants are a group of static values that are used throughout the Builder and Player to pass parameters. They are used specifically for alignments, channels, and channel commands.

Downloads

  • Note 
    All download files are packaged as "com.showitfast.sites.plugins" and as such if you use them in a project, you will need to put them in a corresponding folder located in your classpath. (The default FLA classpath is the folder that the FLA is in.)

File:IPlugin.as

File:IPluginManager.as

File:PluginConstants.as

File:BasePlugin.as

Examples

Color Change

Sample code to add a color picker to the advanced tab and allow the user to change the color of a symbol

Mouse Over

Sample code to show how to create a mouse over for a layer that will be used as a normal button in the site. Note, you must have Hover effect set to trigger this at this point, the recommendation is a grow set to 1 so that it doesn't affect it but passes the hover events.

Border

Sample code to show how to create a border that loads an image.

Text Formatting

An example of how to format text using the style choices.

PayPal Button

This is the code used for the PayPal button, shows how to add and manage lots of properties and compose and post a new request.

Drop Down Code

This code shows examples of using styles, XML lists and linking to pages and requires: