org.apache.flex.swf

Class SWF

java.lang.Object

org.apache.flex.swf.SWF

All Implemented Interfaces:

ISWF

public class SWF
extends Object
implements ISWF

The implementation of a ISWF object. Most of the ISWF properties are encapsulated in the a Header member, but we don't expose the Header at the interface level.

Constructor Summary

Constructors

Constructor and Description
SWF() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addFrame(SWFFrame frame) Add a frame.
void	deleteFrame(int index) Delete a SWF frame.
RGB	getBackgroundColor() Get SWF movie background color.
EnableDebugger2Tag	getEnableDebugger2()
EnableTelemetryTag	getEnableTelemetry() Get the EnableTelemetryTag tag.
FileAttributesTag	getFileAttributes() Expose the FileAttributes tag for SWFWriter.
static FileAttributesTag	getFileAttributes(ISWF swf) Get a FileAttributes tag from an ISWF object.
SWFFrame	getFrameAt(int index) Get frame by index.
int	getFrameCount() Get number of frames.
float	getFrameRate() Get frame delay in 8.8 fixed number of frames per second.
List<SWFFrame>	getFrames() Return all the frames in the SWF.
Rect	getFrameSize() Get SWF frame size in Twips.
Header	getHeader()
String	getMetadata() Get the Metadata text.
ProductInfoTag	getProductInfo() Get the ProductInfoTag tag.
ScriptLimitsTag	getScriptLimits() Get the managed ScriptLimits tag.
String	getTopLevelClass() Get the QName of the top level class.
boolean	getUseAS3() Check if the SWF uses ActionScript3.
boolean	getUseDirectBlit() Check if the SWF uses direct Blit.
boolean	getUseGPU() Check if the SWF uses GPU.
boolean	getUseNetwork() Set whether the SWF uses network.
int	getVersion() Get SWF file version.
boolean	hasMetadata() Check if the SWF has Metadata tag.
void	setBackgroundColor(RGB color) Set SWF movie background color.
void	setEnableDebugger2(EnableDebugger2Tag tag)
void	setEnableTelemetry(EnableTelemetryTag tag) Set the enable telemetry tag associated with the SWF.
void	setFrameRate(float frameRate) Set frame rate.
void	setFrameSize(Rect rect) Set frame size.
void	setMetadata(String value) Set the Metadata text.
void	setProductInfo(ProductInfoTag tag) Set the product info tag associated with the SWF.
void	setScriptLimits(int maxRecursionDepth, int scriptTimeoutSeconds) Set a script limit values.
void	setTopLevelClass(String value) Set root class name.
void	setUseAS3(boolean value) Set whether the SWF uses ActionScript3.
void	setUseDirectBlit(boolean value) Set whether the SWF uses direct Blit.
void	setUseGPU(boolean value) Set whether the SWF uses GPU.
void	setUseNetwork(boolean value) Check if the SWF uses network.
void	setVersion(int version) Set SWF version.

Methods inherited from class java.lang.Object

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

Constructor Detail

SWF

public SWF()

Constructor.

Method Detail

getFileAttributes

public static FileAttributesTag getFileAttributes(ISWF swf)

Get a FileAttributes tag from an ISWF object.

Parameters:

swf - ISWF object

Returns:

FileAttributesTag

addFrame

public void addFrame(SWFFrame frame)

Description copied from interface: ISWF

Add a frame.

Specified by:

addFrame in interface ISWF

Parameters:

frame - SWF frame.

getBackgroundColor

public RGB getBackgroundColor()

Description copied from interface: ISWF

Get SWF movie background color.

Specified by:

getBackgroundColor in interface ISWF

Returns:

color

getFileAttributes

public FileAttributesTag getFileAttributes()

Expose the FileAttributes tag for SWFWriter.

Returns:

FileAttributes tag

getFrameAt

public SWFFrame getFrameAt(int index)

Description copied from interface: ISWF

Get frame by index.

Specified by:

getFrameAt in interface ISWF

Parameters:

index - frame index.

Returns:

frame

getFrameCount

public int getFrameCount()

Description copied from interface: ISWF

Get number of frames.

Specified by:

getFrameCount in interface ISWF

Returns:

frame count.

getFrameRate

public float getFrameRate()

Description copied from interface: ISWF

Get frame delay in 8.8 fixed number of frames per second.

Specified by:

getFrameRate in interface ISWF

Returns:

frame delay.

getFrames

public List<SWFFrame> getFrames()

Return all the frames in the SWF.

Returns:

frames

getFrameSize

public Rect getFrameSize()

Description copied from interface: ISWF

Get SWF frame size in Twips.

Specified by:

getFrameSize in interface ISWF

Returns:

frame size

getHeader

public Header getHeader()

getMetadata

public String getMetadata()

Description copied from interface: ISWF

Get the Metadata text. This is a Metadata property.

The Metadata tag is an optional tag to describe the SWF file to an external process. The tag embeds XML metadata in the SWF file so that, for example, a search engine can locate this tag, access a title for the SWF file, and display that title in search results.

Specified by:

getMetadata in interface ISWF

Returns:

metadata XML text; null if Metadata tag doesn't exit.

getTopLevelClass

public String getTopLevelClass()

Description copied from interface: ISWF

Get the QName of the top level class.

Specified by:

getTopLevelClass in interface ISWF

Returns:

name of top level class.

getVersion

public int getVersion()

Description copied from interface: ISWF

Get SWF file version.

Specified by:

getVersion in interface ISWF

Returns:

version number.

hasMetadata

public boolean hasMetadata()

Description copied from interface: ISWF

Check if the SWF has Metadata tag. This is a FileAttributes property.

Specified by:

hasMetadata in interface ISWF

Returns:

true if the SWF has Metadata tag

getUseAS3

