pandora.start(opts:StartOptions)

Funkcja uruchamia bibliotekę, powinna być wywołana przed użyciem innych funkcji. Obiekt opts przekazuje ustawienia.

pandora.StartOptions

Obiekt zawiera ustwienia inicjujące bibliotekę. Parametry:

pandora.ajax.get(url:String, callback:Function)

Funkcja wysyła żądanie na adres podany w argumencie url za pomocą technologi AJAX z wykorzystaniem metody GET. Po wykonaniu żądania wywoływana jest funkcja callback kóra jako argument przekazuje zwrócony przez AJAX obiekt.

pandora.ajax.post(url:String, param:Object, callback:Function)

Funkcja wysyła żądanie na adres podany w argumencie url za pomocą technologi AJAX z wykorzystaniem metody POST. W obiekcie param przekazywane są parametry metody POST. Po wykonaniu żądania wywoływana jest funkcja callback kóra jako argument przekazuje zwrócony przez AJAX obiekt. Przykład:

Div pandora.system.createAbsoluteDiv(left:Integer, top:Integer, right:Integer, bottom:Integer, width:Integer, height:Integer, css:String, html:String)

Funkcja tworzy div-a posiadającego właściwość css position równą absolute. Argumenty left, top, right, bottom określają położenie div-a względem rodzica, width i height jego wielkość. Teoretycznie, bo z szeregu left, right, width jeden, dowolny argument musi być równy null. Podobnie z położeniem w pionie. Argument css jest opcjonalny, określa wygląd div-a (patrz funkcja setCSSParam). Argument html jest opcjonalny, można w nim przekazać zawartość innerHTML tworzonego div-a. Aliasem dla nazwy funkcji jest cad. Przykład:

Div pandora.system.createDiv(css:String, html:String)

Funkcja tworzy standardowego div-a. Argument css jest opcjonalny, określa wygląd div-a (patrz funkcja setCSSParam). Aliasem dla nazwy funkcji jest cd.

Array pandora.system.createTable(nrow:Integer, ncol:Integer, css:String)

Funkcja tworzy tabelę html o liczbie wierszy podanej w nrow i liczbie kolumn podanej w ncol. Argument css jest opcjonalny i określa styl tabeli. Funkcja zwraca tablicę trójelementową: element DOM tabela, tablica wierszy (tr), tablica komórek (dwuwymiarowa - td). Aliasem nazwy funkcji jest ct. Przykład:

Element pandora.system.createElement(name:String, css:String)

Funkcja tworzy element DOM o nazwie podanej w name. Może to być np. a, span, input itd. Aliasem nazwy funkcji jest ce.

Image pandora.system.createImage(url:String, css:String)

Funkcja tworzy obrazek.

pandora.system.disableSelection(elm:Element)

Funkcja wyłącza możliwość zaznaczania na elemencie. Aliasem dla nazwy funkcji jest dsel.

pandora.system.clearSelection()

Funkcja czyści wszytkie zaznaczenia na stronie. Aliasem dla nazwy funkcji jest csel.

Point pandora.system.globalMousePosition(e:Event)

Funkcja zwraca współrzędne myszki w obszarze roboczym przeglądarki. Aliasem dla nazwy funkcji jest gmp.

Point pandora.system.globalElementPosition(elm:Element)

Funkcja zwraca położenie elementu w obszarze roboczym przeglądarki. Aliasem dla nazwy funkcji jest gep.

Point pandora.system.mousePosition(elm:Element, e:Event)

Funkcja zwraca położenie myszki w elemencie. Aliasem dla nazwy funkcji jest mp.

pandora.system.addEvent(elm:Element, event:String, callback:Function)

Funkcja dodaje obsługę zdarzenia o nazwie event do elementu elm. Aliasem dla nazwy funkcji jest ae.

pandora.system.addWheelEvent(elm:Element, callback:Function)

Funkcja dodaje obsługę zdarzenia obrotu kółkiem myszy do elementu elm. W momencie obracania kółkiem myszy nad elemntem wywoływana jest funkcja callback w argumecie której przekazywana jest zmienna o wartość 1 lub -1 jeden w zależności od kierunku obrotu.

pandora.system.addKeyDownEvent(elm:Element, callback:Function)

Funkcja dodaje obsługę zdarzenia wciśnięcia przycisku w momencie gdy kursor znajduje się nad elementem. W momencie zajscia zdarzenia wywołana zostaje funkcja callback, która jako argument przekazuje kod wciśniętego przycisku.

pandora.system.addKeyUpEvent(elm:Element, callback:Function)

Funkcja dodaje obsługę zdarzenia zwolnienia wciśnietego przycisku w momencie gdy kursor znajduje się nad elementem. W momencie zajscia zdarzenia wywołana zostaje funkcja callback, która jako argument przekazuje kod przycisku.

pandora.system.addResizeEvent(callback:Function)

Funkcja callback jest wywoływana w momencie zmiany rozmiaru okna przeglądrki

pandora.system.cancelEvent(e:Event)

Funkcja anuluje zdarzenie.

pandora.system.cancelStandardEvents(elm:Element)

