interface

  IListView

brief

  ListView のインターフェイス

interface

  IListView

brief

  ListView のインターフェイス

### Hierarchy

- IScrollable
- IBackupRestore
  - IListView
    - BaseListView
    - IExpandableListView

### Implemented by

- ExpandableListView
- ListView

## Index

### Properties

- backupData
- core

### Methods

- _addLine
- addItem
- backup
- clearBackup
- ensureVisible
- getItemInfo
- getScrollPos
- getScrollPosMax
- hasBackup
- isInitialized
- rebuild
- refresh
- release
- removeItem
- restore
- scrollTo
- setScrollHandler
- setScrollStopHandler
- update

## Properties

### backupData

backupData: any

Inherited from IBackupRestore.backupData

- Defined in CDP/UI/listview/Interfaces.ts:243

バックアップデータにアクセス

returns

  バックアップデータオブジェクト

### core

core: IListViewFramework

- Defined in CDP/UI/listview/Interfaces.ts:383

## Methods

### Optional _addLine

- _addLine(_line: LineProfile, insertTo?: number): void
- _addLine(_line: LineProfile[], insertTo?: number): void

- - Defined in CDP/UI/listview/Interfaces.ts:392

  #### Parameters

  - ##### _line: LineProfile

  - ##### Optional insertTo: number

  #### Returns void

- - Defined in CDP/UI/listview/Interfaces.ts:393

  #### Parameters

  - ##### _line: LineProfile[]

  - ##### Optional insertTo: number

  #### Returns void

### addItem

- addItem(height: number, initializer: object, info: any, insertTo?: number): void

- - Defined in CDP/UI/listview/Interfaces.ts:349

  Item 登録 プロパティを指定して、ListItem を管理

  #### Parameters

  - ##### height: number

    [in] ラインの高さ

  - ##### initializer: object

    [in] ListItemView 派生クラスのコンストラクタ

  - ##### info: any

    [in] initializer に渡されるオプション引数

  - ##### Optional insertTo: number

    [in] ラインの挿入位置をインデックスで指定

  #### Returns void

### backup

- backup(key: string): boolean

- Inherited from IBackupRestore.backup

  - Defined in CDP/UI/listview/Interfaces.ts:211

  内部データをバックアップ

  #### Parameters

  - ##### key: string

    [in] バックアップキーを指定

  #### Returns boolean

  true: 成功 / false: 失敗

### clearBackup

- clearBackup(key?: string): boolean

- Inherited from IBackupRestore.clearBackup

  - Defined in CDP/UI/listview/Interfaces.ts:236

  バックアップデータの破棄

  #### Parameters

  - ##### Optional key: string

    [in] バックアップキーを指定

  #### Returns boolean

  true: 成功 / false: 失敗

### ensureVisible

- ensureVisible(index: number, options?: EnsureVisibleOptions): void

- Inherited from IScrollable.ensureVisible

  - Defined in CDP/UI/listview/Interfaces.ts:195

  指定された ListItemView の表示を保証

  #### Parameters

  - ##### index: number

    [in] ListItemView のインデックス

  - ##### Optional options: EnsureVisibleOptions

    [in] オプション

  #### Returns void

### getItemInfo

- getItemInfo(target: number): any
- getItemInfo(target: Event): any

- - Defined in CDP/UI/listview/Interfaces.ts:367

  指定した Item に設定した情報を取得

  #### Parameters

  - ##### target: number

    [in] 識別子. [index | event object]

  #### Returns any

  _addLine() に指定した info オブジェクト

- - Defined in CDP/UI/listview/Interfaces.ts:368

  #### Parameters

  - ##### target: Event

  #### Returns any

### getScrollPos

- getScrollPos(): number

- Inherited from IScrollable.getScrollPos

  - Defined in CDP/UI/listview/Interfaces.ts:171

  スクロール位置を取得

  #### Returns number

  : position

### getScrollPosMax

- getScrollPosMax(): number

