Support
Setup
Set up your xJSFL environment and write or use your first snippets of xJSFL code.
Quick Start
How to install the xJSFL framework, and both run (designers) and write (developers) some simple xJSFL
Komodo
How to install and set up the xJSFL IDE, Komodo Edit, so you can write and run (x)JSFL code
Guides
Guides to the various conceptual and physical aspect of the framework, including background information, illustrative code examples, best-practices, and links to more detailed parts of the documentation.
Framework basics
A tour of the xJSFL framework, how it's structured, how it works, and the thinking of how it was put together
Working with Flash
An overview of the specific parts of xJSFL you'll use to work with visual elements in the Flash IDE
- Moving around Flash
- Introduction to Collections
- Stage selection and manipulation (unfinished)
- Library selection and manipulation
Inspection and debugging tools
Tools and techniques to use to make your development easier and more productive
Extensibility
Builder larger and more useful scripts and applications by building on the base xJSFL code
- Extending xJSFL
- Creating your own functions, libraries and classes
- Combining multiple scripts into stand-alone Modules
- AS3 Module framework (unfinished)
Tutorials
Step-by-step guides, line-by-line code examples, and sample code to test out various aspects of the framework right now
Scripts
The basics of writing an xJSFL script
Snippets
How to take your development (x)JSFL code and package it as code that can be launched from the Snippets panel
Modules
How to manage and package related files, folders and functionality as reusable, distributable Modules
- Module basics (unfinished)
- Writing an xJSFL Module (unfinished)
- Good practices (unfinished)
Workflow
Stand-alone code examples you can use to speed up your everyday Flash workflow
- Moving around Flash (unfinished)
- Working with Elements (unfinished)
- Working with Library Items (unfinished)
- Working with Files (unfinished)
- Adding a UI (unfinished)
- Saving and loading Settings (unfinished)
JSFL API
Documentation on the core JSFL classes, libraries and functions that make up the xJSFL core.
Note that all API pages start with an Overview section which gives you conceptual and background information, followed by an API section which lists each of the properties and methods with example code for each (where appropriate).
Core
- Global properties and functions
- xjsfl: Core class providing a central place for common framework functionality
Data
- JSON: Standard JSON Library
- JSFLInterface: serializes values to XML for type-safe communication with Flash panels
- XML: extensions to XML to workaround Spidermonkey's buggy E4X declarate filtering
Elements
- Selector functions: easily select items or elements using CSS-style expressions
- Selectors: CSS-style expressions used to filter or match elements
- Element Selector ($): CSS-style selection of elements on stage (unfinished)
- Item Selector ($$): CSS-style selection of items in the Library panel (unfinished)
- Collections: powerful Array-like classes for manipulating authoring-time elements:
Flash
- Context: Provides a convenient access to the major DOM elements
- Iterators :Iterate through documents, items, timelines, layers, frames and elements
- Superdoc: logical routing to the expansive Document class’ methods
File
- FileSystem: object-oriented File and Folder classes:
- FLfile: adds FLfile platform-to-URI conversion compatibility for pre-CS4 versions of Flash
OOP
- Class: a base class to create new classes and inherit prototype chains
- Config: an object-oriented wrapper for easily saving and loading settings
- Events: safely manages addition and removal of event listeners
- Module: Base class used to create and manage xJSFL Modules (collections of files)
Text
- Output: logging, introspection, and a variety of printing and formatting methods
- Table: outputs 2D Array/Object arrays to easily-readable ASCII tables
- Template: loading and population of templates, including nesting & auto-indentation
- SimpleTemplate: simple combination of data-to-text
- Logger: logging class with variable replacement and file management
- Source: examine and manipulate source code
UI
- XUL: OO library for creating and managing XUL dialogs
- XULControl: OO wrapper that represents a XUL dialog control
- XULEvent: OO event class to pass information around on dialog updates
Utilities
- Data: a collection of methods for manipulating data, including hierarchies
- Timer: simple timer class, used for benchmarking, etc
AS3 Module Framework
Documentation on the AS3 classes that facilitate ActionScript to JSFL/xJSFL communication from within a Flash panel
- AbstractModule: Base class that sets up module folders and JSFL communication (unfinished)
- Loader: Utility class to load assets and config from module and user folders (unfinished)
- JSFL: Utility class to call and run some common JSFL commands (unfinished)
- Settings: Utility class to save and load settings to a local shared object between sessions (unfinished)
Appendix
Articles relating to xJSFL and JSFL that fall outside the remit of Guides or API
Coding
- Writing better JavaScript (unfinished)
- xJSFL Coding Style (unfinished)
- Method styles (unfinished)
JSFL Knowledgebase
- JSFL gotchas (unfinished)
- JSFL bugs (unfinished)
One last thing...
Comments on the quality or relevancy of any of the documentation are welcome.
Thank you.