TreeWidget PDF Drukuj

Atrybuty

  • items - tablica zawierająca obiekty węzłów należących do kontrolki
  • target - element do którego ładowana jest zawartość węzłów
  • name - nazwa kontrolki wysyłana do serwera jako parametr określony w atrybucie widgetParam
  • link - domyślny adres wywoływany na serwerze przez węzły
  • useCache - użycie pamięci podręcznej; zawartość każdego węzła ładowana jest tylko raz; wartość false oznacza ładowanie zawartości węzła za każdym razem kiedy zostanie wybrany (wartość domyślna: true)
  • useHash - dynamiczna zmiana adresu (patrz Uwagi) (wartość domyślna: false)
  • useSaving - zapamiętywanie aktywnego węzła (patrz Uwagi) (wartość domyślna: false)
  • autoTextUpdate - wartość true oznacza, że odpowiedź tekstowa będzie automatycznie wstawiana do elementu target (wartość domyślna: true)
  • itemParam - nazwa parametru wysyłanego do serwera zawierającego nazwę węzła (wartość domyślna: "item")
  • widgetParam - nazwa parametru wysyłanego do serwera zawierającego nazwę kontrolki (wartość domyślna: "widget")
  • selectFirstItem - wartość true oznacza, że pierwszy dodany węzeł zostania automatycznie wybrana (wartość domyślna: true)
  • reqConfig - ustawienia zapytań wysyłanych przez kontrolkę (patrz Uwagi) (wartość domyślna: {})
  • fading - animowana zmiana zawartości (wartość domyślna: false)
  • fadeSteps - ilość kroków animacj zmiany zawartości (wartość domyślna: 25)
  • fadeDuration -czas trwania animacji zmiany zawartości (wartość domyślna: 500ms)
  • overOpen - zwijanie/rozwijanie węzłów po najechaniu kursorem (wartość domyślna: false)
  • overWait - czas w milisekundach jaki musi minąć od najechania kursorem na węzeł aby został zwinięty/rozwinięty (wartość domyślna: 200ms)
  • tree - element, gdzie dodawane są nowe węzły
  • indent - rozmiar wcięcia węzłów podrzędnych (wartość domyślna: 25)
  • newItemUnfold - określa, czy nowe węzły mają być rozwiniete czy zwinięte (wartość domyślna: true)
  • selectBeforeOpen - wartość true oznacza, że węzły muszą być najpierw wybrane zanim zostaną rozwinięte/zwinięte; wartość false oznacza że węzły są rozwijane/zwijane od razu po ich wybraniu (wartość domyślna: false)
  • foldAnimation - płynne zwijanie/rozwijanie węzłów podrzędnych (wartość domyślna: true)
  • foldSteps - ilość kroków animacji zwijania/rozwijania
  • foldDuration - czas trwania animacji zwijania/rozwijania
  • imageClass - klasa ikon
  • imagePosition - położenie ikon; "left" (po lewej) lub "right" (po prawej) (wartość domyślna: "left")
  • areaClass - klasa elementu zawierającego węzły podrzędne
  • itemClass - bazowa klasa węzła
  • foldClass - klasa zwiniętęgo węzła
  • unfoldClass - klasa rozwiniętego węzła
  • itemSelectClass - klasa zaznaczonego węzła
  • foldSelectClass - klasa zaznaczonego, zwiniętego węzła
  • unfoldSelectClass - klasa zaznaczonego, rozwiniętego węzła
  • itemImage - bazowa ikona węzła
  • foldImage - ikona zwiniętego węzła
  • unfoldImage - ikona rozwiniętego węzła
  • itemSelectImage - ikona zaznaczonego węzła
  • foldSelectImage - ikona zaznaczonego, zwiniętego węzła
  • unfoldSelectImage - ikona zaznaczonego, rozwiniętego węzła
  • OnSelect(item) - funkcja wywoływana po wybraniu węzła
    • item - obiekt TreeItem wybranego węzła
  • OnDeselect(item) - funkcja wywoływana przy zmianie węzła
    • item - obiekt TreeItem poprzedniego węzła
  • OnUpdate(item, response) - funkcja wywoływana po odebraniu odpowiedzi z serwera
    • item - obiekt TreeItem węzła, którego zawartość została pobrana
    • response - odebrana odpowiedź
  • OnRetrieve(item) - funkcja wywoływana przy wysyłaniu zapytania do serwera
    • item - obiekt TreeItem węzła, którego zawartość jest pobierana
  • OnError() - funkcja wywoływana przy problemie w odbiorze zawartości węzła

