KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*
2  * $Id: FlashItem.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.*;
54 import java.lang.reflect.Constructor JavaDoc;
55 import org.openlaszlo.iv.flash.util.*;
56
57 /**
58  * Abstract base class for all Flash entities
59  * <P>
60  * All objects which can be parsed from swf file or generated into swf file are subclasses of this class
61  * <P>
62  * Object of this class can:<br>
63  * <UL>
64  * <LI>write itself to {@link FlashBuffer}
65  * <LI>print itself to {@link PrintStream}
66  * <LI>be copied through {@link ScriptCopier}
67  * </UL>
68  *
69  * @author Dmitry Skavish
70  */
71 public abstract class FlashItem {
72
73     /**
74      * Writes object to flash buffer
75      *
76      * @param fob flash buffer to write
77      */
78     public abstract void write( FlashOutput fob );
79
80     /**
81      * Prints object to {@link PrintStream}
82      *
83      * @param out stream to print
84      * @param indent this string is printed before each line printed
85      */
86     public abstract void printContent( PrintStream out, String JavaDoc indent );
87
88     /**
89      * Copies this flash item into empty given one through {@link ScriptCopier}<br>
90      * All subclasses of this class has to override this method if they have their own data
91      *
92      * @param item item to copy to
93      * @param copier copier
94      * @return filled object
95      * @see #getCopy
96      */
97     protected FlashItem copyInto( FlashItem item, ScriptCopier copier ) {
98         return item;
99     }
100
101     /**
102      * Creates copy of this object using {@link ScriptCopier} class
103      *
104      * @param copier copier to use
105      * @return copy of this object
106      * @see #copyInto
107      */
108     public FlashItem getCopy( ScriptCopier copier ) {
109         try {
110             Constructor JavaDoc c = getClass().getConstructor( new Class JavaDoc [] {} );
111             FlashItem o = (FlashItem) c.newInstance( new Object JavaDoc[] {} );
112             return copyInto( o, copier );
113         } catch( Exception JavaDoc e ) {
114             return null;
115         }
116     }
117
118     public String JavaDoc toString() {
119         ByteArrayOutputStream bos = new ByteArrayOutputStream();
120         PrintStream ps = new PrintStream(bos);
121         printContent(ps, "");
122         ps.flush();
123         return bos.toString();
124     }
125 }
126
127
Popular Tags