LayerElement

java.lang.Object
- ohos.agp.components.element.Element
- - ohos.agp.components.element.LayerElement

```
public class LayerElement
extends Element
```
Provides an element that manages a list of other elements.
These elements are drawn in list order. Therefore, the element with the largest index will be drawn on the top of the layer. That element can be defined in an XML file with the xml-tag, and other elements in the LayerElement are defined in a nested xml-tag. A LayerElement has its own bounds and padding that are common for all internal elements. Every internal element can also have its own bounds, inlays, and size. These properties allow you to position the internal elements within the LayerElement.

从以下版本开始:

7

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

字段概要

字段
限定符和类型	字段	说明
`static int`	`DEPENDENT`	Indicates the mode used to nest each layer element inside the inlay of the previous element.
`static int`	`INDEPENDENT`	Indicates the mode used to nest each layer element inside the inlay of the parent element.

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

构造器概要

构造器
构造器	说明
`LayerElement()`	Default constructor used to create a `LayerElement`.
`LayerElement(Element[] elements)`	A constructor used to create a `LayerElement` with a list of specified elements.

方法概要

所有方法实例方法具体方法
限定符和类型	方法	说明
`int`	`addElement(Element element)`	Adds an element to this `LayerElement`.
`int`	`getCount()`	Obtains the number of elements within this `LayerElement`.
`Optional<Element>`	`getElement(int index)`	Obtains the element with the specified index within this `LayerElement`.
`int`	`getElementAlignment(int index)`	Obtains the alignment used to position or stretch the specified element within its container.
`int`	`getElementHeight(int index)`	Obtains the explicit height of the specified element within this `LayerElement`.
`int`	`getElementInlayBottom(int index)`	Obtains the inlay from the bottom bound of the specified element.
`int`	`getElementInlayEnd(int index)`	Obtains the inlay from the end bound of the specified element.
`int`	`getElementInlayLeft(int index)`	Obtains the inlay from the left bound of the specified element.
`int`	`getElementInlayRight(int index)`	Obtains the inlay from the right bound of the specified element.
`int`	`getElementInlayStart(int index)`	Obtains the inlay from the start bound of the specified element.
`int`	`getElementInlayTop(int index)`	Obtains the inlay from the top bound of the specified element.
`int`	`getElementWidth(int index)`	Obtains the explicit width of the specified element within this `LayerElement`.
`int`	`getPaddingBottom()`	Obtains the bottom padding of this `LayerElement`.
`int`	`getPaddingEnd()`	Obtains the end padding of this `LayerElement`.
`int`	`getPaddingLeft()`	Obtains the left padding of this `LayerElement`.
`int`	`getPaddingMode()`	Obtains the padding mode of this `LayerElement`.
`int`	`getPaddingRight()`	Obtains the right padding of this `LayerElement`.
`int`	`getPaddingStart()`	Obtains the start padding of this `LayerElement`.
`int`	`getPaddingTop()`	Obtains the top padding of this `LayerElement`.
`Optional<Element>`	`getTop()`	Obtains the top element within this `LayerElement`.
`int`	`replaceElement(int index, Element element)`	Replaces the element with the specified index within this `LayerElement`.
`boolean`	`setElementAlignment(int index, int alignment)`	Sets the alignment used to position or stretch the specified element within its container.
`boolean`	`setElementHeight(int index, int height)`	Sets an explicit height for the specified element within this `LayerElement`.
`boolean`	`setElementInlay(int index, int left, int top, int right, int bottom)`	Sets the inlay for the specified element within this `LayerElement`.
`boolean`	`setElementInlayRtl(int index, int start, int top, int end, int bottom)`	Sets the relative inlay for the specified element.
`boolean`	`setElementSize(int index, int width, int height)`	Sets an explicit width and height for the specified element within this `LayerElement`.
`boolean`	`setElementWidth(int index, int width)`	Sets an explicit width for the specified element within this `LayerElement`.
`void`	`setPadding(int left, int top, int right, int bottom)`	Sets the absolute padding for this `LayerElement`.
`void`	`setPaddingMode(int mode)`	Sets the padding mode for this `LayerElement`.
`void`	`setPaddingRtl(int start, int top, int end, int bottom)`	Sets the relative padding for this `LayerElement`.

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

- 字段详细资料
  - DEPENDENT
```
public static final int DEPENDENT
```
    Indicates the mode used to nest each layer element inside the inlay of the previous element.
    
    从以下版本开始:
    
    7
    
    另请参阅:
    
    常量字段值
  - INDEPENDENT
```
public static final int INDEPENDENT
```
    Indicates the mode used to nest each layer element inside the inlay of the parent element.
    
    从以下版本开始:
    
    7
    
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - LayerElement
```
public LayerElement(Element[] elements)
```
    A constructor used to create a LayerElement with a list of specified elements.
    
    参数:
    
    elements - Indicates the array of elements to be added as internal items of this LayerElement.
    
    从以下版本开始:
    
    7
  - LayerElement
```
public LayerElement()
```
    Default constructor used to create a LayerElement.
    
    从以下版本开始:
    
    7
- 方法详细资料
  - addElement
```
public int addElement(Element element)
```
    Adds an element to this LayerElement.
    
    参数:
    
    element - Indicates the element to add.
    
    返回:
    
    Returns the index of the element if the operation is successful; returns -1 if the parameter is invalid.
    
    从以下版本开始:
    
    7
  - replaceElement
```
public int replaceElement(int index,
                          Element element)
```
    Replaces the element with the specified index within this LayerElement.
    
    参数:
    
    index - Indicates the index of the element to be replaced. The value must be in the range between 0 and - 1.
    
    element - Indicates the element to be used for the replacement.
    
    返回:
    
    Returns the index of the new element if the operation is successful; returns -1 if one of the parameters is invalid.
    
    从以下版本开始:
    
    7
  - getElement
```
public Optional<Element> getElement(int index)
```
    Obtains the element with the specified index within this LayerElement.
    
    参数:
    
    index - Indicates the index of the element. The value must be in the range between 0 and getCount().
    
    返回:
    
    Returns the element as an Optional object if the operation is successful; returns an empty Optional object if the parameter is invalid.
    
    从以下版本开始:
    
    7
  - getTop
```
public Optional<Element> getTop()
```
    Obtains the top element within this LayerElement.
    
    返回:
    
    Returns the top element as an Optional object if the operation is successful; returns an empty Optional object if the LayerElement is empty.
    
    从以下版本开始:
    
    7
  - getCount
```
public int getCount()
```
    Obtains the number of elements within this LayerElement.
    
    返回:
    
    Returns the number of elements.
    
    从以下版本开始:
    
    7
  - setElementSize
```
public boolean setElementSize(int index,
                              int width,
                              int height)
```
    Sets an explicit width and height for the specified element within this LayerElement.
    
    参数:
    
    index - Indicates the index of the element. The value must be in the range between 0 and getCount().
    
    width - Indicates the width to set, in pixels. The value -1 means that the optimal width will be used.
    
    height - Indicates the height to set, in pixels. The value -1 means that the optimal height will be used.
    
    返回:
    
    Returns true if the operation is successful; returns false otherwise.
    
    从以下版本开始:
    
    7
  - setElementWidth
```
public boolean setElementWidth(int index,
                               int width)
```
    Sets an explicit width for the specified element within this LayerElement.
    
    参数:
    
    index - Indicates the index of the element. The value must be in the range between 0 and getCount().
    
    width - Indicates the width to set, in pixels. The value -1 means that the optimal width will be used.
    
    返回:
    
    Returns true if the operation is successful; returns false otherwise.
    
    从以下版本开始:
    
    7
  - setElementHeight
```
public boolean setElementHeight(int index,
                                int height)
```
    Sets an explicit height for the specified element within this LayerElement.
    
    参数:
    
    index - Indicates the index of the element. The value must be in the range between 0 and getCount().
    
    height - Indicates the height to set, in pixels. The value -1 means that the optimal height will be used.
    
    返回:
    
    Returns true if the operation is successful; returns false otherwise.
    
    从以下版本开始:
    
    7
  - getElementWidth
```
public int getElementWidth(int index)
```
    Obtains the explicit width of the specified element within this LayerElement.
    
    参数:
    
    index - Indicates the index of the element. The value must be in the range between 0 and getCount().
    
    返回:
    
    Returns the explicit width of the element, in pixels, if the operation is successful; returns -1 otherwise.
    
    从以下版本开始:
    
    7
  - getElementHeight
