001: /*
002: * $Id: FlashItem.java,v 1.2 2002/02/15 23:44:27 skavish Exp $
003: *
004: * ==========================================================================
005: *
006: * The JGenerator Software License, Version 1.0
007: *
008: * Copyright (c) 2000 Dmitry Skavish (skavish@usa.net). All rights reserved.
009: *
010: * Redistribution and use in source and binary forms, with or without
011: * modification, are permitted provided that the following conditions are met:
012: *
013: * 1. Redistributions of source code must retain the above copyright
014: * notice, this list of conditions and the following disclaimer.
015: *
016: * 2. Redistributions in binary form must reproduce the above copyright
017: * notice, this list of conditions and the following disclaimer in
018: * the documentation and/or other materials provided with the
019: * distribution.
020: *
021: * 3. The end-user documentation included with the redistribution, if
022: * any, must include the following acknowlegement:
023: * "This product includes software developed by Dmitry Skavish
024: * (skavish@usa.net, http://www.flashgap.com/)."
025: * Alternately, this acknowlegement may appear in the software itself,
026: * if and wherever such third-party acknowlegements normally appear.
027: *
028: * 4. The name "The JGenerator" must not be used to endorse or promote
029: * products derived from this software without prior written permission.
030: * For written permission, please contact skavish@usa.net.
031: *
032: * 5. Products derived from this software may not be called "The JGenerator"
033: * nor may "The JGenerator" appear in their names without prior written
034: * permission of Dmitry Skavish.
035: *
036: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
037: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
038: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
039: * DISCLAIMED. IN NO EVENT SHALL DMITRY SKAVISH OR THE OTHER
040: * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
041: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
042: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
043: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
044: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
045: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
046: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
047: * SUCH DAMAGE.
048: *
049: */
050:
051: package org.openlaszlo.iv.flash.api;
052:
053: import java.io.*;
054: import java.lang.reflect.Constructor;
055: import org.openlaszlo.iv.flash.util.*;
056:
057: /**
058: * Abstract base class for all Flash entities
059: * <P>
060: * All objects which can be parsed from swf file or generated into swf file are subclasses of this class
061: * <P>
062: * Object of this class can:<br>
063: * <UL>
064: * <LI>write itself to {@link FlashBuffer}
065: * <LI>print itself to {@link PrintStream}
066: * <LI>be copied through {@link ScriptCopier}
067: * </UL>
068: *
069: * @author Dmitry Skavish
070: */
071: public abstract class FlashItem {
072:
073: /**
074: * Writes object to flash buffer
075: *
076: * @param fob flash buffer to write
077: */
078: public abstract void write(FlashOutput fob);
079:
080: /**
081: * Prints object to {@link PrintStream}
082: *
083: * @param out stream to print
084: * @param indent this string is printed before each line printed
085: */
086: public abstract void printContent(PrintStream out, String indent);
087:
088: /**
089: * Copies this flash item into empty given one through {@link ScriptCopier}<br>
090: * All subclasses of this class has to override this method if they have their own data
091: *
092: * @param item item to copy to
093: * @param copier copier
094: * @return filled object
095: * @see #getCopy
096: */
097: protected FlashItem copyInto(FlashItem item, ScriptCopier copier) {
098: return item;
099: }
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 c = getClass().getConstructor(new Class[] {});
111: FlashItem o = (FlashItem) c.newInstance(new Object[] {});
112: return copyInto(o, copier);
113: } catch (Exception e) {
114: return null;
115: }
116: }
117:
118: public String toString() {
119: ByteArrayOutputStream bos = new ByteArrayOutputStream();
120: PrintStream ps = new PrintStream(bos);
121: printContent(ps, "");
122: ps.flush();
123: return bos.toString();
124: }
125: }
|