@eclipse-scout/core/dist/d.ts/src/focus/FocusContext.d.ts

Eclipse Scout runtime

/// <reference types="jquery" />
import { FocusManager } from '../index';
import KeyDownEvent = JQuery.KeyDownEvent;
import FocusInEvent = JQuery.FocusInEvent;
import FocusOutEvent = JQuery.FocusOutEvent;
import TriggeredEvent = JQuery.TriggeredEvent;
/**
 * A focus context is associated with a $container, and controls how to focus elements within that $container.
 */
export declare class FocusContext {
    focusManager: FocusManager;
    /** variable to store the last valid focus position; used to restore focus once being re-activated. */
    lastValidFocusedElement: HTMLElement;
    focusedElement: HTMLElement;
    prepared: boolean;
    $container: JQuery;
    /** Notice: every listener is installed on $container and not on $field level, except 'remove' listener because it does not bubble. */
    protected _keyDownListener: (e: KeyDownEvent) => void;
    protected _focusInListener: (e: FocusInEvent) => void;
    protected _focusOutListener: (e: FocusOutEvent) => void;
    protected _unfocusableListener: (e: TriggeredEvent) => void;
    protected _removeListener: (e: TriggeredEvent) => void;
    constructor($container: JQuery, focusManager: FocusManager);
    ready(): void;
    dispose(): void;
    /**
     * Method invoked once a 'keydown' event is fired to control proper tab cycle.
     */
    protected _onKeyDown(event: KeyDownEvent): void;
    /**
     * Starting from the current `activeElement`, focuses the next or previous valid element within this focus context.
     * If the context does not contain tabbable elements or the `activeElement` is not part of this context, nothing happens.
     *
     * If a TAB key event is given and the target element is the next element in the natural DOM order, the focus is not
     * changed by this method. Instead, the focus is expected to be automatically changed by the browser (default tabbing
     * behavior).
     */
    focusNextTabbable(forward?: boolean, event?: KeyDownEvent): void;
    /**
     * Method invoked once a 'focusin' event is fired by this context's $container or one of its child controls.
     */
    protected _onFocusIn(event: FocusInEvent): void;
    /**
     * Method invoked once a 'focusout' event is fired by this context's $container or one of its child controls.
     */
    protected _onFocusOut(event: FocusOutEvent): void;
    /**
     * Method invoked once a child element of this context's $container is removed.
     */
    protected _onRemove(event: TriggeredEvent): void;
    /**
     * Function invoked once a child element of this context's $container is hidden or disabled
     * and it cannot have the focus anymore. In that case we need to look for a new focusable
     * element.
     */
    protected _onUnfocusable(event: TriggeredEvent): void;
    /**
     * Focuses the given element if being a child of this context's container and matches the given filter (if provided).
     *
     * @param element
     *        the element to focus, or null to focus the context's first focusable element matching the given filter.
     * @param filter
     *        filter that controls which element should be focused, or null to accept all focusable candidates.
     * @param options options to customize to focus
     */
    validateAndSetFocus(element?: HTMLElement, filter?: () => boolean, options?: FocusContextFocusOptions): void;
    /**
     * Calls {@link #validateAndSetFocus} with {@link #lastValidFocusedElement}.
     */
    validateFocus(filter?: () => boolean): void;
    /**
     * Restores the focus on the last valid focused element. Does nothing, if there is no last valid focused element.
     */
    restoreFocus(): void;
    /**
     * Focuses the requested element.
     *
     * @param element the element to focus, or null to focus the context's first focusable element matching the given filter.
     * @param options options to customize to focus
     */
    protected _focus(elementToFocus: HTMLElement, options?: FocusContextFocusOptions): void;
}
export interface FocusContextFocusOptions {
    /**
     * prevents scrolling to new focused element (defaults to false)
     */
    preventScroll?: boolean;
    /**
     * automatically selects the text content of the element if supported (defaults to false)
     */
    selectText?: boolean;
}
//# sourceMappingURL=FocusContext.d.ts.map