Programmer's Guide > Interfaces > Interface Overview
  
Interface Overview
The AOM supports most of the DOM interfaces developed by the W3C, several Arbortext extensions to the DOM interfaces, and many additional Arbortext interfaces for features that are not part of the DOM. Refer to Introduction to the Document Object Model (DOM) for a list of supported DOM specifications.
The interface descriptions use the DOM conventions in presenting a language-neutral definition of the list of constants (enumerations), attributes (properties), and methods implemented for each interface. For some language bindings, the enumeration (constant) names are available as global typedefs (for example, COM C++), as static final constants (Java, JavaScript), or only available as numeric values (JScript and VBScript, currently). Attributes (or properties) in some language bindings are translated to setXxx and setXxx methods. For example, the Application.activeDocument attribute is obtained by calling the Application.getActiveDocument() method in Java. Read-only attributes, as noted in the Access table entry of each attribute description, only have a getXxx method in these language bindings. (Refer to the Index terms “attributes”, “enumerations”, and “methods” for alphabetical listings of each, respectively.)
The descriptions of the W3C interfaces in the following chapters are taken from their respective W3C specifications. Each description provides a reference to its W3C specification.
In the W3C interface descriptions, the DOMString type is a string of 16-bit Unicode characters, the same as the String type in the other interface descriptions. Throughout the documentation consider references to HTML or XML to also include SGML.
Square braces ([]) denote optional trailing parameters which may be omitted in most script bindings. Also, the AOM provides method overloads in the Java binding so that optional parameters may be omitted.
The AOM supports the following interfaces:
Interface
Description
AbstractView
(W3C) A base interface that all views shall derive from.
Acl
Represents the ACL (Arbortext Command Language) interpreter, allowing the AOM programmer to request that a string be executed as an ACL command or evaluated as an ACL function.
ActivexEvent
Provides specific contextual information associated with Activex events.
ADocument
The Arbortext extension to the W3C DOM Document interface.
ADocumentType
Arbortext extensions to the W3C DOM DocumentType interface
AEditEvent
Provides specific contextual information associated with the EditEvent extension.
AElement
The Arbortext extension to the W3C DOM Element interface.
AEvent
The Arbortext extension to the W3C DOM Event interface.
ANode
The Arbortext extension to the W3C DOM Node interface.
Application
Provides access to Arbortext Editor and Arbortext Publishing Engine global functionality. (That is, features that are not associated with any document, document type, or document component.) There is only one Application object instantiation in existence.
ARange
The Arbortext extension to the W3C DOM Range interface.
Attr
(W3C) An attribute in an Element object.
CDATASection
(W3C) Used to escape blocks of text containing characters that would otherwise be regarded as markup.
CharacterData
(W3C) Extends Node with a set of attributes and methods for accessing character data in the DOM.
Comment
(W3C) Inherits from CharacterData and represents the content of a comment, for example, all the characters between the starting <!-- and ending -->.
Component
The base interface for all window components.
Composer
Represents a composition pipeline defined by a Composer Configuration File (CCF).
ControlEvent
Provides specific contextual information associated with Control events.
Dialog
Extends the Window interface.
Document
(W3C) Represents the entire HTML or XML document.
DocumentEvent
(W3C) Provides a mechanism by which the user can create an Event of a type supported by the implementation.
DocumentFragment
(W3C)A "lightweight" or "minimal" Document object.
DocumentRange
(W3C) Provides a mechanism to create Range objects for a document.
DocumentType
(W3C) Each Document has a doctype attribute whose value is either null or a DocumentType object.
DocumentView
(W3C) Implemented by Document objects in DOM implementations supporting DOM Views.
DOMImplementation
(W3C) Provides a number of methods for performing operations that are independent of any particular instance of the document object model.
Element
(W3C) The Element interface represents an element in an HTML or XML document.
Entity
(W3C) This interface represents an entity, either parsed or unparsed, in an XML document.
EntityReference
(W3C) EntityReference objects may be inserted into the structure model when an entity reference is in the source document, or when the user wishes to insert an entity reference.
Event
(W3C) Used to provide contextual information about an event to the handler processing the event.
EventListener
(W3C) The primary method for handling events.
EventTarget
(W3C) Implemented by all Nodes in an implementation which supports the DOM Event Model. Also implemented by all Components in the AOM implementation.
MenuBar
Represents a menu bar.
MenuEvent
Provides specific contextual information associated with Menu events.
MenuItem
Represents a menu item.
MouseEvent
(W3C) Provides specific contextual information associated with Mouse events.
MutationEvent
(W3C) Provides specific contextual information associated with Mutation events.
NamedNodeMap
(W3C) Objects implementing the NamedNodeMap interface are used to represent collections of nodes that can be accessed by name.
Node
(W3C) The primary datatype for the entire Document Object Model.
NodeList
(W3C) Provides the abstraction of an ordered collection of nodes, without defining or constraining how this collection is implemented.
Notation
(W3C) Represents a notation declared in the DTD.
ProcessingInstruction
(W3C) Represents a processing instruction. Used in XML as a way to keep processor-specific information in the text of the document.
PropertyMap
Provides the abstraction of a collection of typed objects associated with string keys.
Range
(W3C) Represents a range of content in a Document, DocumentFragment, or Attr.
ScriptContext
Provides methods to load and run scripts using the Microsoft Windows Scripting engine in separate contexts. This interface is only available in the COM binding of the AOM.
StringList
Provides the abstraction of an ordered collection of Strings, without defining or constraining how this collection is implemented.
TableCell
Represents a single cell in a table.
TableColumn
Represents a column of cells.
TableGrid
Represents a table grid which is a rectangular array of cells.
TableMulticell
Represents a rectangular array of spanned cells in a table.
TableObject
Base class for all table objects.
TableObjectStore
A TableObjectStore contains a collection of TableObjects all from the same document.
TableRectangle
Represents a rectangle of cells.
TableRow
Represents a row of cells.
TableRule
Represents a rule.
TableSet
A collection of one or more TableGrids, each of which is a rectangular array of TableCells.
TableTilePlex
Used to represent a table selection.
Text
(W3C) Inherits from CharacterData and represents the textual content (termed character data in XML) of an Element or Attr.
ToolBarEvent
Provides specific contextual information associated with ToolBar events.
UIEvent
(W3C) Provides specific contextual information associated with User Interface events.
View
A subclass of AbstractView, representing a view of an associated Document.
Window
Represents a top level window frame which is created by Arbortext Editor.
WindowEvent
Provides specific contextual information associated with Window events.
The AOM supports the following Arbortext PE Application interfaces:
Interface
Description
CCComposer
Describes a single composer (.ccf file) installed on the Arbortext Publishing Engine server.
CCCompositionParameter
Describes a single parameter to a Arbortext Content Pipeline composer (.ccf file).
CCDoctype
Describes a single document type installed on a Arbortext Publishing Engine server.
CCDocumentComposer
Describes a composer associated with a document type installed on a Arbortext Publishing Engine server.
CCFrameset
Describes a frameset that is installed on a Arbortext Publishing Engine server.
CCPathEntry
Describes a single directory on a server path list.
CCStylesheet
Describes a stylesheet installed on the Arbortext Publishing Engine server.
CompositionConfiguration
Provides information about a Arbortext Publishing Engine server's composition capabilities.
E3Application
Creates an object that runs in each Arbortext PE sub-process and is called by the Arbortext Publishing Engine to process HTTP requests.
E3ApplicationRequest
Provides request information for a Arbortext Publishing Engine Application.
E3ApplicationResponse
Provides an object to assist a Arbortext Publishing Engine Application in sending a response to the HTTP or SOAP client.
E3ClientCompositionExtension
Describes an object that provides composition type-specific pre- and post-processing routines for the Arbortext Publishing Engine Composition Client.
E3Config
Passes information to a Arbortext Publishing Engine Application during initialization.
E3ServerComposer
Describes an object that handles composition operations on a Arbortext Publishing Engine server. “Composition" includes transforming an input JAR file into an output JAR file.
E3ServerCompositionExtension
Extends the Arbortext Publishing Engine Server Composition Application.
E3ServerCompositionParameter
Describes a parameter passed to or returned by an E3ServerCompositionRequest.
E3ServerCompositionRequest
Describes the request for a composition operation to be performed by the Arbortext Publishing Engine server composition application.
E3ServerCompositionResult
Describes the result of a composition operation under the Arbortext Publishing Engine server composition application.
E3Tracer
Creates entries in the Arbortext Publishing Engine Server Composition trace files.