- Inherited from IScrollable.getScrollPosMax

  - Defined in CDP/UI/listview/Interfaces.ts:178

  スクロール位置の最大値を取得

  #### Returns number

  : position

### hasBackup

- hasBackup(key: string): boolean

- Inherited from IBackupRestore.hasBackup

  - Defined in CDP/UI/listview/Interfaces.ts:228

  バックアップデータの有無

  #### Parameters

  - ##### key: string

    [in] バックアップキーを指定

  #### Returns boolean

  true: 有 / false: 無

### isInitialized

- isInitialized(): boolean

- - Defined in CDP/UI/listview/Interfaces.ts:338

  初期化済みか判定

  #### Returns boolean

  true: 初期化済み / false: 未初期化

### rebuild

- rebuild(): void

- - Defined in CDP/UI/listview/Interfaces.ts:375

  #### Returns void

### refresh

- refresh(): void

- - Defined in CDP/UI/listview/Interfaces.ts:371

  #### Returns void

### release

- release(): void

- - Defined in CDP/UI/listview/Interfaces.ts:377

  #### Returns void

### removeItem

- removeItem(index: number, size?: number, delay?: number): void
- removeItem(index: number[], delay?: number): void

- - Defined in CDP/UI/listview/Interfaces.ts:358

  指定した Item を削除

  #### Parameters

  - ##### index: number

    [in] 解除開始のインデックスを指定. 配列版は reverse index を指定するほうが効率的

  - ##### Optional size: number

    [in] 解除するラインの総数. 既定: 1

  - ##### Optional delay: number

    [in] 実際に要素を削除する delay time 既定: 0 (即時削除)

  #### Returns void

- - Defined in CDP/UI/listview/Interfaces.ts:359

  #### Parameters

  - ##### index: number[]

  - ##### Optional delay: number

  #### Returns void

### restore

- restore(key: string, rebuild: boolean): boolean

- Inherited from IBackupRestore.restore

  - Defined in CDP/UI/listview/Interfaces.ts:220

  内部データをリストア

  #### Parameters

  - ##### key: string

    [in] バックアップキーを指定

  - ##### rebuild: boolean

    [in] rebuild を実行する場合は true を指定

  #### Returns boolean

  true: 成功 / false: 失敗

### scrollTo

- scrollTo(pos: number, animate?: boolean, time?: number): void

- Inherited from IScrollable.scrollTo

  - Defined in CDP/UI/listview/Interfaces.ts:187

  スクロール位置を指定

  #### Parameters

  - ##### pos: number

    [in] スクロール位置 (0 - posMax)

  - ##### Optional animate: boolean

    [in] アニメーションの有無

  - ##### Optional time: number

    [in] アニメーションに費やす時間 [msec]

  #### Returns void

### setScrollHandler

- setScrollHandler(handler: function, on: boolean): void

- Inherited from IScrollable.setScrollHandler

  - Defined in CDP/UI/listview/Interfaces.ts:156

  スクロールイベントハンドラ設定/解除

  #### Parameters

  - ##### handler: function

    [in] ハンドラ関数

    - - (event: Event): void

      - #### Parameters

        - ##### event: Event

        #### Returns void

  - ##### on: boolean

    [in] true: 設定 / false: 解除

  #### Returns void

### setScrollStopHandler

- setScrollStopHandler(handler: function, on: boolean): void

- Inherited from IScrollable.setScrollStopHandler

  - Defined in CDP/UI/listview/Interfaces.ts:164

  スクロール終了イベントハンドラ設定/解除

  #### Parameters

  - ##### handler: function

    [in] ハンドラ関数

    - - (event: Event): void

      - #### Parameters

        - ##### event: Event

        #### Returns void

  - ##### on: boolean

    [in] true: 設定 / false: 解除

  #### Returns void

### update

- update(): void

- - Defined in CDP/UI/listview/Interfaces.ts:373

  #### Returns void

Generated using TypeDoc