• Справочник
• Страницы и элементы

функции, методы, свойства объектов, используемых для управления графическими элементами, страницами, попапами в проекте iRidium

Методы​

Объект IR - глобальный объект, содержащий в себе все функции и константы API iRidium. Методы объекта IR для графического интерфейса позволяют обратиться к страницам и попапам интерфейса визуализации, а также выполнить команды, связанные с работой операционной системы.

Цепочка команд, примененных к объекту IR, позволяет получить доступ к любому объекту интерфейса, использовать его методы и обращаться к свойствам. Иерархия объектов: IR > Page / Popup > Item > State.

IR.CreateItem()​

создать графический элемент на текущей странице проекта.Страница может быть определена при обращении к свойству CurrentPage объекта IR. Чтобы создать элемент на произвольной странице, нужно применить метод CreateItem к ссылке на объект Page или Popup, полученной с помощью метода IR.GetItem().

Синтаксис

IR.CreateItem(item_type, name, X, Y, width, height);

Пример

IR.AddListener(IR.EVENT_START,0, function()
{
var src = IR.CreateItem(IR.ITEM_BUTTON,"Button 1",30,40,800,150);
IR.Log(src) // [Object DialogItemPrototype]
});

Примечания

var src = IR.GetItem("Page 1").CreateItem(IR.ITEM_BUTTON,"Button 1",30,40,800,150);
IR.Log(src) // [Object DialogItemPrototype]

IR.DeleteItem()​

удалить Popup или диалоговый элемент. Страницу удалить нельзя.

Синтаксис

IR.DeleteItem(popup)

Пример

IR.AddListener(IR.EVENT_START, 0, function()
{
IR.DeleteItem(IR.GetItem("Page 1").GetItem("Popup 1"));
});

Примечания

var item = IR.GetItem("Page 1").GetItem("Item 1");
IR.DeleteItem(item);

IR.GetPage()​

получить доступ к странице проекта (Page). Имея доступ к странице, вы можете обратиться к элементам на этой странице с помощью метода .GetItem().

Синтаксис

IR.GetPage(page)

Пример

IR.AddListener(IR.EVENT_START, 0, function()
{
IR.GetPage("Page 1");
});

Примечания

var Item = IR.GetPage("Page 1").GetItem("Item 1");
IR.Log(Item); //    [object DialogItemPrototype]

IR.GetPopup()​

получить доступ к попапу проекта (Popup). Имея доступ к попапу, вы можете обратиться к элементам на этом попапе с помощью метода .GetItem().

Синтаксис

IR.GetPopup(popup)

Пример

IR.AddListener(IR.EVENT_START, 0, function()
{
IR.GetPopup("Popup 1");
});

Примечания

var Item = IR.GetItem("Popup 1").GetItem("Item 1");
IR.Log(Item); //    [object DialogItemPrototype]

IR.ShowPage()​

показать страницу по имени (Page)

Синтаксис

IR.ShowPage(page)

Пример

IR.AddListener(IR.EVENT_START, 0, function()
{
IR.ShowPage("Page 1");
});

Примечания

IR.ShowPopup()​

показать попап по имени (Popup)

Синтаксис

IR.ShowPopup(popup, <effect_group>)

Пример

IR.AddListener(IR.EVENT_START, 0, function()
{
IR.ShowPopup("Popup 1");
});

Примечания

IR.HidePopup()​

скрыть попап по имени (Popup)

Синтаксис

IR.HidePopup(popup, <effect_group>)

Пример

IR.AddListener(IR.EVENT_START, 0, function()
{
IR.HidePopup("Popup 1");
});

Примечания

IR.HideGroup()​

скрыть группу попапов по имени группы. Из группы может быть открыт только один попап - именно он закроется при вызове метода. Имена групп см. в меню "Manage Popup Groups".

Синтаксис

IR.HideGroup(group)

Пример

function hide_1 ()
{
IR.HideGroup("Popup Group 1");
}

Примечания

IR.TogglePopup()​

показать Popup, если он скрыт, и скрыть, если показан

Синтаксис

IR.TogglePopup(popup, <effect_group>)

Пример

IR.AddListener(IR.EVENT_START, 0, function()
{
IR.TogglePopup("Popup 1");
});

Примечания

IR.HideAllPopups()​

скрыть все попапы (Popup) на указанной странице

Синтаксис

IR.HideAllPopups(page, <effect_group>)

Пример

