|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.flagstone.transform.FSTransformObject
com.flagstone.transform.FSMovieObject
com.flagstone.transform.FSShowFrame
public class FSShowFrame
FSShowFrame is used to instruct the Flash Player to display a single frame in a movie or movie clip.
When a frame is displayed the Flash Player performs the following:
Attributes | |
---|---|
type | Identifies the data structure when it is encoded. Read-only. |
Objects are placed in the display list using the FSPlaceObject and FSPlaceObject2 classes and removed using the FSRemoveObject and FSRemoveObject2 classes. An object which has been added to the display list will be displayed in each frame until it is explicitly removed. There is no need to repeatedly add it to the display list.
The scope of a frame is delineated by successive FSShowFrame objects. All the commands that affect change the state of the display list or define actions to be executed take effect when the Flash Player displays the frame. All the objects displayed in a frame must be defined before they can be displayed. The movie is displayed as it is downloaded so displaying objects that are defined later in a movie is not allowed.
FSMovie movie = new FSMovie(); // Frame 1 - starts from the beginning of the file. ... movie.add(new FSShowFrame()); // Frame 2 - starts when the previous frame is displayed. // All displayable objects are referenced using unique identifier. int identifier = movie.newIdentifier(); // Define a shape to be displayed. movie.add(new FSDefineShape(identifier, ......)); // Add the shape to the display list - on layer 1 at coordinates (400, 400) movie.add(new FSPlaceObject(FSPlaceObject.New, identifier, 1, 400, 400)); // Add some actions FSDoAction frameActions = new FSDoAction(); frameActions.add(anAction); frameActions.add(anotherAction); movie.add(frameActions); // The shape is displayed and the actions executed when the FSShowFrame command is executed. movie.add(new FSShowFrame());
The FSShowFrame class represents the ShowFrame data structure from the Macromedia Flash (SWF) File Format Specification. It was introduced in Flash 1.
Field Summary |
---|
Constructor Summary | |
---|---|
FSShowFrame()
Constructs an FSShowFrame object. |
|
FSShowFrame(FSCoder coder)
Construct an FSShowFrame object, initialising it with values decoded from an encoded object. |
|
FSShowFrame(FSShowFrame obj)
Constructs an FSShowFrame object by copying values from an existing object. |
Method Summary | |
---|---|
void |
appendDescription(java.lang.StringBuffer buffer,
int depth)
AppendDescription is used to present a string description of the object including all nested objects up to a specified depth. |
void |
decode(FSCoder coder)
|
void |
encode(FSCoder coder)
|
static FSShowFrame |
getInstance()
Returns a canonical FSShowFrame object. |
int |
length(FSCoder coder)
|
Methods inherited from class com.flagstone.transform.FSMovieObject |
---|
equals, getType |
Methods inherited from class com.flagstone.transform.FSTransformObject |
---|
clone, name, toString |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public FSShowFrame(FSCoder coder)
coder
- an FSCoder containing the binary data.public FSShowFrame()
public FSShowFrame(FSShowFrame obj)
obj
- an FSShowFrame object.Method Detail |
---|
public static FSShowFrame getInstance()
public void appendDescription(java.lang.StringBuffer buffer, int depth)
FSTransformObject
appendDescription
in class FSMovieObject
buffer
- a StringBuffer to which the description of each object is
appended.depth
- the maximum level of nesting up to which objects will be
displayed.public int length(FSCoder coder)
length
in class FSMovieObject
public void encode(FSCoder coder)
encode
in class FSMovieObject
public void decode(FSCoder coder)
decode
in class FSMovieObject
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |