<< Щелкните, чтобы показать Содержание >> Веб-продукты > Веб-разработка > Клиентская объектная модель веб-доступа > Пространства имен

WebAccess – базовое пространство имен

Contents

Базовое пространство имен. Имеет дочерние пространства имен:

•	WebAccess.agent – работа с Агентом веб-доступа;

•	WebAccess.cache – работа с кэшем;

•	WebAccess.components – динамические компоненты;

•	WebAccess.current – текущая открытая часть веб-доступа;

•	WebAccess.environment – информация о текущем окружении;

•	WebAccess.extensions – веб-модули;

•	WebAccess.factories – фабрики объектов;

•	WebAccess.mixins – вспомогательные объекты для расширения функциональности классов;

•	WebAccess.services – сервисы;

•	WebAccess.templates – работа с шаблонами;

•	WebAccess.utils – вспомогательные инструменты.

Собственные функции данного пространства доступны сразу, например, raise. Для запуска программы после инициализации всех компонентов WebAccess служит специальная функция WebAccess.ready().

Для доступа к дочерним пространствам имен необходимо сначала дождаться их инициализации. Если необходимо обеспечить работу лишь с некоторыми из них, можно использовать публичные deferred-объекты.

Предоставляются публичные deferred-объекты:

Тип	Объект	Описание
	AgentInit	Сообщает о готовности к использованию пространства имен WebAccesst.agent после его полной инициализации
	DetailsInit	Сообщает о готовности к использованию пространства имен WebAccess.current.details после его полной инициализации
	ExtensionsInit	Сообщает о готовности к использованию пространства имен WebAccess.extensions после его полной инициализации
	FormControlsInit	Сообщает о готовности к использованию пространства имен WebAccess.current.form.controls после его полной инициализации
	FormInit	Сообщает о готовности к использованию пространства имен WebAccess.current.form после его полной инициализации
	Init	Сообщает о готовности к использованию клиентской объектной модели после ее полной инициализации
	ObjectListInit	Сообщает о готовности к использованию пространства имен WebAccess.current.objectList после его полной инициализации
	SideBarInit	Сообщает о готовности к использованию пространства имен WebAccess.current.sideBar после его полной инициализации. При использовании WebAccess.ready функция будет исполнена несколько позже, так как функция WebAccess.ready дожидается полной инициализации всех deferred-объектов и только потом исполняет переданную ей функцию
	ToolBarInit	Сообщает о готовности к использованию пространства имен WebAccess.current.toolBar после его полной инициализации
	UserInfoInit	Сообщает о готовности к использованию пространства имен WebAccess.current.user после его полной инициализации

Содержит классы:

•	Collection – для реализации коллекций произвольных элементов, например использование коллекции реквизитов;

•	URL – для работы со ссылками, например открыть URL-ссылку в новом окне.

•	Link – для работы со ссылками на объект.

Функции

getLocation – определить текущее местоположение

Синтаксис:

getLocation()

Возвращаемое значение:

Значение строкового типа, указывающее на текущее местонахождение, например explorer, task, job, reference, wizard, about.

isMobile – показывает, что мобильный веб-доступ открыт

Синтаксис:

isMobile()

Возвращаемое значение:

True – мобильный веб-доступ открыт, иначе False.

include – подключить сторонний JS-файл или таблицу стилей CSS

Синтаксис:

include(url)

Параметры:

Имя	Тип	Описание
url	string	Абсолютный или относительный путь к целевому файлу

Возвращаемое значение:

Пространство имен WebAccess.

Описание:

Загрузка JS-файлов или таблиц стилей CSS происходит синхронно в порядке очереди.

Пример

//Подключить сторонний файл General.js.
WebAccess.include('/js/Extension.RecordOffice/General.js');
//Подключить для соответствующих справочников необходимый файл для исполнения специфической логики их работы.
var refCode = WebAccess.current.getReferenceCode();
switch (refCode) {
case 'РКК':
WebAccess.include('/js/Extension.RecordOffice/RRCReference.js');
break;
case 'RRCAssignments':
WebAccess.include('/js/Extension.RecordOffice/RRCAssignmentsReference.js');
break;
case 'ГДЛ':
WebAccess.include('/js/Extension.RecordOffice/LogsReference.js');
break;
case 'IndividualUserModuleSettings':
WebAccess.include('/js/Extension.RecordOffice/IndividualUserModuleSettingsReference.js');
break;
};

logout – выйти из проводника веб-доступа

Синтаксис:

logout()

Возвращаемое значение:

Объет типа WebAccess.

raise – генерировать исключение

Синтаксис:

raise(error, opt_value)

Параметры:

Имя	Тип	Обязательность	Описание
error	string	Да	Код строки ошибки
opt_value	string	Нет	Переданное значение, например имя объекта, вызвавшего ошибку

Описание:

Если при срабатывании исключение не было отловлено конструкцией try/catch или функция не была обернута в функцию tryCatchDecorator, то выполняемый сценарий остановится.

Пример:

//Проверка существования закладки. Если закладка существует, то генерируется исключение
if (jExistingTab.length > 0) WebAccess.raise("ERR_TAB_WITH_THE_SAME_NAME_ALREADY_EXIST", name);

ready – обработчик инициализации

Синтаксис:

ready(callback)

Параметры:

Имя	Тип	Описание
callback	function	Ссылка на функцию, которая будет вызвана немедленно по готовности объектной модели к использованию

Возвращаемое значение:

Пространство имен WebAccess.

Описание:

Добавляет функцию в очередь на исполнение, когда объектная модель WebAccess готова к использованию.

tryCatchDecorator – отобрать исключения, которые могут произойти в функции

Синтаксис:

tryCatchDecorator(decoratedFunction)

Параметры:

Имя	Тип	Описание
decoratedFunction	function	Декорируемая функция

Описание:

Автоматически отбирает исключения, которые могут произойти в функции. Выводит информацию об исключении в стандартную область ошибок и уведомлений. Не рекомендуется использовать в местах, где нужна производительность, особенно при работе в циклах.

Пример:

function ShowCustomizationWindow(el) {
...
//Произошло исключение.
...
};
ShowCustomizationWindow = WebAccess.tryCatchDecorator(ShowCustomizationWindow);
//В результате выполнения функции, исключение будет обработано, и не остановит дальнейшее выполнение сценария.

См. также

Классы пространства имен

Сообщество пользователей DIRECTUM