LSF LocoBrowserGroup — различия между версиями

(Новая страница: «{| class="wikitable" style="float:right; margin-left: 10px;" |- | Библиотека || Locomotive Script Framework |- | Имя класса || LSF_LocoBrow…»)
(нет различий)

Версия 15:51, 6 марта 2018

Библиотека Locomotive Script Framework
Имя класса LSF_LocoBrowserGroup
Файл скрипта lsf_locobrowserinterface.gs
Тип Класс-описание
Базовые классы -- --

LSF_LocoBrowserGroup - Класс описывающий группу свойств универсального браузера LSF_LocoBrowser с командами. Входит в состав Locomotive Script Framework.

Требуется создание производного класса для реализации своей группы

Прототип

class LSF_LocoBrowserGroup
{

  public final int getItemCount(void);

  public final LSF_ILocoBrowserItem getItem(int index);

  final bool getItemContains(LSF_ILocoBrowserItem item);

  final void addItem(LSF_ILocoBrowserItem item);

  final void removeItem(int index);

  public final string getName(void);

  public final string getColour(void);

  final void setColour(string colour);

  public void onBeforeBrowserUpdate(void);

  final LSF_LocoBrowserGroup Init(string name, string colour);

  final LSF_LocoBrowserGroup Init(string name);

};

Интерфейс

getItemCount

Извлечение количества свойств в группе

public final int getItemCount(void)
Возвращает: Количество свойств в группе

getItem

Извлечение свойства

public final LSF_ILocoBrowserItem getItem(int index)
Аргументы:
  • index - Индекс свойства в группе
Возвращает: Объект LSF_ILocoBrowserItem, который описывает свойство

getItemContains

Проверка наличия свойства в группе

public final int getItemContains(LSF_ILocoBrowserItem item)
Аргументы:
Возвращает: true - свойство присутствует в свойстве; false - свойство отсутствует

addItem

Добавление свойства в группу

public final void addItem(LSF_ILocoBrowserItem item)
Аргументы:

removeItem

Удаление индекса из свойства

public final void removeItem(int index)
Аргументы:
  • index - Индекс свойства в группе

getName

Извлечение названия группы

public final string getName(void)
Возвращает: Строка, которая является названием группы.
Примечание: Выводиться в браузере

getColour

Извлечение цвета названия группы

public final string getColour(void)
Возвращает: Строку в формате html (RRGGBB) которая описывает цвет группы

setColour

Устанавливает цвет отображения названия группы

public final void setColour(string colour)
Аргументы:
  • colour - строка в формате html (RRGGBB) описывающая цвет отображения группы
Примечание: Для цвета по умолчанию нужно передать пустую строку

onBeforeBrowserUpdate

Обработчик обновления состояния свойств

public final void onBeforeBrowserUpdate(void)
Примечание: Вызывается автоматически перед обновлением браузера. Требуется переопределить в производном классе для реализации

Init

Выполняет инициализацию класса группы

public final LSF_LocoBrowserGroup Init(string name, string colour)
Аргументы:
  • name - Наименование группы отображаемое в браузере
  • colour - Цвет в формате html (RRGGBB) которым будет отображаться наименование гпуппы
Примечание: Эта функция обязательно должна быть вызвана 1 раз перед использованием экземпляра класса

Init

Выполняет инициализацию класса группы

public final LSF_LocoBrowserGroup Init(string name)
Аргументы:
  • name - Наименование группы отображаемое в браузере
Примечание: Эта функция обязательно должна быть вызвана 1 раз перед использованием экземпляра класса

Использование

Пример производного класса группы

class mygroup isclass LSF_LocoBrowserGroup
{
  Locomotive _myloco;

  public final void Init(Locomotive loco){
    me.Init("Краткая информация");
    _myloco = loco;
    me.addItem(new LSF_LocoBrowserItemInfo().Init("Скорость:", _myloco.GetVelocity() * 3.6));
  }

  public void onBeforeBrowserUpdate(void){
    me.getItem(0).setValue(_myloco.GetVelocity() * 3.6);
  }

};