ui.layout.IBasicLayoutComponent

Base Component to render a Layout.

Name	Type
D	extends IMinProvidedDataSet = IMinProvidedDataSet

currentMousePosition: MouseEvent

Element to access the current Mouse-Position

Memberof

IBasicLayoutComponent

---

Readonly data: D

Contains an actual set of the current data.

---

helpers: Object

Element containing specific helpers.

Author

M.Karkowski

Memberof

IBasicLayoutComponent

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

---

hotkeysEnabled: boolean

You can disable the hot-keys defined in configuration

Memberof

IBasicLayoutComponent

---

panelControlEnabled: boolean

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

Memberof

IBasicLayoutComponent

---

panelControlls: IPanelControl[]

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

Memberof

IBasicLayoutComponent

---

panels: IPossiblePanels

The Elment, holding the currently created instances.

Memberof

IBasicLayoutComponent

---

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

Flag, showing if the layout is ready or not.

Memberof

IBasicLayoutComponent

---

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

An Eventemitter, to show that the system has been resized

Memberof

IBasicLayoutComponent

---

toolbar: Object

Items of the Toolbar.

Memberof

IBasicLayoutComponent

Name	Type	Description
tabElement	any	The w2ui-elment of the tabs.
toolbarElement	any	The w2ui-element of the toolbar (The icons)
add	(tabID: string, config: { disabled?: boolean ; hidden?: boolean ; menu: IMenubar<D> ; onActive?: (D: any) => Promise<boolean> ; onLeave?: (D: any) => Promise<boolean> ; text: string ; tooltip?: string }) => void	The Tab to add.
destroy	() => void	Callback to destroy the Toolbar.
lock	(tab?: string) => void	Locks the tabs.
release	(tab?: string) => void	Releases the tabs.
remove	(tabID: string) => void	Removes the tab.

---

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

closeDynamicW2UiPanel(options): Promise<void>

Closes a dynamic window!

Name	Type	Description
options	Object	The options to use.
options.panel	ValidPanels	The Panel to show
options.silent?	boolean	Appends the Panel or replaces it.

Promise<void>

---

closeFullscreen(): void

Helper to close the fullscreen of the Lay

void

---

controllVisibilityOfPanel(panel, visible): void

Function to toggle the visiblity of a given panel.

Memberof

IBasicLayoutComponent

Name	Type	Description
panel	ValidPanels	The panel to manipulate.
visible	boolean	The visibility. false => hidden; true => visible.

void

---

enablePanelControllButton(panel, enabled): void

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

Memberof

IBasicLayoutComponent

Name	Type	Description
panel	ValidPanels	The panel of the button to manipulate.
enabled	boolean	false => disable; true => enable.

void

---

getElementOfPanel(panel): any

Returns the div of the panel.

Name	Type	Description
panel	ValidPanels	THe Panel.

any

---

isPanelVisible(panel): boolean

Helper, to check if the desired Panel is visible or not

Memberof

IBasicLayoutComponent

Name	Type	Description
panel	ValidPanels	The panel to check.

boolean

---

openDynamicW2UiPanel<I, O>(options): Promise<O>

Opens a dynamic w2ui panel

Author

M.Karkowski

Memberof

IBasicLayoutComponent

Name	Type	Description
I	any	Input data
O	extends TRenderFunctionResult = TRenderFunctionResult	Result Function of the Function

Name	Type	Description
options	Object	The ptions
options.append?	boolean	Appends the Panel or replaces it.
options.input?	I	Input which is fowarded to the render Function "render"
options.panel	ValidPanels	The Panel to show
options.render	TRenderFunction<I, O, D>	Callback which will be called to create the element
options.showOnCreate?	boolean	Show the Panel on creating

Promise<O>

---

openFullscreen(): void

Helper to open the fullscreen of the Layout.

void

---

setContentOfPanel(panel, content): void

Updates the content of the Panel.

Name	Type	Description
panel	ValidPanels	The panel
content	string	The content / HTML

void

---

setVisibilityOfPanel(panel, show): void

Changes the visiblity of a panel

Author

M.Karkowski

Memberof

IBasicLayoutComponent

Name	Type	Description
panel	ValidPanels	The panel to consider
show	boolean	The Flag to show / hide the panel. VISIBLE = TRUE;

void

---

toggleEdit(mode?): void

Toggles the Edit mode.

Memberof

IBasicLayoutComponent

Name	Type	Description
mode?	boolean	The Mode. To force.

void

---

toggleScreenMode(): void

Helper to toggle the Screen mode (Fullscreen or normal)

Author

M.Karkowski

Memberof

IBasicLayoutComponent

void