Package org.loboevolution.svg.smil
Class TimeImpl
java.lang.Object
org.loboevolution.svg.smil.TimeImpl
- All Implemented Interfaces:
Time
TimeImpl class.
-
Field Summary
Fields inherited from interface org.loboevolution.html.dom.smil.Time
SMIL_TIME_ACCESSKEY, SMIL_TIME_EVENT_BASED, SMIL_TIME_INDEFINITE, SMIL_TIME_MEDIA_MARKER, SMIL_TIME_OFFSET, SMIL_TIME_REPEAT, SMIL_TIME_SYNC_BASED, SMIL_TIME_WALLCLOCK -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanIf true , indicates that a sync-based time is relative to the begin of the baseElement.The base element for a sync-based or event-based time.static floatgetClockMilliSecs(String clockVal) getClockMilliSecs.getEvent()The name of the event for an event-based time.The name of the marker from the media element, for media marker times.doubleThe clock value in seconds relative to the syncbase or eventbase.booleanA boolean indicating whether the current Time has been fully resolved to the document schedule.doubleThe clock value in seconds relative to the parent time container begin.shortA code representing the type of the underlying object, as defined above.voidsetBaseBegin(boolean baseBegin) setBaseBegin.voidsetBaseElement(Element baseElement) setBaseElement.voidsetEvent.voidsetMarker.voidsetOffset(double offset) setOffset.
-
Constructor Details
-
TimeImpl
Constructor for TimeImpl.
- Parameters:
time- aStringobject.
-
-
Method Details
-
getResolved
public boolean getResolved()A boolean indicating whether the current Time has been fully resolved to the document schedule. Note that for this to be true, the current Time must be defined (not indefinite), the syncbase and all Time 's that the syncbase depends on must be defined (not indefinite), and the begin Time of all ascendent time containers of this element and all Time elements that this depends upon must be defined (not indefinite).
If this Time is based upon an event, this Time will only be resolved once the specified event has happened, subject to the constraints of the time container.
Note that this may change from true to false when the parent time container ends its simple duration (including when it repeats or restarts).- Specified by:
getResolvedin interfaceTime- Returns:
- a boolean.
-
getResolvedOffset
public double 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.- Specified by:
getResolvedOffsetin interfaceTime- Returns:
- a double.
-
getTimeType
public short getTimeType()A code representing the type of the underlying object, as defined above.- Specified by:
getTimeTypein interfaceTime- Returns:
- a short.
-
getOffset
public double getOffset()The clock value in seconds relative to the syncbase or eventbase. Default value is 0 . -
setOffset
public void setOffset(double offset) setOffset.
-
getBaseElement
The base element for a sync-based or event-based time.- Specified by:
getBaseElementin interfaceTime- Returns:
- a
Elementobject.
-
setBaseElement
setBaseElement.
- Specified by:
setBaseElementin interfaceTime- Parameters:
baseElement- aElementobject.
-
getBaseBegin
public boolean getBaseBegin()If true , indicates that a sync-based time is relative to the begin of the baseElement. If false , indicates that a sync-based time is relative to the active end of the baseElement.- Specified by:
getBaseBeginin interfaceTime- Returns:
- a boolean.
-
setBaseBegin
public void setBaseBegin(boolean baseBegin) setBaseBegin.
- Specified by:
setBaseBeginin interfaceTime- Parameters:
baseBegin- a boolean.
-
getEvent
The name of the event for an event-based time. Default value is null . -
setEvent
setEvent.
-
getMarker
The name of the marker from the media element, for media marker times. Default value is null . -
setMarker
setMarker.
-
getClockMilliSecs
getClockMilliSecs.
- Parameters:
clockVal- aStringobject.- Returns:
- a float.
-