org.apache.flex.swf

Class SWFFrame

java.lang.Object

org.apache.flex.swf.SWFFrame

All Implemented Interfaces:

Iterable<ITag>, ITagContainer

public class SWFFrame
extends Object
implements ITagContainer

SWF frame model manages a list of SWF tags. For the "managed" tags, SWFFrame provides API to access their data. Other tags are grouped by types and are stored in lists.

SWFFrame is a ITagContainer. The enclosed tags are not stored in a one-dimensional array, however, they can be iterated in a deterministic order.

Field Summary

Fields

Modifier and Type	Field and Description
protected ExportAssetsTag	exportAssetsTag
protected FrameLabelTag	frameLabel
protected SymbolClassTag	symbolClass

Constructor Summary

Constructors

Constructor and Description
SWFFrame() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addTag(ITag tag) Add a SWF tag to the frame.
void	defineExport(ICharacterTag tag, String name) Export an ICharacterTag with name.
void	defineSymbol(ICharacterTag tag, String name) Export an ICharacterTag with name.
void	defineSymbol(ICharacterTag tag, String name, Map<Integer,ICharacterTag> dictionary) Export an ICharacterTag with name.
static void	forceSymbolClassTag(SWFFrame frame) Force creating a SymbolClass tag on the frame.
String	getName() Get frame name.
Collection<ICompilerProblem>	getProblems()
String	getSymbolName(ICharacterTag tag) Get the symbol name of a class.
boolean	hasNamedAnchor() Check if this frame has a named anchor tag.
Iterator<ITag>	iterator() Get an iterator of all the tags in the frame.
void	setName(String name, boolean isAnchor) Assign a name to this frame.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

symbolClass

protected SymbolClassTag symbolClass

exportAssetsTag

protected ExportAssetsTag exportAssetsTag

frameLabel

protected FrameLabelTag frameLabel

Constructor Detail

SWFFrame

public SWFFrame()

Constructor.

Method Detail

addTag

public void addTag(ITag tag)

Add a SWF tag to the frame.

Parameters:

tag - tag

defineSymbol

public void defineSymbol(ICharacterTag tag,
                String name)

Export an ICharacterTag with name. The character tag has to be added to the frame before it is defined as a symbol.

Parameters:

tag - character tag

name - export name

defineSymbol

public void defineSymbol(ICharacterTag tag,
                String name,
                Map<Integer,ICharacterTag> dictionary)

Export an ICharacterTag with name. The character tag has to be added to the frame before it is defined as a symbol.

Parameters:

tag - character tag

name - export name

dictionary - Used when reading an existing SWF. If null, only the character tags in the current frame will be checked.

getSymbolName

public String getSymbolName(ICharacterTag tag)

Get the symbol name of a class. The symbol class needs to be read before this can be queried.

Parameters:

tag - A character tag.

Returns:

The name of the tag in the dictionary. Null if the symbol table has not been read or the tag is not defined in this frame.

defineExport

public void defineExport(ICharacterTag tag,
                String name)

Export an ICharacterTag with name. The character tag has to be added to the frame before it is defined as an export asset.

Parameters:

tag - character tag

name - export name

iterator

public Iterator<ITag> iterator()

Get an iterator of all the tags in the frame. This method combines all the managed and not managed tags into one ordered collection.

Specified by:

iterator in interface Iterable<ITag>

setName

public void setName(String name,
           boolean isAnchor)

Assign a name to this frame.

Parameters:

name - frame name

isAnchor - true if the frame name is a named anchor tag

getName

public String getName()

Get frame name.

Returns:

frame name

hasNamedAnchor

public boolean hasNamedAnchor()

Check if this frame has a named anchor tag.

In SWF files of version 6 or later, an extension to the FrameLabel tag called named anchors is available. A named anchor is a special kind of frame label that, in addition to labeling a frame for seeking using ActionGoToLabel, labels the frame for seeking using HTML anchor syntax.

Returns:

true if this frame uses a named anchor tag.

forceSymbolClassTag

public static final void forceSymbolClassTag(SWFFrame frame)

Force creating a SymbolClass tag on the frame.

Parameters:

frame - SWF frame

getProblems

public Collection<ICompilerProblem> getProblems()

Specified by:

getProblems in interface ITagContainer