org.apache.royale.swf.tags

Class ExportAssetsTag

java.lang.Object

org.apache.royale.swf.tags.Tag

org.apache.royale.swf.tags.ExportAssetsTag

All Implemented Interfaces:

ICharacterReferrer, IManagedTag, ITag

public class ExportAssetsTag
extends Tag
implements IManagedTag, ICharacterReferrer

Represents a ExportAssets tag in a SWF file.

The ExportAssets tag makes portions of a SWF file available for import by other SWF files. Each exported character is identified by a string. Any type of character can be exported.

If the value of the character in ExportAssets was previously exported with a different identifier, Flash Player associates the tag with the latter identifier. That is, if Flash Player has already read a given value for Tag1 and the same Tag1 value is read later in the SWF file, the second Name1 value is used.

The map between character tag and name is implemented in a BiMap fashion. A character can only be exported with one name; and a name can only be used to export one character tag.

Note: ExportAssets tag is only used in ActionScript 1 and 2 only. In ActionScript3, ExportAssets is ignored. SymbolClass is used instead.

Constructor Summary

Constructors

Constructor and Description
ExportAssetsTag() Constructor.

Method Summary

Modifier and Type	Method and Description
void	addExport(ICharacterTag characterTag, String name) Export character tag with the given name.
String	description() Sub-class can override this method to provide more information when the tag object is printed out.
Set<String>	getCharacterNames() Get all the symbol names.
ICharacterTag	getCharacterTagByName(String name) Get a character tag by its assigned name.
Iterable<ICharacterTag>	getReferences() Get all the referred character tags.
void	removeExport(ICharacterTag characterTag) Remove a character tag from the exported tags by reference.
void	removeExport(String name) Remove a character tag from the exported tags by name.
int	size() Get the total number of exported tags.

Methods inherited from class org.apache.royale.swf.tags.Tag

getTagType, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ExportAssetsTag

public ExportAssetsTag()

Constructor.

Method Detail

getCharacterNames

public Set<String> getCharacterNames()

Get all the symbol names.

Returns:

symbol names

getCharacterTagByName

public ICharacterTag getCharacterTagByName(String name)

Get a character tag by its assigned name.

Parameters:

name - symbol name

Returns:

character tag

addExport

public void addExport(ICharacterTag characterTag,
                      String name)

Export character tag with the given name.

• If a character is exported multiple time with different name, the last name wins.
• If a name is used to export multiple character tags, the last character tag gets the name, and the previous tags will not be exported.

Parameters:

characterTag - character tag

name - symbol name

removeExport

public void removeExport(ICharacterTag characterTag)

Remove a character tag from the exported tags by reference.

Parameters:

characterTag - tags to remove

removeExport

public void removeExport(String name)

Remove a character tag from the exported tags by name.

Parameters:

name - name of the tag to remove

size

public int size()

Get the total number of exported tags.

Returns:

count of exported tags

description

public String description()

Description copied from class: Tag

Sub-class can override this method to provide more information when the tag object is printed out.

Overrides:

description in class Tag

Returns:

description text

getReferences

public Iterable<ICharacterTag> getReferences()

Get all the referred character tags.

Specified by:

getReferences in interface ICharacterReferrer

Returns:

an iterator of referred character tags