123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287 |
- import { ComponentRef, ElementRef, EventEmitter, Renderer } from '@angular/core';
- import { NavController } from './nav-controller';
- import { NavOptions } from './nav-util';
- import { NavParams } from './nav-params';
- import { Content, Footer, Header, Navbar } from './nav-interfaces';
- /**
- * @name ViewController
- * @description
- * Access various features and information about the current view.
- * @usage
- * ```ts
- * import { Component } from '@angular/core';
- * import { ViewController } from 'ionic-angular';
- *
- * @Component({...})
- * export class MyPage{
- *
- * constructor(public viewCtrl: ViewController) {}
- *
- * }
- * ```
- */
- export declare class ViewController {
- component: any;
- private _cntDir;
- private _cntRef;
- private _ionCntDir;
- private _ionCntRef;
- private _hdrDir;
- private _ftrDir;
- private _isHidden;
- private _leavingOpts;
- private _nb;
- private _onDidDismiss;
- private _onWillDismiss;
- private _dismissData;
- private _dismissRole;
- private _detached;
- _cmp: ComponentRef<any>;
- _nav: NavController;
- _zIndex: number;
- _state: number;
- _cssClass: string;
- _ts: number;
- /**
- * Observable to be subscribed to when the current component will become active
- * @returns {Observable} Returns an observable
- */
- willEnter: EventEmitter<any>;
- /**
- * Observable to be subscribed to when the current component has become active
- * @returns {Observable} Returns an observable
- */
- didEnter: EventEmitter<any>;
- /**
- * Observable to be subscribed to when the current component will no longer be active
- * @returns {Observable} Returns an observable
- */
- willLeave: EventEmitter<any>;
- /**
- * Observable to be subscribed to when the current component is no long active
- * @returns {Observable} Returns an observable
- */
- didLeave: EventEmitter<any>;
- /**
- * Observable to be subscribed to when the current component has been destroyed
- * @returns {Observable} Returns an observable
- */
- willUnload: EventEmitter<any>;
- /**
- * @hidden
- */
- readReady: EventEmitter<any>;
- /**
- * @hidden
- */
- writeReady: EventEmitter<any>;
- /** @hidden */
- data: any;
- /** @hidden */
- instance: any;
- /** @hidden */
- id: string;
- /** @hidden */
- isOverlay: boolean;
- /** @hidden */
- private _emitter;
- constructor(component?: any, data?: any, rootCssClass?: string);
- handleOrientationChange(): void;
- /**
- * @hidden
- */
- init(componentRef: ComponentRef<any>): void;
- _setNav(navCtrl: NavController): void;
- _setInstance(instance: any): void;
- /**
- * @hidden
- */
- subscribe(generatorOrNext?: any): any;
- /**
- * @hidden
- */
- emit(data?: any): void;
- /**
- * Called when the current viewController has be successfully dismissed
- */
- onDidDismiss(callback: (data: any, role: string) => void): void;
- /**
- * Called when the current viewController will be dismissed
- */
- onWillDismiss(callback: (data: any, role: string) => void): void;
- /**
- * Dismiss the current viewController
- * @param {any} [data] Data that you want to return when the viewController is dismissed.
- * @param {any} [role ]
- * @param {NavOptions} navOptions Options for the dismiss navigation.
- * @returns {any} data Returns the data passed in, if any.
- */
- dismiss(data?: any, role?: string, navOptions?: NavOptions): Promise<any>;
- /**
- * @hidden
- */
- getNav(): NavController;
- /**
- * @hidden
- */
- getTransitionName(_direction: string): string;
- /**
- * @hidden
- */
- getNavParams(): NavParams;
- /**
- * @hidden
- */
- setLeavingOpts(opts: NavOptions): void;
- /**
- * Check to see if you can go back in the navigation stack.
- * @returns {boolean} Returns if it's possible to go back from this Page.
- */
- enableBack(): boolean;
- /**
- * @hidden
- */
- readonly name: string;
- /**
- * Get the index of the current component in the current navigation stack.
- * @returns {number} Returns the index of this page within its `NavController`.
- */
- readonly index: number;
- /**
- * @returns {boolean} Returns if this Page is the first in the stack of pages within its NavController.
- */
- isFirst(): boolean;
- /**
- * @returns {boolean} Returns if this Page is the last in the stack of pages within its NavController.
- */
- isLast(): boolean;
- /**
- * @hidden
- * DOM WRITE
- */
- _domShow(shouldShow: boolean, renderer: Renderer): void;
- /**
- * @hidden
- */
- getZIndex(): number;
- /**
- * @hidden
- * DOM WRITE
- */
- _setZIndex(zIndex: number, renderer: Renderer): void;
- /**
- * @returns {ElementRef} Returns the Page's ElementRef.
- */
- pageRef(): ElementRef;
- _setContent(directive: any): void;
- /**
- * @returns {component} Returns the Page's Content component reference.
- */
- getContent(): any;
- _setContentRef(elementRef: ElementRef): void;
- /**
- * @returns {ElementRef} Returns the Content's ElementRef.
- */
- contentRef(): ElementRef;
- _setIONContent(content: Content): void;
- /**
- * @hidden
- */
- getIONContent(): Content;
- _setIONContentRef(elementRef: ElementRef): void;
- /**
- * @hidden
- */
- getIONContentRef(): ElementRef;
- _setHeader(directive: Header): void;
- /**
- * @hidden
- */
- getHeader(): Header;
- _setFooter(directive: Footer): void;
- /**
- * @hidden
- */
- getFooter(): Footer;
- _setNavbar(directive: Navbar): void;
- /**
- * @hidden
- */
- getNavbar(): Navbar;
- /**
- * Find out if the current component has a NavBar or not. Be sure
- * to wrap this in an `ionViewWillEnter` method in order to make sure
- * the view has rendered fully.
- * @returns {boolean} Returns a boolean if this Page has a navbar or not.
- */
- hasNavbar(): boolean;
- /**
- * Change the title of the back-button. Be sure to call this
- * after `ionViewWillEnter` to make sure the DOM has been rendered.
- * @param {string} val Set the back button text.
- */
- setBackButtonText(val: string): void;
- /**
- * Set if the back button for the current view is visible or not. Be sure to call this
- * after `ionViewWillEnter` to make sure the DOM has been rendered.
- * @param {boolean} Set if this Page's back button should show or not.
- */
- showBackButton(shouldShow: boolean): void;
- _preLoad(): void;
- /**
- * @hidden
- * The view has loaded. This event only happens once per view will be created.
- * This event is fired before the component and his children have been initialized.
- */
- _willLoad(): void;
- /**
- * @hidden
- * The view has loaded. This event only happens once per view being
- * created. If a view leaves but is cached, then this will not
- * fire again on a subsequent viewing. This method is a good place
- * to put your setup code for the view; however, it is not the
- * recommended method to use when a view becomes active.
- */
- _didLoad(): void;
- /**
- * @hidden
- * The view is about to enter and become the active view.
- */
- _willEnter(): void;
- /**
- * @hidden
- * The view has fully entered and is now the active view. This
- * will fire, whether it was the first load or loaded from the cache.
- */
- _didEnter(): void;
- /**
- * @hidden
- * The view is about to leave and no longer be the active view.
- */
- _willLeave(willUnload: boolean): void;
- /**
- * @hidden
- * The view has finished leaving and is no longer the active view. This
- * will fire, whether it is cached or unloaded.
- */
- _didLeave(): void;
- /**
- * @hidden
- */
- _willUnload(): void;
- /**
- * @hidden
- * DOM WRITE
- */
- _destroy(renderer: Renderer): void;
- /**
- * @hidden
- */
- _lifecycleTest(lifecycle: string): Promise<boolean>;
- /**
- * @hidden
- */
- _lifecycle(lifecycle: string): void;
- }
- export declare function isViewController(viewCtrl: any): boolean;
|