ColumnSystem

java.lang.Object
- ohos.agp.components.ColumnSystem

```
public class ColumnSystem
extends Object
```
Represents a responsive layout design mechanism that can accommodate different screen sizes and orientations. The column system can be used as an auxiliary positioning tool for UI layout to ensure consistent experience across devices.
The column system has three basic attributes: column, gutter, and margin.
- Columns are used for positioning in the UI layout. The positioning for different screen sizes is determined by the number of columns. The column width is automatically calculated based on the actual device width and the number of columns when the margins and gutters meet the specifications.
- Gutters are used to control the spacing between elements. You can define different gutter values based on the screen sizes to serve as the unified specifications for breakpoints. To achieve a sound visual effect, set the gutter value to one not greater than the margin value.
- Margins are used to control the padding between elements and edges of a screen. You can define different margins based on the screen sizes to serve as the unified specifications for breakpoints.
从以下版本开始:

7

字段概要

字段
限定符和类型	字段	说明
`static int`	`BOTTOM_SHEET_TYPE`	Indicates the column type for bottom sheets.
`static int`	`BUBBLE_TYPE`	Indicates the bubble column type.
`static int`	`CARD_DOUBLE_BUTTON_TYPE`	Indicates the double-button column type for card.
`static int`	`CARD_SINGLE_BUTTON_TYPE`	Indicates the single-button column type for card.
`static int`	`CARD_TYPE`	Indicates the card column type.
`static int`	`CONTENT_TYPE`	Indicates the content column type.
`static int`	`CUSTOM_TYPE`	Indicates a custom column type.
`static int`	`DIALOG_TYPE`	Indicates the dialog column type.
`static int`	`DOUBLE_BUTTON_TYPE`	Indicates the double-button column type.
`static int`	`LARGE_BOTTOMTAB_TYPE`	Indicates the column type for the large bottom tab (that is, a bottom tab that has more than three items).
`static int`	`LARGE_TOOLBAR_TYPE`	Indicates the column type for the large toolbar (that is, a toolbar that has four or fix items).
`static int`	`MENU_TYPE`	Indicates the menu column type.
`static int`	`SINGLE_BUTTON_TYPE`	Indicates the single-button column type.
`static int`	`SMALL_BOTTOMTAB_TYPE`	Indicates the column type for the small bottom tab (that is, a bottom tab that has three items or less).
`static int`	`SMALL_TOOLBAR_TYPE`	Indicates the column type for the small toolbar (that is, a toolbar that has two or three items).
`static int`	`TOAST_TYPE`	Indicates the toast column type.

构造器概要

构造器
构造器	说明
`ColumnSystem(Context context)`	A constructor used to create a default `ColumnSystem` instance.
`ColumnSystem(Context context, int columnType)`	Creates a `ColumnSystem` instance of a specified column type.

方法概要

所有方法实例方法具体方法
限定符和类型	方法	说明
`int`	`getColumnType()`	Obtains the column type of the current column system.
`float`	`getColumnWidth(int columnCount)`	Obtains the total width of a specified number of columns.
`int`	`getGutter()`	Obtains the gutter width of the column system.
`int`	`getMargin()`	Obtains the margin width of the column system.
`int`	`getMaxColumnWidth()`	Obtains the maximum column width of a specified column type.
`int`	`getMinColumnWidth()`	Obtains the minimum column width of a specified column type.
`int`	`getSuggestedWidth()`	Obtains the width for the current column type.
`int`	`getTotalColumnCount()`	Obtains the total number of columns in the current column system.
`void`	`setColumnType(int columnType)`	Sets the column type of the current column system.
`int`	`updateConfiguration(int width, int height, float density)`	Sets the effective area of the column system to partial window.
`int`	`updateConfiguration(Context context)`	Sets the effective area of the column system to complete window.

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

- 字段详细资料
  - BOTTOM_SHEET_TYPE
```
public static final int BOTTOM_SHEET_TYPE
```
    Indicates the column type for bottom sheets.
    
    从以下版本开始:
    
    7
    
    另请参阅:
    
    常量字段值
  - BUBBLE_TYPE
```
public static final int BUBBLE_TYPE
```
    Indicates the bubble column type.
    
    从以下版本开始:
    
    7
    
    另请参阅:
    
    常量字段值
  - CARD_DOUBLE_BUTTON_TYPE
