FrameAnimationElement

java.lang.Object
- ohos.agp.components.element.Element
- - ohos.agp.components.element.ElementContainer
  - - ohos.agp.components.element.FrameAnimationElement

直接已知子类:

ImageAnimationElement
```
public class FrameAnimationElement
extends ElementContainer
```
Creates frame-by-frame animations using element objects.
Animations defined by the element objects are mainly used as the background of component objects.

从以下版本开始:

1

嵌套类概要
- 从类继承的嵌套类/接口 ohos.agp.components.element.Element
  Element.ConstantState, Element.OnBoundsChangeListener, Element.OnChangeListener, Element.OnLayoutDirectionChangeListener, Element.OnRankChangeListener
- 从类继承的嵌套类/接口 ohos.agp.components.element.ElementContainer
  ElementContainer.ElementState

字段概要
- 从类继承的字段 ohos.agp.components.element.Element
  ALPHA_DEFAULT, ALPHA_MAX, ALPHA_MIN, DEFAULT_BOUNDS_RECT, MAX_RANK, MIN_RANK

构造器概要

构造器
构造器	说明
`FrameAnimationElement()`	Default constructor used to create a `FrameAnimationElement` object.
`FrameAnimationElement(Context context, int xmlId)`	Creates a `FrameAnimationElement` object based on the specified XML resource.

方法概要

所有方法实例方法具体方法
限定符和类型	方法	说明
`void`	`addFrame(Element frame, int duration)`	Adds an element frame to an animation.
`boolean`	`getDisposeMode()`	Checks whether dynamic decoding is enabled for this frame animation.
`int`	`getDuration(int index)`	Obtains the duration of a specified frame in an animation.
`Element`	`getFrame(int index)`	Obtains the frame of a specified index.
`int`	`getNumberOfFrames()`	Obtains the number of frames in an animation.
`int`	`getPreDecodeFrames()`	Obtains the number of frames to be decoded before this animation is displayed.
`boolean`	`isOneShot()`	Checks whether an animation is played only once.
`void`	`setDisposeMode(boolean isDisposeMode)`	Sets dynamic decoding for this frame animation.
`void`	`setOneShot(boolean oneShot)`	Sets whether to play an animation only once.
`boolean`	`setPreDecodeFrames(int preDecodeFrames)`	Sets the number of frames to be decoded before this animation is displayed.
`void`	`start()`	Starts an animation.
`void`	`stop()`	Stops an animation.

从类继承的方法 ohos.agp.components.element.Element
clearColorMatrix, drawToCanvas, getAlpha, getBounds, getCallback, getColorMatrix, getHeight, getLayoutDirection, getMinHeight, getMinWidth, getPadding, getRank, getStateColorMode, getVisible, getWidth, isInheritDirection, isVisible, release, setAlpha, setBounds, setBounds, setCallback, setColorMatrix, setInheritDirection, setLayoutDirection, setOnBoundsChangeListener, setOnLayoutDirectionChangeListener, setOnRankChangeListener, setRank, setStateColor, setStateColorList, setStateColorMode, setVisible

从类继承的方法 ohos.agp.components.element.ElementContainer
addChildElement, getChildElement, getChildElementCount, getCurrentElement, getElementState, getEnterFadeDuration, getExitFadeDuration, getFadeInEffectPeriod, getFadeOutEffectPeriod, isStateful, selectElement, setElementState, setEnterFadeDuration, setExitFadeDuration, skipAnimation

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - FrameAnimationElement
```
public FrameAnimationElement()
```
    Default constructor used to create a FrameAnimationElement object.
  - FrameAnimationElement
```
public FrameAnimationElement(Context context,
                             int xmlId)
```
    Creates a FrameAnimationElement object based on the specified XML resource.
    
    参数:
    
    context - Indicates the application context.
    
    xmlId - Indicates the ID of the XML resource.
    
    从以下版本开始:
    
    3
- 方法详细资料
  - start
```
public void start()
```
    Starts an animation.
  - stop
```
public void stop()
```
    Stops an animation.
  - getNumberOfFrames
```
public int getNumberOfFrames()
```
    Obtains the number of frames in an animation.
    
    返回:
    
    Returns the number of frames in the animation.
  - getFrame
```
public Element getFrame(int index)
```
    Obtains the frame of a specified index.
    
    参数:
    
    index - Indicates the specified index used to obtain the frame.
    
    返回:
    
    Returns the element object containing the frame.
  - getDuration
```
public int getDuration(int index)
```
    Obtains the duration of a specified frame in an animation.
    
    参数:
    
    index - Indicates the index of the specified frame.
    
    返回:
    
    Returns the duration of the specified frame.
  - isOneShot
```
public boolean isOneShot()
```
    Checks whether an animation is played only once.
    
    返回:
    
    Returns True if the animation is played only once; returns False otherwise.
  - setOneShot
```
public void setOneShot(boolean oneShot)
```
    Sets whether to play an animation only once.
    
    参数:
    
    oneShot - Indicates whether the animation is played only once. Value true means that the animation is played only once, and false means the opposite.
  - addFrame
```
public void addFrame(Element frame,
                     int duration)
```
    Adds an element frame to an animation.
    
    参数:
    
    frame - Indicates the element frame to add.
    
    duration - Indicates the duration of the element frame, in milliseconds.
  - setDisposeMode
```
public void setDisposeMode(boolean isDisposeMode)
```
    Sets dynamic decoding for this frame animation.
    
    参数:
    
    isDisposeMode - Specifies whether to enable dynamic decoding for this frame animation. The value true means to enable dynamic decoding, and false means the opposite. If you enable dynamic decoding, you must also call setPreDecodeFrames(int) to set the number of frames to be decoded. Enabling dynamic decoding saves random-access memory (RAM) but may consumes more power.
    
    从以下版本开始:
    
    4
  - getDisposeMode
```
public boolean getDisposeMode()
```
    Checks whether dynamic decoding is enabled for this frame animation.
    
    返回:
    
    Returns true if dynamic decoding is enabled; returns false otherwise.
    
    从以下版本开始:
    
    4
  - setPreDecodeFrames
```
public boolean setPreDecodeFrames(int preDecodeFrames)
```
    Sets the number of frames to be decoded before this animation is displayed. This method is available only if dynamic decoding is enabled.
    
    参数:
    
    preDecodeFrames - Indicates the number of frames to set. The value ranges from 1 to 30.
    
    返回:
    
    Returns True if the preDecodeFrames is set properly; returns False otherwise.
    
    从以下版本开始:
    
    4
  - getPreDecodeFrames
```
public int getPreDecodeFrames()
```
    Obtains the number of frames to be decoded before this animation is displayed. This method is available only if dynamic decoding is enabled.
    
    返回:
    
    Returns the number of frames if obtained; returns -1 if dynamic decoding is disabled.
    
    从以下版本开始:
    
    4

类 FrameAnimationElement

嵌套类概要

从类继承的嵌套类/接口 ohos.agp.components.element.Element

从类继承的嵌套类/接口 ohos.agp.components.element.ElementContainer

字段概要

从类继承的字段 ohos.agp.components.element.Element

构造器概要

方法概要

从类继承的方法 ohos.agp.components.element.Element

从类继承的方法 ohos.agp.components.element.ElementContainer

从类继承的方法 java.lang.Object

构造器详细资料

FrameAnimationElement

FrameAnimationElement

方法详细资料

start

stop

getNumberOfFrames

getFrame

getDuration

isOneShot

setOneShot

addFrame

setDisposeMode

getDisposeMode

setPreDecodeFrames

getPreDecodeFrames