Page History

...

Code Block

language	html/xml
title	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 za refreshInterval
	Gadget.autoRefreshrefresh(${refreshInterval});
</script>

...

Gadget API

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

nowy

Metoda

Parametry

Opis

Przykład

getId

brak

Zwraca identyfikator gadżetu

Expand

title	Pokaż przykład

Code Block

language	javascript

var id = Gadget.getId();

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

Expand

title	Pokaż przykład

Code Block

language	javascript

var key = Gadget.getKey();

getTitle

brak

Zwraca aktualny tytuł gadżetu

Expand

title	Pokaż przykład

Code Block

language	javascript

var title = Gadget.getTitle();

setTitle

title: nowy tytuł gadżetu

Zmienia tekst belki tytułowej gadżetu

Expand

title	Pokaż przykład

Code Block

language	javascript

Gadget.setTitle('

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.

Expand

title	Pokaż przykład

Code Block

language	javascript

if(Gadget.hasAutoHeight() == false){
	// akcja
}

enableAutoHeight

brak

Włącza opcję Dopasowana wysokość. Wysokość gadżetu zostanie

obliczona na podstawie

dopasowana do zawartości.

getHeight

setHeight

Expand

title	Pokaż przykład

Code Block

language	javascript

Gadget.enableAutoHeight();

disableAutoHeight

brak

Wyłącza opcję Dopasowana wysokość.Wysokość gadżetu nie ulegnie zmianie.

Expand

title	Pokaż przykład

Code Block

language	javascript

Gadget.disableAutoHeight();

getHeight

brak

Pobiera wysokość gadżetu w pixelach.

Expand

title	Pokaż przykład

Code Block

language	javascript

var h = Gadget.getHeight();

setHeight

height: nowa wysokość gadżetu (int)

Zmienia wysokość gadżetu. Jeżeli opcja Dopasowana wysokość była aktywna, zostanie ona wyłączona.

Expand

title	Pokaż przykład

Code Block

language	javascript

Gadget.setHeight(500);

refresh

interval (opcjonalny) : okres, za który gadżet ma zostać odświeżony

Info
Jeżeli interval jest pusty lub interval<0to gadżet zostanie odświeżony natychmiast

.

Odświeża gadżet, pobierając ponownie zawartość gadżetu zgodnie z jego url. Podczas odświeżenia widoczna jest maska ładowania.

Info
Odświeżenie powoduje wczytanie strony i wszystkich skryptów od nowa, dlatego funkcja nie udostępnia żadnego callback'u.

Expand

title	Pokaż przykład

Code Block

language	javascript

Gadget.refresh();

showConfiguration

forceChange (opcjonalny): jeżeli true:
- wyświetlone okno nie ma przycisku Anuluj, co wymusza na użytkowniku zmianę ustawień na poprawne wartości.

Wyświetla widok konfiguracji gadżetu, opcjonalnie zmuszając go do poprawienia konfiguracji.

Info
Po zapisaniu konfiguracji gadżet jest automatycznie odświeżany

Expand

title	Pokaż przykład

Code Block

language	javascript

Gadget.showConfiguration(true);

Versions Compared

Old Version 2

New Version 3

Key

Gadget API