Interface IBasicLayoutComponent<D>

Base Component to render a Layout.

Type Parameters

Hierarchy

  • IBasicLayoutComponent

Properties

currentMousePosition data helpers hotkeysEnabled panelControlEnabled panelControlls panels ready resized toolbar w2uiLayout

Methods

closeDynamicW2UiPanel closeFullscreen controllVisibilityOfPanel enablePanelControllButton getElementOfPanel isPanelVisible openDynamicW2UiPanel openFullscreen setContentOfPanel setVisibilityOfPanel toggleEdit toggleScreenMode

Properties

currentMousePosition

currentMousePosition: MouseEvent

Element to access the current Mouse-Position

Memberof

IBasicLayoutComponent

Readonly data

data: D

Contains an actual set of the current data.

helpers

helpers: {
    [index: string]: ((...args) => any);
}

Element containing specific helpers.

Author

M.Karkowski

Memberof

IBasicLayoutComponent

Type declaration

  • [index: string]: ((...args) => any)
      • (...args): any

      • Parameters

        • Rest ...args: any

        Returns any

hotkeysEnabled

hotkeysEnabled: boolean

You can disable the hot-keys defined in configuration

Memberof

IBasicLayoutComponent

panelControlEnabled

panelControlEnabled: boolean

Flag, to toggle the Panel-Control. If set to false this control is not shown.

Memberof

IBasicLayoutComponent

panelControlls

panelControlls: IPanelControl[]

Controll elements for the Panels. Contains a toggle function, an icon, tooltip etc. This shows / hides the panels.

Memberof

IBasicLayoutComponent

panels

panels: IPossiblePanels

The Elment, holding the currently created instances.

Memberof

IBasicLayoutComponent

ready

ready: INopeObservable<boolean, boolean, boolean, IEventAdditionalData>

Flag, showing if the layout is ready or not.

Memberof

IBasicLayoutComponent

resized

resized: INopeEventEmitter<IPossiblePanels, IPossiblePanels, IPossiblePanels, IEventAdditionalData>

An Eventemitter, to show that the system has been resized

Memberof

IBasicLayoutComponent

toolbar

toolbar: {
    tabElement: any;
    toolbarElement: any;
    add(tabID, config) => void;
    destroy() => void;
    lock(tab?) => void;
    release(tab?) => void;
    remove(tabID) => void;
}

Items of the Toolbar.

Memberof

IBasicLayoutComponent

Type declaration

  • tabElement: any

    The w2ui-elment of the tabs.

  • toolbarElement: any

    The w2ui-element of the toolbar (The icons)

  • add:function
    • add(tabID, config): void

    • The Tab to add.

      Parameters

      • tabID: string

        The id of the Tab.

      • config: {
            disabled?: boolean;
            hidden?: boolean;
            menu: IMenubar<D>;
            onActive?: ((D) => Promise<boolean>);
            onLeave?: ((D) => Promise<boolean>);
            text: string;
            tooltip?: string;
        }

        The tab to add

        • Optional disabled?: boolean

          Flag which disables the Toolbar

        • Optional hidden?: boolean

          Flag which hides the Toolbar

        • menu: IMenubar<D>

          A Configuration of the Menu, which is provided inside of the Toolbar.

        • Optional onActive?: ((D) => Promise<boolean>)
            • (D): Promise<boolean>

            • Called, if the toolbar is active

              Parameters

              • D: any

              Returns Promise<boolean>

        • Optional onLeave?: ((D) => Promise<boolean>)
            • (D): Promise<boolean>

            • Called, if the toolbar should be left.

              Parameters

              • D: any

              Returns Promise<boolean>

        • text: string

          The Render Text of the Tab

        • Optional tooltip?: string

          A Tooltip, which is shown on hovering over the Tab-Element

      Returns void

  • destroy:function
  • lock:function
  • release:function
  • remove:function

w2uiLayout

w2uiLayout: any

The original W2UI Layout. See here for more details and navigate to layout. There you'll find all methods, events and properties to manipulate the layout. But you should use the wrappers, provided by the abstraction in here.

Memberof

IBasicLayoutComponent

Methods

closeDynamicW2UiPanel

closeFullscreen

controllVisibilityOfPanel

  • Function to toggle the visiblity of a given panel.

    Memberof

    IBasicLayoutComponent

    Parameters

    • panel: types.ui.layout.ValidPanels

      The panel to manipulate.

    • visible: boolean

      The visibility. false => hidden; true => visible.

    Returns void

enablePanelControllButton

  • Helper to enable/disable the Controll Button of a panel. Therefore the Controll-Button must be present.

    Memberof

    IBasicLayoutComponent

    Parameters

    • panel: types.ui.layout.ValidPanels

      The panel of the button to manipulate.

    • enabled: boolean

      false => disable; true => enable.

    Returns void

getElementOfPanel

isPanelVisible

openDynamicW2UiPanel

  • Opens a dynamic w2ui panel

    Author

    M.Karkowski

    Memberof

    IBasicLayoutComponent

    Type Parameters

    Parameters

    • options: {
          append?: boolean;
          input?: I;
          panel: types.ui.layout.ValidPanels;
          render: TRenderFunction<I, O, D>;
          showOnCreate?: boolean;
      }

      The ptions

      • Optional append?: boolean

        Appends the Panel or replaces it.

      • Optional input?: I

        Input which is fowarded to the render Function "render"

      • panel: types.ui.layout.ValidPanels

        The Panel to show

      • render: TRenderFunction<I, O, D>

        Callback which will be called to create the element

      • Optional showOnCreate?: boolean

        Show the Panel on creating

    Returns Promise<O>

openFullscreen

setContentOfPanel

setVisibilityOfPanel

  • Changes the visiblity of a panel

    Author

    M.Karkowski

    Memberof

    IBasicLayoutComponent

    Parameters

    • panel: types.ui.layout.ValidPanels

      The panel to consider

    • show: boolean

      The Flag to show / hide the panel. VISIBLE = TRUE;

    Returns void

toggleEdit

  • Toggles the Edit mode.

    Memberof

    IBasicLayoutComponent

    Parameters

    • Optional mode: boolean

      The Mode. To force.

    Returns void

toggleScreenMode

  • Helper to toggle the Screen mode (Fullscreen or normal)

    Author

    M.Karkowski

    Memberof

    IBasicLayoutComponent

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc