Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MiniBrowserContent

Hierarchy

  • BaseWidget
    • MiniBrowserContent

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected Readonly errorBar

errorBar: HTMLElement & Readonly<{ message: HTMLElement }>

Protected Readonly fileService

fileService: FileService

Protected Readonly frame

frame: HTMLIFrameElement

Protected frameLoadTimeout

frameLoadTimeout: number

Protected Readonly initialHistoryLength

initialHistoryLength: number

Protected Readonly input

input: HTMLInputElement

Protected Readonly keybindings

keybindings: KeybindingRegistry

Protected Readonly loadIndicator

loadIndicator: HTMLElement

Protected Readonly locationMapper

locationMapper: LocationMapperService

Protected Readonly logger

logger: ILogger

Protected Readonly mouseTracker

mouseTracker: ApplicationShellMouseTracker

Protected Readonly navigateBackEmitter

navigateBackEmitter: Emitter<void> = ...

Protected Readonly navigateForwardEmitter

navigateForwardEmitter: Emitter<void> = ...

Readonly onDidChangeVisibility

onDidChangeVisibility: Event<boolean>

Protected Readonly onDidChangeVisibilityEmitter

onDidChangeVisibilityEmitter: Emitter<boolean>

Readonly onDidDispose

onDidDispose: Event<void>

Protected Readonly onDidDisposeEmitter

onDidDisposeEmitter: Emitter<void>

Readonly onScrollUp

onScrollUp: Event<void>

Protected Readonly onScrollUpEmitter

onScrollUpEmitter: Emitter<void>

Readonly onScrollYReachEnd

onScrollYReachEnd: Event<void>

Protected Readonly onScrollYReachEndEmitter

onScrollYReachEndEmitter: Emitter<void>

Protected Readonly openEmitter

openEmitter: Emitter<void> = ...

Protected Readonly pdfContainer

pdfContainer: HTMLElement

Protected Readonly props

props: MiniBrowserProps

Protected Readonly refreshEmitter

refreshEmitter: Emitter<void> = ...

Protected Optional scrollBar

scrollBar: PerfectScrollbar

Protected Optional scrollOptions

scrollOptions: Options

Protected Readonly submitInputEmitter

submitInputEmitter: Emitter<string> = ...

Protected Readonly toDispose

toDispose: DisposableCollection

Protected Readonly toDisposeOnDetach

toDisposeOnDetach: DisposableCollection

Protected Readonly toDisposeOnGo

toDisposeOnGo: DisposableCollection = ...

Protected Readonly transparentOverlay

transparentOverlay: HTMLElement

Protected Readonly windowService

windowService: WindowService

Methods

Protected addClipboardListener

  • addClipboardListener<K>(element: HTMLElement, type: K, listener: EventListenerOrEventListenerObject<K>): void

  • Type parameters

    • K: "copy" | "cut" | "paste"

    Parameters

    • element: HTMLElement
    • type: K
    • listener: EventListenerOrEventListenerObject<K>

    Returns void

Protected addEventListener

  • addEventListener<K>(element: HTMLElement, type: K, listener: EventListenerOrEventListenerObject<K>, useCapture?: boolean): void

  • Type parameters

    • K: "input" | "fullscreenchange" | "fullscreenerror" | "abort" | "animationcancel" | "animationend" | "animationiteration" | "animationstart" | "auxclick" | "blur" | "cancel" | "canplay" | "canplaythrough" | "change" | "click" | "close" | "contextmenu" | "cuechange" | "dblclick" | "drag" | "dragend" | "dragenter" | "dragexit" | "dragleave" | "dragover" | "dragstart" | "drop" | "durationchange" | "emptied" | "ended" | "error" | "focus" | "focusin" | "focusout" | "gotpointercapture" | "invalid" | "keydown" | "keypress" | "keyup" | "load" | "loadeddata" | "loadedmetadata" | "loadstart" | "lostpointercapture" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "pause" | "play" | "playing" | "pointercancel" | "pointerdown" | "pointerenter" | "pointerleave" | "pointermove" | "pointerout" | "pointerover" | "pointerup" | "progress" | "ratechange" | "reset" | "resize" | "scroll" | "securitypolicyviolation" | "seeked" | "seeking" | "select" | "selectionchange" | "selectstart" | "stalled" | "submit" | "suspend" | "timeupdate" | "toggle" | "touchcancel" | "touchend" | "touchmove" | "touchstart" | "transitioncancel" | "transitionend" | "transitionrun" | "transitionstart" | "volumechange" | "waiting" | "wheel" | "copy" | "cut" | "paste"

    Parameters

    • element: HTMLElement
    • type: K
    • listener: EventListenerOrEventListenerObject<K>
    • Optional useCapture: boolean

    Returns void

Protected addKeyListener

  • addKeyListener<K>(element: HTMLElement, keysOrKeyCodes: Predicate | Key | KeyCode | (Key | KeyCode)[], action: (event: KeyboardEvent) => boolean | void | Object, ...additionalEventTypes: K[]): void

  • Type parameters

    • K: "input" | "fullscreenchange" | "fullscreenerror" | "abort" | "animationcancel" | "animationend" | "animationiteration" | "animationstart" | "auxclick" | "blur" | "cancel" | "canplay" | "canplaythrough" | "change" | "click" | "close" | "contextmenu" | "cuechange" | "dblclick" | "drag" | "dragend" | "dragenter" | "dragexit" | "dragleave" | "dragover" | "dragstart" | "drop" | "durationchange" | "emptied" | "ended" | "error" | "focus" | "focusin" | "focusout" | "gotpointercapture" | "invalid" | "keydown" | "keypress" | "keyup" | "load" | "loadeddata" | "loadedmetadata" | "loadstart" | "lostpointercapture" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "pause" | "play" | "playing" | "pointercancel" | "pointerdown" | "pointerenter" | "pointerleave" | "pointermove" | "pointerout" | "pointerover" | "pointerup" | "progress" | "ratechange" | "reset" | "resize" | "scroll" | "securitypolicyviolation" | "seeked" | "seeking" | "select" | "selectionchange" | "selectstart" | "stalled" | "submit" | "suspend" | "timeupdate" | "toggle" | "touchcancel" | "touchend" | "touchmove" | "touchstart" | "transitioncancel" | "transitionend" | "transitionrun" | "transitionstart" | "volumechange" | "waiting" | "wheel" | "copy" | "cut" | "paste"

    Parameters

    • element: HTMLElement
    • keysOrKeyCodes: Predicate | Key | KeyCode | (Key | KeyCode)[]
    • action: (event: KeyboardEvent) => boolean | void | Object
        • (event: KeyboardEvent): boolean | void | Object

        • Parameters

          • event: KeyboardEvent

          Returns boolean | void | Object

    • Rest ...additionalEventTypes: K[]

    Returns void

Protected addUpdateListener

  • addUpdateListener<K>(element: HTMLElement, type: K, useCapture?: boolean): void

  • Type parameters

    • K: "input" | "fullscreenchange" | "fullscreenerror" | "abort" | "animationcancel" | "animationend" | "animationiteration" | "animationstart" | "auxclick" | "blur" | "cancel" | "canplay" | "canplaythrough" | "change" | "click" | "close" | "contextmenu" | "cuechange" | "dblclick" | "drag" | "dragend" | "dragenter" | "dragexit" | "dragleave" | "dragover" | "dragstart" | "drop" | "durationchange" | "emptied" | "ended" | "error" | "focus" | "focusin" | "focusout" | "gotpointercapture" | "invalid" | "keydown" | "keypress" | "keyup" | "load" | "loadeddata" | "loadedmetadata" | "loadstart" | "lostpointercapture" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "pause" | "play" | "playing" | "pointercancel" | "pointerdown" | "pointerenter" | "pointerleave" | "pointermove" | "pointerout" | "pointerover" | "pointerup" | "progress" | "ratechange" | "reset" | "resize" | "scroll" | "securitypolicyviolation" | "seeked" | "seeking" | "select" | "selectionchange" | "selectstart" | "stalled" | "submit" | "suspend" | "timeupdate" | "toggle" | "touchcancel" | "touchend" | "touchmove" | "touchstart" | "transitioncancel" | "transitionend" | "transitionrun" | "transitionstart" | "volumechange" | "waiting" | "wheel" | "copy" | "cut" | "paste"

    Parameters

    • element: HTMLElement
    • type: K
    • Optional useCapture: boolean

    Returns void

clearFlag

  • clearFlag(flag: Flag): void

  • Parameters

    • flag: Flag

    Returns void

