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

    An object which assists in the absolute layout of widgets.

    This class is useful when implementing a layout which arranges its widgets using absolute positioning.

    This class is used by nearly all of the built-in lumino layouts.

    Implements

    • IDisposable
    Index

    Constructors

    • Construct a new layout item.

      Parameters

      • widget: Widget

        The widget to be managed by the item.

        The widget will be set to absolute positioning. The widget will use strict CSS containment.

      Returns LayoutItem

    Properties

    widget: Widget

    The widget managed by the layout item.

    Accessors

    • get isAttached(): boolean

      Whether the managed widget is attached.

      Returns boolean

    • get isDisposed(): boolean

      Whether the layout item is disposed.

      Returns boolean

    • get isHidden(): boolean

      Whether the managed widget is hidden.

      Returns boolean

    • get isVisible(): boolean

      Whether the managed widget is visible.

      Returns boolean

    • get maxHeight(): number

      The computed maximum height of the widget.

      This value can be updated by calling the fit method.

      Returns number

    • get maxWidth(): number

      The computed maximum width of the widget.

      This value can be updated by calling the fit method.

      Returns number

    • get minHeight(): number

      The computed minimum height of the widget.

      This value can be updated by calling the fit method.

      Returns number

    • get minWidth(): number

      The computed minimum width of the widget.

      This value can be updated by calling the fit method.

      Returns number

    Methods

    • Dispose of the the layout item.

      This will reset the positioning of the widget.

      Returns void

    • Update the computed size limits of the managed widget.

      Returns void

    • Update the position and size of the managed widget.

      Parameters

      • left: number

        The left edge position of the layout box.

      • top: number

        The top edge position of the layout box.

      • width: number

        The width of the layout box.

      • height: number

        The height of the layout box.

      Returns void