public boolean getUseAS3()

Description copied from interface: ISWF

Check if the SWF uses ActionScript3. This is a FileAttributes property.

Specified by:

getUseAS3 in interface ISWF

Returns:

true if the SWF uses ActionScript3

setUseAS3

public void setUseAS3(boolean value)

Description copied from interface: ISWF

Set whether the SWF uses ActionScript3. This is a FileAttributes property.

Specified by:

setUseAS3 in interface ISWF

Parameters:

value - true if the SWF uses ActionScript3

setBackgroundColor

public void setBackgroundColor(RGB color)

Description copied from interface: ISWF

Set SWF movie background color.

Specified by:

setBackgroundColor in interface ISWF

Parameters:

color - color in RGB

setFrameRate

public void setFrameRate(float frameRate)

Description copied from interface: ISWF

Set frame rate.

Specified by:

setFrameRate in interface ISWF

Parameters:

frameRate - frame per second

setFrameSize

public void setFrameSize(Rect rect)

Description copied from interface: ISWF

Set frame size.

Specified by:

setFrameSize in interface ISWF

Parameters:

rect - frame size

setMetadata

public void setMetadata(String value)

Description copied from interface: ISWF

Set the Metadata text. This is a Metadata property.

The Metadata tag is an optional tag to describe the SWF file to an external process. The tag embeds XML metadata in the SWF file so that, for example, a search engine can locate this tag, access a title for the SWF file, and display that title in search results.

Setting a non-null value will also set FileAttributes.hasMetadata to true.

Specified by:

setMetadata in interface ISWF

Parameters:

value - Metadata XML string; null value will remove the Metadata tag on the SWF.

setTopLevelClass

public void setTopLevelClass(String value)

Description copied from interface: ISWF

Set root class name.

Specified by:

setTopLevelClass in interface ISWF

Parameters:

value - root class name

setUseDirectBlit

public void setUseDirectBlit(boolean value)

Description copied from interface: ISWF

Set whether the SWF uses direct Blit. This is a FileAttributes property.

Specified by:

setUseDirectBlit in interface ISWF

Parameters:

value - true if the SWF uses direct Blit.

setUseGPU

public void setUseGPU(boolean value)

Description copied from interface: ISWF

Set whether the SWF uses GPU. This is a FileAttributes property.

Specified by:

setUseGPU in interface ISWF

Parameters:

value - true if the SWF uses GPU

setUseNetwork

public void setUseNetwork(boolean value)

Description copied from interface: ISWF

Check if the SWF uses network. This is a FileAttributes property.

Specified by:

setUseNetwork in interface ISWF

Parameters:

value - true if the SWF uses network.

setVersion

public void setVersion(int version)

Description copied from interface: ISWF

Set SWF version.

Specified by:

setVersion in interface ISWF

Parameters:

version - SWF version

getUseDirectBlit

public boolean getUseDirectBlit()

Description copied from interface: ISWF

Check if the SWF uses direct Blit. This is a FileAttributes property.

Specified by:

getUseDirectBlit in interface ISWF

Returns:

true if the SWF uses direct Blit.

getUseGPU

public boolean getUseGPU()

Description copied from interface: ISWF

Check if the SWF uses GPU. This is a FileAttributes property.

Specified by:

getUseGPU in interface ISWF

Returns:

true if the SWF uses GPU

getUseNetwork

public boolean getUseNetwork()

Description copied from interface: ISWF

Set whether the SWF uses network. This is a FileAttributes property.

Specified by:

getUseNetwork in interface ISWF

Returns:

true if the SWF uses network.

deleteFrame

public void deleteFrame(int index)

Description copied from interface: ISWF

Delete a SWF frame.

Specified by:

deleteFrame in interface ISWF

Parameters:

index - frame index

setEnableDebugger2

public void setEnableDebugger2(EnableDebugger2Tag tag)

getEnableDebugger2

public EnableDebugger2Tag getEnableDebugger2()

Specified by:

getEnableDebugger2 in interface ISWF

Returns:

EnableDebugger2 tag or null.

setScriptLimits

public void setScriptLimits(int maxRecursionDepth,
                   int scriptTimeoutSeconds)

Description copied from interface: ISWF

Set a script limit values.

Specified by:

setScriptLimits in interface ISWF

Parameters:

maxRecursionDepth - max recursion depth

scriptTimeoutSeconds - script timeout seconds

getScriptLimits

public ScriptLimitsTag getScriptLimits()

Description copied from interface: ISWF

Get the managed ScriptLimits tag.

Specified by:

getScriptLimits in interface ISWF

Returns:

ScriptLimits tag in this SWF, or null if ISWF.setScriptLimits(int, int) hasn't be called.

getProductInfo

public ProductInfoTag getProductInfo()

Description copied from interface: ISWF

Get the ProductInfoTag tag.

Specified by:

getProductInfo in interface ISWF

Returns:

ProductInfoTag or null if there is no product info associated with the SWF.

setProductInfo

public void setProductInfo(ProductInfoTag tag)

Description copied from interface: ISWF

Set the product info tag associated with the SWF.

Specified by:

setProductInfo in interface ISWF

Parameters:

tag - the ProductInfoTag, may be null.

getEnableTelemetry

public EnableTelemetryTag getEnableTelemetry()

Description copied from interface: ISWF

Get the EnableTelemetryTag tag.

Specified by:

getEnableTelemetry in interface ISWF

Returns:

EnableTelemetryTag or null if there is no enable telemetry information associated with the SWF.

setEnableTelemetry

public void setEnableTelemetry(EnableTelemetryTag tag)

Description copied from interface: ISWF

Set the enable telemetry tag associated with the SWF.

Specified by:

setEnableTelemetry in interface ISWF

Parameters:

tag - the EnableTelemetryTag, may be null.