IR.AddListener(IR.EVENT_ITEM_PRESS,IR.GetPage("Page 1").GetItem("Item 2"), function()
{
IR.HideAllPopups("Page 1", <1>);
});

Примечания

IR.CreateEffect()​

создать эффект анимации во время работы приложения и использовать его при показе и скрытии попапа.

Синтаксис

IR.CreateEffect(effect);

Пример

IR.AddListener(IR.EVENT_START, 0, function()
{
   var Fade = IR.CreateEffect(IR.EFFECT_FADE); // создаем группу, сохраняем в переменную
       Fade.Group = 1000; // присваиваем номер группы
       Fade.Delay = 0; // задержка выполнения эффектов
       Fade.Duration = 400; // продолжительность эффекта
       Fade.Tween = 0; // формула вычисления эффекта (твинер)
    IR.ShowPopup("Popup 1", 1000); // покажем попап с эффектами группы 1000 
});

Примечания

IR.ShowKeyboard()​

показать системную клавиатуру iOS или Android устройства

Синтаксис

IR.ShowKeyboard(type)

Пример

IR.AddListener(IR.EVENT_ITEM_PRESS, IR.GetItem("Page 1").GetItem("Item 1"), function()
{
IR.ShowKeyboard(2);
});

Примечания

IR.PasteFromClipboard()​

Вставить текст из буфера обмена в активный Editbox. Текст будет вставлен только если в буфере действительно находится Текст (а не изображение или др. контент). Курсор позиционируется после вставленного текста

Синтаксис

IR.PasteFromClipboard()

Пример

IR.AddListener(IR.EVENT_ITEM_PRESS, IR.GetItem("Page 1").GetItem("Paste Button"),function()
{
IR.PasteFromClipboard();
});

Примечания

IR.GetClipboard()​

Получить текст из буфера обмена

Синтаксис

IR.GetClipboard()

Пример

`var clipboard = IR.GetClipboard();`

Примечания

IR.ShowPasteHelper()​

над курсором в активном EditBox этот метод отобразит нативное, масштабируемое в соответствии с разрешением проекта всплывающее окно: "PasteHelper" c надписью Paste, аналогично инструменту вставки на iOS и Android устройствах. По нажатию на это всплывающее окно, выполяется команда IR.PasteFromClipboard();. Нажатие на окно вставки, повторное нажатие на поле ввода или смена фокуса сразу закрывают PasteHelper

Синтаксис

IR.ShowPasteHelper()

Пример

IR.AddListener(IR.EVENT_ITEM_HOLD, IR.GetItem("Page 1").GetItem("EditBox"),function()
{
IR.ShowPasteHelper();
});

Примечания

IR.SelectNextEditBox()​

сместить фокус с текущего поля ввода на следующее по списку. Для определения порядка полей ввода используется Z-позиция элементов, посмотреть которую можно, включив отображение элементов в дереве проекта (Tools > Options > Show > Show Items In Tree). По нажатию Tab (на Windows) фокус смещается на следующее поле ввода автоматически, в пределах страницы или окна

Синтаксис

IR.SelectNextEditBox();

Пример

IR.AddListener(IR.EVENT_ITEM_CHANGE, IR.GetItem("Page 1").GetItem("Item 1"), function (action, key)
{
if (action == 2)  // press Enter
{
IR.SelectNextEditBox();
}
});

IR.SetLifeTime()​

установить время (в миллисекундах), в течение которого будет отображаться попап. Если необходимо сделать так, чтобы попап появлялся на определенное время, можно обратиться к его свойству LifeTime, с помощью метода .SetLifeTime().

Синтаксис

IR.SetLifeTime(popup, lt)

Пример

function set_lt()
{
IR.SetLifeTime("Popup 1", 5000);
IR.ShowPopup("Popup 1");
}

IR.GetItem()​

получить доступ к странице или попапу. Имея доступ к странице или попапу, вы можете обратиться к элементам на них с помощью метода .GetItem().

Синтаксис

IR.GetItem(item)

Пример

IR.AddListener(IR.EVENT_START,0, function()
{
var DialogItem = IR.GetItem("Popup 1");
IR.Log(DialogItem); //  [object DialogItemPrototype]
});

Примечания

var Item = IR.GetItem("Popup 1").GetItem("Item 1");
IR.Log(Item); //    [object DialogItemPrototype]

.GetItem()​

получить доступ к графическому элементу на странице или попапе.

Синтаксис

IR.GetItem(page).GetItem(item)

Пример

