com.tinyline.svg
Class SMILTime

java.lang.Object
  com.tinyline.svg.SMILTime

public final class SMILTime
extends java.lang.Object

The SMILTime class is a datatype that represents times within the timegraph. A SMILTime has a type, key values to describe the time, and a boolean to indicate whether the values are currently unresolved. The 3GPP SMIL timing modules includes BasicInlineTiming, MinMaxTiming, BasicTimeContainers, RepeatTiming and EventTiming.

For 'begin' and 'end' attributes either single offset-value or single event-value shall be allowed. Offsets shall not be supported with event-values.

SMILTime Types:

• SMIL_TIME_INDEFINITE
• SMIL_TIME_OFFSET
• SMIL_TIME_EVENT_BASED

When a begin or end value refers to an event, or to the begin or active end of another element, it may not be possible to calculate the time value. For example, if an element is defined to begin on some event, the begin time will not be known until the event happens. Begin and end values like this are described as unresolved. When such a time becomes known (i.e. when it can be calculated as a presentation time), the time is said to be resolved.

Version:

1.9

Field Summary

TinyString	idValue The even-based Id-value
static int	INDEFINITE The time is indefinite if value equals INDEFINITE
int	offset The offset value of clock value.
static int	SMIL_TIME_EVENT_BASED
static int	SMIL_TIME_INDEFINITE The type of the begin value (end value)
static int	SMIL_TIME_OFFSET
int	type The type of this SMILTime object.
static int	UNRESOLVED The time is unresolved if value equals UNRESOLVED
int	value Time of event, syncbase time etc.

Constructor Summary

SMILTime()
Contructs a new SMILTime object.

SMILTime(int type)
Contructs a new SMILTime object.

SMILTime(int type, int offset, TinyString idValue)
Contructs a new SMILTime object.

SMILTime(SMILTime src)
Contructs a new SMILTime object as copy of the given 'src' SMILTime object.

Method Summary

void	copyTo(SMILTime dst) Copies this SMILTime object into the given 'dst' SMILTime object.
boolean	equalTo(SMILTime time) Is time equal to this.
int	getResolvedOffset() The clock value in seconds relative to the parent time container begin.
boolean	greaterThan(SMILTime time) Returns true if the given 'time' is greater than

Methods inherited from class java.lang.Object

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

Field Detail

idValue

public TinyString idValue

The even-based Id-value

INDEFINITE

public static final int INDEFINITE

The time is indefinite if value equals INDEFINITE

See Also:

Constant Field Values

offset

public int offset

The offset value of clock value.

SMIL_TIME_EVENT_BASED

public static final int SMIL_TIME_EVENT_BASED

See Also:

Constant Field Values

SMIL_TIME_INDEFINITE

public static final int SMIL_TIME_INDEFINITE

The type of the begin value (end value)

See Also:

Constant Field Values

SMIL_TIME_OFFSET

public static final int SMIL_TIME_OFFSET

See Also:

Constant Field Values

type

public int type

The type of this SMILTime object.

UNRESOLVED

public static final int UNRESOLVED

The time is unresolved if value equals UNRESOLVED

See Also:

Constant Field Values

value

public int value

Time of event, syncbase time etc. doesn't include offset.

Constructor Detail

SMILTime

public SMILTime()

Contructs a new SMILTime object.

SMILTime

public SMILTime(int type)

Contructs a new SMILTime object.

Parameters:

type - The time value type

SMILTime

public SMILTime(int type,
                int offset,
                TinyString idValue)

Contructs a new SMILTime object.

Parameters:

type - The time value type

idValue - The even-based Id-value

offset - The offset value of clock value

SMILTime

public SMILTime(SMILTime src)

Contructs a new SMILTime object as copy of the given 'src' SMILTime object.

Method Detail

copyTo

public void copyTo(SMILTime dst)

Copies this SMILTime object into the given 'dst' SMILTime object.

equalTo

public final boolean equalTo(SMILTime time)

Is time equal to this.

Parameters:

time - Time value

Returns:

true if this is greater than time.

getResolvedOffset

public int getResolvedOffset()

The clock value in seconds relative to the parent time container begin. This indicates the resolved time relationship to the parent time container. This is only valid if resolved is true.

greaterThan

public final boolean greaterThan(SMILTime time)

Returns true if the given 'time' is greater than

Parameters:

time - the given time value

Returns:

true if this greater than time and false otherwise.