Package org.loboevolution.html.dom.smil

Interface ElementTime

All Known Subinterfaces:
ElementExclusiveTimeContainer, ElementParallelTimeContainer, ElementSequentialTimeContainer, ElementTimeContainer, SMILAnimateColorElement, SMILAnimateElement, SMILAnimateMotionElement, SMILAnimation, SMILDocument, SMILMediaElement, SMILRefElement, SMILSetElement
All Known Implementing Classes:
SVGAnimateElementImpl, SVGAnimateTransformElementImpl, SVGAnimationElementImpl, SVGAnimationImpl
public interface ElementTime
This interface defines the set of timing attributes that are common to all timed elements.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final short
    FILL_FREEZE
    Constant FILL_FREEZE=1
    static final short
    FILL_REMOVE
    Constant FILL_REMOVE=0
    static final short
    RESTART_ALWAYS
    Constant RESTART_ALWAYS=0
    static final short
    RESTART_NEVER
    Constant RESTART_NEVER=1
    static final short
    RESTART_WHEN_NOT_ACTIVE
    Constant RESTART_WHEN_NOT_ACTIVE=2

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    beginElement()
    Causes this element to begin the local timeline (subject to sync constraints).
    boolean
    endElement()
    Causes this element to end the local timeline (subject to sync constraints).
    TimeList
    getBegin()
    The desired value (as a list of times) of the begin instant of this node.
    float
    getDur()
    The desired simple duration value of this node in seconds.
    TimeList
    getEnd()
    The list of active ends for this node.
    String
    getFill()
    A code representing the value of the fill attribute, as defined above.
    float
    getRepeatCount()
    The repeatCount attribute causes the element to play repeatedly (loop) for the specified number of times.
    float
    getRepeatDur()
    The repeatDur causes the element to play repeatedly (loop) for the specified duration in milliseconds.
    default short
    getRestart()
    A code representing the value of the restart attribute, as defined above.
    default void
    pauseElement()
    Causes this element to pause the local timeline (subject to sync constraints).
    default void
    resumeElement()
    Causes this element to resume a paused local timeline.
    default void
    seekElement(float seekTo)
    Seeks this element to the specified point on the local timeline (subject to sync constraints).
    default void
    setBegin(TimeList begin)
    setBegin.
    void
    setDur(float dur)
    setDur.
    default void
    setEnd(TimeList end)
    setEnd.
    void
    setFill(String fill)
    setFill.
    void
    setRepeatCount(float repeatCount)
    setRepeatCount.
    void
    setRepeatDur(float repeatDur)
    setRepeatDur.
    default void
    setRestart(short restart)
    setRestart.

  • Field Details

    • RESTART_ALWAYS

      static final short RESTART_ALWAYS
      Constant RESTART_ALWAYS=0
      See Also:

    • RESTART_NEVER

      static final short RESTART_NEVER
      Constant RESTART_NEVER=1
      See Also:

    • RESTART_WHEN_NOT_ACTIVE

      static final short RESTART_WHEN_NOT_ACTIVE
      Constant RESTART_WHEN_NOT_ACTIVE=2
      See Also:

    • FILL_REMOVE

      static final short FILL_REMOVE
      Constant FILL_REMOVE=0
      See Also:

    • FILL_FREEZE

      static final short FILL_FREEZE
      Constant FILL_FREEZE=1
      See Also:

  • Method Details

    • getBegin

      TimeList getBegin()
      The desired value (as a list of times) of the begin instant of this node.
      Returns:
      a TimeList object.
      Throws:
      DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this attribute is readonly.

    • setBegin

      default void setBegin(TimeList begin)

      setBegin.

      Parameters:
      begin - a TimeList object.

    • getEnd

      TimeList getEnd()
      The list of active ends for this node.
      Returns:
      a TimeList object.
      Throws:
      DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this attribute is readonly.

    • setEnd

      default void setEnd(TimeList end)

      setEnd.

      Parameters:
      end - a TimeList object.

    • getDur

      float getDur()
      The desired simple duration value of this node in seconds. Negative value means "indefinite".
      Returns:
      a float.
      Throws:
      DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this attribute is readonly.

    • setDur

      void setDur(float dur) throws DOMException

      setDur.

      Parameters:
      dur - a float.
      Throws:
      DOMException - if any.

    • getRestart

      default short getRestart()
      A code representing the value of the restart attribute, as defined above. Default value is RESTART_ALWAYS .
      Returns:
      a short.
      Throws:
      DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this attribute is readonly.

    • setRestart

      default void setRestart(short restart)

      setRestart.

      Parameters:
      restart - a short.

    • getFill

      String getFill()
      A code representing the value of the fill attribute, as defined above. Default value is FILL_REMOVE .
      Returns:
      a String object.
      Throws:
      DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this attribute is readonly.

    • setFill

      void setFill(String fill) throws DOMException

      setFill.

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

    • getRepeatCount

      float getRepeatCount()
      The repeatCount attribute causes the element to play repeatedly (loop) for the specified number of times. A negative value repeat the element indefinitely. Default value is 0 (unspecified).
      Returns:
      a float.
      Throws:
      DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this attribute is readonly.

    • setRepeatCount

      void setRepeatCount(float repeatCount) throws DOMException

      setRepeatCount.

      Parameters:
      repeatCount - a float.
      Throws:
      DOMException - if any.

    • getRepeatDur

      float getRepeatDur()
      The repeatDur causes the element to play repeatedly (loop) for the specified duration in milliseconds. Negative means "indefinite".
      Returns:
      a float.
      Throws:
      DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this attribute is readonly.

    • setRepeatDur

      void setRepeatDur(float repeatDur) throws DOMException

      setRepeatDur.

      Parameters:
      repeatDur - a float.
      Throws:
      DOMException - if any.

    • beginElement

      boolean beginElement()
      Causes this element to begin the local timeline (subject to sync constraints).
      Returns:
      true if the method call was successful and the element was begun. false if the method call failed. Possible reasons for failure include: The element doesn't support the beginElement method. (the beginEvent attribute is not set to "undefinite" ) The element is already active and can't be restart when it is active. (the restart attribute is set to "whenNotActive" ) The element is active or has been active and can't be restart. (the restart attribute is set to "never" ).

    • endElement

      boolean endElement()
      Causes this element to end the local timeline (subject to sync constraints).
      Returns:
      true if the method call was successful and the element was endeed. false if method call failed. Possible reasons for failure include: The element doesn't support the endElement method. (the endEvent attribute is not set to "undefinite" ) The element is not active.

    • pauseElement

      default void pauseElement()
      Causes this element to pause the local timeline (subject to sync constraints).

    • resumeElement

      default void resumeElement()
      Causes this element to resume a paused local timeline.

    • seekElement

      default void seekElement(float seekTo)
      Seeks this element to the specified point on the local timeline (subject to sync constraints). If this is a timeline, this must seek the entire timeline (i.e. propagate to all timeChildren).
      Parameters:
      seekTo - The desired position on the local timeline in milliseconds.