IR.AddListener(IR.EVENT_START, 0, function()
{
var DialogItem = IR.GetItem("Page 2").GetItem("Item 2");
IR.Log(DialogItem) // [Object DialogItemPrototype]
});

Примечания

.CreateItem()​

создает графический элемент на странице или попапе

Синтаксис

IR.GetItem(page).CreateItem(item_type, name, X, Y, width, height);

Пример

IR.AddListener(IR.EVENT_START, 0, function()
{
IR.GetItem("Page 2").CreateItem(IR.ITEM_BUTTON, "Button 1", 30, 40, 800, 150);
});

Примечания

.Clone()​

клонирует страницу, попап, графический элемент на странице или попапе

Синтаксис

IR.GetItem(page).Clone(new_page_name);
IR.GetItem(page).GetItem(item).Clone(new_item_name);

Пример

IR.AddListener(IR.EVENT_START, 0, function()
{
IR.GetItem("Page 1").Clone("Page 2");
IR.GetItem("Page 1").GetItem("Item 1").Clone("Item 2");
// result:
IR.Log(IR.GetItem("Page 2")) // [object DialogItemPrototype]
IR.Log(IR.GetItem("Page 1").GetItem("Item 2")) // [object DialogItemPrototype]
});

.GetPopup()​

получает по индексу попап, показанный на странице. Индекс - номер показанного попапа от 0 до n, возвращает null, если нет попапа с таким индексом.

Синтаксис

IR.GetItem(page).GetPopup(index);

Пример

IR.AddListener(IR.EVENT_START, 0, function()
{
var DialogItem = IR.GetItem("Page 1").GetPopup(0);
IR.Log(DialogItem) // [Object DialogItemPrototype]
});

Примечания

.StartActions()​

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

Синтаксис

IR.GetItem(page).GetItem(item).StartActions(event);

Пример

IR.AddListener(IR.EVENT_START, 0, function()
{
IR.GetItem("Page 1").GetItem("Item 1").StartActions(IR.EVENT_ITEM_PRESS);
});

Примечания

.GetState()​

получить состояние графического элемента как объект

Синтаксис

IR.GetItem(page).GetItem(item).GetState(state_index);

Пример

IR.AddListener(IR.EVENT_START, 0, function()
{
var DialogItem = IR.GetItem("Page 1").GetItem("Item 1").GetState(0);
IR.Log(DialogItem); // [object StatePrototype]
});

Примечания

.CreateState()​

добавить состояние графическому элементу

Синтаксис

IR.GetItem(page).GetItem(item).CreateState();

Пример

IR.AddListener(IR.EVENT_START, 0, function()
{
IR.GetItem("Page 1").GetItem("Item 1").CreateState();
});

Примечания

.ShowPopup()​

показать попап на странице

Синтаксис

IR.GetItem(page).ShowPopup(popup, <effect_group>);

Пример

IR.AddListener(IR.EVENT_START, 0, function()
{
IR.GetItem("Page 1").ShowPopup("Popup 1");
});

.HidePopup()​

скрыть попап на странице

Синтаксис

IR.GetItem(page).HidePopup(popup, <effect_group>);

Пример

IR.AddListener(IR.EVENT_START, 0, function()
{
IR.GetItem("Page 1").HidePopup("Popup 1");
});

.TogglePopup()​

скрыть попап, если он показан, показать, если скрыт

Синтаксис

IR.GetItem(page).TogglePopup(popup, <effect_group>);

Пример

IR.AddListener(IR.EVENT_START, 0, function()
{
IR.GetItem("Page 1").TogglePopup("Popup 1");
});

.Show()​

показать графический элемент или попап на странице (универсальный метод)

Синтаксис

IR.GetItem(popup).Show();

Пример

IR.AddListener(IR.EVENT_START, 0, function()
{
IR.GetItem("Popup 1").Show();
});

.Hide()​

скрыть графический элемент или попап на странице (универсальный метод)

Синтаксис

IR.GetItem(page).Hide();

Пример

IR.AddListener(IR.EVENT_START, 0, function()
{
IR.GetItem("Page 1").Hide();
});

События​

Событие - процесс, проброшенный в скрипты и имеющий идентификатор для отслеживания.

Слушатель - это функция, которая выполняется в случае срабатывания указанного ей события

Добавьте слушатель с помощью метода IR.AddListener

IR.AddListener(event, input, action);

