18.4 Entry Headings


Book: ActionScript for Flash MX: The Definitive Guide, 2nd Edition
Section: Chapter 18.  ActionScript Language Reference



Each entry in the Language Reference is presented in the following basic format:

Entry Name Availability

Purpose Access
Synopsis

Table 18-3 describes these headings, as well as additional headings used to document each item.

Table 18-3. Language Reference headings

Heading

Description

Availability

Indicates when the item was added to ActionScript (or when it became an Action, if the item predates formal ActionScript). For example, if the Availability is listed as "Flash 5," the feature is also supported in Flash 6, unless otherwise noted. Furthermore, if the Availability explicitly or implicitly includes Flash 6, the feature is supported both in the Flash MX authoring tool and the Flash Player 6 browser plugin, unless otherwise noted. This heading also summarizes backward-compatibility and deprecation status.

Access

Applies to property entries only. Describes whether the property value can only be retrieved ("read-only") or both retrieved and assigned ("read/write").

Purpose

A brief summary of the item's purpose.

Synopsis

Illustrates the abstract syntax required by the item. Italicized code indicates text that must be replaced by the programmer, such as with a string, integer, expression, or identifier. Some functions can be called with differing types and numbers of arguments, in which case the Synopsis may show multiple supported syntaxes. Note that the Synopsis does not indicate whether function, method, or constructor arguments are optional; that information is available under the Arguments subheading.

Arguments

Applies to method and function entries only. Describes the parameters used with the method or function, as listed in the Synopsis.

Operands

Applies to operator entries only. Describes the operands used with the operator, as listed in the Synopsis.

Returns

Applies to method and function entries only (properties always "return" the value stored within them). Describes the return value of the method, if any. If the method does not have a return value, the Returns subheading is omitted. Functions without documented return values always return undefined.

Description

Explains how the item works and how it might be used in a practical scenario.

Usage

Describes noteworthy peculiarities of the item.

Bugs

Describes known problems associated with the item.

Example

Offers sample code showing the item in use, although shorter samples sometimes appear under the Description subheading.

See Also

Lists cross-references to related entries within this Language Reference and to related material in Part I. Refer also to the book's index and resources listed in the Preface and Appendix A.


    Copyright 2002 O'Reilly & Associates, Inc. All rights reserved.
    1005 Gravenstein Highway North
    Sebastopol, CA 95472
     


    ActionScript for Flash MX. The Definitive Guide
    ActionScript for Flash MX: The Definitive Guide, Second Edition
    ISBN: 059600396X
    EAN: 2147483647
    Year: 2002
    Pages: 780
    Authors: Colin Moock

    flylib.com © 2008-2017.
    If you may any questions please contact us: flylib@qtcs.net