com.phloxui/lib/component/IDialogController.d.ts

PhloxUI Ng2+ Framework

import { EventEmitter } from '@angular/core';
import { ButtonModel } from './model/ComponentDialogModel';
/**
 * <p style="text-indent: 2em;">
 * All dialog component classes, including <code>custom component</code> classes used in [[ComponentDialog]], must be an instance of this interface.
 * </p>
 *
 * @author shiorin, tee4cute
 * @see [[PhloxDialog]]
 */
export interface IDialogController {
    /**
     * <p style="text-indent: 1em;">
   * Get dialog's <code>result</code> which will be resolved by the <code>Promise</code> returned from [[PhloxDialog]].<code><i>show...Dialog</i></code>.
   * </p>
     */
    getDialogResult(): any;
    /**
     * <p style="text-indent: 1em;">
   * Get dialog's <code>error</code> which will be rejected by the <code>Promise</code> returned from [[PhloxDialog]].<code><i>show...Dialog</i></code>.
   * </p>
     */
    getDialogError(): any;
    /**
     * <p style="text-indent: 1em;">
   * Get button models ([[ButtonModel]]) to be rendered in the dialog.
   * </p>
     */
    getDialogButtons(): ButtonModel[];
    /**
     * <p style="text-indent: 1em;">
   * Get an <code>event emitter</code> which will emit the event before the dialog's <code>result</code> is changed.
   * </p>
     */
    getBeforeResultChangeEvent(): EventEmitter<any>;
    /**
     * <p style="text-indent: 1em;">
   * Get an <code>event emitter</code> which will emit the event when the dialog's <code>result</code> is changed.
   * </p>
     */
    getResultChangeEvent(): EventEmitter<any>;
    /**
     * <p style="text-indent: 1em;">
    * Get an <code>event emitter</code> which will emit the event before the dialog's <code>error</code> is changed.
    * </p>
     */
    getBeforeErrorChangeEvent(): EventEmitter<any>;
    /**
     * <p style="text-indent: 1em;">
   * Get an <code>event emitter</code> which will emit the event when the dialog's <code>error</code> is changed.
   * </p>
     */
    getErrorChangeEvent(): EventEmitter<any>;
    /**
     * <p style="text-indent: 1em;">
   * Get an <code>event emitter</code> which will emit the event before the button model is changed.
   * </p>
     */
    getBeforeButtonsChangeEvent(): EventEmitter<any>;
    /**
     * <p style="text-indent: 1em;">
   * Get an <code>event emitter</code> which will emit the event when the button model is changed.
   * </p>
     */
    getButtonsChangeEvent(): EventEmitter<any>;
}