Funkcja anuluje wszystkie standardowe zdarzenie występujące na elemencie.

pandora.system.callbackAfterTime(id:String, time:Integer, callback:Function)

Funkcja umożliwia wywołanie funkcji callback po upływie określonego w time i wyrażonego milisekundach (1000 milisekund = 1 sekunda) czasu. Argument id to identyfikator wywołania tej konkretnej funkcji, używanie takiego samego, powoduje że wywołania będą nadpisywane.

Size pandora.system.bodySize()

Funkcja zwraca rozmiar okna obszaru roboczego przaglądarki w pikselach. Aliasem dla nazwy funkcji jest bs.

pandora.system.setCSSParam(elm:Element, css:String)

Funkcja modyfikuje parametry stylu css elementu DOM przekazanego w argumencie elm. Argument css może być nazwą klasy CSS lub ciągiem lokalnego przypisania stylu css. Aliasem dla nazwy funkcji jest scss. Przykład:

Size pandora.system.size(elm:Element)

Funkcja zwraca rozmiar elementu w pikselach.

pandora.system.hide(elm:Element)

Funkcja ukrywa element.

pandora.system.show(elm:Element)

Funkcja uwidacznia ukryty element.

pandora.system.setBackgroundImage(elm:Element, image:String, repeat:String, position:String)

Funkcja ustawia tło dla elementu. Argument image to ścieżka do obrazka. Domyślnie jest on ustawiany na środku elementu i nie powtarza się. Właściwości te można zmienić korzystająć z opcjonalnych argumentów repeat i position. Zakres wartości z jakich można w ich przypadku korzystać pokrywa się z odpowiadającymi parametrami CSS. Aliasem dla nazwy funkcji jest sbi.

pandora.system.setRounding(div:Div, radius:Integer)

Funkcja ustawia zaokrąglenie narożników div-a. W argumencie radius określa się promień zaokrąglenia. Aliasem dla nazwy funkcji jest srad.

pandora.system.insertCSS(url:String)

Funkcja dynamicznie dołącza plik styli CSS.

Integer pandora.system.btoi(value:Boolean)

Funkcja zamienia typu Boolean an zmienną typu Integer (0 lub 1).

Integer pandora.system.stringWidth(text:String, fontFamily:String, fontSize:String, fontWeight:String)

Funkcja zwraca w pikselach długość tekstu przekazanego jako text. Pozostałe argumenty są wymagane i sa odpowiednikmi parametrów CSS ustawionych dla tekstu który chcemy badać.

Integer pandora.system.time()

Funkcja zwraca ilość milisekund jakie upłyneły od 1 stycznia 1970.

Integer pandora.system.uniqueToken()

Funkcja zwraca unikalny token

pandora.system.setTip(elm:Element, text:String)

Funkcja przypisuje do elementu dymek z tekstem, który pojawia sie po niecałej sekundzie po najechaniu myszką na element.

pandora.controls.TreeNode(opts:TreeNodeOptions)

Klasa pozwala stworzyć wezeł drzewa kontrolki TreeView.

addEvent(event:String, callback:Function)

Funkcja dodaje do okna obsługę zdarzenia. Dostępne sa następujące zdarzenia:
check - wywoływane w momencie kliknięcia przez użytkownika chcekboxa. Funkcja callback przez pierwszy argument przekazuje czy chcekbox przy weźle jest zaznaczony.

expand()

Funkcja rozwja węzeł.

collapse()

Funkcja zwija węzeł.

create()

Funkcja wewnętrzna, tworzy bebechy wezła w drzewku, wywoływana jest automatycznie.

Boolean isVisibleInTree()

Funkcja sprawdza czy węzeł jest widoczny w drzewie biorąc pod uwage zaznaczenia chcekboxów, w tym siebie samego.

Boolean isInData(value:String)

Funkcja sprawdza czy wartość podana w value znajduje się polu data węzła.

pandora.controls.TreeNodeOptions

Parametry:

pandora.controls.TreeView(div:Div, opts:TreeViewOptions)

Klasa pozwala stworzyć kontrolkę typu drzewko.

addEvent(event:String, callback:Function)

Funkcja dodaje do okna obsługę zdarzenia. Dostępne sa następujące zdarzenia:
check - wywoływane w momencie kliknięcia przez użytkownika na chcekboxa przy dowolnym węźle.

TreeNode getNodeById(id:String)

funkcja zwraca węzeł o zadanym identyfikatorze

expandAll()

funkcja rozwija wszytkie węzły i ich dzieci i dzieci ich dzieci...

collapseAll()

funkcja zwija wszytkie węzły i ich dzieci i dzieci ich dzieci...

TreeNode addNode(node:TreeNode,parent:String)

funkcja dodaje węzeł nodedo drzewa. Argument parent to identyfikator węzła rodzica. Jesli nie podamy wartości, podamy null, lub wartość '', węzeł zostanie dodany bezpośrednio do drzewa. Żeby wyegzekwować dodanie węzła, należy odświeżyć drzewko za pomocą refresh.

TreeNode addNode(node:TreeNode,parent:TreeNode)

