ComponentContainer.LayoutConfig

java.lang.Object
- ohos.agp.components.ComponentContainer.LayoutConfig

所有已实现的接口:

Cloneable

直接已知子类:

AdaptiveBoxLayout.LayoutConfig, DependentLayout.LayoutConfig, DirectionalLayout.LayoutConfig, FlexLayout.LayoutConfig, ListComponent.ListLayoutConfig, MagicLayout.LayoutConfig, SlideDrawer.LayoutConfig, StackLayout.LayoutConfig, TableLayout.LayoutConfig

封闭类:

ComponentContainer
```
public static class ComponentContainer.LayoutConfig
extends Object
implements Cloneable
```
Provides layout parameters, such as width and height and margin.
The margin layout information of each child component can be provided.

字段概要

字段
限定符和类型	字段	说明
`int`	`height`	component height.
`static int`	`MATCH_CONTENT`	`MATCH_CONTENT` means that the component will be big enough to enclose its content and use its own padding.
`static int`	`MATCH_PARENT`	`MATCH_PARENT` means that each child component will be the same size as its parent component, but the parent padding size (if any) needs to be deducted.
`int`	`width`	component width.

构造器概要

构造器
构造器	说明
`LayoutConfig()`	Default constructor used to create a `LayoutConfig` instance with the width and height set to MATCH_CONTENT by default.
`LayoutConfig(int width, int height)`	A constructor used to create a `LayoutConfig` instance by specifying width and height.
`LayoutConfig(ComponentContainer.LayoutConfig config)`	A constructor used to create a `LayoutConfig` instance from an existing `LayoutConfig` instance.
`LayoutConfig(Context context, AttrSet attrSet)`	Obtains attributes from `AttrSet` to instantiate `LayoutConfig`.

方法概要

所有方法实例方法具体方法
限定符和类型	方法	说明
`Object`	`clone()`	Creates and returns a copy of this object.
`int`	`getHorizontalEndMargin()`	Obtains the end margin.
`int`	`getHorizontalStartMargin()`	Obtains the start margin.
`Component.LayoutDirection`	`getLayoutDirection()`	Returns the layout direction: `LayoutDirection#LTR` or `LayoutDirection#RTL`
`int`	`getMarginBottom()`	Obtains the bottom margin.
`int`	`getMarginLeft()`	Obtains the left margin.
`int`	`getMarginRight()`	Obtains the right margin.
`int[]`	`getMargins()`	Obtains the left, top, right, and bottom margins of the component.
`int[]`	`getMarginsLeftAndRight()`	Obtains horizontal (left and right) margins of the component.
`int[]`	`getMarginsTopAndBottom()`	Obtains vertical (top and bottom) margins of the component.
`int`	`getMarginTop()`	Obtains the top margin.
`protected boolean`	`isMarginsRelative()`	Check if current margins is relative or not.
`void`	`setMarginBottom(int bottom)`	Sets the bottom margin for the component.
`void`	`setMarginLeft(int left)`	Sets the left margin for the component.
`void`	`setMarginRight(int right)`	Sets the right margin for the component.
`void`	`setMargins(int left, int top, int right, int bottom)`	Sets the margins in integers.
`void`	`setMarginsLeftAndRight(int left, int right)`	Sets horizontal (left and right) margins for the component.
`void`	`setMarginsRelative(int start, int top, int end, int bottom)`	Sets the relative margins in integers.
`void`	`setMarginsTopAndBottom(int top, int bottom)`	Sets vertical (top and bottom) margins for the component.
`void`	`setMarginTop(int top)`	Sets the top margin for the component.

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

- 字段详细资料
  - MATCH_CONTENT
```
public static final int MATCH_CONTENT
```
    MATCH_CONTENT means that the component will be big enough to enclose its content and use its own padding.
    
    另请参阅:
    
    常量字段值
  - MATCH_PARENT
```
public static final int MATCH_PARENT
```
    MATCH_PARENT means that each child component will be the same size as its parent component, but the parent padding size (if any) needs to be deducted.
    
    另请参阅:
    
    常量字段值
  - height
```
public int height
```
    component height.
    The height can be MATCH_PARENT, MATCH_CONTENT, or a specific value, in unit of pixels.
  - width
```
public int width
```
    component width.
    The width can be MATCH_PARENT, MATCH_CONTENT, or a specific value in unit of pixels.
- 构造器详细资料
  - LayoutConfig
