Controller

Hierarchy

• Controller
  • DetailsController
  • DirectoryController
  • PopoverController
  • Tooltip

Implements

• BaseController

Index

Constructors

• constructor

Properties

• _canClose
• autoresize
• classList
• closable
• containers
• destroyed
• eventOptions
• events
• fullscreen
• loaded
• map
• middlewareOptions
• middlewares
• mobileCloseBtn
• name
• opened
• options
• parent
• position
• resizeSensor
• scrollable
• state
• styles
• template
• templates
• uid
• withToolbar

Methods

• adjustHeight
• close
• destroy
• getMainTemplate
• getToolbarTemplate
• getWrapperTemplate
• init
• is
• open
• redraw
• render
• resize
• setEventHandlers
• setMainTemplate
• setOptions
• setState
• setStyles
• updateScroll
• updateTopShift
• viewDidAppear
• viewDidDisappear
• viewDidLoad
• viewDidRedraw
• viewWillRedraw

Constructors

constructor

• new Controller(options: ControllerOptions): Controller

• Parameters

  • options: ControllerOptions

  Returns Controller

Properties

_canClose

_canClose: boolean

Implementation of BaseController._canClose

autoresize

autoresize: boolean

Implementation of BaseController.autoresize

classList

classList: string[]

Implementation of BaseController.classList

closable

closable: boolean

Implementation of BaseController.closable

containers

containers: { contentView?: HTMLElement; contentWrap?: HTMLElement; contentWrap2?: HTMLElement; main?: HTMLElement; parent: HTMLElement; sizer?: HTMLElement; toolbar?: HTMLElement; view?: HTMLElement }

Implementation of BaseController.containers

Type declaration

• optionalcontentView?: HTMLElement

• optionalcontentWrap?: HTMLElement

• optionalcontentWrap2?: HTMLElement

• optionalmain?: HTMLElement

• parent: HTMLElement

• optionalsizer?: HTMLElement

• optionaltoolbar?: HTMLElement

• optionalview?: HTMLElement

destroyed

destroyed: boolean

Implementation of BaseController.destroyed

eventOptions

eventOptions: { afterClose: BaseEventHandler<{ controller: BaseController }>; afterLoad: BaseEventHandler<{ controller: BaseController }>; afterRedraw: BaseEventHandler<{ controller: BaseController }>; afterShow: BaseEventHandler<{ controller: BaseController }>; afterUnload: BaseEventHandler<{ controller: BaseController }>; beforeClose: BaseEventHandler<{ controller: BaseController }>; beforeLoad: BaseEventHandler<{ controller: BaseController }>; beforeRedraw: BaseEventHandler<{ controller: BaseController }>; beforeShow: BaseEventHandler<{ controller: BaseController }>; resize: BaseEventHandler<{ controller: BaseController }> } & {}

Implementation of BaseController.eventOptions

events

events: Events

Implementation of BaseController.events

fullscreen

fullscreen: { lg: boolean; md: boolean; sm: boolean }

Implementation of BaseController.fullscreen

Type declaration

• lg: boolean

• md: boolean

• sm: boolean

loaded

loaded: boolean

Implementation of BaseController.loaded

map

map: MapSVGMap

Implementation of BaseController.map

middlewareOptions

middlewareOptions: Middleware[]

Implementation of BaseController.middlewareOptions

middlewares

middlewares: MiddlewareList

Implementation of BaseController.middlewares

mobileCloseBtn

mobileCloseBtn: HTMLElement

Implementation of BaseController.mobileCloseBtn

name

name: string

Implementation of BaseController.name

opened

opened: boolean

Implementation of BaseController.opened

options

options: unknown

Implementation of BaseController.options

optionalparent

parent?: ObjectWithEvents

Implementation of BaseController.parent

optionalposition

position?: absolute | relative | fixed

Implementation of BaseController.position

resizeSensor

resizeSensor: ResizeSensor

Implementation of BaseController.resizeSensor

scrollable

scrollable: boolean

Implementation of BaseController.scrollable

state

state: {}

Implementation of BaseController.state

Type declaration

• [key string]: any

styles

styles: Partial<CSSStyleDeclaration>

Implementation of BaseController.styles

template

template: string

Implementation of BaseController.template

templates

templates: { main: HandlebarsTemplateDelegate<any>; toolbar: HandlebarsTemplateDelegate<any> }

Implementation of BaseController.templates

Type declaration

• main: HandlebarsTemplateDelegate<any>

• toolbar: HandlebarsTemplateDelegate<any>

uid

uid: number

Implementation of BaseController.uid

withToolbar

withToolbar: boolean

Implementation of BaseController.withToolbar

Methods

adjustHeight

• adjustHeight(): void

• Adjusts height of the container to fit content.

  ---

  Returns void

close

• close(): void

• Closes the container

  ---

  Returns void

destroy

• destroy(): void

• Destroys the controller.

  ---

  Returns void

getMainTemplate

• getMainTemplate(): string

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

  ---

  Returns string

getToolbarTemplate

• getToolbarTemplate(): string

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

  ---

  Returns string

getWrapperTemplate

• getWrapperTemplate(): string

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

  ---

  Returns string

init

• init(): void

• Initialization

  ---

  Returns void

is

• is(name: string): boolean

• Parameters

  • name: string

  Returns boolean

open

• open(): void

• Returns void

redraw

• redraw(): void

• Redraws the container.

  ---

  Returns void

render

• render(): void

• Renders the content.

  ---

  Returns void

resize

• resize(): void

• Returns void

setEventHandlers

• setEventHandlers(): void

• Sets event handlers

  ---

  Returns void

setMainTemplate

• setMainTemplate(template: any): any

• Sets the template for the body

  ---

  Parameters

  • template: any

  Returns any

setOptions

• setOptions(options: Record<string, any>): void

• Parameters

  • options: Record<string, any>

  Returns void

setState

• setState(state?: {}, overwrite?: boolean): void

• Parameters

  • optionalstate: {}

  • overwrite: boolean = false

  Returns void

setStyles

• setStyles(styles: Partial<CSSStyleDeclaration>): void

• Parameters

  • styles: Partial<CSSStyleDeclaration>

  Returns void

updateScroll

• updateScroll(): void

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

  ---

  Returns void

updateTopShift

• updateTopShift(): void

• Updates top shift of the main container depending on toolbar height

  ---

  Returns void

viewDidAppear

• viewDidAppear(): void

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

  @abstract

  ---

  Returns void

viewDidDisappear

• viewDidDisappear(): void

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

  @abstract

  ---

  Returns void

viewDidLoad

• viewDidLoad(): void

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

  ---

  Returns void

viewDidRedraw

• viewDidRedraw(): void

• Returns void

viewWillRedraw

• viewWillRedraw(): void

• Returns void