Gadget API

Wstęp

Każdy gadżet osadzony w dashboardzie ma mieć możliwość wykonywania akcji przy użyciu skryptów JavaScript.

W momencie załadowania widoku gadżetu, dostępny jest już dla niego obiekt Gadget, który reprezentuje ten gadżet i udostępnia zestaw metod, dzięki którym może np. zmienić tytuł gadżetu czy wyświetlić okno konfiguracji.

Przykład pojedynczego widoku gadżetu (w technologii Freemarker).

Przykładowy widok .ftl gadżetu

<!-- pomocnicze macro -->
<#import "/plugin.ftl" as plugin/>
 
<!-- ... ... -->
 
<!-- Skrypt wykorzystujący GadgetApi -->
<script type="text/javascript">
	// zmiana tytułu
	Gadget.setTitle('<@plugin.message "gadget.title"/>');
 
	// automatyczne odświeżanie gadżetu
	Gadget.autoRefresh(${refreshInterval});
</script>

Dokumentacja

Poniżej przedstawiono wszystkie dostępne metody obiektu Gadget.

Metoda	Parametry	Opis	Przykład
getId	brak	Zwraca identyfikator gadżetu
getKey	brak	Zwraca klucz gadżetu. Klucz gadżetu składa się z klucza wtyczki oraz klucza modułu np. *com.suncode.plugin.dashboard:introduction*
getTitle	brak	Zwraca aktualny tytuł gadżetu
setTitle	title: nowy tytuł gadżetu	Zmienia tekst belki tytułowej gadżetu	Pokaż Gadget.setTitle('nowy tytuł');
hasAutoHeight	brak	Zwraca *true* jeżeli gadżet ma zaznaczoną opcję Dopasowana wysokość. Tak skonfigurowany gadżet próbuje dopasować się do faktycznej zawartości.
enableAutoHeight	brak	Włącza opcję Dopasowana wysokość. Wysokość gadżetu zostanie obliczona na podstawie zawartości
getHeight
setHeight