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

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

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

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

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

Класс не предусматривает создание потомков.

Прототип

final class LSF_LocoBrowserItemInfo isclass LSF_ILocoBrowserItem
{

  public final string getName(void); //Реализует интерфейс LSF_ILocoBrowserItem.getName

  public final string getColour(void); //Реализует интерфейс LSF_ILocoBrowserItem.getColour

  public final int getActionCount(void); //Реализует интерфейс LSF_ILocoBrowserItemCommand.getActionCount

  public final LSF_LocoBrowserAction getAction(int index); //Реализует интерфейс LSF_ILocoBrowserItemCommand.getAction

  public final bool getEnabledState(void); //Реализует интерфейс LSF_ILocoBrowserItemCommand.getEnabledState

  public final bool getVisibleState(); //Реализует интерфейс LSF_ILocoBrowserItem.getVisibleState

  public final void setColour(string colour);

  public final void setEnabledState(bool enabled);

  public final string getValue(void); //Реализует интерфейс LSF_ILocoBrowserItem.getValue

  public final void setVisibleState(bool visible);

  public final bool getActionContains(LSF_LocoBrowserAction action);

  public final void addAction(LSF_LocoBrowserAction action);

  public final void removeAction(int index);

  public final LSF_LocoBrowserItemCommand Init(string name, string colour, bool enabled, bool visible);

  public final LSF_LocoBrowserItemCommand Init(string name, string colour, bool enabled);

  public final LSF_LocoBrowserItemCommand Init(string name, bool enabled, bool visible);

  public final LSF_LocoBrowserItemCommand Init(string name, bool enabled);

  public final LSF_LocoBrowserItemCommand Init(string name, string colour);

  public final LSF_LocoBrowserItemCommand Init(string name);

};

Интерфейс

getName

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

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

getColour

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

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

getActionCount

Извлечение количества элементов действия

public final int getActionCount(void)
Возвращает: Количество элементов действия

getAction

Извлечение действия

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

getEnabledState

Указатель, что действия свойства активны

public final bool getEnabledState(void)
Возвращает: true - действия свойства активны; false - действия свойства не активны

getVisibleState

Указатель, что свойство отображается в браузере

public final bool getVisibleState(void)
Возвращает: true - свойство отображается в браузере; false - свойство скрыто

setColour

Устанавливает цвет отображения значения свойства

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

setEnabledState

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

public final void setEnabledState(bool enable)
Аргументы:
  • enable - rue - действия свойства активны; false - действия свойства не активны

setVisibleState

Устанавливает состояние видимости действия

public final void setVisibleState(bool visible)
Аргументы:
  • visible - true - действие отображается; false - действие скрыто

getActionContains

Проверка наличия действия в свойстве

public final int getActionContains(LSF_LocoBrowserAction action)
Аргументы:
  • action - Объект LSF_LocoBrowserAction, который описывает интерактивное действие свойства, наличие которого необходимо проверить
Возвращает: true - действие присутствует в свойстве; false - действие отсутствует

addAction

Добавление действия в свойство

public final void addAction(LSF_LocoBrowserAction action)
Аргументы:
  • action - Объект LSF_LocoBrowserAction, который описывает интерактивное действие свойства

removeAction

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

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

Init

Выполняет инициализацию класса описания свойства

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

Init

Выполняет инициализацию класса описания свойства

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

Init

Выполняет инициализацию класса описания свойства

public final LSF_LocoBrowserItemCommand Init(string name, bool enable, bool visible)
Аргументы:
  • name - Наименование свойства отображаемое в браузере
  • enable - Указатель, что действия свойства активны: true - действия активны; false - действия неактивны
  • visible - Указатель, что свойство отображается: true - отображается; false - скрыто
Примечание: Эта функция обязательно должна быть вызвана 1 раз перед использованием экземпляра класса

Init

Выполняет инициализацию класса описания свойства

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

Init

Выполняет инициализацию класса описания свойства

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

Init

Выполняет инициализацию класса описания свойства

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