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

PhloxUI Ng2+ Framework

/**
 * <p style="text-indent: 2em;">
 * An interface class of item, especially a <code>component</code>, can be navigated by a <code>navigator</code> ([[INavigator]]).
 * </p>
 *
 * @author shiorin, tee4cute
 * @see [[INavigator]]
 */
export interface INavigatee {
    /**
     * <p style="text-indent: 1em;">
     * Get the name of this <code>navigatee</code> item. This should be unique within the same <code>navigator</code>.
     * </p>
     */
    getName(): string;
    /**
     * <p style="text-indent: 1em;">
     * To check that this <code>navigatee</code> item is currently <code>active</code> or not. The active item is a currently-navigated-to item which,
     * in most cases, means that it is an item being showed or displayed by the <code>navigator</code>.
     * </p>
     */
    isActive(): boolean;
}