Class: ToolbarController

Extends

• Controller

Constructors

Constructor

new ToolbarController(options): ToolbarController;

Parameters

Parameter	Type
options	ToolbarControllerOptions

Returns

ToolbarController

Overrides

Controller.constructor

Methods

adjustHeight()

adjustHeight(): void;

Adjusts height of the container to fit content.

Returns

void

Inherited from

Controller.adjustHeight

---

close()

close(): void;

Closes the container

Returns

void

Inherited from

Controller.close

---

destroy()

destroy(): void;

Destroys the controller.

Returns

void

Inherited from

Controller.destroy

---

getMainTemplate()

getMainTemplate(): string;

This method must be overriden by a child class and to return an HTML code for the main content

Returns

string

Inherited from

Controller.getMainTemplate

---

getToolbarTemplate()

getToolbarTemplate(): string;

This method must be overriden by a child class and return an HTML code for the toolbar.

Returns

string

Inherited from

Controller.getToolbarTemplate

---

getWrapperTemplate()

getWrapperTemplate(): string;

This method must be overriden by a child class and to return an HTML code for the main content

Returns

string

Inherited from

Controller.getWrapperTemplate

---

init()

init(): void;

Initialization

Returns

void

Inherited from

Controller.init

---

is()

is(name): boolean;

Parameters

Parameter	Type
name	string

Returns

boolean

Inherited from

Controller.is

---

open()

open(): void;

Returns

void

Inherited from

Controller.open

---

redraw()

redraw(): void;

Redraws the container.

Returns

void

Inherited from

Controller.redraw

---

render()

render(): void;

Renders the content.

Returns

void

Inherited from

Controller.render

---

resize()

resize(): void;

Returns

void

Inherited from

Controller.resize

---

setEventHandlers()

setEventHandlers(): void;

Sets event handlers

Returns

void

Overrides

Controller.setEventHandlers

---

setMainTemplate()

setMainTemplate(template): HandlebarsTemplateDelegate<any>;

Sets the template for the body

Parameters

Parameter	Type
template	any

Returns

HandlebarsTemplateDelegate<any>

Inherited from

Controller.setMainTemplate

---

setOptions()

setOptions(options): void;

Parameters

Parameter	Type
options	Record<string, any>

Returns

void

Inherited from

Controller.setOptions

---

setState()

setState(state?, overwrite?): void;

Parameters

Parameter	Type	Default value
state?	{ [key: string]: any; }	undefined
overwrite?	boolean	false

Returns

void

Inherited from

Controller.setState

---

setStyles()

setStyles(styles): void;

Parameters

Parameter	Type
styles	Partial<CSSStyleDeclaration>

Returns

void

Inherited from

Controller.setStyles

---

show()

show(controllerName): void;

Parameters

Parameter	Type
controllerName	string

Returns

void

---

updateScroll()

updateScroll(): void;

Updates the size of the scrollable container. Automatically fires when window size or content size changes.

Returns

void

Inherited from

Controller.updateScroll

---

updateTopShift()

updateTopShift(): void;

Updates top shift of the main container depending on toolbar height

Returns

void

Inherited from

Controller.updateTopShift

---

viewDidAppear()

abstract viewDidAppear(): void;

Fires when the view appears after being hidden. Should be overriden by a child class.

Returns

void

Inherited from

Controller.viewDidAppear

---

viewDidDisappear()

abstract viewDidDisappear(): void;

This method fires when the view disappears. Should be overriden by a child class.

Returns

void

Inherited from

Controller.viewDidDisappear

---

viewDidLoad()

viewDidLoad(): void;

This method fires when the view is fully loaded. Can be used to do any final actions.

Returns

void

Inherited from

Controller.viewDidLoad

---

viewDidRedraw()

viewDidRedraw(): void;

Returns

void

Overrides

Controller.viewDidRedraw

---

viewWillRedraw()

viewWillRedraw(): void;

Returns

void

Inherited from

Controller.viewWillRedraw

Properties

_canClose

