[Contents] [Previous] [First] 

Chapter 11
Composer Plug-in API Reference

Plug-in Composer Package Classes
IO Package Classes
Testbed Package Classes
Test Classes Sample Classes

To help you familiarize yourself with the Composer Plug-in API as quickly as possible, this reference lists Composer Plug-in classes by package membership.

Each class and method entry includes a brief description and links to the corresponding reference entry.

[Top]

Plug-in Composer Package Classes
Composer Plug-in building blocks
Class Name Description
Plugin Composer plug-in base class, parent of all Composer plug-in classes. To write a plug-in, you subclass from this class and override some of its methods.
Document The HTML document. Its name is a relative URL. You do not subclass from this class.
Factory For advanced plug-in registration. Allows developers to write wrapper plug-ins that support foreign plug-in types.
ImageEncoder Image encoder base class, parent of all image encoder classes. To write an image encoder, you subclass from this class and override some of its methods. This class extends the image file formats that Composer can write.
ImageEncoderFactory Used to create image encoders at runtime.

[Top] [ Plug-in Composer Package Classes]

IO Package Classes
Utility classes that help parse the document
Class Name Description
Comment HTML comments, with the format:
'<!' + commentText + '>'
Subclass of Token.
Entity Multicharacter combinations that start with '&', and end in ';' and represent unusual characters. Subclass of Token.
JavaScriptEntity HTML expression that provides runtime evaluation of parameter values. Subclass of Token.
LexicalStream HTML lexical stream. Takes UnicodeInputStream object and breaks it into lexical tokens.
SelectedHTMLReader A filter for excluding unselected text from an HTML stream.
Tag HTML tag, which has a name, an open or close property, and zero or more attributes. Subclass of Token.
Text Text of an HTML document. Subclass of Token.
Token Base class for HTML tokens.

[Top] [IO Package Classes]

Testbed Package Classes

The Testbed Package contains two types of classes:

[Top]

Test Classes
Composer Plug-in testing environment
Testbed Package
Class Name Description
Test Composer Plug-in Testbed. Allows you to test your plug-in outside of the Composer interface.
ImageEncoderTest Composer Plug-in Testbed. Allows you to test your image encoder outside of the Composer interface.

[Top] [Testbed Package: Composer Plug-in Testing Environment]

Sample Plug-in Classes
Sample Composer Plug-ins
Testbed Package
Class Name Description
AddApplet Sample plug-in. Shows how to use the LOCALDATA property to add local data files to a Composer document.
AddButton Sample plug-in. Shows how to add images to the document.
AddLayer Sample plug-in. Turns the selected text into a layer.
Colorize Sample plug-in. Applies a color pattern to the selected text in an HTML document. Shows low-level HTML parsing.
DocInfo Sample plug-in. Allows user to view and edit raw HTML. Shows how to access document information, such as the base URL, the working directory and its URL, and the current event, if any.
DocInfoResources Sample plug-in. Resource bundle object used in DocInfo sample.
EditHomePage Sample plug-in. Shows how to open the Netscape Home Page for editing.
EditRaw Sample plug-in. View and edit the raw HTML of the document. Shows how to call AWT.
IFCTest Sample plug-in. Example of using the IFC from a plug-in.
IFCTestBundle Resource bundle object used in IFCTest sample.
RedirectTest Sample plug-in. Shows how to redirect the open event to a new document URL.
SmallCaps Sample plug-in. Implements Netscape-style small caps. Shows low-level HTML parsing.
Tableize Sample plug-in. Places selected text in a table.
TagStrip Sample plug-in. Strips tags from selected text in HTML document. Shows low-level HTML parsing.
TextImageEncoder Sample plug-in. Image encoder.

[Top] [Testbed Package: Sample Plug-in Classes]
[Testbed Package Classes] [Contents] [Previous] [First]

Copyright © 1997 Netscape Communications Corporation