Class JsonSettingEditor

An interface for modifying and saving application settings.

Hierarchy

Constructors

constructor

Properties

_editor _fetching _instructions _list _saving _state _when key node registry state translator

Accessors

alignment canRevertRaw canSaveRaw commandsChanged dataset disposed handleMoved handles hiddenMode id isAttached isDisposed isHidden isVisible layout orientation parent renderer settings source spacing title widgets

Methods

_fetchState _onStateChanged _saveState _setLayout _setState activate addClass addWidget children clearFlag close contains dispose fit handleEvent hasClass hide insertWidget notifyLayout onActivateRequest onAfterAttach onAfterDetach onAfterHide onAfterShow onBeforeAttach onBeforeDetach onBeforeHide onBeforeShow onChildAdded onChildRemoved onCloseRequest onFitRequest onResize onUpdateRequest processMessage relativeSizes removeClass revert save setFlag setHidden setRelativeSizes show testFlag toggleClass update

Constructors

constructor

Properties

Private _editor

_editor: PluginEditor

Private _fetching

_fetching: null | Promise<void> = null

Private _instructions

_instructions: Widget

Private _list

_list: PluginList

Private _saving

_saving: boolean = false

Private _state

_state: ILayoutState = ...

Private _when

_when: Promise<any>

Readonly key

key: string

The state database key for the editor's state management.

Readonly node

node: HTMLElement

Get the DOM node owned by the widget.

Readonly registry

registry: ISettingRegistry

The setting registry used by the editor.

Readonly state

state: IStateDB<ReadonlyPartialJSONValue>

The state database used to store layout.

Protected translator

translator: ITranslator

Accessors

alignment

  • get alignment(): Alignment

  • Get the content alignment for the split panel.

    Notes

    This is the alignment of the widgets in the layout direction.

    The alignment has no effect if the widgets can expand to fill the entire split panel.

    Returns Alignment

  • set alignment(value): void

  • Set the content alignment for the split panel.

    Notes

    This is the alignment of the widgets in the layout direction.

    The alignment has no effect if the widgets can expand to fill the entire split panel.

    Parameters

    • value: Alignment

    Returns void

canRevertRaw

canSaveRaw

commandsChanged

dataset

  • get dataset(): DOMStringMap

  • The dataset for the widget's DOM node.

    Returns DOMStringMap

disposed

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

  • A signal emitted when the widget is disposed.

    Returns ISignal<this, void>

handleMoved

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

  • A signal emitted when a split handle has moved.

    Returns ISignal<this, void>

handles

  • get handles(): readonly HTMLDivElement[]

  • A read-only array of the split handles in the panel.

    Returns readonly HTMLDivElement[]

hiddenMode

  • get hiddenMode(): HiddenMode

  • Get the method for hiding the widget.

    Returns HiddenMode

  • set hiddenMode(value): void

  • Set the method for hiding the widget.

    Parameters

    • value: HiddenMode

    Returns void

id

  • get id(): string

  • Get the id of the widget's DOM node.

    Returns string

  • set id(value): void

  • Set the id of the widget's DOM node.

    Parameters

    • value: string

    Returns void

isAttached

  • get isAttached(): boolean

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

    Returns boolean

isDisposed

  • get isDisposed(): boolean

  • Test whether the widget has been disposed.

    Returns boolean

isHidden

  • get isHidden(): boolean

  • Test whether the widget is explicitly hidden.

    Returns boolean

isVisible

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

    Returns boolean

layout

  • get layout(): null | Layout

  • Get the layout for the widget.

    Returns null | Layout

  • set layout(value): void

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

    Parameters

    • value: null | Layout

    Returns void

orientation

  • get orientation(): Orientation

  • Get the layout orientation for the split panel.

    Returns Orientation

  • set orientation(value): void

  • Set the layout orientation for the split panel.

    Parameters

    • value: Orientation

    Returns void

parent

  • get parent(): null | Widget

  • Get the parent of the widget.

    Returns null | Widget

  • set parent(value): void

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

    Parameters

    Returns void

renderer

  • get renderer(): IRenderer

  • The renderer used by the split panel.

    Returns IRenderer

settings

source

spacing

  • get spacing(): number

  • Get the inter-element spacing for the split panel.

    Returns number

  • set spacing(value): void

  • Set the inter-element spacing for the split panel.

    Parameters

    • value: number

    Returns void

title

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

    Returns Title<Widget>

