com.flagstone.transform
Class FSSerialNumber

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

public class FSSerialNumber
extends FSMovieObject

FSSerialNumber is used to add a user-defined serial number into a Flash file.

The serial number is simply a string and can contain arbitrary information.

Attributes
type Identifies the data structure when it is encoded. Read-only.
serialNumber A string containing the serial number.

Example

 movie.add(new FSSerialNumber("1234-DGF-2354"));
 

History

The FSSerialNumber represents the SerialNumber tag in the Macromedia Flash (SWF) File Format Specification. It is not known when this tag was introduced.


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
FSSerialNumber(FSCoder coder)
          Construct an FSSerialNumber object, initialising it with values decoded from an encoded object.
FSSerialNumber(FSSerialNumber obj)
          Constructs an FSSerialNumber object by copying values from an existing object.
FSSerialNumber(java.lang.String aString)
          Constructs an FSSerialNumber action with the specified string.
 
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 getSerialNumber()
          Gets the serial number.
 int length(FSCoder coder)
           
 void setSerialNumber(java.lang.String aString)
          Sets the serial number.
 
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

FSSerialNumber

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

Parameters:
coder - an FSCoder containing the binary data.

FSSerialNumber

public FSSerialNumber(java.lang.String aString)
Constructs an FSSerialNumber action with the specified string.

Parameters:
aString - an arbitrary string containing the serial number.

FSSerialNumber

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

Parameters:
obj - an FSSerialNumber object.
Method Detail

getSerialNumber

public java.lang.String getSerialNumber()
Gets the serial number.

Returns:
the serial number string.

setSerialNumber

public void setSerialNumber(java.lang.String aString)
Sets the serial number.

Parameters:
aString - an arbitrary string containing the serial number.

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