com.flagstone.transform
Class FSPointer

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

public class FSPointer
extends FSMovieObject

FSPointer defines an unsigned 32-bit pointer.

It is thought that this class was used by Macromedia's Generator product and its exact function is not known. It is included in the framework for completeness.

Attributes
type Identifies the data structure when it is encoded. Read-only.
pointer The pointer value.

History

The FSPointer class represents the DefineBitsPtr tag from the Macromedia Flash (SWF) File Format Specification. It is not documented in later editions of the specification. It is not known when this tag was added.


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
FSPointer(FSCoder coder)
          Construct an FSPointer object, initialising it with values decoded from an encoded object.
FSPointer(FSPointer obj)
          Constructs an FSPointer object by copying values from an existing object.
FSPointer(int aPointer)
          Constructs an FSPointer object, specifying the pointer.
 
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.
 int getPointer()
          Gets the value for the pointer.
 int length(FSCoder coder)
           
 void setPointer(int aPointer)
          Sets the pointer.
 
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

FSPointer

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

Parameters:
coder - an FSCoder containing the binary data.

FSPointer

public FSPointer(int aPointer)
Constructs an FSPointer object, specifying the pointer.

Parameters:
aPointer - the pointer.

FSPointer

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

Parameters:
obj - an FSPointer object.
Method Detail

getPointer

public int getPointer()
Gets the value for the pointer.

Returns:
the pointer value.

setPointer

public void setPointer(int aPointer)
Sets the pointer.

Parameters:
aPointer - the pointer.

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