funkcja dodaje węzeł nodedo drzewa. Argument parent to obiekt węzła rodzica. Jesli jako parent nie podamy wartości lub podamy null, węzeł zostanie dodany bezpośrednio do drzewa. Żeby wyegzekwować dodanie węzła, należy odświeżyć drzewko za pomocą refresh.

refresh()

funkcja odświeża stan drzewa, względniając dodane węzły.

clear()

funkcja czyści drzewo z węzłów.

TreeNode findNodeWithValueInData(value:String)

funkcja zwraca węzeł posiadający wartość value w polu data (patrz funkcja isInData węzła).

createFromText(text:String,checkedNodesId:Array)

funkcja tworzy drzewko na podstwie odpowiednio sformatowanego tekstu. Na każdy węzeł skałada się sekcja. Sekcje są rozdzielane znakiem '|'.Kolejność sekcji - węzłów, odpowiada kolejności węzłów w drzewie przy pełnym jego rozinięciu. Na sekcje skłądają się parametry rozdzielene średnikami. I tak kolejne parametry oznaczają:
0 - identyfikator węzła
1 - identyfikator węzła rodzica
2 - etykieta
3 - wartości które trafią do pola data węzła
4 - czy przy węźle znajduje się chcekbox (0 lub 1)
5 - czy węzeł jest zaznaczony (0 lub 1)
6 - czy węzeł jest rozwinięty
7 - adres do obrazka ikonki
8 - czy na węzeł można klinąć
9 - kolor tekstu
10 - czy jest przycisk menu
Przykład:

pandora.controls.Window(opts:WindowOptions)

Klasa pozwala utworzyć okienko które można przesówać, zmieniać rozmiar itd.

focus()

Funkcja ustawia okno jako aktywne, przy okazji wszytkie inne widoczne okna ustawiane są jako nieaktywne.

blur()

Funkcja ustawia okno jako nieaktywne.

addEvent(event:String, callback:Function)

Funkcja dodaje do okna obsługę zdarzenia. Dostępne sa następujące zdarzenia:
close - wywoływane w momencie wciśnięcia przycisku zamykającego okno. Jeśli nie dodamy tego zdarzenia, okno zamyka się tuż po wciśnięciu przycisku. Po dodaniu o zamknięcie trzeba zatroszczyć się samemu w funkcji callback np. wywołując funkcję close.
focus - funkcja jest wywoływana w momencie aktywowanai okna, także w gdy wywoływana jest funkja focus.

close()

Funkcja zamyka okno.

setStyle(active:Boolean)

Funkcja nadaj styl okienka aktywnego (active równy true) lub nieaktywnego (active równy false).

collapse()

Funkcja zwija okienko do paska tytułowgo.

expand()

Funkcja rozwija okienko.

String getSettings()

Funkcja zwraca tekst zawierający konfigurację podstawowych parametrów okna: położenie, rozmiar, czy jest rowinięte itd.

setSettings(set:String)

Funkcja pozwala ustawić podstwowe parametry okna. Argumentem funkcji jest ciąg tekstowy w postaci zwracanej przez funkcję getSettings.

Div getWorkspaceDiv()

Funkcja zwraca div-a stanowiącego obszar roboczy okna.

pandora.controls.WindowOptions

Parametry:

pandora.controls.WindowStyle

Parametry:

pandora.controls.Map(div:Div, opts:MapOptions)

Klasa tworzy interfejs mapowy. Div przekazany w konstruktorze musi mieć pozycję absolutną.

Point p2r(pos:Point)

Funkcja przelicza współrzędne ekranowe pos do współrzędnych układu mapy.

Number p2r(value:Number)

Funkcja przelicza odległość w układzie ekranu do odległości w układzie współrzędnych mapy.

pandora.controls.MapOptions

Obiekt zawiera ustwienia inicjujące obiekt mapy. Parametry:

Boolean pandora.math.intersects(a:Box, b:Box)

Funkcja sprawdza czy obiekty wzajemnie się przecinają

Box pandora.math.sub(a:Box, b:Box)

Funkcja odjmuje odpowiadające sobie wartości.

Box pandora.math.scalar(a:Box, scalar:Float)

Funkcja mnoży przez skalar każda z wartości obiektu box.

Point pandora.math.round(a:Point)

Funkcja zwraca obiekt o zaokraglonych wartościach.

Box pandora.math.round(a:Box)

Funkcja zwraca obiekt o zaokraglonych wartościach.

Obiekt to tablica jednowymiarowa, dwuelementowa. Przechowóje wymiary, w kolejności szerokść i wysokość. Nie posiada osobnego konstruktora, tworzy się jak standardową tablicę, przykład:

Obiekt to tablica jednowymiarowa, dwuelementowa. Przechowóje wspłrzędne, w kolejności x i y. Nie posiada osobnego konstruktora, tworzy się jak standardową tablicę, przykład:

Obiekt to tablica jednowymiarowa, czteroelementowa. Przechowóje zakres przestrzenny obiektu, kolejne pola to w kolejności: xmin, ymin, xmax, ymax. Nie posiada osobnego konstruktora, tworzy się jak standardową tablicę, przykład: