Theia API Documentation v1.65.0
    Preparing search index...

    Class WebviewWidget

    A contract for widgets that want to store and restore their inner state, between sessions.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    _badge? _badgeTooltip? _contentOptions _state contextKeyService contextMenuRenderer element environment externalEndpoint externalUriService fileService hideTimeout html iconUrl identifier isExtractable keybindings mouseTracker node onDidChangeBadgeEmitter onDidChangeBadgeTooltipEmitter onDidChangeVisibility onDidChangeVisibilityEmitter onDidDispose onDidDisposeEmitter onMessage onMessageEmitter onScrollUp onScrollUpEmitter onScrollYReachEnd onScrollYReachEndEmitter openerService options outputManager pendingMessages preferences ready resourceCache scrollBar? scrollOptions? secondaryWindow sharedStyle themeDataProvider toDispose toDisposeOnDetach toDisposeOnIcon toHide transparentOverlay viewState viewType FACTORY_ID

    Accessors

    badge badgeTooltip contentOptions dataset disposed hiddenMode id isAttached isDisposed isHidden isVisible layout onDidChangeBadge onDidChangeBadgeTooltip parent state title

    Methods

    activate addClass addClipboardListener addEventListener addKeyListener addUpdateListener children clearFlag close contains disableScrollBarFocus dispatchMouseEvent dispose doHide doSend doShow doUpdateContent fit forceHide forwardConsoleLog getPreviewNode getRedirect getScrollContainer handleContextMenu handleVisiblityChanged hasClass hide init loadLocalhost loadResource normalizeRequestUri notifyLayout on onActivateRequest onAfterAttach onAfterDetach onAfterHide onAfterShow onBeforeAttach onBeforeDetach onBeforeHide onBeforeShow onChildAdded onChildRemoved onCloseRequest onFitRequest onResize onUpdateRequest openLink postMessage preprocessHtml processMessage reload removeClass restoreState sendMessage setContentOptions setFlag setHidden setHTML setIconUrl setIframeHeight show storeState style testFlag toEndpoint toggleClass toRemoteUrl toSupportedLink trace update

    Constructors

    Properties

    Protected Optional_badge

    _badge?: number

    Protected Optional_badgeTooltip

    _badgeTooltip?: string

    Protected_contentOptions

    _contentOptions: WebviewContentOptions = {}

    Protected_state

    _state: undefined | string
    contextKeyService: ContextKeyService
    contextMenuRenderer: ContextMenuRenderer
    element: undefined | HTMLIFrameElement
    environment: WebviewEnvironment
    externalEndpoint: string
    externalUriService: ExternalUriService
    fileService: FileService
    hideTimeout: any
    html: string = ''
    iconUrl: undefined | IconUrl
    identifier: WebviewWidgetIdentifier
    isExtractable: boolean = true

    Set to true to mark the widget to be extractable.

    keybindings: KeybindingRegistry
    mouseTracker: ApplicationShellMouseTracker
    node: HTMLElement

    Get the DOM node owned by the widget.

    onDidChangeBadgeEmitter: Emitter<void> = ...
    onDidChangeBadgeTooltipEmitter: Emitter<void> = ...
    onDidChangeVisibility: Event<boolean>
    onDidChangeVisibilityEmitter: Emitter<boolean>
    onDidDispose: Event<void>
    onDidDisposeEmitter: Emitter<void>
    onMessage: Event<any> = ...
    onMessageEmitter: Emitter<any> = ...
    onScrollUp: Event<void>
    onScrollUpEmitter: Emitter<void>
    onScrollYReachEnd: Event<void>
    onScrollYReachEndEmitter: Emitter<void>
    openerService: OpenerService
    options: WebviewPanelOptions = {}
    outputManager: OutputChannelManager
    pendingMessages: any[] = []
    preferences: WebviewPreferences
    ready: Deferred<void> = ...
    resourceCache: WebviewResourceCache
    scrollBar?: PerfectScrollbar
    scrollOptions?: Options
    secondaryWindow: undefined | Window = undefined

    The secondary window that the window was extracted to or undefined if it is not yet extracted.

    sharedStyle: PluginSharedStyle
    themeDataProvider: WebviewThemeDataProvider
    toDispose: DisposableCollection
    toDisposeOnDetach: DisposableCollection
    toDisposeOnIcon: DisposableCollection = ...
    toHide: DisposableCollection = ...
    transparentOverlay: HTMLElement

    eslint-disable-next-line max-len XXX This is a hack to be able to tack the mouse events when drag and dropping the widgets. On mousedown we put a transparent div over the iframe to avoid losing the mouse tacking.

    viewState: WebviewPanelViewState = ...
    viewType: string
    FACTORY_ID: string = 'plugin-webview'

    Accessors

    • get dataset(): DOMStringMap

      The dataset for the widget's DOM node.

      Returns DOMStringMap

    • get disposed(): ISignal<this, void>

      A signal emitted when the widget is disposed.

      Returns ISignal<this, void>

    • get hiddenMode(): HiddenMode

      Get the method for hiding the widget.

      Returns HiddenMode

    • set hiddenMode(value: HiddenMode): void

      Set the method for hiding the widget.

      Parameters

      Returns void

    • get id(): string

      Get the id of the widget's DOM node.

      Returns string

    • set id(value: string): void

      Set the id of the widget's DOM node.

      Parameters

      • value: string

      Returns void

    • get isAttached(): boolean

      Test whether the widget's node is attached to the DOM.

      Returns boolean

    • get isDisposed(): boolean

      Test whether the widget has been disposed.

      Returns boolean

    • get isHidden(): boolean

      Test whether the widget is explicitly hidden.

      Returns boolean

    • get isVisible(): boolean

      Test whether the widget is visible.

      A widget is visible when it is attached to the DOM, is not explicitly hidden, and has no explicitly hidden ancestors.

      Returns boolean

    • get layout(): null | Layout

      Get the layout for the widget.

      Returns null | Layout

    • set layout(value: null | Layout): void

      Set the layout for the widget.

      The layout is single-use only. It cannot be changed after the first assignment.

      The layout is disposed automatically when the widget is disposed.

      Parameters

      Returns void

    • get parent(): null | Widget

      Get the parent of the widget.

      Returns null | Widget

    • set parent(value: null | Widget): void

      Set the parent of the widget.

      Children are typically added to a widget by using a layout, which means user code will not normally set the parent widget directly.

      The widget will be automatically removed from its old parent.

      This is a no-op if there is no effective parent change.

      Parameters

      Returns void

    • get title(): Title<Widget>

      The title object for the widget.

      The title object is used by some container widgets when displaying the widget alongside some title, such as a tab panel or side bar.

      Since not all widgets will use the title, it is created on demand.

      The owner property of the title is set to this widget.

      Returns Title<Widget>

    Methods

    • Post an 'activate-request' message to the widget.

      This is a simple convenience method for posting the message.

      Returns void

    • Add a class name to the widget's DOM node.

      Parameters

      • name: string

        The class name to add to the node.

        If the class name is already added to the node, this is a no-op.

        The class name must not contain whitespace.

      Returns void

    • Type Parameters

      • K extends keyof HTMLElementEventMap

      Parameters

      Returns void

    • Type Parameters

      • K extends keyof HTMLElementEventMap = never

      Parameters

      Returns void

    • Type Parameters

      • K extends keyof HTMLElementEventMap

      Parameters

      • element: HTMLElement
      • type: K
      • OptionaluseCapture: boolean

      Returns void

    • Create an iterator over the widget's children.

      Returns IterableIterator<Widget>

      A new iterator over the children of the widget.

      The widget must have a populated layout in order to have children.

      If a layout is not installed, the returned iterator will be empty.

    • Clear the given widget flag.

      This will not typically be called directly by user code.

      Parameters

      Returns void

    • Send a 'close-request' message to the widget.

      This is a simple convenience method for sending the message.

      Returns void

    • Test whether a widget is a descendant of this widget.

      Parameters

      • widget: Widget

        The descendant widget of interest.

      Returns boolean

      true if the widget is a descendant, false otherwise.

    • Parameters

      • scrollContainer: HTMLElement

      Returns void

    • Dispose of the widget and its descendant widgets.

      It is unsafe to use the widget after it has been disposed.

      All calls made to this method after the first are a no-op.

      Returns void

    • Post a 'fit-request' message to the widget.

      This is a simple convenience method for posting the message.

      Returns void

    • Returns undefined | Node

    • Parameters

      • isNowVisible: boolean

      Returns void

    • Test whether the widget's DOM node has the given class name.

      Parameters

      • name: string

        The class name of interest.

      Returns boolean

      true if the node has the class, false otherwise.

    • Hide the widget and make it hidden to its parent widget.

      This causes the isHidden property to be true.

      If the widget is explicitly hidden, this is a no-op.

      Returns void

    • Invoke the message processing routine of the widget's layout.

      Parameters

      • msg: Message

        The message to dispatch to the layout.

        This is a no-op if the widget does not have a layout.

        This will not typically be called directly by user code.

      Returns void

    • A message handler invoked on an 'after-show' message.

      The default implementation of this handler is a no-op.

      Parameters

      Returns void

    • A message handler invoked on a 'before-hide' message.

      The default implementation of this handler is a no-op.

      Parameters

      Returns void

    • A message handler invoked on a 'fit-request' message.

      The default implementation of this handler is a no-op.

      Parameters

      Returns void

    • Remove a class name from the widget's DOM node.

      Parameters

      • name: string

        The class name to remove from the node.

        If the class name is not yet added to the node, this is a no-op.

        The class name must not contain whitespace.

      Returns void

    • Set the given widget flag.

      This will not typically be called directly by user code.

      Parameters

      Returns void

    • Show or hide the widget according to a boolean value.

      Parameters

      • hidden: boolean

        true to hide the widget, or false to show it.

        This is a convenience method for hide() and show().

      Returns void

    • Show the widget and make it visible to its parent widget.

      This causes the isHidden property to be false.

      If the widget is not explicitly hidden, this is a no-op.

      Returns void

    • Test whether the given widget flag is set.

      This will not typically be called directly by user code.

      Parameters

      Returns boolean

    • Toggle a class name on the widget's DOM node.

      Parameters

      • name: string

        The class name to toggle on the node.

      • Optionalforce: boolean

        Whether to force add the class (true) or force remove the class (false). If not provided, the presence of the class will be toggled from its current state.

      Returns boolean

      true if the class is now present, false otherwise.

      The class name must not contain whitespace.

    • Post an 'update-request' message to the widget.

      This is a simple convenience method for posting the message.

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    activateaddClassaddClipboardListeneraddEventListeneraddKeyListeneraddUpdateListenerchildrenclearFlagclosecontainsdisableScrollBarFocusdispatchMouseEventdisposedoHidedoSenddoShowdoUpdateContentfitforceHideforwardConsoleLoggetPreviewNodegetRedirectgetScrollContainerhandleContextMenuhandleVisiblityChangedhasClasshideinitloadLocalhostloadResourcenormalizeRequestUrinotifyLayoutononActivateRequestonAfterAttachonAfterDetachonAfterHideonAfterShowonBeforeAttachonBeforeDetachonBeforeHideonBeforeShowonChildAddedonChildRemovedonCloseRequestonFitRequestonResizeonUpdateRequestopenLinkpostMessagepreprocessHtmlprocessMessagereloadremoveClassrestoreStatesendMessagesetContentOptionssetFlagsetHiddensetHTMLsetIconUrlsetIframeHeightshowstoreStatestyletestFlagtoEndpointtoggleClasstoRemoteUrltoSupportedLinktraceupdate