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

    Class PanelLayout

    A concrete layout implementation suitable for many use cases.

    This class is suitable as a base class for implementing a variety of layouts, but can also be used directly with standard CSS to layout a collection of widgets.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Accessors

    fitPolicy isDisposed parent widgets

    Methods

    [iterator] addWidget attachWidget detachWidget dispose init insertWidget moveWidget onAfterAttach onAfterDetach onAfterHide onAfterShow onBeforeAttach onBeforeDetach onBeforeHide onBeforeShow onChildHidden onChildRemoved onChildShown onFitRequest onResize onUpdateRequest processParentMessage removeWidget removeWidgetAt

    Constructors

    Accessors

    • get fitPolicy(): FitPolicy

      Get the fit policy for the layout.

      The fit policy controls the computed size constraints which are applied to the parent widget by the layout.

      Some layout implementations may ignore the fit policy.

      Returns FitPolicy

    • set fitPolicy(value: FitPolicy): void

      Set the fit policy for the layout.

      The fit policy controls the computed size constraints which are applied to the parent widget by the layout.

      Some layout implementations may ignore the fit policy.

      Changing the fit policy will clear the current size constraint for the parent widget and then re-fit the parent.

      Parameters

      Returns void

    • get isDisposed(): boolean

      Test whether the layout is disposed.

      Returns boolean

    • get parent(): null | Widget

      Get the parent widget of the layout.

      Returns null | Widget

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

      Set the parent widget of the layout.

      This is set automatically when installing the layout on the parent widget. The parent widget should not be set directly by user code.

      Parameters

      Returns void

    • get widgets(): readonly Widget[]

      A read-only array of the widgets in the layout.

      Returns readonly Widget[]

    Methods

    • Create an iterator over the widgets in the layout.

      Returns IterableIterator<Widget>

      A new iterator over the widgets in the layout.

    • Add a widget to the end of the layout.

      Parameters

      • widget: Widget

        The widget to add to the layout.

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

      Returns void

    • Attach a widget to the parent's DOM node.

      Parameters

      • index: number

        The current index of the widget in the layout.

      • widget: Widget

        The widget to attach to the parent.

        This method is called automatically by the panel layout at the appropriate time. It should not be called directly by user code.

        The default implementation adds the widgets's node to the parent's node at the proper location, and sends the appropriate attach messages to the widget if the parent is attached to the DOM.

        Subclasses may reimplement this method to control how the widget's node is added to the parent's node.

      Returns void

    • Detach a widget from the parent's DOM node.

      Parameters

      • index: number

        The previous index of the widget in the layout.

      • widget: Widget

        The widget to detach from the parent.

        This method is called automatically by the panel layout at the appropriate time. It should not be called directly by user code.

        The default implementation removes the widget's node from the parent's node, and sends the appropriate detach messages to the widget if the parent is attached to the DOM.

        Subclasses may reimplement this method to control how the widget's node is removed from the parent's node.

      Returns void

    • Dispose of the resources held by the layout.

      This will clear and dispose all widgets in the layout.

      All reimplementations should call the superclass method.

      This method is called automatically when the parent is disposed.

      Returns void

    • Perform layout initialization which requires the parent widget.

      Returns void

    • Insert a widget into the layout at the specified index.

      Parameters

      • index: number

        The index at which to insert the widget.

      • widget: Widget

        The widget to insert into the layout.

        The index will be clamped to the bounds of the widgets.

        If the widget is already added to the layout, it will be moved.

        An index which is non-integral.

      Returns void

    • Move a widget in the parent's DOM node.

      Parameters

      • fromIndex: number

        The previous index of the widget in the layout.

      • toIndex: number

        The current index of the widget in the layout.

      • widget: Widget

        The widget to move in the parent.

        This method is called automatically by the panel layout at the appropriate time. It should not be called directly by user code.

        The default implementation moves the widget's node to the proper location in the parent's node and sends the appropriate attach and detach messages to the widget if the parent is attached to the DOM.

        Subclasses may reimplement this method to control how the widget's node is moved in the parent's node.

      Returns void

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

      The default implementation of this method forwards the message to all widgets. It assumes all widget nodes are attached to the parent widget node.

      This may be reimplemented by subclasses as needed.

      Parameters

      Returns void

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

      The default implementation of this method forwards the message to all widgets. It assumes all widget nodes are attached to the parent widget node.

      This may be reimplemented by subclasses as needed.

      Parameters

      Returns void

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

      The default implementation of this method forwards the message to all non-hidden widgets. It assumes all widget nodes are attached to the parent widget node.

      This may be reimplemented by subclasses as needed.

      Parameters

      Returns void

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

      The default implementation of this method forwards the message to all non-hidden widgets. It assumes all widget nodes are attached to the parent widget node.

      This may be reimplemented by subclasses as needed.

      Parameters

      Returns void

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

      The default implementation of this method forwards the message to all widgets. It assumes all widget nodes are attached to the parent widget node.

      This may be reimplemented by subclasses as needed.

      Parameters

      Returns void

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

      The default implementation of this method forwards the message to all widgets. It assumes all widget nodes are attached to the parent widget node.

      This may be reimplemented by subclasses as needed.

      Parameters

      Returns void

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

      The default implementation of this method forwards the message to all non-hidden widgets. It assumes all widget nodes are attached to the parent widget node.

      This may be reimplemented by subclasses as needed.

      Parameters

      Returns void

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

      The default implementation of this method forwards the message to all non-hidden widgets. It assumes all widget nodes are attached to the parent widget node.

      This may be reimplemented by subclasses as needed.

      Parameters

      Returns void

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

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

      Parameters

      Returns void

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

      This will remove the child widget from the layout.

      Subclasses should not typically reimplement this method.

      Parameters

      Returns void

    • A message handler invoked on a 'child-shown' 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

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

      The layout should ensure that its widgets are resized according to the specified layout space, and that they are sent a 'resize' message if appropriate.

      The default implementation of this method sends an UnknownSize resize message to all widgets.

      This may be reimplemented by subclasses as needed.

      Parameters

      Returns void

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

      The layout should ensure that its widgets are resized according to the available layout space, and that they are sent a 'resize' message if appropriate.

      The default implementation of this method sends an UnknownSize resize message to all widgets.

      This may be reimplemented by subclasses as needed.

      Parameters

      Returns void

    • Process a message sent to the parent widget.

      Parameters

      • msg: Message

        The message sent to the parent widget.

        This method is called by the parent widget to process a message.

        Subclasses may reimplement this method as needed.

      Returns void

    • Remove a widget from the layout.

      Parameters

      • widget: Widget

        The widget to remove from the layout.

        A widget is automatically removed from the layout when its parent is set to null. This method should only be invoked directly when removing a widget from a layout which has yet to be installed on a parent widget.

        This method does not modify the widget's parent.

      Returns void

    • Remove the widget at a given index from the layout.

      Parameters

      • index: number

        The index of the widget to remove.

        A widget is automatically removed from the layout when its parent is set to null. This method should only be invoked directly when removing a widget from a layout which has yet to be installed on a parent widget.

        This method does not modify the widget's parent.

        An index which is non-integral.

      Returns void

    Settings

    Member Visibility

    On This Page

    Notes
    Constructors
    Accessors
    Methods