Brick Global  1.0.0

Abricos! User Interface Library > Sys > Brick.Component.API
Filters

Class Brick.Component.API

Known Subclasses:
Brick.mod.news.API Brick.mod.webos.API Brick.mod.comment.API Brick.mod.sys.API Brick.mod.blog.API Brick.mod.user.API Brick.mod.feedback.API
API модуля.

Constructor

Brick.Component.API ( name )
Parameters:
name <String> Имя модуля

Properties

name - String

Имя модуля которому принадлежит API

Methods

addWidget

void addWidget ( name , widget )
Добавить виджет в коллекцию
Parameters:
name <String> Имя виджета
widget <Object> Объект виджета
Returns: void

fire

static void fire ( moduleName , componentName , methodName , param , func )
Вызвать метод API компонента из указанного модуля.

Принцип работы метода:

  • 1. Проверяет, был ли зарегистрирован компонент указанного модуля. Если да, то п.3, иначе п.2.
  • 2. Делает запрос загрузчику загрузить компонент из указанного модуля.
  • 3. Проверяет, есть ли данный метод в API (Brick.mod.[moduleName].[componentName].API.[methodName]), если да, то выплняет его, иначе...

Parameters:
moduleName <String> Имя модуля
componentName <String> Имя компонента
methodName <String> Имя метода
param <Object> (optional) Параметры для вызываемого метода
func <Function> (optional) Дополнительная функция, которая будет выполнена по окончанию запуска метода.
Returns: void

fireFunction

static void fireFunction ( moduleName , componentName , fn )
Выполнить указанную функцию, при необходимости, предварительно загрузить компонент модуля.
Parameters:
moduleName <String> Имя модуля
componentName <String> Имя компонента
fn <Function> Функция, которая будет выполнена
Returns: void

fn

void fn ( componentName , fn )
Выполнить функцию, предварительно загрузив необходимый компонент из текущего модуля. Использует статичный метод Brick.Component.API.fire().
Parameters:
componentName <String> Имя компонента, который необходимо подгрузить
fn <Function> Функция, которая будет выполнена
Returns: void

getWidget

Object getWidget ( name )
Получить виджет из коллекции.
Parameters:
name <String> Имя виджета
Returns: Object

removeWidget

void removeWidget ( name )
Удалить виджет из коллекции. Если у виджета определен метод destroy, то вызвать его.
Parameters:
name <String> Имя виджета
Returns: void

Properties