Package mgui.interfaces.attributes.video

Class AttributeObjectVideoTask

java.lang.Object

mgui.interfaces.graphics.video.VideoTask

mgui.interfaces.attributes.video.AttributeObjectVideoTask

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable<VideoTask>, XMLObject

public class AttributeObjectVideoTask
extends VideoTask

Represents a video task which modifies an Attribute.

Since:

1.0

Version:

1.0

Author:

Andrew Reid

Nested Class Summary

Nested classes/interfaces inherited from interface mgui.interfaces.xml.XMLObject

XMLObject.XMLEncoding, XMLObject.XMLType

Field Summary

Fields

Modifier and Type	Field	Description
java.lang.String	attribute
java.lang.Object	end_value
boolean	incremental
AttributeObject	object
java.lang.String	object_class
java.lang.String	object_name
java.lang.Object	start_value
double	step

Fields inherited from class mgui.interfaces.graphics.video.VideoTask

isOn, start_time, started, stop_time

Constructor Summary

Constructors

Constructor	Description
AttributeObjectVideoTask()
AttributeObjectVideoTask(long start, long stop, AttributeObject object, java.lang.String attribute, java.lang.Object start_value)	Constructs a basic set attribute task (no iteration)
AttributeObjectVideoTask(long start, long stop, AttributeObject object, java.lang.String attribute, java.lang.Object start_value, java.lang.Object end_value, boolean incremental, double step)	Constructs a set attribute task with possible iteration

Method Summary

Modifier and Type	Method	Description
java.lang.Object	clone()
protected boolean	do_it(InterfaceGraphic<?> g, long time)	Perform this task, contingent on time.
java.lang.String	getName()
java.lang.String	getXML(int tab)	Returns this object's XML representation as a single string.
static XMLObject	getXMLInstance(org.xml.sax.Attributes attributes)
java.lang.String	getXMLSchema()	Returns the XML schema for this object's XML representation
void	handleXMLElementEnd(java.lang.String localName)	Handles the end of an XML element.
void	handleXMLElementStart(java.lang.String localName, org.xml.sax.Attributes attributes, XMLObject.XMLType type)	Handles the start of an XML element.
void	setFromTask(VideoTask task)
void	updateTask(InterfaceDisplayPanel panel)

Methods inherited from class mgui.interfaces.graphics.video.VideoTask

compareTo, getDTD, getLocalName, getSchema, getShortXML, getShortXML, getStart, getStop, getXML, handleXMLString, isActive, perform, reset, setStart, setStop, writeXML, writeXML, writeXML

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

object

public AttributeObject object

attribute

public java.lang.String attribute

start_value

public java.lang.Object start_value

end_value

public java.lang.Object end_value

incremental

public boolean incremental

step

public double step

object_name

public java.lang.String object_name

object_class

public java.lang.String object_class

Constructor Details

AttributeObjectVideoTask

public AttributeObjectVideoTask()

AttributeObjectVideoTask

public AttributeObjectVideoTask(long start,
long stop,
AttributeObject object,
java.lang.String attribute,
java.lang.Object start_value)

Constructs a basic set attribute task (no iteration)

Parameters:

start -

stop -

object -

attribute -

new_value -

AttributeObjectVideoTask

public AttributeObjectVideoTask(long start,
long stop,
AttributeObject object,
java.lang.String attribute,
java.lang.Object start_value,
java.lang.Object end_value,
boolean incremental,
double step)

Constructs a set attribute task with possible iteration

Parameters:

start -

stop -

object -

attribute -

new_value -

Method Details

do_it

protected boolean do_it(InterfaceGraphic<?> g,
long time)
                 throws VideoException

Description copied from class: VideoTask

Perform this task, contingent on time.

Specified by:

do_it in class VideoTask

Returns:

Throws:

VideoException

getName

public java.lang.String getName()

Specified by:

getName in class VideoTask

setFromTask

public void setFromTask(VideoTask task)

Specified by:

setFromTask in class VideoTask

getXMLSchema

public java.lang.String getXMLSchema()

Description copied from interface: XMLObject

Returns the XML schema for this object's XML representation

See http://en.wikipedia.org/wiki/XML_schema.

Returns:

getXML

public java.lang.String getXML(int tab)

Description copied from interface: XMLObject

Returns this object's XML representation as a single string. NOTE: this is not feasible for larger objects and containers, thus may not be implemented for these objects. Use the XMLObject.writeXML(int,java.io.Writer,mgui.io.standard.xml.XMLOutputOptions,mgui.interfaces.ProgressUpdater) functions to write larger objects to file.

Specified by:

getXML in interface XMLObject

Overrides:

getXML in class VideoTask

Parameters:

tab - The number of tabs to place before the opening XML wrapper

Returns:

handleXMLElementStart

public void handleXMLElementStart(java.lang.String localName,
org.xml.sax.Attributes attributes,
XMLObject.XMLType type)

Description copied from interface: XMLObject

Handles the start of an XML element.

Specified by:

handleXMLElementStart in interface XMLObject

Overrides:

handleXMLElementStart in class VideoTask

Parameters:

localName - Local name of the element

attributes - Set of element attributes

type - The XMLType of this element

handleXMLElementEnd

public void handleXMLElementEnd(java.lang.String localName)

Description copied from interface: XMLObject

Handles the end of an XML element.

Specified by:

handleXMLElementEnd in interface XMLObject

Overrides:

handleXMLElementEnd in class VideoTask

Parameters:

localName - Local name of the element

updateTask

public void updateTask(InterfaceDisplayPanel panel)

Overrides:

updateTask in class VideoTask

clone

public java.lang.Object clone()

Specified by:

clone in class VideoTask

getXMLInstance

public static XMLObject getXMLInstance(org.xml.sax.Attributes attributes)