Package | fl.livepreview |
Class | public class LivePreviewParent |
Inheritance | LivePreviewParent MovieClip Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
Language Version: | ActionScript 3.0 |
Product Version: | Flash CS3 |
Runtime Versions: | AIR 1.0, Flash Player 9.0.28.0 |
When a property is set on a component instance or when a component instance is resized on the Stage, Flash makes calls to the methods of this class, which in turn call methods in your component code to set the properties and to resize the component.
In cases where your component must implement a specific action when it is in live preview mode, use the following code to test for live preview mode:
var isLivePreview:Boolean = (parent != null && getQualifiedClassName(parent) == "fl.livepreview::LivePreviewParent");
The LivePreviewParent class supports the definition of a setSize()
method that uses width
and height
values to resize
a component. If you do not define a setSize()
method, this object
sets the width
and height
properties individually.
You can also use this class to create a custom live preview SWF file without creating a SWC file; however, it is probably easier to create a component live preview file by:
- Exporting your component as a SWC file.
- Changing the .swc file extension to .zip.
- Extracting the SWF file within the ZIP file.
To create a component live preview file in this way, follow these steps:
- Create a new Flash document.
- Set its document class to fl.livepreview.LivePreviewParent.
- Drag your component to the Stage and position it to x and y coordinates of 0.
- Check to ensure that the component parameters remain at their default settings. This should be the case if you drag the component from the Library panel or from the Components panel.
- Select Modify > Document from the main menu and, for the Match option, click Contents.
- Click OK.
- Publish the file to see the resulting SWF file as a custom live preview SWF file.
- Right-click the asset in the Library panel and select Component Definition from the context menu.
- The Component Definition dialog box allows you to specify a custom live preview SWF file for a component.
In some cases, you may want to have a custom live preview SWF file that is
completely different from your component. See the live preview of the fl.containers.UILoader
component for such an example. This live preview does not use the properties of UILoader,
nor does it implement getter and setter functions for these properties. It does, however,
implement a setSize()
method that uses width
and height
parameters to draw the component at the new size.
Property | Defined By | ||
---|---|---|---|
accessibilityImplementation : AccessibilityImplementation
The current accessibility implementation (AccessibilityImplementation)
for this InteractiveObject instance. | InteractiveObject | ||
accessibilityProperties : AccessibilityProperties
The current accessibility options for this display object. | DisplayObject | ||
alpha : Number
Indicates the alpha transparency value of the object specified. | DisplayObject | ||
blendMode : String
A value from the BlendMode class that specifies which blend mode to use. | DisplayObject | ||
blendShader : Shader [write-only]
Sets a shader that is used for blending the foreground and background. | DisplayObject | ||
buttonMode : Boolean
Specifies the button mode of this sprite. | Sprite | ||
cacheAsBitmap : Boolean
If set to true, Flash runtimes cache an internal bitmap representation of the
display object. | DisplayObject | ||
cacheAsBitmapMatrix : Matrix
If non-null, this Matrix object defines how a display object is rendered when
cacheAsBitmap is set to true. | DisplayObject | ||
constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | ||
contextMenu : NativeMenu
Specifies the context menu associated with this object. | InteractiveObject | ||
currentFrame : int [read-only]
Specifies the number of the frame in which the playhead is located in the timeline of
the MovieClip instance. | MovieClip | ||
currentFrameLabel : String [read-only]
The label at the current frame in the timeline of the MovieClip instance. | MovieClip | ||
currentLabel : String [read-only]
The current label in which the playhead is located in the timeline of the MovieClip instance. | MovieClip | ||
currentLabels : Array [read-only]
Returns an array of FrameLabel objects from the current scene. | MovieClip | ||
currentScene : Scene [read-only]
The current scene in which the playhead is located in the timeline of the MovieClip instance. | MovieClip | ||
doubleClickEnabled : Boolean
Specifies whether the object receives doubleClick events. | InteractiveObject | ||
dropTarget : DisplayObject [read-only]
Specifies the display object over which the sprite is being dragged, or on
which the sprite was dropped. | Sprite | ||
enabled : Boolean
A Boolean value that indicates whether a movie clip is enabled. | MovieClip | ||
filters : Array
An indexed array that contains each filter object currently associated with the display object. | DisplayObject | ||
focusRect : Object
Specifies whether this object displays a focus rectangle. | InteractiveObject | ||
framesLoaded : int [read-only]
The number of frames that are loaded from a streaming SWF file. | MovieClip | ||
graphics : Graphics [read-only]
Specifies the Graphics object that belongs to this sprite where vector
drawing commands can occur. | Sprite | ||
height : Number
Indicates the height of the display object, in pixels. | DisplayObject | ||
hitArea : Sprite
Designates another sprite to serve as the hit area for a sprite. | Sprite | ||
isPlaying : Boolean [read-only]
Indicates whether this movie clip is curently playing. | MovieClip | ||
loaderInfo : LoaderInfo [read-only]
Returns a LoaderInfo object containing information about loading the file
to which this display object belongs. | DisplayObject | ||
mask : DisplayObject
The calling display object is masked by the specified mask object. | DisplayObject | ||
mouseChildren : Boolean
Determines whether or not the children of the object are mouse, or user input device, enabled. | DisplayObjectContainer | ||
mouseEnabled : Boolean
Specifies whether this object receives mouse, or other user input, messages. | InteractiveObject | ||
mouseX : Number [read-only]
Indicates the x coordinate of the mouse or user input device position, in pixels. | DisplayObject | ||
mouseY : Number [read-only]
Indicates the y coordinate of the mouse or user input device position, in pixels. | DisplayObject | ||
myInstance : DisplayObject
The component instance. | LivePreviewParent | ||
name : String
Indicates the instance name of the DisplayObject. | DisplayObject | ||
needsSoftKeyboard : Boolean
Specifies whether a virtual keyboard (an on-screen, software keyboard) should display
when this InteractiveObject instance receives focus. | InteractiveObject | ||
numChildren : int [read-only]
Returns the number of children of this object. | DisplayObjectContainer | ||
opaqueBackground : Object
Specifies whether the display object is opaque with a certain background color. | DisplayObject | ||
parent : DisplayObjectContainer [read-only]
Indicates the DisplayObjectContainer object that contains this display object. | DisplayObject | ||
prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | ||
root : DisplayObject [read-only]
For a display object in a loaded SWF file, the root property is the
top-most display object in the portion of the display list's tree structure represented by that SWF file. | DisplayObject | ||
rotation : Number
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. | DisplayObject | ||
rotationX : Number
Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | DisplayObject | ||
rotationY : Number
Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | DisplayObject | ||
rotationZ : Number
Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | DisplayObject | ||
scale9Grid : Rectangle
The current scaling grid that is in effect. | DisplayObject | ||
scaleX : Number
Indicates the horizontal scale (percentage) of the object as applied from the registration point. | DisplayObject | ||
scaleY : Number
Indicates the vertical scale (percentage) of an object as applied from the registration point of the object. | DisplayObject | ||
scaleZ : Number
Indicates the depth scale (percentage) of an object as applied from the registration point of the object. | DisplayObject | ||
scenes : Array [read-only]
An array of Scene objects, each listing the name, the number of frames,
and the frame labels for a scene in the MovieClip instance. | MovieClip | ||
scrollRect : Rectangle
The scroll rectangle bounds of the display object. | DisplayObject | ||
softKeyboardInputAreaOfInterest : Rectangle
Defines the area that should remain on-screen when a soft keyboard is displayed. | InteractiveObject | ||
soundTransform : flash.media:SoundTransform
Controls sound within this sprite. | Sprite | ||
stage : Stage [read-only]
The Stage of the display object. | DisplayObject | ||
tabChildren : Boolean
Determines whether the children of the object are tab enabled. | DisplayObjectContainer | ||
tabEnabled : Boolean
Specifies whether this object is in the tab order. | InteractiveObject | ||
tabIndex : int
Specifies the tab ordering of objects in a SWF file. | InteractiveObject | ||
textSnapshot : flash.text:TextSnapshot [read-only]
Returns a TextSnapshot object for this DisplayObjectContainer instance. | DisplayObjectContainer | ||
totalFrames : int [read-only]
The total number of frames in the MovieClip instance. | MovieClip | ||
trackAsMenu : Boolean
Indicates whether other display objects that are SimpleButton or MovieClip objects can receive
mouse release events or other user input release events. | MovieClip | ||
transform : flash.geom:Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds. | DisplayObject | ||
useHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the pointer rolls
over a sprite in which the buttonMode property is set to true. | Sprite | ||
visible : Boolean
Whether or not the display object is visible. | DisplayObject | ||
width : Number
Indicates the width of the display object, in pixels. | DisplayObject | ||
x : Number
Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of
the parent DisplayObjectContainer. | DisplayObject | ||
y : Number
Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of
the parent DisplayObjectContainer. | DisplayObject | ||
z : Number
Indicates the z coordinate position along the z-axis of the DisplayObject
instance relative to the 3D parent container. | DisplayObject |
Method | Defined By | ||
---|---|---|---|
Initializes the scale and align modes of the Stage, sets the
myInstance property, resizes myInstance to
the proper size and uses the ExternalInterface class to expose
functions to Flash. | LivePreviewParent | ||
Adds a child DisplayObject instance to this DisplayObjectContainer instance. | DisplayObjectContainer | ||
Adds a child DisplayObject instance to this DisplayObjectContainer
instance. | DisplayObjectContainer | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | EventDispatcher | ||
Indicates whether the security restrictions
would cause any display objects to be omitted from the list returned by calling
the DisplayObjectContainer.getObjectsUnderPoint() method
with the specified point point. | DisplayObjectContainer | ||
Determines whether the specified display object is a child of the DisplayObjectContainer instance or
the instance itself. | DisplayObjectContainer | ||
Dispatches an event into the event flow. | EventDispatcher | ||
Returns a rectangle that defines the area of the display object relative to the coordinate system
of the targetCoordinateSpace object. | DisplayObject | ||
Returns the child display object instance that exists at the specified index. | DisplayObjectContainer | ||
Returns the child display object that exists with the specified name. | DisplayObjectContainer | ||
Returns the index position of a child DisplayObject instance. | DisplayObjectContainer | ||
Returns an array of objects that lie under the specified point and are children
(or grandchildren, and so on) of this DisplayObjectContainer instance. | DisplayObjectContainer | ||
Returns a rectangle that defines the boundary of the display object,
based on the coordinate system defined by the targetCoordinateSpace
parameter, excluding any strokes on shapes. | DisplayObject | ||
Converts the point object from the Stage (global) coordinates
to the display object's (local) coordinates. | DisplayObject | ||
Converts a two-dimensional point from the Stage (global) coordinates to a
three-dimensional display object's (local) coordinates. | DisplayObject | ||
Starts playing the SWF file at the specified frame. | MovieClip | ||
Brings the playhead to the specified frame of the movie clip and stops it there. | MovieClip | ||
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | ||
Indicates whether an object has a specified property defined. | Object | ||
Evaluates the bounding box of the display object to see if it overlaps or intersects with the
bounding box of the obj display object. | DisplayObject | ||
Evaluates the display object to see if it overlaps or intersects with the
point specified by the x and y parameters. | DisplayObject | ||
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | ||
Converts a three-dimensional point of the three-dimensional display
object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates. | DisplayObject | ||
Converts the point object from the display object's (local) coordinates to the
Stage (global) coordinates. | DisplayObject | ||
Sends the playhead to the next frame and stops it. | MovieClip | ||
Moves the playhead to the next scene of the MovieClip instance. | MovieClip | ||
Resizes the component instance on the Stage to the specified
dimensions, either by calling a user-defined method, or by
separately setting the width and height
properties. | LivePreviewParent | ||
Updates the properties of the component instance. | LivePreviewParent | ||
Moves the playhead in the timeline of the movie clip. | MovieClip | ||
Sends the playhead to the previous frame and stops it. | MovieClip | ||
Moves the playhead to the previous scene of the MovieClip instance. | MovieClip | ||
Indicates whether the specified property exists and is enumerable. | Object | ||
Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance. | DisplayObjectContainer | ||
Removes a child DisplayObject from the specified index position in the child list of
the DisplayObjectContainer. | DisplayObjectContainer | ||
Removes one or more child DisplayObject instances from the DisplayObjectContainer instance. | DisplayObjectContainer | ||
Removes a listener from the EventDispatcher object. | EventDispatcher | ||
Raises a virtual keyboard. | InteractiveObject | ||
Changes the position of an existing child in the display object container. | DisplayObjectContainer | ||
Sets the availability of a dynamic property for loop operations. | Object | ||
Lets the user drag the specified sprite. | Sprite | ||
Lets the user drag the specified sprite on a touch-enabled device. | Sprite | ||
Stops the playhead in the movie clip. | MovieClip | ||
Ends the startDrag() method. | Sprite | ||
Ends the startTouchDrag() method, for use with touch-enabled devices. | Sprite | ||
Swaps the z-order (front-to-back order) of the two specified child objects. | DisplayObjectContainer | ||
Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the
child list. | DisplayObjectContainer | ||
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | ||
Returns the string representation of the specified object. | Object | ||
Returns the primitive value of the specified object. | Object | ||
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher |
myInstance | property |
public var myInstance:DisplayObject
Language Version: | ActionScript 3.0 |
Product Version: | Flash CS3 |
Runtime Versions: | AIR 1.0, Flash Player 9.0.28.0 |
The component instance.
LivePreviewParent | () | Constructor |
public function LivePreviewParent()
Language Version: | ActionScript 3.0 |
Product Version: | Flash CS3 |
Runtime Versions: | AIR 1.0, Flash Player 9.0.28.0 |
Initializes the scale and align modes of the Stage, sets the
myInstance
property, resizes myInstance
to
the proper size and uses the ExternalInterface class to expose
functions to Flash.
onResize | () | method |
public function onResize(width:Number, height:Number):void
Language Version: | ActionScript 3.0 |
Product Version: | Flash CS3 |
Runtime Versions: | AIR 1.0, Flash Player 9.0.28.0 |
Resizes the component instance on the Stage to the specified
dimensions, either by calling a user-defined method, or by
separately setting the width
and height
properties.
This method is called by Flash Player.
Parameters
width:Number — The new width for the myInstance instance.
| |
height:Number — The new height for the myInstance instance.
|
onUpdate | () | method |
public function onUpdate(... updateArray):void
Language Version: | ActionScript 3.0 |
Product Version: | Flash CS3 |
Runtime Versions: | AIR 1.0, Flash Player 9.0.28.0 |
Updates the properties of the component instance. This method is called by Flash Player when there is a change in the value of a property. This method updates all component properties, whether or not they were changed.
Parameters
... updateArray — An array of parameter names and values.
|
Mon Nov 28 2011, 06:48 AM -08:00