```
public LayoutConfig()
```
    Default constructor used to create a LayoutConfig instance with the width and height set to MATCH_CONTENT by default.
    It sets the width and height of the layout to MATCH_CONTENT.
  - LayoutConfig
```
public LayoutConfig(Context context,
                    AttrSet attrSet)
```
    Obtains attributes from AttrSet to instantiate LayoutConfig.
    
    参数:
    
    context - Indicates the application context.
    
    attrSet - Indicates the attribute set to obtain.
  - LayoutConfig
```
public LayoutConfig(int width,
                    int height)
```
    A constructor used to create a LayoutConfig instance by specifying width and height.
    
    参数:
    
    width - Indicates the width in pixels. The value can be a fixed value, MATCH_CONTENT, or MATCH_PARENT.
    
    height - Indicates the height in pixels. The value can be a fixed value, MATCH_CONTENT, or MATCH_PARENT.
  - LayoutConfig
```
public LayoutConfig(ComponentContainer.LayoutConfig config)
```
    A constructor used to create a LayoutConfig instance from an existing LayoutConfig instance.
    
    参数:
    
    config - Indicates the layout parameters based on which the instance will be created.
- 方法详细资料
  - clone
```
public Object clone()
             throws CloneNotSupportedException
```
    Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:
    x.clone() != x
    will be true, and that the expression:
    x.clone().getClass() == x.getClass()
    will be true, but these are not absolute requirements. While it is typically the case that:
    x.clone().equals(x)
    will be true, this is not an absolute requirement.
    By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().
    By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.
    The method clone for class Object performs a specific cloning operation. First, if the class of this object does not implement the interface Cloneable, then a CloneNotSupportedException is thrown. Note that all arrays are considered to implement the interface Cloneable and that the return type of the clone method of an array type T[] is T[] where T is any reference or primitive type. Otherwise, this method creates a new instance of the class of this object and initializes all its fields with exactly the contents of the corresponding fields of this object, as if by assignment; the contents of the fields are not themselves cloned. Thus, this method performs a "shallow copy" of this object, not a "deep copy" operation.
    The class Object does not itself implement the interface Cloneable, so calling the clone method on an object whose class is Object will result in throwing an exception at run time.
    覆盖:
    
    clone 在类中 Object
    
    返回:
    
    a clone of this instance.
    
    抛出:
    
    CloneNotSupportedException - if the object's class does not support the Cloneable interface. Subclasses that override the clone method can also throw this exception to indicate that an instance cannot be cloned.
    
    另请参阅:
    
    Cloneable
  - setMargins
```
public void setMargins(int left,
                       int top,
                       int right,
                       int bottom)
```
    Sets the margins in integers.
    
    参数:
    
    left - Indicates the left margin, in pixels.
    
    top - Indicates the top margin, in pixels.
    
    right - Indicates the right margin, in pixels.
    
    bottom - Indicates the bottom margin, in pixels.
    
    另请参阅:
    
    setMarginsRelative(int, int, int, int), getMarginLeft(), getMarginTop(), getMarginRight(), getMarginBottom()
  - setMarginsRelative
```
public void setMarginsRelative(int start,
                               int top,
                               int end,
                               int bottom)
```
    Sets the relative margins in integers.
    
    参数:
    
    start - Indicates the start margin, in pixels.
    
    top - Indicates the top margin, in pixels.
    
    end - Indicates the end margin, in pixels.
    
    bottom - Indicates the bottom margin, in pixels.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    setMargins(int, int, int, int), getHorizontalStartMargin(), getMarginTop(), getHorizontalEndMargin(), getMarginBottom()
  - setMarginLeft
```
public void setMarginLeft(int left)
```
    Sets the left margin for the component.
    
    参数:
    
    left - Indicates the left margin to set, in pixels.
    
    从以下版本开始:
    
    4
  - setMarginTop
```
public void setMarginTop(int top)
```
    Sets the top margin for the component.
    
    参数:
    
    top - Indicates the top margin to set, in pixels.
    
    从以下版本开始:
    
    4
  - setMarginRight
```
public void setMarginRight(int right)
```
    Sets the right margin for the component.
    
    参数:
    
    right - Indicates the right margin to set, in pixels.
    
    从以下版本开始:
    
    4
  - setMarginBottom
```
public void setMarginBottom(int bottom)
```
    Sets the bottom margin for the component.
    
    参数:
    
    bottom - Indicates the bottom margin to set, in pixels.
    
    从以下版本开始:
    
    4
  - setMarginsLeftAndRight