• event - идентификатор события, за которым следит слушатель
• input - входной параметр, необходимый для создания слушателя. Если параметра нет, укажите 0
• action - не именованная функция или ссылка на объявленную функцию, внутри которой выполняются действия
• pointer - указатель на контекст вызова слушателя (не обязательный). Обратиться к контексту можно с помощью оператора this. Контекст может меняться во время работы программы

Пример:

IR.AddListener(IR.EVENT_ITEM_PRESS, IR.GetItem("Page 1").GetItem("Item 1"), function ()
{
    IR.Log("pressed!");
});

IR.EVENT_ITEM_PRESS​

идентификатор события, которое срабатывает при нажатии на графический элемент

Синтаксис

IR.AddListener(IR.EVENT_ITEM_PRESS, item, function, [pointer]);

Пример

IR.AddListener(IR.EVENT_ITEM_PRESS, IR.GetItem("Page 1").GetItem("Item 1"), function ()
{
IR.Log("action"); // action
});

IR.EVENT_ITEM_RELEASE​

идентификатор события, которое срабатывает при отпускании графического элемента

Синтаксис

IR.AddListener(IR.EVENT_ITEM_RELEASE, item, function, [pointer]);

Пример

IR.AddListener(IR.EVENT_ITEM_RELEASE, IR.GetItem("Page 1").GetItem("Item 1"), function ()
{
IR.Log("action"); // action
});

IR.EVENT_ITEM_HOLD​

идентификатор события, которое срабатывает при удержании графического элемента

Синтаксис

IR.AddListener(IR.EVENT_ITEM_HOLD, item, function, [pointer]);

Пример

IR.AddListener(IR.EVENT_ITEM_HOLD, IR.GetItem("Page 1").GetItem("Item 1"), function ()
{
IR.Log("action"); // action
});

IR.EVENT_ITEM_END_HOLD​

идентификатор события, которое срабатывает в конце удержания графического элемента (при отпускании, после события HOLD)

Синтаксис

IR.AddListener(IR.EVENT_ITEM_END_HOLD, item, function, [pointer]);

Пример

IR.AddListener(IR.EVENT_ITEM_END_HOLD, IR.GetItem("Page 1").GetItem("Item 1"), function ()
{
IR.Log("action"); // action
});

IR.EVENT_ITEM_LOST_FOCUS​

идентификатор события, которое срабатывает при отпускании любого объекта интерфейса (вместе с Release или End Of Hold). Событие указывает на потерю элементом фокуса

Синтаксис

IR.AddListener(IR.EVENT_ITEM_LOST_FOCUS, item, function, [pointer]);

Пример

IR.AddListener(IR.EVENT_ITEM_LOST_FOCUS, IR.GetItem("Page 1").GetItem("Item 1"), function ()
{
IR.Log("action"); // action
});

IR.EVENT_ITEM_CHANGE​

идентификатор события, которое срабатывает при вводе текста в EditBox. С его помощью можно различать ввод символа и отправку команды, такой как Del или Enter. Событие возвращает: action - идентификатор действия:

key - идентификатор клавиши, дающий наиболее точное представление о действии.

Например: action : 30 (ALT), key : 56 (LEFT ALT), 90 (RIGHT ALT)

Синтаксис

IR.AddListener(IR.EVENT_ITEM_CHANGE, item, function (action, key) {}, [pointer]);

Пример

IR.AddListener(IR.EVENT_ITEM_CHANGE, IR.GetItem("Page 1").GetItem("Item 1"), function (action, key)
{
if (action == 1)  // insert text
{
IR.Log("new string: " + IR.GetItem("Page 1").GetItem("Item 1").Text)
}
});

IR.EVENT_MOUSE_DOWN​

идентификатор события, которое срабатывает при нажатии кнопки мыши (Windows)

Синтаксис

IR.AddListener(IR.EVENT_MOUSE_DOWN, item, function, [pointer]);

Пример

IR.AddListener(IR.EVENT_MOUSE_DOWN, IR.GetItem("Page 1").GetItem("Item 1"), function ()
{
IR.Log("action"); // action
});

IR.EVENT_MOUSE_UP​

идентификатор события, которое срабатывает при отжатии кнопки мыши (Windows)

Синтаксис

IR.AddListener(IR.EVENT_MOUSE_UP, item, function, [pointer]);

Пример

IR.AddListener(IR.EVENT_MOUSE_UP, IR.GetItem("Page 1").GetItem("Item 1"), function ()
{
IR.Log("action"); // action
});

IR.EVENT_MOUSE_MOVE​