```
public int getElementHeight(int index)
```
    Obtains the explicit height of the specified element within this LayerElement.
    
    参数:
    
    index - Indicates the index of the element. The value must be in the range between 0 and getCount().
    
    返回:
    
    Returns the explicit height of the element, in pixels, if the operation is successful; returns -1 otherwise.
    
    从以下版本开始:
    
    7
  - setElementAlignment
```
public boolean setElementAlignment(int index,
                                   int alignment)
```
    Sets the alignment used to position or stretch the specified element within its container.
    
    参数:
    
    index - Indicates the index of the element. The value must be in the range between 0 and getCount().
    
    alignment - Indicates the alignment to set.
    
    返回:
    
    Returns true if the operation is successful; returns false otherwise.
    
    从以下版本开始:
    
    7
  - getElementAlignment
```
public int getElementAlignment(int index)
```
    Obtains the alignment used to position or stretch the specified element within its container.
    
    参数:
    
    index - Indicates the index of the element. The value must be in the range between 0 and getCount().
    
    返回:
    
    Returns the alignment if the operation is successful; returns -1 if the parameter is invalid.
    
    从以下版本开始:
    
    7
  - setElementInlay
```
public boolean setElementInlay(int index,
                               int left,
                               int top,
                               int right,
                               int bottom)
```
    Sets the inlay for the specified element within this LayerElement.
    
    参数:
    
    index - Indicates the index of the element. The value must be in the range between 0 and getCount().
    
    left - Indicates the left inlay to add to the left bound of the element, in pixels.
    
    top - Indicates the top inlay to add to the top bound of the element, in pixels.
    
    right - Indicates the right inlay to add to the right bound of the element, in pixels.
    
    bottom - Indicates the bottom inlay to add to the bottom bound of the element, in pixels.
    
    返回:
    
    Returns true if the operation is successful; returns false otherwise.
    
    从以下版本开始:
    
    7
  - setElementInlayRtl
```
public boolean setElementInlayRtl(int index,
                                  int start,
                                  int top,
                                  int end,
                                  int bottom)
```
    Sets the relative inlay for the specified element.
    
    参数:
    
    index - Indicates the index of the element. The value must be in the range between 0 and getCount().
    
    start - Indicates the start inlay to add to the start bound of the element, in pixels.
    
    top - Indicates the top inlay to add to the top bound of the element, in pixels.
    
    end - Indicates the end inlay to add to the end bound of the element, in pixels.
    
    bottom - Indicates the bottom inlay to add to the bottom bound of the element, in pixels.
    
    返回:
    
    Returns true if the operation is successful; returns false otherwise.
    
    从以下版本开始:
    
    7
  - getElementInlayLeft
```
public int getElementInlayLeft(int index)
```
    Obtains the inlay from the left bound of the specified element.
    
    参数:
    
    index - Indicates the index of the element. The value must be in the range between 0 and getCount().
    
    返回:
    
    Returns the inlay, in pixels, if the operation is successful; returns -1 otherwise.
    
    从以下版本开始:
    
    7
  - getElementInlayTop
```
public int getElementInlayTop(int index)
```
    Obtains the inlay from the top bound of the specified element.
    
    参数:
    
    index - Indicates the index of the element. The value must be in the range between 0 and getCount().
    
    返回:
    
    Returns the inlay, in pixels, if the operation is successful; returns -1 otherwise.
    
    从以下版本开始:
    
    7
  - getElementInlayRight
```
public int getElementInlayRight(int index)
```
    Obtains the inlay from the right bound of the specified element.
    
    参数:
    
    index - Indicates the index of the element. The value must be in the range between 0 and getCount().
    
    返回:
    
    Returns the inlay, in pixels, if the operation is successful; returns -1 otherwise.
    
    从以下版本开始:
    
    7
  - getElementInlayBottom
```
public int getElementInlayBottom(int index)
```
    Obtains the inlay from the bottom bound of the specified element.
    
    参数:
    
    index - Indicates the index of the element. The value must be in the range between 0 and getCount().
    
    返回:
    
    Returns the inlay, in pixels, if the operation is successful; returns -1 otherwise.
    
    从以下版本开始:
    
    7
  - getElementInlayStart