Metody

  • AddItem(parent, name, [type, link, text])  - dodaje węzeł do drzewka; zwraca obiekt TreeItem
    • parent - obiekt TreeItem węzła nadrzędnego lub jego nazwa, gdzie wstawiony ma być nowy węzeł; wartość null oznacza, że zostanie on wstawiony bez węzłą nadrzędnego
    • name - nazwa zakładki wysyłana do serwera jako parametr określony w atrybucie itemParam
    • type - typ pobieranej zawartości ("text", "json" lub "xml") (wartość domyślna: "text")
    • link - adres strony, skąd pobierana jest zawartość węzła; domyślnie adres ustawiony w kontrolce
    • text - wyświetlany tekst w drzewku; domyślnie wyświetlana jest nazwa węzła
  • GetItem(name) - zwraca węzeł o podanej nazwie
    • name - nazwa szukanego węzła
  • RemoveItem(item) - usuwa dany węzeł
    • item - nazwa lub obiekt TreeItem węzła, który chcemy usunąć
  • Load(url) - dynamicznie ładuje węzły w formacie JSON z podanego adresu (patrz Uwagi)
    • url - adres, skąd pobrane mają zostać węzły
  • MoveBefore(item, before) - przesuwa węzeł przed podanym węzłem
    • item - nazwa lub obiekt TreeItem węzła, który chcemy przesunąć
    • before - nazwa lub obiekt TreeItem węzła, za którym ma zostać wstawiony przesuwany węzeł
  • MoveAfter(item, after) - przesuwa węzeł za podanym węzłem
    • item - nazwa lub obiekt TreeItem węzła, który chcemy przesunąć
  • InsertItem(parent, name, [type, link, text]) - identycznie jak AddItem; funkcja zachowana w celu kompatybilności z poprzednimi wersjami

Przykłady

// przykładowe dane pobierane przez funkcję Load
[
        {
            name: "node1",
            title: "Pierwszy węzeł",
            child:
            [
                {
                    name: "node2",
                    title: "Drugi węzeł",
                    type: "text",
                    link: "node2.txt"
                },
                {
                    name: "node3",
                    title: "Trzeci węzeł",
                    type: "text",
                    link: "node3.txt"
                }
            ]
        },
        {
            name: "node4",
            title: "Czwarty węzeł",
            type: "text",
            link: "node4.txt"
        }
]

 

Uwagi

  • Zapamiętywanie aktywnego węzła (atrybut useSaving) polega na automatycznym wybraniu zapamiętanego węzła po przeładowaniu strony (mechanizm oparty jest na ciasteczkach).
  • Dynamiczna zmiana adresu (atrybut useHash) polega na dopisaniu nazwy aktywnego węzła po znaku #, adres zmienia się następująco:

    http://www.przyklad.com#nazwa_węzła

    Mechanizm ten umożliwia zapamiętywanie dynamicznych stron, ponieważ w przypadku wywołania takiego adresu automatycznie wybrany zostanie węzeł o nazwie nazwa_węzła.
  • Domyślnie zawartość węzłów ładowana jest ze strony określonej w parametrze link w obiekcie kontrolki. W celu ładowania zawartości z innego adresu, należy przekazać ten adres podczas dodawania nowego węzła jako argument link w funkcji AddItem. Możliwa jest także późniejsza zmiana tego adresu poprzez ustawienie atrybutu link w obiekcie TreeItem.
  • Atrybut reqConfig zawiera ustawienia zapytań wysyłanych przez kontrolkę w postaci obiektu zawierającego pary "atrybut: wartość", przykładowe ustawienia:

    tree.reqConfig = {
        username: "lorem",
        password: "ipsum",
        encoding: "iso-8859-2"
    }
 
« poprzedni artykuł   następny artykuł »