# All files / scripts/CDP/Framework Page.ts

26.92% Statements 35/130
3.77% Branches 2/53
7.5% Functions 3/40
27.97% Lines 33/118

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    337
    338
    339
    340
    3411x

    1x

    1x

    1x

    1x
    1x
    1x
    1x
    1x
    1x
    1x

    1x

    1x

    1x

    1x

    1x

    1x

    1x

    1x

    1x

    1x

    1x

    1x

    1x

    1x

    1x

    1x

    1x

    1x

    1x

    1x

    1x

    1x

     ﻿namespace CDP.Framework {

        import Promise = CDP.Promise;

        const TAG = "[CDP.Framework.Page] ";

        /**
         * @en Internal Intent interface for managed update info.
         * @ja 更新情報が管理された内部 Intent インターフェイスクラス
         *
         * @internal
         */
        interface ManagedIntent extends Intent {
            /**
             * @en set "true" when update in Page class.
             * @ja ページ内で更新された場合 true
             */
            _update: boolean;
        }

        /**
         * @en Base class of all page unit.
         * @ja すべてのページの基本となる既定クラス
         */
        export class Page implements IPage {

            //////////////////////////////////////////
            // data member

            protected _owner: IPage;
            private _$page: JQuery;
            private _$header: JQuery;
            private _$footer: JQuery;
            private _intent: ManagedIntent;
            private _keepIntent: boolean;
            private _initialized: boolean;

            //////////////////////////////////////////
            // public methods

            /**
             * @param _url
             *  - `en` page's URL
             *  - `ja` ページ URL
             * @param _id
             *  - `en` page's ID
             *  - `ja` ページ ID
             * @param options
             *  - `en` construction options
             *  - `ja` 構築オプション
             */
            constructor(private _url: string, private _id: string, options?: PageConstructOptions) {
                this.setup(options);
            }

            //////////////////////////////////////////
            // public accessor

            get active(): boolean           { return !!this._$page && this._$page.hasClass("ui-page-active");   }
            get url(): string               { return this._url;                                                 }
            get id(): string                { return this._id;                                                  }
            get $page(): JQuery             { return this._$page;                                               }
            get $header(): JQuery           { return this._$header;                                             }
            get $footer(): JQuery           { return this._$footer;                                             }
            get intent(): Intent            { return this._intent;                                              }
            set intent(newIntent: Intent)   { this._intent = <any>newIntent; this._intent._update = true;       }

            //////////////////////////////////////////
            // Implemtents: IPage

            // Orientation の変更を受信
            public onOrientationChanged(newOrientation: Orientation): void {
                if (this._owner) {
                    this._owner.onOrientationChanged(newOrientation);
                }
            }

            // H/W Back Button ハンドラ
            public onHardwareBackButton(event?: JQuery.Event): boolean {
                if (this._owner) {
                    return this._owner.onHardwareBackButton(event);
                } else {
                    return false;
                }
            }

            // Router "before route change" ハンドラ
            public onBeforeRouteChange(): IPromiseBase<any> {
                if (this._owner) {
                    return this._owner.onBeforeRouteChange();
                } else {
                    return Promise.resolve();
                }
            }

            // 汎用コマンドを受信
            public onCommand(event?: JQuery.Event, kind?: string): boolean {
                if (this._owner) {
                    return this._owner.onCommand(event, kind);
                } else {
                    return false;
                }
            }

            // 最初の OnPageInit() のときにのみコールされる
            public onInitialize(event: JQuery.Event): void {
                if (this._owner) {
                    this._owner.onInitialize(event);
                }
            }

            // jQM event: "pagebeforecreate" に対応
            public onPageBeforeCreate(event: JQuery.Event): void {
                if (this._owner) {
                    this._owner.onPageBeforeCreate(event);
                }
            }

            // jQM event: "pagecreate" (旧:"pageinit") に対応
            public onPageInit(event: JQuery.Event): void {
                if (this._owner) {
                    this._owner.onPageInit(event);
                }
            }

            // jQM event: "pagebeforeshow" に対応
            public onPageBeforeShow(event: JQuery.Event, data?: ShowEventData): void {
                if (this._owner) {
                    this._owner.onPageBeforeShow(event, data);
                }
            }

            // jQM event: "pagecontainershow" (旧:"pageshow") に対応
            public onPageShow(event: JQuery.Event, data?: ShowEventData): void {
                if (this._owner) {
                    this._owner.onPageShow(event, data);
                }
            }

            // jQM event: "pagebeforehide" に対応
            public onPageBeforeHide(event: JQuery.Event, data?: HideEventData): void {
                if (this._owner) {
                    this._owner.onPageBeforeHide(event, data);
                }
            }

            // jQM event: "pagecontainerhide" (旧:"pagehide") に対応
            public onPageHide(event: JQuery.Event, data?: HideEventData): void {
                if (this._owner) {
                    this._owner.onPageHide(event, data);
                }
            }

            // jQM event: "pageremove" に対応
            public onPageRemove(event: JQuery.Event): void {
                if (this._owner) {
                    this._owner.onPageRemove(event);
                }
            }

            //////////////////////////////////////////
            // private methods

            // mixin 用疑似コンストラクタ
            private setup(options: PageConstructOptions): void {
                // mixin destination 用の再初期化
                this._initialized = false;
                this._intent = null;

                // イベントバインド
                const selector: string = "#" + this._id;
                $(document)
                    .off("pagebeforecreate", selector)
                    .on("pagebeforecreate", selector, (event: JQuery.Event) => {
                        this._$page = $(selector).first();
                        this._$header = this._$page.children(":jqmData(role=header)").first();
                        this._$footer = this._$page.children(":jqmData(role=footer)").first();
                        this._$page
                            .on("pagecreate", (ev: JQuery.Event) => {
                                this.pageInit(ev);
                            })
                            .on("pagebeforeshow", (ev: JQuery.Event, data: ShowEventData) => {
                                this.pageBeforeShow(ev, data);
                            })
                            // [Note]instead future version "pagecontainershow".
                            .on("pageshow", (ev: JQuery.Event, data: ShowEventData) => {
                                this.pageShow(ev, data);
                            })
                            .on("pagebeforehide", (ev: JQuery.Event, data: HideEventData) => {
                                this.pageBeforeHide(ev, data);
                            })
                            // [Note]instead future version "pagecontainerhide".
                            .on("pagehide", (ev: JQuery.Event, data: HideEventData) => {
                                this.pageHide(ev, data);
                            })
                            .on("pageremove", (ev: JQuery.Event) => {
                                this.pageRemove(ev);
                            });
                        this.pageBeforeCreate(event);
                    });

                options = options || {};

                // owner 設定
                this._owner = options.owner;
                // intent 設定
                this._keepIntent = options.keepIntent;

                // Router へ登録
                if (null == options.route) {
                    options.route = this._id;
                }
                Router.register(options.route, this._url, options.top, options.callback);
            }

            // PageTransitionDirection の判定
            private getDirection(): PageTransitionDirection {
                const activeIndex = Router._getJqmHistory().activeIndex;
                const prevIndex = Router._getJqmHistory().previousIndex;

                if (null == activeIndex || null == prevIndex) {
                    return "unknown";
                } else if (prevIndex === activeIndex) {
                    return "same";
                } else if (activeIndex < prevIndex) {
                    return "back";
                } else {
                    return "forward";
                }
            }

            private pageBeforeCreate(event: JQuery.Event): void {
                this.onPageBeforeCreate(event);
            }

            private pageInit(event: JQuery.Event): void {
                if (!this._initialized) {
                    this.onInitialize(event);
                    this._initialized = true;
                }
                this.onPageInit(event);
            }

            private pageBeforeShow(event: JQuery.Event, data: ShowEventData): void {
                Framework._setActivePage(this);
                this._intent = <ManagedIntent>Router._popIntent();
                this.onPageBeforeShow(event, $.extend(data, { direction: this.getDirection() }));
            }

            private pageShow(event: JQuery.Event, data: ShowEventData): void {
                this.onPageShow(event, $.extend(data, { direction: this.getDirection() }));
            }

            private pageBeforeHide(event: JQuery.Event, data: HideEventData): void {
                this.onPageBeforeHide(event, $.extend(data, { direction: this.getDirection() }));
                if (null != this._intent && (this._keepIntent || this._intent._update)) {    // intent に更新があった場合
                    delete this._intent._update;
                    Router._pushIntent(this._intent);
                } else if (Router.fromHashChanged() && Router.isInSubFlow()) {    // Sub Flow 内で back された場合
                    Router._pushIntent(this._intent);
                }
                this._intent = null;
                Framework._setActivePage(null);
            }

            private pageHide(event: JQuery.Event, data: HideEventData): void {
                this.onPageHide(event, $.extend(data, { direction: this.getDirection() }));
            }

            private pageRemove(event: JQuery.Event): void {
                this.onPageRemove(event);
                this._$page.off();
                this._$page = null;
                this._$header.off();
                this._$header = null;
                this._$footer.off();
                this._$footer = null;
            }
        }

        ///////////////////////////////////////////////////////////////////////
        // closure methods

        /*
         * jQM1.4 にて、duplicate とされている "pageshow", "pagehide" はまだ据え置き。
         * http://jquerymobile.com/upgrade-guide/1.4/#navigation
         *
         * 特定ページに対して、イベントを取得できないため。
         * Forum でも議論中なので、決着がついてから対応を考慮する。
         * https://github.com/jquery/jquery-mobile/issues/6865
         *
         * [参考] よくわかるイベントチートシート
         *  - 本家(1.4+) http://jqmtricks.wordpress.com/2014/03/26/jquery-mobile-page-events/
         *  - 有志(~1.3) http://dev.screw-axis.com/doc/jquery_mobile/resources/cheatsheet/
         *
         * 以下は不完全な対応予定コード
         *
         * 特に振る舞いが変わるのは、"pagehide" で、検討されている仕様では
         * DOM を特定できないため、onPageHide() をインスタンスに伝えることができない。
         *
         * 仕様が変わらない場合は
         * onPageBeforeHide() の中で post して onPageHide() を発行する予定(過去互換保証)
         *
         * 2015/03/25 追記:
         * 仕様は確定. jQM1.6 より削除される予定
         *  jQM1.4 相当の参考実装 plugin があり、この実装相当の機能を cdp.framework.jqm で抱える予定
         *  https://github.com/arschmitz/jquery-mobile-onpage
         *
         * 公式見解
         * https://github.com/jquery/jquery-mobile/issues/7283#issuecomment-40746622
         */
    /*
        // bind "pagecontainershow", and "pagecontainerhide".
        (() => {
            let $body: any = $("body");
            $(document)
                .on("pagecontainershow", (event: JQuery.Event, data: ShowEventData) => {
                    if (0 < data.prevPage.length) {
                        // "pagecontainershow" は "pagecontainerhide" よりも遅いので、やはり DOM にはアクセスできない
                        let $prevpage = $("#" + data.prevPage[0].id);
                        $prevpage.trigger("_pagehide", data);
                    }
                    // 以下の対応で、"pagecontainershow" は "pageshow" 同等の振る舞いにすることが可能
                    let pageId = $body.pagecontainer("getActivePage").prop("id");
                    let $page = $("#" + pageId);
                    $page.trigger("_pageshow", data);
                })
                .on("pagecontainerhide", (event: JQuery.Event, data: HideEventData) => {
                    // "pagecontainerhide" を受けたときは既に DOM から消えているため、page は特定できない。
                    //let pageId = $body.pagecontainer('getActivePage').prop("id");
                    //let $page = $("#" + pageId);
                    //$page.trigger("_pagehide", data);
                })
                .on("pagecontainertransition", (event: JQuery.Event, data: any) => {
                    // "pagecontainertransition" には toPage にしかアクセスはできない
                })
            ;
        })();
    */
    }