| java.lang.Object
 org.openlaszlo.iv.flash.util.IVVector
org.openlaszlo.iv.flash.api.Frame
| Frame | | final public class Frame extends IVVector (Code) | | A movie frame
A frame contains zero or more FlashObjects.
A frame can have a name (to be referenced in gotoFrame action).
author:
Dmitry Skavish
See Also: Timeline |
| Method Summary | |
| public void | addBounds(Rectangle2D rect)
| | public void | addFlashObject(FlashObject o)
| | public Instance | addInstance(FlashDef def, int depth, AffineTransform matrix, CXForm cxform)
Adds flash object's instance to this frame
Creates new instance and adds it to this frame using specified
depth, matrix and cxform. | | public Instance | addInstance(FlashDef def, int depth, AffineTransform matrix, CXForm cxform, String name)
Adds flash object's instance to this frame
Creates new instance and adds it to this frame using specified
depth, matrix, cxform and name. | | public Instance | addInstance(int depth, AffineTransform matrix)
Adds new instance of flash object which is already on a timeline with new transformation matrix
Creates new instance of an existing on a timeline flash object
and assigns specified transformation matrix to it. | | public Instance | addInstance(int depth, AffineTransform matrix, CXForm cxform)
Adds new instance of flash object which is already on a timeline with new transformation matrix
Creates new instance of an existing on a timeline flash object
and assigns specified transformation and color matrixes to it. | | public Instance | addInstance(Instance inst, int depth)
| | public void | addStopAction()
Add a stop action to this frame. | | public void | append(Frame f)
| | public void | apply(Context context)
| | public void | collectDeps(DepsCollector dc)
| | public void | doCommand(FlashFile file, Context context, Script parent, int frame)
| | public void | generate(FlashOutput fob, DepsCollector dc)
Writes content of this frame to flash buffer
Has to be used only when this frame is from main timeline. | | public IVVector | getCopy(ScriptCopier copier)
| | public FlashObject | getFlashObjectAt(int index)
| | public String | getName()
| | public boolean | isAnchor()
| | public boolean | isConstant()
Returns true if this frame is constant
Returns true if all the objects from this frame are constants. | | public void | process(FlashFile file, Context context)
| | public void | remove(FlashObject o)
| | public FlashObject | removeFlashObjectAt(int index)
| | public RemoveObject | removeInstance(int depth)
"Removes" flash object's instance from specified layer
Does not actually remove any instance from this frame, but rather adds
flash tag RemoveObject to this frame. | | public void | setAnchor(boolean is_anchor)
| | public void | setFlashObjectAt(FlashObject o, int index)
| | public void | setName(String name)
| | public void | write(FlashOutput fob)
Writes content of this frame to flash buffer
Has to be used only when this frame is NOT from main timeline. |
| Frame | | public Frame()(Code) | | Creates empty frame
|
| Frame | | public Frame(int capacity)(Code) | | Creates frame of specified capacity
Parameters:
capacity - capacity of created frame |
| Frame | | public Frame(IVVector data)(Code) | | Creates frame from specified vector
Creates frame with capacity equal to the size of specified vector
and copies all data from the specified vector to this frame
Parameters:
data - vector to copy from |
| addBounds | | public void addBounds(Rectangle2D rect)(Code) | | Adds bounds of all the object from this frame to the specified rectangle
Parameters:
rect - specified bounds |
| addFlashObject | | public void addFlashObject(FlashObject o)(Code) | | Adds specified flash object to this frame
Parameters:
o - flash object to be added |
| addInstance | | public Instance addInstance(FlashDef def, int depth, AffineTransform matrix, CXForm cxform)(Code) | | Adds flash object's instance to this frame
Creates new instance and adds it to this frame using specified
depth, matrix and cxform.
Parameters:
def - flash definition instance of which has to be added
Parameters:
depth - layer depth of the instance to be added
Parameters:
matrix - transformation matrix for the instance (optional)
Parameters:
cxform - transformation color for the instance (optional) added instance
See Also: Instance |
| addInstance | | public Instance addInstance(FlashDef def, int depth, AffineTransform matrix, CXForm cxform, String name)(Code) | | Adds flash object's instance to this frame
Creates new instance and adds it to this frame using specified
depth, matrix, cxform and name.
Parameters:
def - flash definition instance of which has to be added
Parameters:
depth - layer depth of the instance to be added
Parameters:
matrix - transformation matrix for the instance (optional)
Parameters:
cxform - transformation color for the instance (optional)
Parameters:
name - name of the instance (optional) added instance
See Also: Instance |
| addInstance | | public Instance addInstance(int depth, AffineTransform matrix)(Code) | | Adds new instance of flash object which is already on a timeline with new transformation matrix
Creates new instance of an existing on a timeline flash object
and assigns specified transformation matrix to it.
Parameters:
depth - layer depth of the existing instance
Parameters:
matrix - transformation matrix for the instance (optional) added instance |
| addInstance | | public Instance addInstance(int depth, AffineTransform matrix, CXForm cxform)(Code) | | Adds new instance of flash object which is already on a timeline with new transformation matrix
Creates new instance of an existing on a timeline flash object
and assigns specified transformation and color matrixes to it.
Parameters:
depth - layer depth of the existing instance
Parameters:
matrix - transformation matrix for the instance (optional)
Parameters:
cxform - color matrix for the instance (optional) added instance |
| addInstance | | public Instance addInstance(Instance inst, int depth)(Code) | | Adds specified instance into specified layer
Parameters:
inst - specified instance
Parameters:
depth - layer depth added instance |
| addStopAction | | public void addStopAction()(Code) | | Add a stop action to this frame. We do this a lot so it's nice to
have this code in one place.
|
| append | | public void append(Frame f)(Code) | | Appends all the objects from the specified frame to this one
Parameters:
f - frame to be added to this one |
| apply | | public void apply(Context context)(Code) | | Applies specified context to all the object from this frame
Parameters:
context - specified context |
| collectDeps | | public void collectDeps(DepsCollector dc)(Code) | | Collects dependencies of all the object from this frame
Parameters:
dc - dependencies collector |
| doCommand | | public void doCommand(FlashFile file, Context context, Script parent, int frame) throws IVException(Code) | | Performs all generator commands from this frame
Parameters:
file - flash file to used for processing commands
Parameters:
context - context to used for processing commands
Parameters:
parent - parent script
Parameters:
frame - this frame's number in the parent script's timelime
exception:
IVException - thrown if there were some errors during command processing |
| generate | | public void generate(FlashOutput fob, DepsCollector dc)(Code) | | Writes content of this frame to flash buffer
Has to be used only when this frame is from main timeline.
Parameters:
fob - flash buffer to write to
Parameters:
dc - dependencies collector |
| getCopy | | public IVVector getCopy(ScriptCopier copier)(Code) | | Creates a copy of this frame
The copy contains copies of all the objects
Parameters:
copier - copier to be used when copying Frame casted to IVVector |
| getFlashObjectAt | | public FlashObject getFlashObjectAt(int index)(Code) | | Returns flash object at specified index
Parameters:
index - specified index flash object at specified index |
| getName | | public String getName()(Code) | | Returns name of this frame
name of this frame or null |
| isAnchor | | public boolean isAnchor()(Code) | | Returns whether this frame is named anchor or not
Only for Flash MX
whether this frame is named anchor or not |
| isConstant | | public boolean isConstant()(Code) | | Returns true if this frame is constant
Returns true if all the objects from this frame are constants.
true - if this frame is constant |
| process | | public void process(FlashFile file, Context context) throws IVException(Code) | | Processes all the scripts from this frame in the specified context
Parameters:
file - flash file to be used for processing scripts
Parameters:
context - context to be used for processing scripts
exception:
IVException - |
| remove | | public void remove(FlashObject o)(Code) | | Removes specified flash object from this frame
Parameters:
o - specified flash object to be removed |
| removeFlashObjectAt | | public FlashObject removeFlashObjectAt(int index)(Code) | | Removes flash object at specified index
Parameters:
index - specified index removed flash object |
| removeInstance | | public RemoveObject removeInstance(int depth)(Code) | | "Removes" flash object's instance from specified layer
Does not actually remove any instance from this frame, but rather adds
flash tag RemoveObject to this frame.
Parameters:
depth - layer depth of the existing instance to be removed RemoveObject tag |
| setAnchor | | public void setAnchor(boolean is_anchor)(Code) | | Sets whether this frame is named anchor or not
Only for Flash MX
Parameters:
is_anchor - this frame is named anchor if its true |
| setFlashObjectAt | | public void setFlashObjectAt(FlashObject o, int index)(Code) | | Replaces flash object at specified index with new one
Parameters:
o - new flash object to be replaced with
Parameters:
index - specified index |
| setName | | public void setName(String name)(Code) | | Assings name to this frame
Parameters:
name - new name of this frame |
| write | | public void write(FlashOutput fob)(Code) | | Writes content of this frame to flash buffer
Has to be used only when this frame is NOT from main timeline.
Parameters:
fob - flash buffer to write to |
|
|