Package org.loboevolution.html.dom.smil

Interface Time

All Known Implementing Classes:
TimeImpl
public interface Time
The Time interface is a datatype that represents times within the timegraph. A Time has a type, key values to describe the time, and a boolean to indicate whether the values are currently unresolved. Still need to address the wallclock values.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final short
    SMIL_TIME_ACCESSKEY
    Constant SMIL_TIME_ACCESSKEY=7
    static final short
    SMIL_TIME_EVENT_BASED
    Constant SMIL_TIME_EVENT_BASED=3
    static final short
    SMIL_TIME_INDEFINITE
    Constant SMIL_TIME_INDEFINITE=0
    static final short
    SMIL_TIME_MEDIA_MARKER
    Constant SMIL_TIME_MEDIA_MARKER=5
    static final short
    SMIL_TIME_OFFSET
    Constant SMIL_TIME_OFFSET=1
    static final short
    SMIL_TIME_REPEAT
    Constant SMIL_TIME_REPEAT=6
    static final short
    SMIL_TIME_SYNC_BASED
    Constant SMIL_TIME_SYNC_BASED=2
    static final short
    SMIL_TIME_WALLCLOCK
    Constant SMIL_TIME_WALLCLOCK=4

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getBaseBegin()
    If true , indicates that a sync-based time is relative to the begin of the baseElement.
    Element
    getBaseElement()
    The base element for a sync-based or event-based time.
    String
    getEvent()
    The name of the event for an event-based time.
    String
    getMarker()
    The name of the marker from the media element, for media marker times.
    double
    getOffset()
    The clock value in seconds relative to the syncbase or eventbase.
    boolean
    getResolved()
    A boolean indicating whether the current Time has been fully resolved to the document schedule.
    double
    getResolvedOffset()
    The clock value in seconds relative to the parent time container begin.
    short
    getTimeType()
    A code representing the type of the underlying object, as defined above.
    void
    setBaseBegin(boolean baseBegin)
    setBaseBegin.
    void
    setBaseElement(Element baseElement)
    setBaseElement.
    void
    setEvent(String event)
    setEvent.
    void
    setMarker(String marker)
    setMarker.
    void
    setOffset(double offset)
    setOffset.

  • Field Details

    • SMIL_TIME_INDEFINITE

      static final short SMIL_TIME_INDEFINITE
      Constant SMIL_TIME_INDEFINITE=0
      See Also:

    • SMIL_TIME_OFFSET

      static final short SMIL_TIME_OFFSET
      Constant SMIL_TIME_OFFSET=1
      See Also:

    • SMIL_TIME_SYNC_BASED

      static final short SMIL_TIME_SYNC_BASED
      Constant SMIL_TIME_SYNC_BASED=2
      See Also:

    • SMIL_TIME_EVENT_BASED

      static final short SMIL_TIME_EVENT_BASED
      Constant SMIL_TIME_EVENT_BASED=3
      See Also:

    • SMIL_TIME_WALLCLOCK

      static final short SMIL_TIME_WALLCLOCK
      Constant SMIL_TIME_WALLCLOCK=4
      See Also:

    • SMIL_TIME_MEDIA_MARKER

      static final short SMIL_TIME_MEDIA_MARKER
      Constant SMIL_TIME_MEDIA_MARKER=5
      See Also:

    • SMIL_TIME_REPEAT

      static final short SMIL_TIME_REPEAT
      Constant SMIL_TIME_REPEAT=6
      See Also:

    • SMIL_TIME_ACCESSKEY

      static final short SMIL_TIME_ACCESSKEY
      Constant SMIL_TIME_ACCESSKEY=7
      See Also:

  • Method Details

    • getResolved

      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).
      Returns:
      a boolean.

    • getResolvedOffset

      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.
      Returns:
      a double.

    • getTimeType

      short getTimeType()
      A code representing the type of the underlying object, as defined above.
      Returns:
      a short.

    • getOffset

      double getOffset()
      The clock value in seconds relative to the syncbase or eventbase. Default value is 0 .
      Returns:
      a double.
      Throws:
      DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised on attempts to modify this readonly attribute.

    • setOffset

      void setOffset(double offset) throws DOMException

      setOffset.

      Parameters:
      offset - a double.
      Throws:
      DOMException - if any.

    • getBaseElement

      Element getBaseElement()
      The base element for a sync-based or event-based time.
      Returns:
      a Element object.
      Throws:
      DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised on attempts to modify this readonly attribute.

    • setBaseElement

      void setBaseElement(Element baseElement) throws DOMException

      setBaseElement.

      Parameters:
      baseElement - a Element object.
      Throws:
      DOMException - if any.

    • getBaseBegin

      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.
      Returns:
      a boolean.
      Throws:
      DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised on attempts to modify this readonly attribute.

    • setBaseBegin

      void setBaseBegin(boolean baseBegin) throws DOMException

      setBaseBegin.

      Parameters:
      baseBegin - a boolean.
      Throws:
      DOMException - if any.

    • getEvent

      String getEvent()
      The name of the event for an event-based time. Default value is null .
      Returns:
      a String object.
      Throws:
      DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised on attempts to modify this readonly attribute.

    • setEvent

      void setEvent(String event) throws DOMException

      setEvent.

      Parameters:
      event - a String object.
      Throws:
      DOMException - if any.

    • getMarker

      String getMarker()
      The name of the marker from the media element, for media marker times. Default value is null .
      Returns:
      a String object.
      Throws:
      DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised on attempts to modify this readonly attribute.

    • setMarker

      void setMarker(String marker) throws DOMException

      setMarker.

      Parameters:
      marker - a String object.
      Throws:
      DOMException - if any.