Justify Engine: Main Class: BaseDisplay

new BaseDisplay()

Базовый класс "Дисплей", содержит методы размещения и работы виртуальных экранов (BaseScreen) на дисплее (в браузере)

Source:: display.js

Methods

addApplication(application, name)

Добавляет внешнее приложение в список внешних приложений шаблона

Parameters:

Name	Type	Description
`application`		объект внешнего приложения
`name`		название приложения, по которому к нему будут происходить обращения в шаблоне

Source:: display.js

addPopupScreen(screen, name)

Добавляет всплывающее окно в список всплывающих окон шаблона.

Parameters:

Name	Type	Description
`screen`		объект всплывающего окна
`name`		название окна, по которому к нему будут происходить обращения в шаблоне

Source:: display.js

addScreen(screen, name)

Добавляет экран в список экранов шаблона.

Parameters:

Name	Type	Description
`screen`		объект экрана
`name`		название экрана, по которому к нему будут происходить обращения в шаблоне

Source:: display.js

back(defaultScreen)

Переход на предыдущий экран, согласно истории переходов между экранами

Parameters:

Name	Type	Description
`defaultScreen`		название экрана по умолчанию, на который следует перейти в случае ошибок или отсутствия истории переходов

Source:: display.js

cleanHistory()

Очищает всю историю переходов внутри интерфейса (и для экранов, и для всплывающих окон)

Source:: display.js

clearApplicationList()

Полная очистка списка внешних приложений шаблона

Source:: display.js

computeScaleDividers()

Определяет коэффициенты масштабирования для ширины и высоты слоя/окна с интерфейсом приложения. Если масштабирование не применялось, то коэффициентам присваивается 1.

Source:: display.js

getCurrentPopupScreen()

Возвращает объект всплывающего окна, отображаемого в данный момент

Source:: display.js

Returns:

Type: *

getCurrentScreen()

Возвращает объект экрана, отображаемого в данный момент

Source:: display.js

Returns:

Type: *

getHeight()

Возвращает высоту слоя/окна с интерфейсом приложения

Source:: display.js

Returns:

Type: Number

getLengthOfHistory()

Возвращает количество экранов, сохраненных в истории переходов между экранами

Source:: display.js

Returns:

Type: Number

getLengthOfPopupHistory()

Возвращает количество всплывающих окон, сохраненных в истории переходов между всплывающими окнами

Source:: display.js

Returns:

Type: Number

getScaleDividerByX()

Возвращает коэффициент масштабирования для ширины слоя/окна с интерфейсом приложения.

Source:: display.js

Returns:

Type: Number

getScaleDividerByY()

Возвращает коэффициент масштабирования для высоты слоя/окна с интерфейсом приложения.

Source:: display.js

Returns:

Type: Number

getScreenByName(name)

Возвращает объект экрана, по его имени

Parameters:

Name	Type	Description
`name`		название экрана в шаблоне

Source:: display.js

Returns:

Type: *

getWidth()

Возвращает ширину слоя/окна с интерфейсом приложения

Source:: display.js

Returns:

Type: Number

hideAllScreens()

Скрывает все экраны шаблона

Source:: display.js

isApplicationExist(name)

Проверка на наличие внешнего приложения в шаблоне

Parameters:

Name	Type	Description
`name`		название внешнего приложения

Source:: display.js

Returns:

true - если приложение существует, false - если такое приложение не найдено

Type: Boolean

isScaled()

Возвращает true если к интерфейсу было применено масштабирование, и false если интерфейс не масштабирован

Source:: display.js

Returns:

Type: Boolean

isScreenExist(name)

Проверка на наличие экрана в шаблоне

Parameters:

Name	Type	Description
`name`		название экрана

Source:: display.js

Returns:

true - если экран существует, false - если такой экран не найден

Type: Boolean

keyDown(keyCode, param)

Передает дальнейшую обработку нажатия кнопки пульта на уровень экрана/окна

Parameters:

Name	Type	Description
`keyCode`		название кнопки
`param`		дополнительные параметры

Source:: display.js

managePopupScreenHiding(name)

Реализует логику скрытия всплывающего окна, в случае если было открыто несколько окон

Parameters:

Name	Type	Description
`name`		название всплывающего окна, которое необходимо скрыть

Source:: display.js

mouseEnter(param)

Обрабатывает событие наведения курсора мыши на элемент (onmouseenter) и передает дальнейшую обработку на уровень экрана/окна

Parameters:

Name	Type	Description
`param`		значение атрибута x-mouse-enter-param для HTML-элемента, используется как идентификатор для метода, по которому его можно вызвать, либо как дополнительный параметр для обработки внутри экрана/окна

