pt.tumba.parser.swf
Class Symbol

java.lang.Object
  extended by pt.tumba.parser.swf.Symbol
Direct Known Subclasses:
Button, EditField, Font, Image, ImportedSymbol, MorphShape, MovieClip, QTMovie, Shape, Text

public abstract class Symbol
extends java.lang.Object

Base class for all defined symbols

Author:
unknown

Field Summary
protected  int id
          Description of the Field
 
Constructor Summary
protected Symbol()
          Constructor for the Symbol object
protected Symbol(int id)
          Constructor for the Symbol object
 
Method Summary
protected  int define(Movie movie, SWFTagTypes timelineWriter, SWFTagTypes definitionWriter)
          Make sure that the Symbol is fully defined in the given Movie and return the character id
protected abstract  int defineSymbol(Movie movie, SWFTagTypes timelineWriter, SWFTagTypes definitionwriter)
          Override to provide symbol definition
 int getId()
          Get the internal SWF id for the symbol.
protected  int getNextId(Movie movie)
          Gets the nextId attribute of the Symbol object
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

id

protected int id
Description of the Field

Constructor Detail

Symbol

protected Symbol()
Constructor for the Symbol object


Symbol

protected Symbol(int id)
Constructor for the Symbol object

Parameters:
id - Description of the Parameter
Method Detail

getId

public int getId()
Get the internal SWF id for the symbol. This will always be zero for a Movie that was not loaded from an existing SWF until the Movie is written out.

Returns:
The id value

define

protected int define(Movie movie,
                     SWFTagTypes timelineWriter,
                     SWFTagTypes definitionWriter)
              throws java.io.IOException
Make sure that the Symbol is fully defined in the given Movie and return the character id

Parameters:
movie - Description of the Parameter
timelineWriter - Description of the Parameter
definitionWriter - Description of the Parameter
Returns:
Description of the Return Value
Throws:
java.io.IOException - Description of the Exception

getNextId

protected int getNextId(Movie movie)
Gets the nextId attribute of the Symbol object

Parameters:
movie - Description of the Parameter
Returns:
The nextId value

defineSymbol

protected abstract int defineSymbol(Movie movie,
                                    SWFTagTypes timelineWriter,
                                    SWFTagTypes definitionwriter)
                             throws java.io.IOException
Override to provide symbol definition

Parameters:
movie - Description of the Parameter
timelineWriter - Description of the Parameter
definitionwriter - Description of the Parameter
Returns:
the new symbol id
Throws:
java.io.IOException - Description of the Exception