Документация


Автоматически сгенерированная документация по коду системы с разбиением на разделы и примеры.


МенюДокументацияПодразделы
/ XmLoader /

Structure.Xmini.XmLoader

./extensions/OntoDocBuilder/xmini/XminiLoader/XmLoader.as

Движок Xmini представляет собой swf-загрузчик, куда могут быть подгружены Flex-интерфейсы сервисов движка QuickStart.
Включает с себя Main.mxml-интерфейс и XmLoader.as-класс (диспетчер). При первом обращении к статичекому свойству XmLoader.self создается сиглтон.
После инициализации в Main.mxml-приложении XmLoader.self.initialize(gateway:String, [onInit:Function]) доступна следующая фунциональность:
  • loadService(xmURL:String) подргужает в swf-загрузчик Flex-интерфейс сервиса и полученный с сервера контент;
  • xmTrace(text:String) выводит строку отладки в debug-окне;
  • showError(text:String) оповещает об ошибках в работе с удаленным соединением.

Основные компоненты:
  • xmState:String = "''/loading/error/debug";
  • remotingConnection:NetConnection;
  • serviceViewLoader:SWFLoader;

XmLoader имплементирует интерфейс IXmLoader, описанный в библиотеке XminiLib. Таким образом, для разработки собственных сервисов вам нужна только библиотека XminiLib.


Подразделы


xmState

[Bindable] public var xmState:String = '';
При изменении xmState приложение (XminiLoader) переходит в указанное состояние
xmState:String = "''/loading/error/debug"

_serviceMap

private var _serviceMap:Object;
Подгружаемый с сервера список доступных сервисов в формате Map

serviceList

[Bindable] public var serviceList:Array;
Список доступных сервисов, подготовленный для вывода в ComboBox

userInfo

[Bindable] public var userInfo: Object;
Информация о текущем пользователе. Всегда свежая :)
Имеет структуру аналогичную возвращаемой удаленной процедурой util.QSUtil.getUserInfo.

_remoteQSUtil

[Bindable] private var _remoteQSUtil: XmRemoteUtil_QSUtil
Обьект для удаленного вызова процедур QSUtil.

self

public static function get self():XmLoader
обращение к синглтону – объекту-диспетчеру
(сам объект хранится в статической приватной переменной _xmLoader и создается при первом обращении к свойству self)

initialize

public function initialize(gatewayURL:String, onInit: Function = null):void
при инициализации XmLoader-а устанавливается удаленное соединение по указанному gatewayURL и _xmLoader прописыватся в глобальном реестре
  • gatewayURL – - адрес точки удаленного вызова процедур
  • onInit – - функция, которая будет вызвана после полной инициализации XmLoader. Может быть null.

serviceViewLoader

public var serviceViewLoader:SWFLoader
ссылка на SWF-загрузчик для интерфейсов сервисов

remotingConnection

[Bindable] public var remotingConnection:RemotingConnection
удаленное соединение для централизованного вызова удаленных процедур

refreshUserInfo

public function refreshUserInfo()
Эта функция должна вызываться после каждого логина/логаута в системе.

debugText

[Bindable] public var debugText: String = ''
Полный текст, выводящийся в окне отладки.

xmTrace

public function xmTrace(text: String):void
Добавление сообщения в трейслист в окне отладки.

errorMsg

[Bindable] public var errorMsg:String = 'Неизвестная ошибка';
Текст об ошибке в алерте.

errorComponent

[Bindable] public var errorComponent:Class = null;
При генерации ошибки показывает не алерт, а нижеуказанный компонент.

showError

public function showError(errorString: String):void
Выводит на экран ссобщение об ошибке.

currentServiceName

public var currentServiceName:String = ''
Имя текущего сервиса

serviceParams

public var serviceParams:Object
Параметры вызова текущего сервиса

_loadingServiceName

private var _loadingServiceName: String
Имя подгружаемого сервиса

loadService

public function loadService(request:String):void
Загрузка указаного сервиса (Flex-интерфейс + контент, определенный параметрами).
Предназначен для создания ссылок внутри Xmini-сайта.
  • request – в формате: имя сервиса:String + '?' + параметры:String

loadServiceParam

public function loadServiceParam(serviceName:String, _serviceParams:Object):void
Загрузка указаного сервиса (Flex-интерфейс + контент, определенный параметрами)
  • serviceName – имя сервиса
  • _serviceParams – параметры

goToURL

public function goToURL(url:String):void
Открыть новое окно с указанным url

IHistoryManagerClient

public function loadState(state:Object):void
public function saveState():Object
private var _isHistoryLoading:Boolean = false;
private var _serviceOwnHistoryObj: Object;
public function save():void

Имплементация интерфейса IHistoryManagerClient.
*
XmLoader может ожидать от приложения, что оно поддерживает интерфейс saveState(). Тогда автоматически добавляется возможность сохранять историю и внутри приложения.
Для сохранения состояния приложение вызывает save();
Для загрузки старого – когда приложение полностью инициализируется после LoadDoc(msg:Object), оно может обратиться к свойству msg.history.
*
По умолчанию история сохраняется для каждой подгрузки сервиса (вызова loadServiceParam).

stateManipulating

Манипулирование состояниями у приложения. Сделано дабы не морочаться с состояниями.
Комментарии [0]  (показать)
Комментарии скрыты. Чтобы увидеть комментарии нажмите сюда.