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 FSRemoveObject2

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

All Implemented Interfaces:
  java.lang.Cloneable

    public class FSRemoveObject2

extends FSMovieObject

FSRemoveObject2 removes an object from the display list.

Attributes
type | Identifies the data structure when it is encoded. Read-only.
layer | The number of the layer in the Flash Player's Display List where the object is displayed.

The FSRemoveObject2 class only requires the layer number to identify a particular object, unlike the FSRemoveObject class which also requires the object's identifier although only one object can be placed on a given layer.

# History

The FSRemoveObject2 class represents the RemoveObject2 tag from the Macromedia Flash (SWF) File Format Specification. It was introduced in Flash in Flash 3.

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
`FSRemoveObject2(FSCoder coder)` Construct an FSRemoveObject2 object, initialising it with values decoded from an encoded object.
`FSRemoveObject2(FSRemoveObject2 obj)` Constructs an FSRemoveObject2 object by copying values from an existing object.
`FSRemoveObject2(int layer)` Constructs an FSRemoveObject2, specifying the layer in the display list where the object to be removed is currently displayed.

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` | `getLayer()` Gets the layer in the display list where the object to be removed is currently displayed.
`int` | `length(FSCoder coder)`
`void` | `setLayer(int aLayer)` Sets the layer in the display list from which the object will be removed.

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

### FSRemoveObject2

    public FSRemoveObject2(FSCoder coder)

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

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

### FSRemoveObject2

    public FSRemoveObject2(int layer)

  Constructs an FSRemoveObject2, specifying the layer in the display list where the object to be removed is currently displayed.

  Parameters:
    `layer` - the layer number on which the object is displayed.

### FSRemoveObject2

    public FSRemoveObject2(FSRemoveObject2 obj)

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

  Parameters:
    `obj` - an FSRemoveObject2 object.

Method Detail

### getLayer

    public int getLayer()

  Gets the layer in the display list where the object to be removed is currently displayed.

  Returns:
    the layer number where the object is currently displayed.

### setLayer

    public void setLayer(int aLayer)

  Sets the layer in the display list from which the object will be removed.

  Parameters:
    `aLayer` - the layer number on which the object is displayed.

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