Protected contentDocument

  • contentDocument(): null | Document

Protected createButton

  • createButton(parent: HTMLElement, title: string, ...className: string[]): HTMLElement

Protected createContentArea

  • createContentArea(parent: HTMLElement): HTMLElement & Readonly<{ errorBar: HTMLElement & Readonly<{ message: HTMLElement }>; frame: HTMLIFrameElement; loadIndicator: HTMLElement; pdfContainer: HTMLElement; transparentOverlay: HTMLElement }>

  • Parameters

    • parent: HTMLElement

    Returns HTMLElement & Readonly<{ errorBar: HTMLElement & Readonly<{ message: HTMLElement }>; frame: HTMLIFrameElement; loadIndicator: HTMLElement; pdfContainer: HTMLElement; transparentOverlay: HTMLElement }>

Protected createErrorBar

  • createErrorBar(): HTMLElement & Readonly<{ message: HTMLElement }>

Protected createIFrame

  • createIFrame(): HTMLIFrameElement

Protected createInput

  • createInput(parent: HTMLElement): HTMLInputElement

Protected createNext

  • createNext(parent: HTMLElement): HTMLElement

Protected createOpen

  • createOpen(parent: HTMLElement): HTMLElement

Protected createPrevious

  • createPrevious(parent: HTMLElement): HTMLElement

Protected createRefresh

  • createRefresh(parent: HTMLElement): HTMLElement

Protected createToolbar

  • createToolbar(parent: HTMLElement): HTMLDivElement & Readonly<{ input: HTMLInputElement }>

Protected disableScrollBarFocus

  • disableScrollBarFocus(scrollContainer: HTMLElement): void

  • Parameters

    • scrollContainer: HTMLElement

    Returns void

dispose

  • dispose(): void

  • Returns void

Protected frameSrc

  • frameSrc(): string

Protected getScrollContainer

  • getScrollContainer(): MaybePromise<HTMLElement>

  • Returns MaybePromise<HTMLElement>

Protected getToolbarProps

  • getToolbarProps(): "show" | "hide" | "read-only"

Protected go

  • go(location: string, options?: Partial<{ preserveFocus: boolean; showLoadIndicator: boolean }>): Promise<void>

Protected handleBack

  • handleBack(): void

Protected handleForward

  • handleForward(): void

Protected handleInputChange

  • handleInputChange(e: KeyboardEvent): void

Protected handleOpen

  • handleOpen(): void

Protected handleRefresh

  • handleRefresh(): void

Protected hideErrorBar

  • hideErrorBar(): void

Protected hideLoadIndicator

  • hideLoadIndicator(): void

Protected init

  • init(): void

Protected listenOnContentChange

  • listenOnContentChange(location: string): Promise<void>

Protected mapLocation

  • mapLocation(location: string): Promise<string>

Protected maybeResetBackground

  • maybeResetBackground(): void

Protected onActivateRequest

  • onActivateRequest(msg: Message): void

Protected onAfterAttach

  • onAfterAttach(msg: Message): void

  • Parameters

    • msg: Message

    Returns void

Protected onAfterDetach

  • onAfterDetach(msg: Message): void

  • Parameters

    • msg: Message

    Returns void

Protected onBeforeAttach

  • onBeforeAttach(msg: Message): void

  • Parameters

    • msg: Message

    Returns void

Protected onBeforeDetach

  • onBeforeDetach(msg: Message): void

  • Parameters

    • msg: Message

    Returns void

Protected onClick

  • onClick(element: HTMLElement, emitter: Emitter<any>): HTMLElement

Protected onCloseRequest

  • onCloseRequest(msg: Message): void

  • Parameters

    • msg: Message

    Returns void

Protected onFrameError

  • onFrameError(): void

Protected onFrameLoad

  • onFrameLoad(): void

Protected onFrameTimeout

  • onFrameTimeout(): void

Protected onUpdateRequest

  • onUpdateRequest(msg: Message): void

  • Parameters

    • msg: Message

    Returns void

setFlag

  • setFlag(flag: Flag): void

  • Parameters

    • flag: Flag

    Returns void

Protected setInput

  • setInput(value: string): void

Protected showErrorBar

  • showErrorBar(message: string): void

Protected showLoadIndicator

  • showLoadIndicator(): void