Source:: display.js

mouseLeave(param)

Обрабатывает событие выхода курсора мыши из области элемента и передает дальнейшую обработку на уровень экрана/окна

Parameters:

Name	Type	Description
`param`		значение атрибута x-mouse-leave-param для HTML-элемента, используется как идентификатор для метода, по которому его можно вызвать, либо как дополнительный параметр для обработки внутри экрана/окна

Source:: display.js

mouseMove(e)

Обрабатывает движение курсора мыши (onmousemove) и передает дальнейшую обработку на уровень экрана/окна

Parameters:

Name	Type	Description
`e`		объект события движения курсора

Source:: display.js

reset()

Вызывает метод reset для всех экранов шаблона

Source:: display.js

resetResized(name)

Сбрасывает информацию о том, что для экрана применялся метод resize. После этого, при следующем отображении экрана, к нему снова будет применен метод resize.

Parameters:

Name	Type	Description
`name`		название экрана в шаблоне

Source:: display.js

resize(w, h)

Вызывает метод resize для всех экранов шаблона

Parameters:

Name	Type	Description
`w`		ширина слоя/окна с интерфейсом приложения
`h`		высота слоя/окна с интерфейсом приложения

Source:: display.js

runApplication(name)

Вызов (запуск) внешнего приложения

Parameters:

Name	Type	Description
`name`		название приложения

Source:: display.js

setAutoSize()

Определяет предпочтительные ширину и высоту слоя/окна с интерфейсом приложения и применяет их.

Source:: display.js

setGlobalKeyCodeHandler(keyCode, handler, context)

Обеспечивает единый функционал по нажатию кнопки во всех экранах

Parameters:

Name	Type	Description
`keyCode`		название кнопки
`handler`		метод с функционалом кнопки
`context`		объект экрана, в котором находится вызываемый метод (контекст выполнения метода)

Source:: display.js

setGlobalMouseEnterHandler(param, handler, context)

Обеспечивает единый функционал для наведения курсора на область элемента (событие onmouseenter), которое происходит на ряде похожих элементов во всех экранах

Parameters:

Name	Type	Description
`param`		значение атрибута x-mouse-enter-param для HTML-элемента, используется как идентификатор для метода, по которому его можно вызвать
`handler`		метод с функционалом
`context`		объект экрана, в котором находится вызываемый метод (контекст выполнения метода)

Source:: display.js

setGlobalMouseLeaveHandler(param, handler, context)

Обеспечивает единый функционал для выхода курсора из области элемента (событие onmouseleave), которое происходит на ряде похожих элементов во всех экранах

Parameters:

Name	Type	Description
`param`		значение атрибута x-mouse-leave-param для HTML-элемента, используется как идентификатор для метода, по которому его можно вызвать
`handler`		метод с функционалом
`context`		объект экрана, в котором находится вызываемый метод (контекст выполнения метода)

Source:: display.js

setGlobalMouseMoveHandler(handler, context)

Обеспечивает единый функционал для движений курсора мыши во всех экранах

Parameters:

Name	Type	Description
`handler`		метод с функционалом
`context`		объект экрана, в котором находится вызываемый метод (контекст выполнения метода)

Source:: display.js

setGlobalWheelHandler(handler, context)

Обеспечивает единый функционал для использования колесика прокрутки мыши (событие onwheel) во всех экранах

Parameters:

Name	Type	Description
`handler`		метод с функционалом
`context`		объект экрана, в котором находится вызываемый метод (контекст выполнения метода)

Source:: display.js

setHeight(value)

Устанавливает высоту слоя/окна с интерфейсом приложения

Parameters:

Name	Type	Description
`value`		значение высоты

Source:: display.js

setWidth(value)

Устанавливает ширину слоя/окна с интерфейсом приложения

Parameters:

Name	Type	Description
`value`		значение ширины

Source:: display.js

showPopupScreen(name, id)

Отображает всплывающее окно

Parameters:

Name	Type	Description
`name`		название экрана в шаблоне
`id`		id HTML-элемента, с которым каким-либо образом связано окно

Source:: display.js

showScreen(name, skipHistory, obj)

Отображает экран

Parameters:

Name	Type	Description
`name`		название экрана в шаблоне
`skipHistory`		флаг, указывающий что экран не должен сохраняться в истории переходов
`obj`

Source:: display.js

wheel(e)

Обрабатывает событие прокрутки колесика мыши (onwheel) и передает дальнейшую обработку на уровень экрана/окна

Parameters:

Name	Type	Description
`e`		объект события прокрутки колесика

Source:: display.js