```
public static final int CARD_DOUBLE_BUTTON_TYPE
```
    Indicates the double-button column type for card.
    
    从以下版本开始:
    
    7
    
    另请参阅:
    
    常量字段值
  - CARD_SINGLE_BUTTON_TYPE
```
public static final int CARD_SINGLE_BUTTON_TYPE
```
    Indicates the single-button column type for card.
    
    从以下版本开始:
    
    7
    
    另请参阅:
    
    常量字段值
  - CARD_TYPE
```
public static final int CARD_TYPE
```
    Indicates the card column type.
    
    从以下版本开始:
    
    7
    
    另请参阅:
    
    常量字段值
  - CONTENT_TYPE
```
public static final int CONTENT_TYPE
```
    Indicates the content column type.
    
    从以下版本开始:
    
    7
    
    另请参阅:
    
    常量字段值
  - CUSTOM_TYPE
```
public static final int CUSTOM_TYPE
```
    Indicates a custom column type.
    
    从以下版本开始:
    
    7
    
    另请参阅:
    
    常量字段值
  - DIALOG_TYPE
```
public static final int DIALOG_TYPE
```
    Indicates the dialog column type.
    This column type can be automatically adapted to four sub-types based on the window size and window width/height ratio:
    - Window size < 12 and window width/height ratio > 9:16
    - Window size < 12 and window width/height ratio <= 9:16
    - Window size >= 12 and window width/height ratio > 9:16
    - Window size >= 12 and window width/height ratio <= 9:16
    从以下版本开始:
    
    7
    
    另请参阅:
    
    常量字段值
  - DOUBLE_BUTTON_TYPE
```
public static final int DOUBLE_BUTTON_TYPE
```
    Indicates the double-button column type.
    
    从以下版本开始:
    
    7
    
    另请参阅:
    
    常量字段值
  - LARGE_BOTTOMTAB_TYPE
```
public static final int LARGE_BOTTOMTAB_TYPE
```
    Indicates the column type for the large bottom tab (that is, a bottom tab that has more than three items).
    
    从以下版本开始:
    
    7
    
    另请参阅:
    
    常量字段值
  - LARGE_TOOLBAR_TYPE
```
public static final int LARGE_TOOLBAR_TYPE
```
    Indicates the column type for the large toolbar (that is, a toolbar that has four or fix items).
    
    从以下版本开始:
    
    7
    
    另请参阅:
    
    常量字段值
  - MENU_TYPE
```
public static final int MENU_TYPE
```
    Indicates the menu column type.
    
    从以下版本开始:
    
    7
    
    另请参阅:
    
    常量字段值
  - SINGLE_BUTTON_TYPE
```
public static final int SINGLE_BUTTON_TYPE
```
    Indicates the single-button column type.
    
    从以下版本开始:
    
    7
    
    另请参阅:
    
    常量字段值
  - SMALL_BOTTOMTAB_TYPE
```
public static final int SMALL_BOTTOMTAB_TYPE
```
    Indicates the column type for the small bottom tab (that is, a bottom tab that has three items or less).
    
    从以下版本开始:
    
    7
    
    另请参阅:
    
    常量字段值
  - SMALL_TOOLBAR_TYPE
```
public static final int SMALL_TOOLBAR_TYPE
```
    Indicates the column type for the small toolbar (that is, a toolbar that has two or three items).
    
    从以下版本开始:
    
    7
    
    另请参阅:
    
    常量字段值
  - TOAST_TYPE
```
public static final int TOAST_TYPE
```
    Indicates the toast column type.
    
    从以下版本开始:
    
    7
    
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - ColumnSystem
```
public ColumnSystem(Context context)
```
    A constructor used to create a default ColumnSystem instance.
    
    参数:
    
    context - Indicates the application context.
    
    从以下版本开始:
    
    7
  - ColumnSystem
```
public ColumnSystem(Context context,
                    int columnType)
```
    Creates a ColumnSystem instance of a specified column type.
    
    参数:
    
    context - Indicates the application context.
    
    columnType - Indicates the column type.
    
    从以下版本开始:
    
    7
- 方法详细资料
  - getTotalColumnCount
```
public int getTotalColumnCount()
```
    Obtains the total number of columns in the current column system.
    
    返回:
    
    Returns the total number of columns in the current column system.
    
    从以下版本开始:
    
    7
  - getSuggestedWidth