```
public int getElementInlayStart(int index)
```
    Obtains the inlay from the start bound of the specified element.
    
    参数:
    
    index - Indicates the index of the element. The value must be in the range between 0 and getCount().
    
    返回:
    
    Returns the inlay, in pixels, if the operation is successful; returns -1 otherwise.
    
    从以下版本开始:
    
    7
  - getElementInlayEnd
```
public int getElementInlayEnd(int index)
```
    Obtains the inlay from the end bound of the specified element.
    
    参数:
    
    index - Indicates the index of the element. The value must be in the range between 0 and getCount().
    
    返回:
    
    Returns the inlay, in pixels, if the operation is successful; returns -1 otherwise.
    
    从以下版本开始:
    
    7
  - setPaddingMode
```
public void setPaddingMode(int mode)
```
    Sets the padding mode for this LayerElement.
    The padding mode will affect the bounds of each layer in this LayerElement.
    
    参数:
    
    mode - Indicates the padding mode to set. The value can be DEPENDENT or INDEPENDENT. The default value is INDEPENDENT.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if the value of mode is not DEPENDENT or INDEPENDENT.
    
    从以下版本开始:
    
    7
  - getPaddingMode
```
public int getPaddingMode()
```
    Obtains the padding mode of this LayerElement.
    
    返回:
    
    Returns the padding mode, which can be DEPENDENT or INDEPENDENT.
    
    从以下版本开始:
    
    7
  - setPadding
```
public void setPadding(int left,
                       int top,
                       int right,
                       int bottom)
```
    Sets the absolute padding for this LayerElement.
    
    参数:
    
    left - Indicates the left padding to set, in pixels.
    
    top - Indicates the top padding to set, in pixels.
    
    right - Indicates the right padding to set, in pixels.
    
    bottom - Indicates the bottom padding to set, in pixels.
    
    从以下版本开始:
    
    7
  - setPaddingRtl
```
public void setPaddingRtl(int start,
                          int top,
                          int end,
                          int bottom)
```
    Sets the relative padding for this LayerElement.
    
    参数:
    
    start - Indicates the start padding to set, in pixels.
    
    top - Indicates the top padding to set, in pixels.
    
    end - Indicates the end padding to set, in pixels.
    
    bottom - Indicates the bottom padding to set, in pixels.
    
    从以下版本开始:
    
    7
  - getPaddingLeft
```
public int getPaddingLeft()
```
    Obtains the left padding of this LayerElement.
    
    返回:
    
    Returns the left padding, in pixels.
    
    从以下版本开始:
    
    7
  - getPaddingTop
```
public int getPaddingTop()
```
    Obtains the top padding of this LayerElement.
    
    返回:
    
    Returns the top padding, in pixels.
    
    从以下版本开始:
    
    7
  - getPaddingRight
```
public int getPaddingRight()
```
    Obtains the right padding of this LayerElement.
    
    返回:
    
    Returns the right padding, in pixels.
    
    从以下版本开始:
    
    7
  - getPaddingBottom
```
public int getPaddingBottom()
```
    Obtains the bottom padding of this LayerElement.
    
    返回:
    
    Returns the bottom padding, in pixels.
    
    从以下版本开始:
    
    7
  - getPaddingStart
```
public int getPaddingStart()
```
    Obtains the start padding of this LayerElement.
    
    返回:
    
    Returns the start padding, in pixels.
    
    从以下版本开始:
    
    7
  - getPaddingEnd
```
public int getPaddingEnd()
```
    Obtains the end padding of this LayerElement.
    
    返回:
    
    Returns the end padding, in pixels.
    
    从以下版本开始:
    
    7

类 LayerElement

嵌套类概要

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

字段概要

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

构造器概要

方法概要

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

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

字段详细资料

DEPENDENT

INDEPENDENT

构造器详细资料

LayerElement

LayerElement

方法详细资料

addElement

replaceElement

getElement

getTop

getCount

setElementSize

setElementWidth

setElementHeight

getElementWidth

getElementHeight

setElementAlignment

getElementAlignment

setElementInlay

setElementInlayRtl

getElementInlayLeft

getElementInlayTop

getElementInlayRight

getElementInlayBottom

getElementInlayStart

getElementInlayEnd

setPaddingMode

getPaddingMode

setPadding

setPaddingRtl

getPaddingLeft

getPaddingTop

getPaddingRight

getPaddingBottom

getPaddingStart

getPaddingEnd