Создание JavaScript-плагина

16.12.2016

Выберите название для плагина, например, MyPlugin. Если плагин с данным названием уже установлен в DS, то новый плагин его перезапишет.

Список установленных плагинов можно посмотреть в разделе Plugins на вкладке Docs в DroidScript или Wifi IDE. Также можно воспользоваться примером ниже.

Пример. Получение списка установленных плагинов

Выполнить

Создайте четыре файла:

MyPlugin.html - файл документации а формате html
MyPlugin.inc - файл с кодом плагина на JavaScript
Version.txt - файл, содержащий версию плагина
MyPlugin.jar - пустой файл (не содержит никакого текста)

Примеры файлов даны ниже.

MyPlugin.html

<!DOCTYPE html> 
<html>

<head>
	<meta charset="utf-8">
	<title>Мой плагин</title> 
		<meta name="viewport" content="width=device-width, initial-scale=1"> 
        <style type="text/css">
        </style>
</head>

<body>

<div data-role="header" data-position="fixed">
		<a href='#' class='ui-btn-left' data-icon='arrow-l' data-theme="c" onclick="history.back(); return false">Back</a> 
		<h1>MyPlugin</h1>
	</div>

<div data-role="content">	
			
		<p>Документация</p>
		
		<p>Для использования плагина MyPlugin его необходимо подключить к приложению с помощью метода <b>LoadPlugin</b>:</p>
		
		<div class="samp"> app.LoadPlugin( 'MyPlugin' );</div>
		
		<p>После нужно создать экземпляр объекта плагина:</p>
		
		<div class="samp"> plg = app.CreateObject( 'MyPlugin' );</div>
		  
		<br>
		<p>Примеры:</p>
		
		<div data-role="collapsible" data-collapsed="true"  data-mini="true" data-theme="a" data-content-theme="b">
			<h3>Получение версии плагина</h3>
			<div id="examp1" style="font-size:70%">
				<pre>
app.LoadPlugin( 'MyPlugin' );
var plg = app.CreateObject( 'MyPlugin' );

function OnStart(){

var _lay = app.CreateLayout( 'Linear', 'VCenter,FillXY' );
	
	_lay.AddChild( (function(){
	
		var _btn = app.CreateButton( 'Получить версию плагина' );
		_btn.SetOnTouch( function(){	
		
			app.ShowPopup( 'Версия плагина ' + plg.GetVersion() );
		});
		
		return _btn;
		
	})() );
	
	app.AddLayout( _lay );
 };
				</pre>
			</div>
			<div name="divCopy" align="right">
			<a href="#" data-role="button" data-mini="true" data-inline="true" onclick="copy(snip1)">  Copy  </a>
			<a href="#" data-role="button" data-mini="true" data-inline="true" onclick="copy(examp1)">Copy All</a>
			<a href="#" data-role="button" data-mini="true" data-inline="true" onclick="demo(examp1)">   Run   </a>
			</div>
		</div>
		
		<div data-role="collapsible" data-collapsed="true"  data-mini="true" data-theme="a" data-content-theme="b">
			<h3>Создание элемента в плагине</h3>
			<div id="examp2" style="font-size:70%">
			<pre>
app.LoadPlugin( 'MyPlugin' );
var plg = app.CreateObject( 'MyPlugin' );

function OnStart(){

var _lay = app.CreateLayout( 'Linear', 'VCenter,FillXY' );
	
	_lay.AddChild( (function(){
	
		var _btn = app.CreateButton( 'Создать кнопку' );
		_btn.SetOnTouch( function(){	
		
			plg.CreateMyButton( 'Кнопка плагина' );
		});
		
		return _btn;
		
	})() );
	
	app.AddLayout( _lay );
 };
			</pre>
			</div>
			<div name="divCopy" align="right">
			<a href="#" data-role="button" data-mini="true" data-inline="true" onclick="copy(snip2)">  Copy  </a>
			<a href="#" data-role="button" data-mini="true" data-inline="true" onclick="copy(examp2)">Copy All</a>
			<a href="#" data-role="button" data-mini="true" data-inline="true" onclick="demo(examp2)">   Run   </a>
			</div>
		</div>
		
		<div data-role="collapsible" data-collapsed="true"  data-mini="true" data-theme="a" data-content-theme="b">
			<h3>Проверка работы функции обратного вызова</h3>
			<div id="examp3" style="font-size:70%">
<pre>			
app.LoadPlugin( 'MyPlugin' );
var plg = app.CreateObject( 'MyPlugin' );

function OnStart(){

</body>
</html>

MyPlugin.inc

Version.txt

MyPlugin.jar

Установка плагина

Установка плагина происходит так:

Запакуйте 4 указанных выше файла в архив MyPlugin.zip
Скопируйте полученный архив в папку DroidScript/Plugins. Если в директории DroidScript нет папки Plugins, то создайте её.
Перехзапустите DroidScript.

В процессе запуска DroidScript переместит из папки Plugins архив плагина, распакует его в свою приватную директорию и после отобразит всплывающее сообщение о том, что плагин успешно установился, а документацию и примеры работы с ним можно посмотреть в разделе Docs/Plugins. Перейдите в этот раздел и в списке плагинов выберите MyPlugin.

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

Для использования плагина в своём приложении его нужно вначале загрузить методом app.LoadPlugin( Имя Плагина ), а затем создать объект для доступа к интерфейсу (открытым функциям/свойствам) плагина при помощи метода app.CreateИмяПлагина().

app.LoadPlugin( 'MyPlugin' );

var _plg = app.CreateMyPlugin();

После этого можно обращаться к открытым функциям плагина:

_plg.GetVersion();

Деинсталляция плагина

Деинсталляция плагина заключается в удалении его папки из приватной папки DroidScript. Для этого можно воспользоваться следующим примером.

Пример. Деинсталляция установленных плагинов.

Выполнить

function OnStart(){

lay = app.CreateLayout( "linear", "VCenter,FillXY" );    
 
    txt = app.CreateTextEdit( "" );
    txt.SetHint("Плагины для удаления");
    lay.AddChild( txt );
 
    btn=app.CreateButton("удалить плагин");
    btn.SetOnTouch(DeleteUserPlugin);
    lay.AddChild(btn);
    
    privFldr = app.GetPrivateFolder( "Plugins" );
    plgins = app.ListFolder(privFldr);
 
    lvw = app.CreateListView( plgins, "Выберите плагин для деинсталляции или нажмите Back для выхода");
    lvw.Show();
    lvw.SetOnTouch( lvw_OnTouch );
 
    app.AddLayout( lay );
}
 
function lvw_OnTouch( item )
{
  txt.SetText( item );
}
 
 
function DeleteUserPlugin()
{
    var plg = "" + txt.GetText()
    if (plg == "") return;
    plugDir = privFldr + "/" + plg.toLowerCase();
    if (app.FolderExists(plugDir))
    {
        var list = app.ListFolder(plugDir);
        var yesNo = app.CreateYesNoDialog( "Вы действительно хотите деинсталлировать плагин " + txt.GetText() + "? \nThe following files or folders will be all deleted:\n\n" + list + "\n\nIt is no way for undo!",'ShowNow');
        yesNo.Show();           
        yesNo.SetOnTouch( yesNo_OnTouch );
    }
}
 
 
function yesNo_OnTouch( yesNoresult ){
    if( yesNoresult == "Yes" )
    { 
        app.DeleteFolder(plugDir);
        
        app.Alert("Плагин " + txt.GetText() + " деинсталлирован!");
        txt.SetText("");
    }
    else
    {
        app.ShowPopup("No changings!");
    }
}