Properties | Methods
Top Level

Class XMLUI

Object

public class XMLUI
extends Object

Player version: Flash Player 7

The XMLUI object enables communication with SWF files that are used as custom user interfaces for the flash authoring tool's extensibility features (such as Behaviors, Commands, Effects, and Tools).

Macromedia Flash MX 2004 and later versions comes with several extensibility features including Behaviors, Commands (JavaScript API), Effects, and Tools. With these features, advanced users can extend or automate the authoring tool's functionality. The XML to UI engine works with each of these extensibility features to create dialog boxes that the user sees if the extension either requires or accepts parameters. Dialog boxes can be defined using XML tags or by creating a SWF file to display. The XMLUI object provides a mechanism by which an advanced user can communicate with a SWF file used in such a manner.



Property Summary

Properties inherited from class Object
__proto__, __resolve, constructor, prototype


Method Summary
static accept() : Void
Makes the current XMLUI dialog exit with an "accept" state.
static cancel() : Void
Makes the current XMLUI dialog exit with a "cancel" state.
static get(name:String) : String
Retrieves the value of the specified property of the current XMLUI dialog.
static set(name:String, value:String) : Void
Modifies the value of the specified property of the current XMLUI dialog.

Methods inherited from class Object
addProperty, hasOwnProperty, isPropertyEnumerable, isPrototypeOf, registerClass, toString, unwatch, valueOf, watch


Method Detail

accept Method

public static accept() : Void

Player version: Flash Player 7

Makes the current XMLUI dialog exit with an "accept" state. Identical to the user clicking the OK button.

cancel Method

public static cancel() : Void

Player version: Flash Player 7

Makes the current XMLUI dialog exit with a "cancel" state. Identical to the user clicking the Cancel button.

get Method

public static get(name:String) : String

Player version: Flash Player 7

Retrieves the value of the specified property of the current XMLUI dialog.

Parameters
name:String — The name of the XMLUI property to retrieve.

Returns
String — Returns the value of the property as a String.

set Method

public static set(name:String, value:String) : Void

Player version: Flash Player 7

Modifies the value of the specified property of the current XMLUI dialog.

Parameters
name:String — The name of the XMLUI property to modify.
value:String — The value to which the specified property will be set.

Properties | Methods

Copyright © 2005 Macromedia Inc. All rights reserved.
Tue Sep 13 2005, 16:15 PDT