Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.flagstone.transform
Class FSExport

    java.lang.Object
      com.flagstone.transform.FSTransformObject
          com.flagstone.transform.FSMovieObject
              com.flagstone.transform.FSExport

All Implemented Interfaces:
  java.lang.Cloneable

    public class FSExport

extends FSMovieObject

FSExport is used to export shapes and other objects so they can be used in another Flash file.

Since the identifier for an object is only unique within a given Flash file, each object exported must be given a name so it can referenced when it is imported.

Attributes
type | Identifies the data structure when it is encoded. Read-only.
objects | A HashTable containing key-value pairs where the key is the identifier of the object being exported and the value is name assigned to the object so it can be referenced when it is imported into a Flash file.

# Examples

To export an object from a Flash file:

      FSDefineShape shape = new FSDefineShape(...);

      movie.add(shape);
      movie.add(new FSExport(shape.getIdentifier(), "Shape"));

The object can then be imported into another file:

     movie.add(new FSImport("exportFile.swf", movie.newIdentifier(), "Shape"));

# History

The FSExport class represents the ExportAssets tag in 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
`FSExport(FSCoder coder)` Construct an FSExport object, initialising it with values decoded from an encoded object.
`FSExport(FSExport obj)` Constructs an FSExport object by copying values from an existing object.
`FSExport(int anIdentifier, java.lang.String aString)` Constructs an FSExport object that exports the object with the specified identifier.

Method Summary
`void` | `add(int anIdentifier, java.lang.String aString)` Adds the identifier and name to the list of objects to be exported.
`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.util.Hashtable` | `getObjects()` Gets the table of objects to be imported.
`int` | `length(FSCoder coder)`
`void` | `setObjects(java.util.Hashtable aTable)` Sets the table of objects to be imported.

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

### FSExport

    public FSExport(FSCoder coder)

  Construct an FSExport object, initialising it with values decoded from an encoded object.

  Parameters:
    `coder` - an FSCoder containing the binary data.

### FSExport

    public FSExport(int anIdentifier,
                    java.lang.String aString)

  Constructs an FSExport object that exports the object with the specified identifier. The exported object is assigned the specified name to allow it to be referenced in files importing the object.

  Parameters:
    `anIdentifier` - the identifier of the object to be exported.
    `aString` - the name of the exported object to allow it to be referenced.

### FSExport

    public FSExport(FSExport obj)

  Constructs an FSExport object by copying values from an existing object.

  Parameters:
    `obj` - an FSExport object.

Method Detail

### add

    public void add(int anIdentifier,
                    java.lang.String aString)

  Adds the identifier and name to the list of objects to be exported.

  Parameters:
    `anIdentifier` - the identifier of the object to be exported.
    `aString` - the name of the exported object to allow it to be referenced.

### getObjects

    public java.util.Hashtable getObjects()

  Gets the table of objects to be imported.

  Returns:
    the table of imported objects.

### setObjects

    public void setObjects(java.util.Hashtable aTable)

  Sets the table of objects to be imported.

  Parameters:
    `aTable` - the table of objects being imported.

### 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`

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD