Dyskusja MediaWiki:Gadget-sftJSmsg.js

Dokumentacja klasy obsługi komunikatów JS-HTML

Diagram klasy

W skrócie klasa sftJSmsg umożliwia zastąpienie komunikatów JS typu alert(), prompt(), ale także tworzenie bardziej zaawansowanych formularzy HTML.

Funkcje pomocnicze

Aby uprościć użycie przy podstawowych zastosowaniach, udostępniona została funkcja jsAlert('tekst komunikatu'). Takie wywołanie jest funkcjonalnie analogiczne do alert('tekst komunikatu') ma jednak następujące zalety:

• Nie blokuje działania skryptów na stronie.
• Nie blokuje całej przeglądarki (a jedynie zasłania HTML).
• Posiada wbudowane mechanizmy kolejkowania (jeśli funkcja zostanie wywołana parę razy przed załadowaniem strony, to komunikaty będą pojawiać się po kolei po jej załadowaniu).
• Zaawansowany użytkownik ma możliwość zablokowanie jej wykonania poprzez redefinicję.

Podstawowe metody

Podstawową metodą jest show(), która pokazuje komunikat HTML podany w pierwszym parametrze. W drugim parametrze można (opcjonalnie) podać kod JavaScript w formie ciągu znakowego (string), który zostanie wywołany po wciśnięciu OK (domyślnie wywoływana jest tylko metoda close).

Podstawowe opcje (atrybuty klasy)

• showCancel – jeśli ma wartość true, to widoczny będzie przycisk anulowania (wywołujący metodę close).
• noButtons – jeśli ma wartość true, to komunikat pokaże się bez domyślnych przycisków, co oznacza, że metoda close będzie musiała być wywołana niezależnie (lub komunikat będzie musiał być zamknięty w inny sposób).
• createRegularForm – jeśli ma wartość true, to w komunikacie tworzony jest formularz HTML według danych z atrybutu RegularForm (domyślnie wykorzystywana jest metoda POST i adres bieżącej strony). Przycisk „OK” wysyła wówczas dane do serwera.
• autoOKClose – jeśli ma wartość false, to przycisk „OK” nie będzie wywoływał metody close („OK” wywoła wówczas tylko kod z akcji zawartej w parametrze strOKclick metody show).
• styleZbase – bazowa warstwa (z-index) dla komunikatu; może być istotne jeśli np. parę wiadomości ma się pojawić jedna nad drugą.
• styleWidth – szerokość komunikatu.
• styleTop – pozycja od góry dokumentu HTML (jeśli zostanie ustawione na undefined, to pozycja zostanie ustalona automatycznie).
• pozFromTop – pozycja od góry widocznej części strony, na jakiej ma zostać wyświetlona wiadomość HTML.