en

  Interface of Page class.

ja

  ページクラスのインターフェイスクラス

### Hierarchy

- IOrientationChangedListener
- IBackButtonEventListener
- ICommandListener
  - IPage

### Implemented by

- Page

## Index

### Properties

- $footer
- $header
- $page
- active
- id
- intent
- url

### Methods

- onBeforeRouteChange
- onCommand
- onHardwareBackButton
- onInitialize
- onOrientationChanged
- onPageBeforeCreate
- onPageBeforeHide
- onPageBeforeShow
- onPageHide
- onPageInit
- onPageRemove
- onPageShow

## Properties

### $footer

$footer: JQuery

- Defined in Interfaces.ts:341

en

  jQuery object of page's footer.

ja

  ページフッタの jQuery オブジェクト

### $header

$header: JQuery

- Defined in Interfaces.ts:335

en

  jQuery object of page's header.

ja

  ページヘッダの jQuery オブジェクト

### $page

$page: JQuery

- Defined in Interfaces.ts:329

en

  jQuery object of page.

ja

  ページの jQuery オブジェクト

### active

active: boolean

- Defined in Interfaces.ts:311

en

  Return true if page is active.

ja

  ページがアクティブである時 true

### id

id: string

- Defined in Interfaces.ts:323

en

  Stored target page ID.

ja

  対象のページ ID を格納

### intent

intent: Intent

- Defined in Interfaces.ts:347

en

  intent parameter passing between pages.

ja

  ページ間で受け渡される intent オブジェクト

### url

url: string

- Defined in Interfaces.ts:317

en

  Stored target page url.

ja

  対象のページ URL を格納

## Methods

### onBeforeRouteChange

- onBeforeRouteChange(): IPromiseBase<any>

- - Defined in Interfaces.ts:358
  en

    Received Router "before route change" event.

  ja

    Router "before route change" ハンドラ
    ページ遷移直前に非同期処理を行うことが可能

  #### Returns IPromiseBase<any>

  - `en` promise object
  - `ja` Promise オブジェクト

### onCommand

- onCommand(event?: Event, kind?: string): boolean

- Inherited from ICommandListener.onCommand

  - Defined in Interfaces.ts:262
  en

    Received generic command

  ja

    汎用コマンドを受信

  #### Parameters

  - ##### Optional event: Event

    - `en` event object
    - `ja` イベントオブジェクト

  - ##### Optional kind: string

    - `en` command kind identifier
    - `ja` コマンド種別識別子

  #### Returns boolean

  - `en` true: continue default operation / false: stop default operation
  - `ja` true: 既定の処理を行わない / false: 既定の処理を行う

### onHardwareBackButton

- onHardwareBackButton(event?: Event): boolean

- Inherited from IBackButtonEventListener.onHardwareBackButton

  - Defined in Interfaces.ts:240
  en

    Received H/W Back Button event

  ja

    H/W Back Button ハンドラ

  #### Parameters

  - ##### Optional event: Event

    - `en` event object
    - `ja` イベントオブジェクト

  #### Returns boolean

  - `en` true: continue default operation / false: stop default operation
  - `ja` true: 既定の処理を行わない / false: 既定の処理を行う

### onInitialize

- onInitialize(event: Event): void

- - Defined in Interfaces.ts:364
  en

    It's called only when before the first OnPageInit().

  ja

    最初の OnPageInit() のときにのみコールされる

  #### Parameters

  - ##### event: Event

  #### Returns void

### onOrientationChanged

- onOrientationChanged(newOrientation: Orientation): void

- Inherited from IOrientationChangedListener.onOrientationChanged

  - Defined in Interfaces.ts:221
  en

    Received orientation code when that is changed.

  ja

    Orientation の変更を受信

  #### Parameters

  - ##### newOrientation: Orientation

    - `en` new orientation code.
    - `ja` 変更後の orientation code

  #### Returns void

### onPageBeforeCreate

- onPageBeforeCreate(event: Event): void

- - Defined in Interfaces.ts:370
  en

    Event handler of jQM event: "pagebeforecreate".

  ja

    jQM event: "pagebeforecreate" に対応

  #### Parameters

  - ##### event: Event

  #### Returns void

### onPageBeforeHide

- onPageBeforeHide(event: Event, data?: HideEventData): void

- - Defined in Interfaces.ts:415
  en

    Event handler of jQM event: "pagebeforehide".

  ja

    jQM event: "pagebeforehide" に対応

  #### Parameters

  - ##### event: Event

    - `en` event object
    - `ja` イベントオブジェクト

  - ##### Optional data: HideEventData

    - `en` additional information
    - `ja` 付加情報

  #### Returns void

### onPageBeforeShow

- onPageBeforeShow(event: Event, data?: ShowEventData): void

- - Defined in Interfaces.ts:389
  en

    Event handler of jQM event: "pagebeforeshow"

  ja

    jQM event: "pagebeforeshow" に対応

  #### Parameters

  - ##### event: Event

    - `en` event object
    - `ja` イベントオブジェクト

  - ##### Optional data: ShowEventData

    - `en` additional information
    - `ja` 付加情報

  #### Returns void

### onPageHide

- onPageHide(event: Event, data?: HideEventData): void

- - Defined in Interfaces.ts:428
  en

    Event handler of jQM event: "pagecontainerhide" (previous version defined "pagehide").

  ja

    jQM event: "pagecontainerhide" (旧:"pagehide") に対応

  #### Parameters

  - ##### event: Event

    - `en` event object
    - `ja` イベントオブジェクト

  - ##### Optional data: HideEventData

    - `en` additional information
    - `ja` 付加情報

  #### Returns void

### onPageInit

- onPageInit(event: Event): void

- - Defined in Interfaces.ts:376
  en

    Event handler of jQM event: "pagecreate" (previous version defined "pageinit").

  ja

    jQM event: "pagecreate" (旧:"pageinit") に対応

  #### Parameters

  - ##### event: Event

  #### Returns void

### onPageRemove

- onPageRemove(event: Event): void

- - Defined in Interfaces.ts:434
  en

    Event handler of jQM event: "pageremove".

  ja

    jQM event: "pageremove" に対応

  #### Parameters

  - ##### event: Event

  #### Returns void

### onPageShow

- onPageShow(event: Event, data?: ShowEventData): void

- - Defined in Interfaces.ts:402
  en

    Event handler of jQM event: "pagecontainershow" (previous version defined "pageshow").

  ja

    jQM event: "pagecontainershow" (旧:"pageshow") に対応

  #### Parameters

  - ##### event: Event

    - `en` event object
    - `ja` イベントオブジェクト

  - ##### Optional data: ShowEventData

    - `en` additional information
    - `ja` 付加情報

  #### Returns void

Generated using TypeDoc