DirectoryController
Hierarchy
- Controller
- DirectoryController
Index
Constructors
Properties
Methods
- addPagination
- adjustHeight
- close
- convertId
- deselectItems
- destroy
- getDirectoryItemObjects
- getMainTemplate
- getToolbarTemplate
- getWrapperTemplate
- highlightItems
- init
- is
- open
- redraw
- render
- resize
- selectItems
- setEventHandlers
- setMainTemplate
- setOptions
- setState
- setStyles
- toggle
- unhighlightItems
- updateScroll
- updateTopShift
- viewDidAppear
- viewDidDisappear
- viewDidRedraw
- viewWillRedraw
Constructors
constructor
Parameters
options: DirectoryControllerOptions
Returns DirectoryController
Properties
_canClose
autoresize
classList
closable
containers
Type declaration
optionalcontentView?: HTMLElement
optionalcontentWrap?: HTMLElement
optionalcontentWrap2?: HTMLElement
optionalmain?: HTMLElement
parent: HTMLElement
optionalsizer?: HTMLElement
optionaltoolbar?: HTMLElement
optionalview?: HTMLElement
destroyed
eventOptions
events
fade
fullscreen
loaded
map
mapBtn
menuBtn
middlewareOptions
middlewares
mobileButtons
mobileCloseBtn
name
opened
options
optionalparent
repository
resizeSensor
scrollable
state
Type declaration
[key string]: any
styles
template
templates
Type declaration
main: HandlebarsTemplateDelegate<any>
toolbar: HandlebarsTemplateDelegate<any>
withToolbar
Methods
addPagination
Parameters
pager: any
HTML string with the buttons
Returns void
adjustHeight
Adjusts height of the container to fit content.
Returns void
close
Closes the container
Returns void
convertId
Parameters
id: any
Returns string
deselectItems
Deselects directory items
Returns void
destroy
Destroys the controller.
Returns void
getDirectoryItemObjects
getMainTemplate
This method must be overriden by a child class and to return an HTML code for the main content
Returns string
getToolbarTemplate
Returns a HTML content for the Directory toolbar
Returns string
HTML content
getWrapperTemplate
This method must be overriden by a child class and to return an HTML code for the main content
Returns string
highlightItems
Highlights directory items
Parameters
ids: any
A list of object IDs
Returns void
init
Initialization
Returns void
is
Parameters
name: string
Returns boolean
open
Returns void
redraw
Redraws the container.
Returns void
render
Renders the content.
Returns void
resize
Returns void
selectItems
Highlights directory items
Parameters
ids: any
A list of object IDs
scrollTo: boolean = true
Returns void
setEventHandlers
Sets event handlers
Returns void
setMainTemplate
Sets the template for the body
Parameters
template: any
Returns any
setOptions
Parameters
options: Record<string, any>
Returns void
setState
Parameters
optionalstate: {}
overwrite: boolean = false
Returns void
setStyles
Parameters
styles: Partial<CSSStyleDeclaration>
Returns void
toggle
Toggles view between map and directory on mobile devices
Parameters
optionalon: boolean
If "true", directory is shown and map is hidden, and vice-versa.
Returns void
unhighlightItems
Unhighlights directory items
Returns void
updateScroll
Updates the size of the scrollable container. Automatically fires when window size or content size changes.
Returns void
updateTopShift
Updates top shift of the main container depending on toolbar height
Returns void
viewDidAppear
Fires when the view appears after being hidden. Should be overriden by a child class.
Returns void
viewDidDisappear
This method fires when the view disappears. Should be overriden by a child class.
Returns void
viewDidRedraw
Returns void
viewWillRedraw
Returns void
Adds pagination buttons to the directory.