```
public void setMarginsLeftAndRight(int left,
                                   int right)
```
    Sets horizontal (left and right) margins for the component.
    
    参数:
    
    left - Indicates the left margin to set, in pixels.
    
    right - Indicates the right margin to set, in pixels.
    
    从以下版本开始:
    
    4
  - setMarginsTopAndBottom
```
public void setMarginsTopAndBottom(int top,
                                   int bottom)
```
    Sets vertical (top and bottom) margins for the component.
    
    参数:
    
    top - Indicates the top margin to set, in pixels.
    
    bottom - Indicates the bottom margin to set, in pixels.
    
    从以下版本开始:
    
    4
  - getMargins
```
public int[] getMargins()
```
    Obtains the left, top, right, and bottom margins of the component.
    
    返回:
    
    Returns the left, top, right, and bottom margins, in pixels.
    
    从以下版本开始:
    
    4
    
    另请参阅:
    
    setMargins(int, int, int, int)
  - getMarginsLeftAndRight
```
public int[] getMarginsLeftAndRight()
```
    Obtains horizontal (left and right) margins of the component.
    
    返回:
    
    Returns the horizontal margins, in pixels.
    
    从以下版本开始:
    
    4
    
    另请参阅:
    
    setMarginsLeftAndRight(int, int)
  - getMarginsTopAndBottom
```
public int[] getMarginsTopAndBottom()
```
    Obtains vertical (top and bottom) margins of the component.
    
    返回:
    
    Returns the vertical margins, in pixels.
    
    从以下版本开始:
    
    4
    
    另请参阅:
    
    setMarginsTopAndBottom(int, int)
  - getMarginLeft
```
public int getMarginLeft()
```
    Obtains the left margin.
    
    返回:
    
    Returns the left margin in pixels.
    
    从以下版本开始:
    
    4
    
    另请参阅:
    
    setMargins(int, int, int, int)
  - getMarginTop
```
public int getMarginTop()
```
    Obtains the top margin.
    
    返回:
    
    Returns the top margin in pixels.
    
    从以下版本开始:
    
    4
    
    另请参阅:
    
    setMargins(int, int, int, int)
  - getMarginRight
```
public int getMarginRight()
```
    Obtains the right margin.
    
    返回:
    
    Returns the right margin in pixels.
    
    从以下版本开始:
    
    4
    
    另请参阅:
    
    setMargins(int, int, int, int)
  - getMarginBottom
```
public int getMarginBottom()
```
    Obtains the bottom margin.
    
    返回:
    
    Returns the bottom margin in pixels.
    
    从以下版本开始:
    
    4
    
    另请参阅:
    
    setMargins(int, int, int, int)
  - getHorizontalStartMargin
```
public int getHorizontalStartMargin()
```
    Obtains the start margin.
    
    返回:
    
    Returns the start margin in pixels.
    
    从以下版本开始:
    
    4
    
    另请参阅:
    
    setMarginsRelative(int, int, int, int), getHorizontalEndMargin()
  - getHorizontalEndMargin
```
public int getHorizontalEndMargin()
```
    Obtains the end margin.
    
    返回:
    
    Returns the end margin in pixels.
    
    从以下版本开始:
    
    4
    
    另请参阅:
    
    setMarginsRelative(int, int, int, int), getHorizontalStartMargin()
  - isMarginsRelative
```
protected boolean isMarginsRelative()
```
    Check if current margins is relative or not.
    
    返回:
    
    true if relative, otherwise false.
    
    从以下版本开始:
    
    4
  - getLayoutDirection
```
public Component.LayoutDirection getLayoutDirection()
```
    Returns the layout direction: LayoutDirection#LTR or LayoutDirection#RTL
    
    返回:
    
    Return the layout direction.
    
    从以下版本开始:
    
    3

类 ComponentContainer.LayoutConfig

字段概要

构造器概要

方法概要

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

字段详细资料

MATCH_CONTENT

MATCH_PARENT

height

width

构造器详细资料

LayoutConfig

LayoutConfig

LayoutConfig

LayoutConfig

方法详细资料

clone

setMargins

setMarginsRelative

setMarginLeft

setMarginTop

setMarginRight

setMarginBottom

setMarginsLeftAndRight

setMarginsTopAndBottom

getMargins

getMarginsLeftAndRight

getMarginsTopAndBottom

getMarginLeft

getMarginTop

getMarginRight

getMarginBottom

getHorizontalStartMargin

getHorizontalEndMargin

isMarginsRelative

getLayoutDirection