widgets

  • get widgets(): readonly Widget[]

  • A read-only array of the widgets in the panel.

    Returns readonly Widget[]

Methods

Private _fetchState

Private _onStateChanged

Private _saveState

Private _setLayout

Private _setState

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): 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

addWidget

  • addWidget(widget): void

  • Add a widget to the end of the panel.

    Parameters

    • widget: Widget

      The widget to add to the panel.

      Notes

      If the widget is already contained in the panel, it will be moved.

    Returns void

children

  • children(): IterableIterator<Widget>

  • Create an iterator over the widget's children.

    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): void

  • Clear the given widget flag.

    Notes

    This will not typically be called directly by user code.

    Parameters

    • flag: Flag

    Returns void

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): 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

fit

  • fit(): void

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

    Notes

    This is a simple convenience method for posting the message.

    Returns void

handleEvent

  • handleEvent(event): void

  • Handle the DOM events for the split panel.

    Parameters

    • event: Event

      The DOM event sent to the panel.

      Notes

      This method implements the DOM EventListener interface and is called in response to events on the panel's DOM node. It should not be called directly by user code.

    Returns void

hasClass

  • hasClass(name): 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

insertWidget

  • insertWidget(index, widget): void

  • Insert a widget at the specified index.

    Parameters

    • index: number

      The index at which to insert the widget.

    • widget: Widget

      The widget to insert into to the panel.

      Notes

      If the widget is already contained in the panel, it will be moved.

    Returns void

Protected notifyLayout

  • notifyLayout(msg): 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): void

  • A message handler invoked on an 'activate-request' message.

    Notes

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

    Parameters

    • msg: Message

    Returns void

Protected onAfterAttach

Protected onAfterDetach

  • onAfterDetach(msg): void

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

    Parameters

    • msg: Message

    Returns void

Protected onAfterHide

  • onAfterHide(msg): 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): 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): void

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

    Parameters

    • msg: Message

    Returns void

Protected onBeforeDetach

  • onBeforeDetach(msg): 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): 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): 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): void

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

    Parameters

    • msg: ChildMessage

    Returns void

Protected onChildRemoved

  • onChildRemoved(msg): void

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

    Parameters

    • msg: ChildMessage

    Returns void

Protected onCloseRequest

Protected onFitRequest

  • onFitRequest(msg): void

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

    Notes

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

    Parameters

    • msg: Message

    Returns void

Protected onResize

  • onResize(msg): 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 onUpdateRequest

  • onUpdateRequest(msg): void

  • A message handler invoked on an 'update-request' message.

    Notes

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

    Parameters

    • msg: Message

    Returns void

processMessage

  • processMessage(msg): 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

relativeSizes

  • relativeSizes(): number[]

  • Get the relative sizes of the widgets in the panel.

    Returns number[]

    A new array of the relative sizes of the widgets.

    Notes

    The returned sizes reflect the sizes of the widgets normalized relative to their siblings.

    This method does not measure the DOM nodes.

removeClass

  • removeClass(name): 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

revert

save

setFlag

  • setFlag(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): 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

setRelativeSizes

  • setRelativeSizes(sizes, update?): void

  • Set the relative sizes for the widgets in the panel.

    Parameters

    • sizes: number[]

      The relative sizes for the widgets in the panel.

    • Optional update: boolean

      Update the layout after setting relative sizes. Default is True.

      Notes

      Extra values are ignored, too few will yield an undefined layout.

      The actual geometry of the DOM nodes is updated asynchronously.

    Returns 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): 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, force?): 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

Settings

Member Visibility

Theme

On This Page

constructor_editor_fetching_instructions_list_saving_state_whenkeynoderegistrystatetranslatoralignmentcanRevertRawcanSaveRawcommandsChangeddatasetdisposedhandleMovedhandleshiddenModeidisAttachedisDisposedisHiddenisVisiblelayoutorientationparentrenderersettingssourcespacingtitlewidgets_fetchState_onStateChanged_saveState_setLayout_setStateactivateaddClassaddWidgetchildrenclearFlagclosecontainsdisposefithandleEventhasClasshideinsertWidgetnotifyLayoutonActivateRequestonAfterAttachonAfterDetachonAfterHideonAfterShowonBeforeAttachonBeforeDetachonBeforeHideonBeforeShowonChildAddedonChildRemovedonCloseRequestonFitRequestonResizeonUpdateRequestprocessMessagerelativeSizesremoveClassrevertsavesetFlagsetHiddensetRelativeSizesshowtestFlagtoggleClassupdate