KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > openlaszlo > iv > flash > api > FlashDef


1 /*
2  * $Id: FlashDef.java,v 1.2 2002/02/15 23:44:27 skavish Exp $
3  *
4  * ==========================================================================
5  *
6  * The JGenerator Software License, Version 1.0
7  *
8  * Copyright (c) 2000 Dmitry Skavish (skavish@usa.net). All rights reserved.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  * notice, this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright
17  * notice, this list of conditions and the following disclaimer in
18  * the documentation and/or other materials provided with the
19  * distribution.
20  *
21  * 3. The end-user documentation included with the redistribution, if
22  * any, must include the following acknowlegement:
23  * "This product includes software developed by Dmitry Skavish
24  * (skavish@usa.net, http://www.flashgap.com/)."
25  * Alternately, this acknowlegement may appear in the software itself,
26  * if and wherever such third-party acknowlegements normally appear.
27  *
28  * 4. The name "The JGenerator" must not be used to endorse or promote
29  * products derived from this software without prior written permission.
30  * For written permission, please contact skavish@usa.net.
31  *
32  * 5. Products derived from this software may not be called "The JGenerator"
33  * nor may "The JGenerator" appear in their names without prior written
34  * permission of Dmitry Skavish.
35  *
36  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39  * DISCLAIMED. IN NO EVENT SHALL DMITRY SKAVISH OR THE OTHER
40  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47  * SUCH DAMAGE.
48  *
49  */
50
51 package org.openlaszlo.iv.flash.api;
52
53 import java.io.PrintStream JavaDoc;
54 import org.openlaszlo.iv.flash.util.*;
55
56 /**
57  * Abstract base class for all Flash definitions (characters in macromedia definition)
58  * <p>
59  * Definition has an ID and an optional name<BR>
60  * ID is unique in the whole flash movie<BR>
61  * Set of Flash definitions defines a <B>library</B> in flash movie.
62  *
63  * @author Dmitry Skavish
64  * @see FlashItem
65  * @see FlashObject
66  */
67 public abstract class FlashDef extends FlashObject {
68
69     private int id;
70     private String JavaDoc name;
71
72     /**
73      * Returns ID of this definition
74      *
75      * @return definition ID
76      */
77     public int getID() {
78         return id;
79     }
80
81     /**
82      * Sets ID to definition
83      *
84      * @param id new ID
85      */
86     public void setID( int id ) {
87         this.id = id;
88     }
89
90     /**
91      * Returns name of definition or null
92      *
93      * @return name of definition or null
94      */
95     public String JavaDoc getName() {
96         return name;
97     }
98
99     /**
100      * Sets name to definition
101      *
102      * @param name new name
103      */
104     public void setName( String JavaDoc name ) {
105         this.name = name;
106     }
107
108     protected FlashItem copyInto( FlashItem item, ScriptCopier copier ) {
109         super.copyInto( item, copier );
110         ((FlashDef)item).id = id;
111         ((FlashDef)item).name = name;
112         return item;
113     }
114
115 }
116
117
Popular Tags