Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CodeCell

A widget for a code cell. The namespace for the CodeCell class statics.

Hierarchy

Implements

  • IMessageHandler
  • IObservableDisposable

Index

Classes

Interfaces

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new CodeCell(options: IOptions): CodeCell

Properties

Private _output

_output: OutputArea = null

Private _outputHidden

_outputHidden: boolean = false

Private _outputPlaceholder

_outputPlaceholder: OutputPlaceholder = null

Private _outputWrapper

_outputWrapper: Widget = null

Private _outputsScrolled

_outputsScrolled: boolean

Private _rendermime

_rendermime: IRenderMimeRegistry = null

Private _savingMetadata

_savingMetadata: boolean = false

Private _syncScrolled

_syncScrolled: boolean = false

contentFactory

contentFactory: IContentFactory

The content factory used by the widget.

dataset

dataset: DOMStringMap

The dataset for the widget's DOM node.

disposed

disposed: ISignal<this, void>

A signal emitted when the widget is disposed.

id

id: string

Set the id of the widget's DOM node.

isAttached

isAttached: boolean

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

isDisposed

isDisposed: boolean

Test whether the widget has been disposed.

isHidden

isHidden: boolean

Test whether the widget is explicitly hidden.

isVisible

isVisible: boolean

Test whether the widget is visible.

Notes

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

layout

layout: Layout | null

Set the layout for the widget.

Notes

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

The layout is disposed automatically when the widget is disposed.

model

model: ICodeCellModel

The model used by the widget.

node

node: HTMLElement

Get the DOM node owned by the widget.

parent

parent: Widget | null

Set the parent of the widget.

Notes

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.

title

title: Title<Widget>

The title object for the widget.

Notes

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.

Static defaultContentFactory

defaultContentFactory: ContentFactory = new ContentFactory()

The default content factory for cells.

Accessors

editor

  • get editor(): IEditor

editorWidget

  • get editorWidget(): CodeEditorWrapper

inputArea

inputHidden

  • get inputHidden(): boolean
  • set inputHidden(value: boolean): void

outputArea

  • get outputArea(): OutputArea

  • Get the output area for the cell.

    Returns OutputArea

outputHidden

  • get outputHidden(): boolean
  • set outputHidden(value: boolean): void

  • The view state of output being collapsed.

    Returns boolean

  • The view state of output being collapsed.

    Parameters

    • value: boolean

    Returns void

outputsScrolled

  • get outputsScrolled(): boolean
  • set outputsScrolled(value: boolean): void

  • Whether the output is in a scrolled state?

    Returns boolean

  • Whether the output is in a scrolled state?

    Parameters

    • value: boolean

    Returns void

promptNode

  • get promptNode(): HTMLElement

readOnly

  • get readOnly(): boolean
  • set readOnly(value: boolean): void

ready

  • get ready(): Promise<void>

  • A promise that resolves when the widget renders for the first time.

    Returns Promise<void>

syncCollapse

  • get syncCollapse(): boolean
  • set syncCollapse(value: boolean): void

syncEditable

  • get syncEditable(): boolean
  • set syncEditable(value: boolean): void

syncScrolled

  • get syncScrolled(): boolean
  • set syncScrolled(value: boolean): void

  • Whether to sync the scrolled state to the cell model.

    Returns boolean

  • Whether to sync the scrolled state to the cell model.

    Parameters

    • value: boolean

    Returns void

Methods

Private _outputLengthHandler

  • _outputLengthHandler(sender: OutputArea, args: number): void

  • Handle changes in the number of outputs in the output area.

    Parameters

    • sender: OutputArea
    • args: number

    Returns void

activate

  • activate(): void

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

    Notes

    This is a simple convenience method for posting the message.

    Returns void

addClass

  • addClass(name: string): void

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

    Parameters

    • name: string

      The class name to add to the node.

      Notes

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

      The class name must not contain whitespace.

    Returns void

children

  • children(): IIterator<Widget>

  • Create an iterator over the widget's children.

    Returns IIterator<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

  • Clear the given widget flag.

    Notes

    This will not typically be called directly by user code.

    Parameters

    • flag: Flag

    Returns void

clone

cloneOutputArea

  • cloneOutputArea(): OutputArea

  • Clone the OutputArea alone, returning a simplified output area, using the same model.

    Returns OutputArea

close

  • close(): void

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

    Notes

    This is a simple convenience method for sending the message.

    Returns void

contains

  • contains(widget: Widget): boolean

  • 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.

dispose

  • dispose(): void

fit

  • fit(): void

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

    Notes

    This is a simple convenience method for posting the message.

    Returns void

Protected handleInputHidden

  • handleInputHidden(value: boolean): void

  • Handle the input being hidden.

    Notes

    This method is called by the case cell implementation and is subclasses here so the code cell can watch to see when input is hidden without accessing private state.

    Parameters

    • value: boolean

    Returns void

hasClass

  • hasClass(name: string): boolean

  • 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

  • hide(): void

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

    Notes

    This causes the isHidden property to be true.

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

    Returns void

initializeState

  • initializeState(): this

  • Initialize view state from model.

    Notes

    Should be called after construction. For convenience, returns this, so it can be chained in the construction, like new Foo().initializeState();

    Returns this

loadCollapseState

  • loadCollapseState(): void

  • Revert view collapse state from model.

    We consider the collapsed metadata key as the source of truth for outputs being hidden.

    Returns void

loadEditableState

  • loadEditableState(): void

loadScrolledState

  • loadScrolledState(): void

  • Revert view collapse state from model.

    Returns void

Protected notifyLayout

  • notifyLayout(msg: Message): void

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

    Parameters

    • msg: Message

      The message to dispatch to the layout.

      Notes

      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

Protected onActivateRequest

  • onActivateRequest(msg: Message): void

  • Handle 'activate-request' messages.

    Parameters

    • msg: Message

    Returns void

Protected onAfterAttach

  • onAfterAttach(msg: Message): void

  • Handle after-attach messages.

    Parameters

    • msg: Message

    Returns void

Protected onAfterDetach

  • onAfterDetach(msg: Message): void

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

    Notes

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

    Parameters

    • msg: Message

    Returns void

Protected onAfterHide

  • onAfterHide(msg: Message): void

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

    Notes

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

    Parameters

    • msg: Message

    Returns void

Protected onAfterShow

  • onAfterShow(msg: Message): void

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

    Notes

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

    Parameters

    • msg: Message

    Returns void

Protected onBeforeAttach

  • onBeforeAttach(msg: Message): void

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

    Notes

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

    Parameters

    • msg: Message

    Returns void

Protected onBeforeDetach

  • onBeforeDetach(msg: Message): void

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

    Notes

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

    Parameters

    • msg: Message

    Returns void

Protected onBeforeHide

  • onBeforeHide(msg: Message): void

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

    Notes

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

    Parameters

    • msg: Message

    Returns void

Protected onBeforeShow

  • onBeforeShow(msg: Message): void

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

    Notes

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

    Parameters

    • msg: Message

    Returns void

Protected onChildAdded

  • onChildAdded(msg: ChildMessage): void

  • A message handler invoked on a 'child-added' message.

    Notes

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

    Parameters

    • msg: ChildMessage

    Returns void

Protected onChildRemoved

  • onChildRemoved(msg: ChildMessage): void

  • A message handler invoked on a 'child-removed' message.

    Notes

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

    Parameters

    • msg: ChildMessage

    Returns void

Protected onCloseRequest

  • onCloseRequest(msg: Message): void

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

    Notes

    The default implementation unparents or detaches the widget.

    Parameters

    • msg: Message

    Returns void

Protected onFitRequest

  • onFitRequest(msg: Message): void

  • Handle fit-request messages.

    Parameters

    • msg: Message

    Returns void

Protected onMetadataChanged

  • onMetadataChanged(model: IObservableMap<JSONValue>, args: IChangedArgs<JSONValue>): void

  • Handle changes in the metadata.

    Parameters

    • model: IObservableMap<JSONValue>
    • args: IChangedArgs<JSONValue>

    Returns void

Protected onResize

  • onResize(msg: ResizeMessage): void

  • A message handler invoked on a 'resize' message.

    Notes

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

    Parameters

    • msg: ResizeMessage

    Returns void

Protected onStateChanged

  • onStateChanged(model: ICellModel, args: IChangedArgs<any>): void

  • Handle changes in the model.

    Parameters

    Returns void

Protected onUpdateRequest

  • onUpdateRequest(msg: Message): void

  • Handle update-request messages.

    Parameters

    • msg: Message

    Returns void

processMessage

  • processMessage(msg: Message): void

  • Process a message sent to the widget.

    Parameters

    • msg: Message

      The message sent to the widget.

      Notes

      Subclasses may reimplement this method as needed.

    Returns void

removeClass

  • removeClass(name: string): void

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

    Parameters

    • name: string

      The class name to remove from the node.

      Notes

      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

saveCollapseState

  • saveCollapseState(): void

saveEditableState

  • saveEditableState(): void

saveScrolledState

  • saveScrolledState(): void

  • Save view collapse state to model

    Returns void

setFlag

  • setFlag(flag: Flag): void

  • Set the given widget flag.

    Notes

    This will not typically be called directly by user code.

    Parameters

    • flag: Flag

    Returns void

setHidden

  • setHidden(hidden: boolean): void

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

    Parameters

    • hidden: boolean

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

      Notes

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

    Returns void

setPrompt

  • setPrompt(value: string): void

show

  • show(): void

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

    Notes

    This causes the isHidden property to be false.

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

    Returns void

testFlag

  • testFlag(flag: Flag): boolean

  • Test whether the given widget flag is set.

    Notes

    This will not typically be called directly by user code.

    Parameters

    • flag: Flag

    Returns boolean

toggleClass

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

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

    Parameters

    • name: string

      The class name to toggle on the node.

    • Optional force: 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.

    Notes

    The class name must not contain whitespace.

update

  • update(): void

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

    Notes

    This is a simple convenience method for posting the message.

    Returns void

Static execute

  • execute(cell: CodeCell, session: IClientSession, metadata?: JSONObject): Promise<IExecuteReplyMsg | void>

  • Execute a cell given a client session.

    Parameters

    • cell: CodeCell
    • session: IClientSession
    • Optional metadata: JSONObject

    Returns Promise<IExecuteReplyMsg | void>

Generated using TypeDoc