```
public int getSuggestedWidth()
```
    Obtains the width for the current column type.
    When you create a ColumnSystem instance using ColumnSystem(ohos.app.Context), the return value is the width for the default column type. When you create a ColumnSystem instance using ColumnSystem(ohos.app.Context,int), the return value is the width for the specified column type. For the column type that uses a width range, for example, ColumnSystem.SINGLE_BUTTON_TYPE, the return value is the minimum width.
    
    返回:
    
    Returns the width for the current column type.
    
    从以下版本开始:
    
    7
  - getColumnWidth
```
public float getColumnWidth(int columnCount)
```
    Obtains the total width of a specified number of columns.
    
    参数:
    
    columnCount - Indicates the number of columns.
    
    返回:
    
    Returns the total width of the specified number of columns. For example, value 6 indicates the total width of six columns and five gutters.
    
    从以下版本开始:
    
    7
  - getColumnType
```
public int getColumnType()
```
    Obtains the column type of the current column system.
    
    返回:
    
    Returns the column type of the current column system.
    
    从以下版本开始:
    
    7
  - setColumnType
```
public void setColumnType(int columnType)
```
    Sets the column type of the current column system.
    
    参数:
    
    columnType - Indicates the column type.
    
    从以下版本开始:
    
    7
  - getMargin
```
public int getMargin()
```
    Obtains the margin width of the column system.
    
    返回:
    
    Returns the margin width of the column system.
    
    从以下版本开始:
    
    7
  - getGutter
```
public int getGutter()
```
    Obtains the gutter width of the column system.
    
    返回:
    
    Returns the gutter width of the column system.
    
    从以下版本开始:
    
    7
  - getMinColumnWidth
```
public int getMinColumnWidth()
```
    Obtains the minimum column width of a specified column type.
    
    返回:
    
    Returns the minimum column width if the specified column type, for example, ColumnSystem.SINGLE_BUTTON_TYPE, uses a width range; returns a fixed value if the specified column type uses a fixed width.
    
    从以下版本开始:
    
    7
  - getMaxColumnWidth
```
public int getMaxColumnWidth()
```
    Obtains the maximum column width of a specified column type.
    
    返回:
    
    Returns the maximum column width if the specified column type, for example, ColumnSystem.SINGLE_BUTTON_TYPE, uses a width range; returns a fixed value if the specified column type uses a fixed width.
    
    从以下版本开始:
    
    7
  - updateConfiguration
```
public int updateConfiguration(Context context)
```
    Sets the effective area of the column system to complete window.
    
    参数:
    
    context - Indicates the application context.
    
    返回:
    
    Returns the column width used by the current column type if the setting is successful; returns the previous value if the setting has failed.
    
    从以下版本开始:
    
    7
  - updateConfiguration
```
public int updateConfiguration(int width,
                               int height,
                               float density)
```
    Sets the effective area of the column system to partial window.
    
    参数:
    
    width - Indicates the width of the effective area.
    
    height - Indicates the height of the effective area.
    
    density - Indicates the screen density of the effective area. Generally, the value of density is the same as that on the device.
    
    返回:
    
    Returns the column width used by the current column type if the setting is successful; returns the previous value if the setting has failed.
    
    从以下版本开始:
    
    7

类 ColumnSystem

字段概要

构造器概要

方法概要

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

字段详细资料

BOTTOM_SHEET_TYPE

BUBBLE_TYPE

CARD_DOUBLE_BUTTON_TYPE

CARD_SINGLE_BUTTON_TYPE

CARD_TYPE

CONTENT_TYPE

CUSTOM_TYPE

DIALOG_TYPE

DOUBLE_BUTTON_TYPE

LARGE_BOTTOMTAB_TYPE

LARGE_TOOLBAR_TYPE

MENU_TYPE

SINGLE_BUTTON_TYPE

SMALL_BOTTOMTAB_TYPE

SMALL_TOOLBAR_TYPE

TOAST_TYPE

构造器详细资料

ColumnSystem

ColumnSystem

方法详细资料

getTotalColumnCount

getSuggestedWidth

getColumnWidth

getColumnType

setColumnType

getMargin

getGutter

getMinColumnWidth

getMaxColumnWidth

updateConfiguration

updateConfiguration