fsfree.java

利用opensource的开源jar实现生成flash文件

/*
 * FSFree.java
 * Transform
 * 
 * Copyright (c) 2001-2006 Flagstone Software Ltd. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, 
 * are permitted provided that the following conditions are met:
 *
 *  * Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright notice, 
 *    this list of conditions and the following disclaimer in the documentation 
 *    and/or other materials provided with the distribution.
 *  * Neither the name of Flagstone Software Ltd. nor the names of its contributors 
 *    may be used to endorse or promote products derived from this software 
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
 * IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 
 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package com.flagstone.transform;

/**
FSFree deletes the object with the specified identifier, freeing up resources in the Flash Player.

<table class="datasheet">

<tr><th align="left" colspan="2">Attributes</th></tr>

<tr>
<td><a name="FSFree_0">type</a></td>
<td>Identifies the data structure when it is encoded. Read-only.</td>
</tr>

<tr>
<td><a name="FSFree_1">identifier</a></td>
<td>The identifier of the object, in the range 1..65535, that will be deleted from the Flash Player's memory.</td>
</tr>

</table>

<h1 class="datasheet">History</h1>

<p>The FSFree class represents the FreeCharacter tag from the Macromedia Flash (SWF) File Format Specification. It was introduced in Flash 3.</p>
 */  
public class FSFree extends FSMovieObject
{
    private int identifier = 0;
        
    /**
     * Construct an FSFree object, initalizing it with values decoded from an
     * encoded object.
     * 
     * @param coder an FSCoder containing the binary data.
     */
    public FSFree(FSCoder coder)
    {
        super(Free);
        decode(coder);
    }
    /** Constructs an FSFree object with the specified identifier. The identifier must be in the range 1..65535.

        @param anIdentifier the identifier of the object to be deleted.
        */
    public FSFree(int anIdentifier)
    {
        super(Free);
        setIdentifier(anIdentifier);
    }
    /**
     * Constructs an FSFree object by copying values from an existing object.
     *
     * @param obj an FSFree object.
     */
    public FSFree(FSFree obj)
    {
        super(obj);
        identifier = obj.identifier;
    }    
 
    /** Gets the identifier of the object to be deleted.

        @return the object's identifier.
        */
    public int getIdentifier() { return identifier; }

    /** Sets the identifier of the object to be deleted. The identifier must be in the range 1..65535.

        @param anIdentifier the identifier of the object to be deleted.
        */
    public void setIdentifier(int anIdentifier)
    {
        identifier = anIdentifier;
    }

    public boolean equals(Object anObject)
    {
        boolean result = false;
        
        if (super.equals(anObject))
        {
            result = identifier == ((FSFree)anObject).getIdentifier();
        }
        return result;
    }

    public void appendDescription(StringBuffer buffer, int depth)
    {
        buffer.append(name());
        
        if (depth > 0)
        {
            buffer.append(": { ");
            Transform.append(buffer, "identifier", identifier);
            buffer.append("}");
        }
    }

    public int length(FSCoder coder)
    {
        super.length(coder);

        length += 2;
            
        return length;
    }
    
    public void encode(FSCoder coder)
    {
        super.encode(coder);
        coder.writeWord(identifier, 2);
        coder.endObject(name());
    }
    
    public void decode(FSCoder coder)
    {
        super.decode(coder);        
        identifier = coder.readWord(2, false);
        coder.endObject(name());
    }
}