com.flagstone.transform
Class FSEnableDebugger

java.lang.Object
  extended by com.flagstone.transform.FSTransformObject
      extended by com.flagstone.transform.FSMovieObject
          extended by com.flagstone.transform.FSEnableDebugger
All Implemented Interfaces:
java.lang.Cloneable

public class FSEnableDebugger
extends FSMovieObject

Enables a movie to be debugged when played using the Flash authoring tool, allowing the variables defined in the arrays of actions specified in object to be inspected.

Attributes
type Identifies the data structure when it is encoded. Read-only.
password An MD5 encrypted password.

In order to use the debugger a password must be supplied. When encrypted using the MD5 algorithm it must match the value stored in the password attribute.

History

The FSEnableDebugger class represents the EnableDebugger data structure of the Macromedia Flash (SWF) File Format Specification. It was introduced in Flash 5.


Field Summary
 
Fields inherited from class com.flagstone.transform.FSMovieObject
ButtonColorTransform, ButtonSound, DefineBitsPtr, DefineButton, DefineButton2, DefineFont, DefineFont2, DefineImage, DefineImage2, DefineJPEGImage, DefineJPEGImage2, DefineJPEGImage3, DefineMorphShape, DefineMovieClip, DefineShape, DefineShape2, DefineShape3, DefineSound, DefineText, DefineText2, DefineTextField, DefineVideo, DoAction, EnableDebugger, EnableDebugger2, Export, extendLength, FontInfo, FontInfo2, FrameLabel, Free, Import, Initialize, JPEGTables, length, LimitScript, PathsArePostscript, PlaceObject, PlaceObject2, Protect, QuicktimeMovie, RemoveObject, RemoveObject2, SerialNumber, SetBackgroundColor, ShowFrame, SoundStreamBlock, SoundStreamHead, SoundStreamHead2, StartSound, TabOrder, type, VideoFrame
 
Constructor Summary
FSEnableDebugger(FSCoder coder)
          Construct an FSEnableDebugger object, initialising it with values decoded from an encoded object.
FSEnableDebugger(FSEnableDebugger obj)
          Constructs an FSEnableDebugger object by copying values from an existing object.
FSEnableDebugger(java.lang.String password)
          Constructs an FSEnableDebugger2 object with an MD5 encrypted password.
 
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)
           
 boolean equals(java.lang.Object anObject)
          Returns true if anObject is equal to this one.
 java.lang.String getPassword()
          Gets the MD5 encrypted password.
 int length(FSCoder coder)
           
 void setPassword(java.lang.String aString)
          Sets the MD5 encrypted password.
 
Methods inherited from class com.flagstone.transform.FSMovieObject
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

FSEnableDebugger

public FSEnableDebugger(FSCoder coder)
Construct an FSEnableDebugger object, initialising it with values decoded from an encoded object.

Parameters:
coder - an FSCoder containing the binary data.

FSEnableDebugger

public FSEnableDebugger(java.lang.String password)
Constructs an FSEnableDebugger2 object with an MD5 encrypted password.

Parameters:
password - the string defining the password.

FSEnableDebugger

public FSEnableDebugger(FSEnableDebugger obj)
Constructs an FSEnableDebugger object by copying values from an existing object.

Parameters:
obj - an FSEnableDebugger object.
Method Detail

getPassword

public java.lang.String getPassword()
Gets the MD5 encrypted password.

Returns:
the string defining the password.

setPassword

public void setPassword(java.lang.String aString)
Sets the MD5 encrypted password.

Parameters:
aString - the string defining the password.

equals

public boolean equals(java.lang.Object anObject)
Description copied from class: FSMovieObject
Returns true if anObject is equal to this one. Objects are considered equal if they would generate identical binary data when they are encoded to a Flash file.

Overrides:
equals in class FSMovieObject
Returns:
true if this object would be identical to anObject when encoded.

appendDescription

public void appendDescription(java.lang.StringBuffer buffer,
                              int depth)
Description copied from class: FSTransformObject
AppendDescription is used to present a string description of the object including all nested objects up to a specified depth. This method provide a more controlled way of creating a string representation of an object since large objects such as font or shape definitions can contain dozens of nested objects. The representation of the object is appended to the StringBuffer, showing the name of the class and values of the attributes it contains. If the object contains any attributes that are objects then the object graph will be traversed up to the specified depth. If objects are nested at a level less than specified depth then the full string representation of the object is displayed. For objects at the specified depth only the name of the class is displayed. Any objects below this depth are not displayed.

Overrides:
appendDescription in class FSMovieObject
Parameters:
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.

length

public int length(FSCoder coder)
Overrides:
length in class FSMovieObject

encode

public void encode(FSCoder coder)
Overrides:
encode in class FSMovieObject

decode

public void decode(FSCoder coder)
Overrides:
decode in class FSMovieObject