идентификатор события, которое срабатывает при перетягивании курсора мыши с зажатой левой кнопкой (Windows). Отдает каждое изменение координат курсора до момента, пока левая кнопка не будет отпущена.

Синтаксис

IR.AddListener(IR.EVENT_MOUSE_MOVE, item, function, [pointer]);

Пример

IR.AddListener(IR.EVENT_MOUSE_MOVE, IR.GetItem("Page 1").GetItem("Item 1"), function (x, y)
{
IR.Log(x + ":" + y); // new coordinates on move
});

IR.EVENT_TOUCH_DOWN​

идентификатор события, которое срабатывает при нажатии на элемент (iOS, Android)

Синтаксис

IR.AddListener(IR.EVENT_TOUCH_DOWN, item, function (x, y, id), [pointer]);

Пример

IR.AddListener(IR.EVENT_TOUCH_DOWN, IR.GetItem("Page 1").GetItem("Item 1"), function (x, y, id)
{
IR.Log(x + " " + y + " " + id);
});

IR.EVENT_TOUCH_UP​

идентификатор события, которое срабатывает при отпускании элемента (iOS, Android)

Синтаксис

IR.AddListener(IR.EVENT_TOUCH_UP, item, function (x, y, id), [pointer]);

Пример

IR.AddListener(IR.EVENT_TOUCH_UP, IR.GetItem("Page 1").GetItem("Item 1"), function (x, y, id)
{
IR.Log(x + " " + y + " " + id);
});

IR.EVENT_TOUCH_MOVE​

идентификатор события, которое срабатывает при перемещении пальца по элементу (iOS, Android)

Синтаксис

IR.AddListener(IR.EVENT_TOUCH_MOVE, item, function, [pointer]);

Пример

IR.AddListener(IR.EVENT_TOUCH_MOVE, IR.GetItem("Page 1").GetItem("Item 1"), function ()
{
IR.Log(x + ":" + y); // new coordinates on move
});

IR.EVENT_ITEM_SHOW​

идентификатор события, которое срабатывает при показе страницы или попапа

Синтаксис

IR.AddListener(IR.EVENT_ITEM_SHOW, item, function, [pointer]);

Пример

IR.AddListener(IR.EVENT_ITEM_SHOW, IR.GetItem("Page 1"), function ()
{
IR.Log("action"); // action
});

IR.EVENT_ITEM_HIDE​

идентификатор события, которое срабатывает при скрытии страницы или попапа

Синтаксис

IR.AddListener(IR.EVENT_ITEM_HIDE, item, function, [pointer]);

Пример

IR.AddListener(IR.EVENT_ITEM_HIDE, IR.GetItem("Page 1"), function ()
{
IR.Log("action"); // action
});

IR.EVENT_POPUP_ITEM_CHANGE​

идентификатор события, которое срабатывает при выполнении любого действия у элементов попапа

Синтаксис

IR.AddListener(IR.EVENT_POPUP_ITEM_CHANGE, item, function (event, popup, item), [pointer]);

Пример

IR.AddListener(IR.EVENT_POPUP_ITEM_CHANGE,IR.GetPopup("Popup 1"),function(event, popup, item){
IR.Log(event); // идетификатор события, например 142-Press, 143-Release, 146-Hold
IR.Log(popup.Name); // имя Popup
IR.Log(item.Name); // имя элемента
});

Свойства объектов​

Свойство объекта - одна из характеристик объекта, доступная для обращения. Набор свойств зависит от типа объекта. Объекты, полученные при обращении к нижележащим объектам иерархии, не наследуют их свойств (например, обратившись к объекту Item нельзя получить ширину объекта Popup, на котором он расположен).

IR​

IR.property

Page​

IR.GetItem(page).property

Popup​

IR.GetItem(popup).property

Item​

IR.GetItem(page/popup).GetItem(item).property

Item: Level​

IR.GetItem(page/popup).GetItem(level).property

Item: Multistate Level​

IR.GetItem(page/popup).GetItem(MS_level).property

Item: Joystick​

IR.GetItem(page/popup).GetItem(Joystick).property

Item: Up/Down Button​

IR.GetItem(page/popup).GetItem(Up/Down_Button).property

Item: Trigger Button​

IR.GetItem(page/popup).GetItem(Trigger_Button).property

Item: List​

IR.GetItem(page/popup).GetItem(list).property

см. подробнее в JavaScript API iRIdium. Списки

State​

IR.GetItem(page/popup).GetItem(item).GetState(n).property