_canClose: boolean;

Inherited from

Controller._canClose

---

autoresize

autoresize: boolean;

Inherited from

Controller.autoresize

---

buttons

buttons: object;

Index Signature

[key: string]: HTMLButtonElement

---

classList

classList: string[];

Inherited from

Controller.classList

---

closable

closable: boolean;

Inherited from

Controller.closable

---

containers

containers: object;

contentView?

optional contentView: HTMLElement;

contentWrap?

optional contentWrap: HTMLElement;

contentWrap2?

optional contentWrap2: HTMLElement;

main?

optional main: HTMLElement;

parent

parent: HTMLElement;

sizer?

optional sizer: HTMLElement;

toolbar?

optional toolbar: HTMLElement;

view?

optional view: HTMLElement;

Inherited from

Controller.containers

---

destroyed

destroyed: boolean;

Inherited from

Controller.destroyed

---

eventOptions

eventOptions: object & object;

Type declaration

afterClose?

optional afterClose: BaseEventHandler<{
  controller: BaseController;
}>;

afterLoad?

optional afterLoad: BaseEventHandler<{
  controller: BaseController;
}>;

afterRedraw?

optional afterRedraw: BaseEventHandler<{
  controller: BaseController;
}>;

afterShow?

optional afterShow: BaseEventHandler<{
  controller: BaseController;
}>;

afterUnload?

optional afterUnload: BaseEventHandler<{
  controller: BaseController;
}>;

beforeClose?

optional beforeClose: BaseEventHandler<{
  controller: BaseController;
}>;

beforeLoad?

optional beforeLoad: BaseEventHandler<{
  controller: BaseController;
}>;

beforeRedraw?

optional beforeRedraw: BaseEventHandler<{
  controller: BaseController;
}>;

beforeShow?

optional beforeShow: BaseEventHandler<{
  controller: BaseController;
}>;

resize?

optional resize: BaseEventHandler<{
  controller: BaseController;
}>;

Inherited from

Controller.eventOptions

---

events

events: Events;

Inherited from

Controller.events

---

fullscreen

fullscreen: object;

lg

lg: boolean;

md

md: boolean;

sm

sm: boolean;

Inherited from

Controller.fullscreen

---

loaded

loaded: boolean;

Inherited from

Controller.loaded

---

map

map: MapSVGMap;

Inherited from

Controller.map

---

middlewareOptions

middlewareOptions: Middleware[];

Inherited from

Controller.middlewareOptions

---

middlewares

middlewares: MiddlewareList;

Inherited from

Controller.middlewares

---

mobileCloseBtn

mobileCloseBtn: HTMLElement;

Inherited from

Controller.mobileCloseBtn

---

name

name: string;

Inherited from

Controller.name

---

noPadding?

optional noPadding: boolean;

Inherited from

Controller.noPadding

---

opened

opened: boolean;

Inherited from

Controller.opened

---

openedFullscreen

openedFullscreen: boolean = false;

Inherited from

Controller.openedFullscreen

---

options

options: unknown;

Inherited from

Controller.options

---

parent?

optional parent: ObjectWithEvents;

Inherited from

Controller.parent

---

position?

optional position: "absolute" | "relative" | "fixed";

Inherited from

Controller.position

---

resizeSensor

resizeSensor: ResizeSensor;

Inherited from

Controller.resizeSensor

---

scrollable

scrollable: boolean;

Inherited from

Controller.scrollable

---

state

state: object;

Index Signature

[key: string]: any

Inherited from

Controller.state

---

styles

styles: Partial<CSSStyleDeclaration>;

Inherited from

Controller.styles

---

template

template: string;

Inherited from

Controller.template

---

templates

templates: object;

main

main: HandlebarsTemplateDelegate<any>;

toolbar

toolbar: HandlebarsTemplateDelegate<any>;

Inherited from

Controller.templates

---

uid

uid: number;

Inherited from

Controller.uid

---

withToolbar

withToolbar: boolean;

Inherited from

Controller.withToolbar