Class HorizontalLayout

HorizontalLayout 类按水平顺序从左到右排列布局元素，在元素和围绕元素的可选填充之间带有可选间隙。

Version

Egret 2.4

Version

eui 1.0

Platform

Web

Include Example

extension/eui/layout/HorizontalLayoutExample.ts

Language

zh_CN

Hierarchy (View Summary)

LinearLayoutBase
- HorizontalLayout

Constructors

constructor

new HorizontalLayout(): HorizontalLayout
构造函数。

Returns HorizontalLayout

Version
Egret 2.4

Version
eui 1.0

Platform
Web

Language
zh_CN
Inherited from LinearLayoutBase.constructor
- Defined in extension/eui/layouts/supportClasses/LayoutBase.ts:52

Properties

`Protected`elementSizeTable

elementSizeTable: number[] = []

虚拟布局使用的尺寸缓存。

Version

Egret 2.4

Version

eui 1.0

Platform

Web

Language

zh_CN

`Protected`startIndex

startIndex: number = -1

虚拟布局使用的当前视图中的第一个元素索引

Version

Egret 2.4

Version

eui 1.0

Platform

Web

Language

zh_CN

`Protected`endIndex

endIndex: number = -1

虚拟布局使用的当前视图中的最后一个元素的索引

Version

Egret 2.4

Version

eui 1.0

Platform

Web

Language

zh_CN

`Protected`indexInViewCalculated

indexInViewCalculated: boolean = false

视图的第一个和最后一个元素的索引值已经计算好的标志

Version

Egret 2.4

Version

eui 1.0

Platform

Web

Language

zh_CN

`Protected`maxElementSize

maxElementSize: number = 0

子元素最大的尺寸

Version

Egret 2.4

Version

eui 1.0

Platform

Web

Language

zh_CN

Accessors

target

get target(): Group
此布局将测量其元素、调整其元素的大小并定位其元素的 Group 容器。

Returns Group

Version
Egret 2.4

Version
eui 1.0

Platform
Web

Language
zh_CN
Inherited from LinearLayoutBase.target
- Defined in extension/eui/layouts/supportClasses/LayoutBase.ts:78
set target(value: Group): void
Parameters
- value: Group
Returns void
Inherited from LinearLayoutBase.target
- Defined in extension/eui/layouts/supportClasses/LayoutBase.ts:82

useVirtualLayout

get useVirtualLayout(): boolean
若要配置容器使用虚拟布局，请为与容器关联的布局的 useVirtualLayout 属性设置为 true。只有布局设置为 VerticalLayout、HorizontalLayout 或 TileLayout 的 DataGroup 才支持虚拟布局。不支持虚拟化的布局子类必须禁止更改此属性。

Returns boolean
Default
```
false
```
Version
Egret 2.4

Version
eui 1.0

Platform
Web

Language
zh_CN
Inherited from LinearLayoutBase.useVirtualLayout
- Defined in extension/eui/layouts/supportClasses/LayoutBase.ts:121
set useVirtualLayout(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from LinearLayoutBase.useVirtualLayout
- Defined in extension/eui/layouts/supportClasses/LayoutBase.ts:125

horizontalAlign

get horizontalAlign(): string
布局元素的水平对齐策略。

HorizontalAlign 和 JustifyAlign类定义此属性的可能值。

Returns string
Default
```
"left"
```
Version
Egret 2.4

Version
eui 1.0

Platform
Web

Language
zh_CN
Inherited from LinearLayoutBase.horizontalAlign
- Defined in extension/eui/layouts/supportClasses/LinearLayoutBase.ts:59
set horizontalAlign(value: string): void
Parameters
- value: string
Returns void
Inherited from LinearLayoutBase.horizontalAlign
- Defined in extension/eui/layouts/supportClasses/LinearLayoutBase.ts:63

verticalAlign

get verticalAlign(): string
布局元素的垂直对齐策略。请使用 VerticalAlign 定义的常量。

VerticalAlign 和 JustifyAlign类定义此属性的可能值。

Returns string
Default
```
"top"
```
Version
Egret 2.4

Version
eui 1.0

Platform
Web

Language
zh_CN
Inherited from LinearLayoutBase.verticalAlign
- Defined in extension/eui/layouts/supportClasses/LinearLayoutBase.ts:100
set verticalAlign(value: string): void
Parameters
- value: string
Returns void
Inherited from LinearLayoutBase.verticalAlign
- Defined in extension/eui/layouts/supportClasses/LinearLayoutBase.ts:104

gap

get gap(): number
布局元素之间的间隔（以像素为单位）。

Returns number
Default
```
6
```
Version
Egret 2.4

Version
eui 1.0

Platform
Web

Language
zh_CN
Inherited from LinearLayoutBase.gap
- Defined in extension/eui/layouts/supportClasses/LinearLayoutBase.ts:137
set gap(value: number): void
Parameters
- value: number
Returns void
Inherited from LinearLayoutBase.gap
- Defined in extension/eui/layouts/supportClasses/LinearLayoutBase.ts:141

paddingLeft

get paddingLeft(): number
容器的左边缘与第一个布局元素的左边缘之间的像素数。

Returns number
Default
```
0
```
Version
Egret 2.4

Version
eui 1.0

Platform
Web

Language
zh_CN
Inherited from LinearLayoutBase.paddingLeft
- Defined in extension/eui/layouts/supportClasses/LinearLayoutBase.ts:175
set paddingLeft(value: number): void
Parameters
- value: number
Returns void
Inherited from LinearLayoutBase.paddingLeft
- Defined in extension/eui/layouts/supportClasses/LinearLayoutBase.ts:179

paddingRight

get paddingRight(): number
容器的右边缘与最后一个布局元素的右边缘之间的像素数。

Returns number
Default
```
0
```
Version
Egret 2.4

Version
eui 1.0

Platform
Web

Language
zh_CN
Inherited from LinearLayoutBase.paddingRight
- Defined in extension/eui/layouts/supportClasses/LinearLayoutBase.ts:214
set paddingRight(value: number): void
Parameters
- value: number
Returns void
Inherited from LinearLayoutBase.paddingRight
- Defined in extension/eui/layouts/supportClasses/LinearLayoutBase.ts:218

paddingTop

get paddingTop(): number
容器的顶边缘与所有容器的布局元素的顶边缘之间的最少像素数。

Returns number
Default
```
0
```
Version
Egret 2.4

Version
eui 1.0

Platform
Web

Language
zh_CN
Inherited from LinearLayoutBase.paddingTop
- Defined in extension/eui/layouts/supportClasses/LinearLayoutBase.ts:253
set paddingTop(value: number): void
Parameters
- value: number
Returns void
Inherited from LinearLayoutBase.paddingTop
- Defined in extension/eui/layouts/supportClasses/LinearLayoutBase.ts:257

paddingBottom

get paddingBottom(): number
容器的底边缘与所有容器的布局元素的底边缘之间的最少像素数。

Returns number
Default
```
0
```
Version
Egret 2.4

Version
eui 1.0

Platform
Web

Language
zh_CN
Inherited from LinearLayoutBase.paddingBottom
- Defined in extension/eui/layouts/supportClasses/LinearLayoutBase.ts:292
set paddingBottom(value: number): void
Parameters
- value: number
Returns void
Inherited from LinearLayoutBase.paddingBottom
- Defined in extension/eui/layouts/supportClasses/LinearLayoutBase.ts:296

Methods

`Protected`measureReal

measureReal(): void
计算目标容器 measuredWidth 和 measuredHeight 的精确值

Returns void

Version
Egret 2.4

Version
eui 1.0

Platform
Web

Language
zh_CN
Overrides LinearLayoutBase.measureReal
- Defined in extension/eui/layouts/HorizontalLayout.ts:42

`Protected`measureVirtual

measureVirtual(): void
计算目标容器 measuredWidth 和 measuredHeight 的近似值

Returns void

Version
Egret 2.4

Version
eui 1.0

Platform
Web

Language
zh_CN
Overrides LinearLayoutBase.measureVirtual
- Defined in extension/eui/layouts/HorizontalLayout.ts:72

`Protected`updateDisplayListReal

updateDisplayListReal(width: number, height: number): void
更新真实布局的显示列表
Parameters
- width: number
- height: number
Returns void

Version
Egret 2.4

Version
eui 1.0

Platform
Web

Language
zh_CN
Overrides LinearLayoutBase.updateDisplayListReal
- Defined in extension/eui/layouts/HorizontalLayout.ts:102

`Protected`updateDisplayListVirtual

updateDisplayListVirtual(width: number, height: number): void
更新虚拟布局的显示列表
Parameters
- width: number
- height: number
Returns void

Version
Egret 2.4

Version
eui 1.0

Platform
Web

Language
zh_CN
Overrides LinearLayoutBase.updateDisplayListVirtual
- Defined in extension/eui/layouts/HorizontalLayout.ts:288

`Protected`getStartPosition

getStartPosition(index: number): number
获取指定索引元素的起始位置
Parameters
- index: number
Returns number

Version
Egret 2.4

Version
eui 1.0

Platform
Web

Language
zh_CN
Overrides LinearLayoutBase.getStartPosition
- Defined in extension/eui/layouts/HorizontalLayout.ts:398

`Protected`getElementSize

getElementSize(index: number): number
获取指定索引元素的尺寸
Parameters
- index: number
Returns number

Version
Egret 2.4

Version
eui 1.0

Platform
Web

Language
zh_CN
Overrides LinearLayoutBase.getElementSize
- Defined in extension/eui/layouts/HorizontalLayout.ts:428

`Protected`getElementTotalSize

getElementTotalSize(): number
获取缓存的子对象尺寸总和

Returns number

Version
Egret 2.4

Version
eui 1.0

Platform
Web

Language
zh_CN
Overrides LinearLayoutBase.getElementTotalSize
- Defined in extension/eui/layouts/HorizontalLayout.ts:449

elementAdded

elementAdded(index: number): void
在已添加布局元素之后且在验证目标的大小和显示列表之前，由目标调用。按元素状态缓存的布局（比如虚拟布局）可以覆盖此方法以更新其缓存。
Parameters
- index: number
  发生改变的子项索引
Returns void

Version
Egret 2.4

Version
eui 1.0

Platform
Web

Language
zh_CN
Overrides LinearLayoutBase.elementAdded
- Defined in extension/eui/layouts/HorizontalLayout.ts:473

`Protected`getIndexInView

getIndexInView(): boolean
获取视图中第一个和最后一个元素的索引,返回是否发生改变。

Returns boolean
索引是否已改变

Version
Egret 2.4

Version
eui 1.0

Platform
Web

Language
zh_CN
Overrides LinearLayoutBase.getIndexInView
- Defined in extension/eui/layouts/HorizontalLayout.ts:487

setTypicalSize

setTypicalSize(width: number, height: number): void
设置一个典型元素的大小
Parameters
- width: number
  元素的宽
- height: number
  元素的高
Returns void

Version
Egret 2.4

Version
eui 1.0

Platform
Web

Language
zh_CN
Inherited from LinearLayoutBase.setTypicalSize
- Defined in extension/eui/layouts/supportClasses/LayoutBase.ts:170

getElementIndicesInView

getElementIndicesInView(): number[]
返回此 Group 中可见的元素的索引。

Returns number[]
可见的元素的索引。

Version
Egret 2.4

Version
eui 1.0

Platform
Web

Language
zh_CN
Inherited from LinearLayoutBase.getElementIndicesInView
- Defined in extension/eui/layouts/supportClasses/LayoutBase.ts:302

`Protected`invalidateTargetLayout

invalidateTargetLayout(): void
失效目标容器的尺寸和显示列表的简便方法，调用目标容器的 measure()和updateDisplayList方法

Returns void

Version
Egret 2.4

Version
eui 1.0

Platform
Web

Language
zh_CN
Inherited from LinearLayoutBase.invalidateTargetLayout
- Defined in extension/eui/layouts/supportClasses/LinearLayoutBase.ts:324

measure

measure(): void
基于目标的内容测量其默认大小

Returns void

Version
Egret 2.4

Version
eui 1.0

Platform
Web

Language
zh_CN
Inherited from LinearLayoutBase.measure
- Defined in extension/eui/layouts/supportClasses/LinearLayoutBase.ts:339

updateDisplayList

updateDisplayList(width: number, height: number): void
调整目标的元素的大小并定位这些元素。
Parameters
- width: number
- height: number
Returns void

Version
Egret 2.4

Version
eui 1.0

Platform
Web

Language
zh_CN
Inherited from LinearLayoutBase.updateDisplayList
- Defined in extension/eui/layouts/supportClasses/LinearLayoutBase.ts:396

elementRemoved

elementRemoved(index: number): void
必须在已删除布局元素之后且在验证目标的大小和显示列表之前，由目标调用此方法。按元素状态缓存的布局（比如虚拟布局）可以覆盖此方法以更新其缓存。
Parameters
- index: number
Returns void

Version
Egret 2.4

Version
eui 1.0

Platform
Web

Language
zh_CN
Inherited from LinearLayoutBase.elementRemoved
- Defined in extension/eui/layouts/supportClasses/LinearLayoutBase.ts:501

clearVirtualLayoutCache

clearVirtualLayoutCache(): void
如果 useVirtualLayout 为 true，则当布局目标改变时，布局目标可以使用此方法来清除已缓存布局信息。

Returns void

Version
Egret 2.4

Version
eui 1.0

Platform
Web

Language
zh_CN
Inherited from LinearLayoutBase.clearVirtualLayoutCache
- Defined in extension/eui/layouts/supportClasses/LinearLayoutBase.ts:515

`Protected`findIndexAt

findIndexAt(x: number, i0: number, i1: number): number
折半查找法寻找指定位置的显示对象索引
Parameters
- x: number
- i0: number
- i1: number
Returns number

Version
Egret 2.4

Version
eui 1.0

Platform
Web

Language
zh_CN
Inherited from LinearLayoutBase.findIndexAt
- Defined in extension/eui/layouts/supportClasses/LinearLayoutBase.ts:538

scrollPositionChanged

scrollPositionChanged(): void
verticalScrollPosition 或 horizontalScrollPosition 属性更改时调用。

Returns void

Version
Egret 2.4

Version
eui 1.0

Platform
Web

Language
zh_CN
Inherited from LinearLayoutBase.scrollPositionChanged
- Defined in extension/eui/layouts/supportClasses/LinearLayoutBase.ts:611

`Protected`flexChildrenProportionally

flexChildrenProportionally(
    spaceForChildren: number,
    spaceToDistribute: number,
    totalPercent: number,
    childInfoArray: any[],
): void
为每个可变尺寸的子项分配空白区域。
Parameters
- spaceForChildren: number
- spaceToDistribute: number
- totalPercent: number
- childInfoArray: any[]
Returns void

Version
Egret 2.4

Version
eui 1.0

Platform
Web

Language
zh_CN
Inherited from LinearLayoutBase.flexChildrenProportionally
- Defined in extension/eui/layouts/supportClasses/LinearLayoutBase.ts:723

Class HorizontalLayout

Version

Version

Platform

Include Example

Language

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns HorizontalLayout

Version

Version

Platform

Language

Properties

ProtectedelementSizeTable

Version

Version

Platform

Language

ProtectedstartIndex

Version

Version

Platform

Language

ProtectedendIndex

Version

Version

Platform

Language

ProtectedindexInViewCalculated

Version

Version

Platform

Language

ProtectedmaxElementSize

Version

Version

Platform

Language

Accessors

target

Returns Group

Version

Version

Platform

Language

Parameters

Returns void

useVirtualLayout

Returns boolean

Default

Version

Version

Platform

Language

Parameters

Returns void

horizontalAlign

Returns string

Default

Version

Version

Platform

Language

Parameters

Returns void

verticalAlign

Returns string

Default

Version

Version

Platform

Language

Parameters

`Protected`elementSizeTable

`Protected`startIndex

`Protected`endIndex

`Protected`indexInViewCalculated

`Protected`maxElementSize

`Protected`measureReal

`Protected`measureVirtual

`Protected`updateDisplayListReal

`Protected`updateDisplayListVirtual