SearchDocumentView | @jupyterlab (original) (raw)

Hierarchy (View Summary)

• VDomRenderer<SearchDocumentModel>
  • SearchDocumentView

Index

Constructors

constructor

• new SearchDocumentView(
  model: SearchDocumentModel,
  translator?: ITranslator,
  keyBindings?: ISearchKeyBindings,
  ): SearchDocumentView

• Parameters

  • model: SearchDocumentModel
  • Optionaltranslator: ITranslator
  • OptionalkeyBindings: ISearchKeyBindings

Returns SearchDocumentView

Properties

Readonlynode

OptionalrenderPromise

renderPromise?: Promise<void>

Protected Optionaltranslator

Accessors

closed

• get closed(): ISignal<SearchDocumentView, void>

• Returns ISignal<SearchDocumentView, void>

dataset

• get dataset(): DOMStringMap

• Returns DOMStringMap

disposed

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

• Returns ISignal<this, void>

hiddenMode

• get hiddenMode(): HiddenMode

• Returns HiddenMode

• set hiddenMode(value: HiddenMode): void

• Parameters

  • value: HiddenMode

Returns void

id

• get id(): string

• Returns string

• set id(value: string): void

• Returns void

isAttached

• get isAttached(): boolean

• Returns boolean

isDisposed

• get isDisposed(): boolean

• Returns boolean

isHidden

• get isHidden(): boolean

• Returns boolean

isVisible

• get isVisible(): boolean

• Returns boolean

layout

• get layout(): null | Layout

• Returns null | Layout

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

• Parameters

  • value: null | Layout

Returns void

model

• get model(): T

• Returns T

• set model(newValue: T): void

• Returns void

modelChanged

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

• Returns ISignal<this, void>

parent

• get parent(): null | Widget

• Returns null | Widget

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

• Parameters

  • value: null | Widget

Returns void

title

• get title(): Title<Widget>

• Returns Title<Widget>

Methods

activate

• activate(): void

• Returns void

addClass

• addClass(name: string): void

• Returns void

children

• children(): IterableIterator<Widget>

• Returns IterableIterator<Widget>

A new iterator over the children of the widget.

Notes

The widget must have a populated layout in order to have children.
If a layout is not installed, the returned iterator will be empty.

clearFlag

• clearFlag(flag: Flag): void

• Returns void

close

• close(): void

• Returns void

contains

• contains(widget: Widget): boolean

• Returns boolean

true if the widget is a descendant, false otherwise.

dispose

• dispose(): void

• Returns void

fit

• fit(): void

• Returns void

focusSearchInput

• focusSearchInput(): void

• Returns void

hasClass

• hasClass(name: string): boolean

• Returns boolean

true if the node has the class, false otherwise.

hide

• hide(): void

• Returns void

ProtectednotifyLayout

• notifyLayout(msg: Message): void

• Returns void

ProtectedonActivateRequest

• onActivateRequest(msg: Message): void

• Returns void

ProtectedonAfterAttach

• onAfterAttach(msg: Message): void

• Returns void

ProtectedonAfterDetach

• onAfterDetach(msg: Message): void

• Returns void

ProtectedonAfterHide

• onAfterHide(msg: Message): void

• Returns void

ProtectedonAfterShow

• onAfterShow(msg: Message): void

• Returns void

ProtectedonBeforeAttach

• onBeforeAttach(msg: Message): void

• Returns void

ProtectedonBeforeDetach

• onBeforeDetach(msg: Message): void

• Returns void

ProtectedonBeforeHide

• onBeforeHide(msg: Message): void

• Returns void

ProtectedonBeforeShow

• onBeforeShow(msg: Message): void

• Returns void

ProtectedonChildAdded

• onChildAdded(msg: ChildMessage): void

• Parameters

  • msg: ChildMessage

Returns void

ProtectedonChildRemoved

• onChildRemoved(msg: ChildMessage): void

• Parameters

  • msg: ChildMessage

Returns void

ProtectedonCloseRequest

• onCloseRequest(msg: Message): void

• Returns void

ProtectedonFitRequest

• onFitRequest(msg: Message): void

• Returns void

ProtectedonResize

• onResize(msg: ResizeMessage): void

• Parameters

  • msg: ResizeMessage

Returns void

ProtectedonUpdateRequest

• onUpdateRequest(msg: Message): void

• Returns void

processMessage

• processMessage(msg: Message): void

• Returns void

removeClass

• removeClass(name: string): void

• Returns void

render

• render(): Element

• Returns Element

ProtectedsetFiltersVisibility

• setFiltersVisibility(v: boolean): void

• Returns void

setFlag

• setFlag(flag: Flag): void

• Returns void

setHidden

• setHidden(hidden: boolean): void

• Parameters

  • hidden: boolean

Returns void

ProtectedsetReplaceInputVisibility

• setReplaceInputVisibility(v: boolean): void

• Returns void

setReplaceText

• setReplaceText(replace: string): void

• Parameters

  • replace: string

Returns void

setSearchText

• setSearchText(search: string): void

• Returns void

show

• show(): void

• Returns void

showReplace

• showReplace(): void

• Returns void

testFlag

• testFlag(flag: Flag): boolean

• Returns boolean

toggleClass

• toggleClass(name: string, force?: boolean): boolean

• Parameters

  • name: string
  • Optionalforce: boolean

Returns boolean

true if the class is now present, false otherwise.

Notes

The class name must not contain whitespace.

update

• update(): void

• Returns void

Staticcreate

• create(element: ReactRenderElement): ReactWidget

• Parameters

  • element: ReactRenderElement

Returns ReactWidget