XUL:wizard

z Mozilla Developer Center, polskiego centrum programistów Mozilli.

« Dokumentacja XUL    [ Przykłady | Atrybuty | Własności | Metody | Podobne ]

Ten element powinien być stosowany do tworzenia kreatorów krok-po-kroku, jaki znajduje się w różnych aplikacjach aby przeprowadzić użytkownika przez jakieś zadanie. Jest to okno z kilkoma krokami znajdującymi się na kilku stronach. Element wizard tworzy okno i dostarcza nagłówek oraz przyciski wzdłuż dolnej krawędzi i obsługuje nawigację pomiędzy stronami. Każda strona powinna być tworzona używając elementu wizardpage. Strony wyświetlane są w takiej kolejności w jakiej zostały umieszczone wewnątrz elementu wizard, chyba że użyjesz atrybutów next i pageid stron by zmienić sekwencję. Kreator zostanie wyświetlony w sposób odpowiedni dla platformy i motywu użytkownika. W nowszych wersjach Mozilli, element statusbar może zostać umieszczony bezpośrednio wewnątrz elementu wizard i będzie współdzielony przez wszystkie strony.

Dodatkowe informacje są dostępne w kursie XUL.

Atrybuty

firstpage, lastpage, onextra1, onextra2, onwizardback, onwizardcancel, onwizardfinish, onwizardnext, pagestep, title

Własności

canAdvance, canRewind, currentPage, onFirstPage, onLastPage, pageCount, pageIndex, pageStep, title, wizardPages

Metody

advance, cancel, extra1, extra2, getButton, getPageById, goTo, rewind

[edytuj] Przykłady

<?xml version="1.0"?>
<?xml-stylesheet href="chrome://global/skin/" type="text/css"?>

<wizard id="theWizard" title="Secret Code Wizard"
  xmlns="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul">

<script>
function checkCode(){
  document.getElementById('theWizard').canAdvance = (document.getElementById('secretCode').value == "cabbage");
} 
</script>

  <wizardpage onpageshow="checkCode();">
       <label value="Enter the secret code:"/>
       <textbox id="secretCode" onkeyup="checkCode();"/>
  </wizardpage>

  <wizardpage>
       <label value="That is the correct secret code."/>
  </wizardpage>

</wizard>

[edytuj] Atrybuty

Dziedziczy z elementu XUL align, allowevents, allownegativeassertions, class, coalesceduplicatearcs, collapsed, container, containment, context, contextmenu, datasources, dir, empty, equalsize, flags, flex, height, hidden, id, insertafter, insertbefore, left, maxheight, maxwidth, menu, minheight, minwidth, mousethrough, observes, ordinal, orient, pack, persist, popup, position, preference-editable, ref, removeelement, sortDirection, sortResource, sortResource2, statustext, style, template, tooltip, tooltiptext, top, uri, wait-cursor, width

firstpage

Typ: boolean

Ustawiony na true, jeśli wizard jest na pierwszej stronie.

lastpage

Typ: boolean

Ustawiony na true, jeśli wizard jest na ostatniej stronie.

onextra1

Typ: kod skryptu

Ten atrybut powinien być ustawiony w kodzie, który wywołany bedzie kiedy użytkownik naciśnie dodatkowy przycisk (extra1).

onextra2

Typ: kod skryptu

Ten atrybut powinien być ustawiony w kodzie, który wywołany bedzie kiedy użytkownik naciśnie dodatkowy przycisk (extra2).

onwizardback

Typ: kod skryptu

Powinien być ustawiony kod, który jest wywołany kiedy użytkownik naciśnie przycisk Wstecz. Zwraca true, aby pozwolić na to by wyświetlić wcześniejszą stronę i false, aby nie pozwolić na powrót do wcześniejszej strony. Zastosuj własność canRewind, aby zasygnalizować użytkownikowi (przez odłączenie przycisku Wstecz), że on nie może wrócić do poprzedniej strony.

onwizardcancel

Typ: kod skryptu

Powinien być ustawiony kod, który jest wywołany, kiedy użytkownik naciśnie przycisk Anuluj. Zwraca true, aby pozwolić kreatorowi zostać anulowanym i zamkniętym lub zwróci false, aby chronić kreator przed anulowaniem.

onwizardfinish

Typ: kod skryptu

Powinien być ustawiać kod, który jest wywoływany kiedy użytkownik naciśnie przycisk Zakończ, który pojawi się przycisk Dalej na ostatniej stronie kreatora. Zwraca true pozwalając kreatorowi na zamknięcie się lub zwraca false, zapobiega przejście do następnej strony. Zastosuj własność canAdvance, aby zasygnalizować użytkownikowi (poprzez wyłączenie przycisku Zakończ), że nie ma on końca.

onwizardnext

Typ: kod skryptu

Powinien być ustawiać kod, który jest wywoływany kiedy użytkownik naciśnie przycisk Dalej, podczas pobytu na bieżącej stronie. Zwraca true pozwalając następnej stronie na wyświetlenie sie i zwraca false nie pozwalając na przejście do następnej strony. Zastosuj własność canAdvance aby zasygnalizować użytkownikowi (poprzez wyłączenie przycisku Dalej), że nie może on przejść do następnej strony.

pagestep

Typ: integer

Indeks bieżącej strony.

title

Typ: string

Tekst wyświetlony na pasku tytułu w oknie dialogowym.

[edytuj] Własności

Dziedziczy z elementu XUL align, allowEvents, boxObject, builder, className, collapsed, contextMenu, controllers, currentItem, database, datasources, dir, flex, height, hidden, id, left, listBoxObject, maxHeight, maxWidth, menu, minHeight, minWidth, observes, ordinal, orient, pack, persist, ref, resource, statusText, style, tooltip, tooltipText, top, value, width Dziedziczy z elementu DOM attributes, childNodes, cloneNode, firstChild, lastChild, localName, namespaceURI, nextSibling, nodeName, nodeType, nodeValue, ownerDocument, parentNode, prefix, previousSibling, tagName

canAdvance

Typ: boolean

Ta własność jest ustawiona na true, jeśli użytkownik naciśnie przycisk 'Dalej', aby przejść do następnej strony. Jeśli ta własność jest ustawiona na false, użytkownik nie może przejść do następnej strony. Ustaw tą własność na true, aby zasygnalizować, że użytkownik może przejść do następnej strony. Ustawiając własność na false, przejście do następnej strony zostanie odrzucone (zabronione). Możemy to zobaczyć poprzez włączony lub wyłączony przycisk 'Dalej' lub na ostatniej stronie kreatora będzie umieszczony przycisk 'Zakończ'.

canRewind

Typ: boolean

Ta własność jest ustawiona na true, jeśli użytkownik może nacisnąć przycisk Wstecz, aby przejść do poprzedniej strony. Jeśli własność jest false, użytkownik nie będzie mógł przejść do poprzedniej strony. Ustaw tą własność na true, aby zasygnalizować, że użytkownik może przejść do poprzedniej strony. Ustaw na false, aby nie pozwolić na przeniesienie do poprzedniej strony. Posiada efekt włączonego lub wyłączonego przycisku Wstecz.

currentPage

Typ: element wizardpage

Wartość zwraca element kreatora (wizardpage), który jest aktualnie wyświetlany. Możemy modyfikować tą wartość, aby zmienić aktualną stronę.

onFirstPage

Typ: boolean

Ta własność jest ustawiona na true, jeśli użytkownik jest na pierwszej stronie, która może być lub nie być pierwsza w indeksie.

onLastPage

Typ: boolean

Ta własność jest ustawiona na true, jeśli użytkownik jest na ostatniej stronie kreatora.

pageCount

Typ: integer

Ta własność trzyma liczbę stron w kreatorze (wizard).

pageIndex

Typ: integer

Ta własność zwraca indeks aktualnie zaznaczonej strony. Możemy zmienić zaznaczenie strony poprzez modyfikacje tej własności.

pageStep

Typ: integer

This property returns the number of pages that the user has navigated through so far, meaning that the user would press the Back button this many times to go back to the beginning. This property is different than pageIndex, because pages are not necessarily navigated in order.

title

Typ: string

Tytuł, który pojawia się na górze kreatora (wizard). Jest przesłaniany przez atrybut label na indywidualnych stronach.

wizardPages

Typ: DOM NodeList elementów wizardpage

Ta własność podtrzymuje listę elementów wizardpage w wizard.

[edytuj] Metody

Dziedziczy z elementu XUL blur, click, doCommand, focus, getElementsByAttribute Dziedziczy z elementu DOM addEventListener, appendChild, dispatchEvent, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, hasAttribute, hasAttributeNS, hasAttributes, hasChildNodes, insertBefore, isSupported, normalize, removeAttribute, removeAttributeNode, removeAttributeNS, removeChild, removeEventListener, replaceChild, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS

advance ( pageID )

Zwraca typ: nie zwraca wartości

Wywołaj tą metodę, aby przejść stronę dalej. Jest równoważna naciśnięciu przycisku Dalej. Własność canAdvance musi być ustawiona na true dla strony, która będzie zmieniona. Kod w atrybucie onwizardnext jest wywołany przed zmianą strony. Argument pageID pozwala nam określić indeks strony do której mamy przejść. Dostarcza null jako argument przejścia do strony dalej w pewnej kolejności.

cancel ()

Zwraca typ: nie zwraca wartości

Wywołuje tą metodę do anulowania i zamknięcia kreatora. Kod w atrybucie onwizardcancel jest wywołany zanim okno kreatora zostanie anulowane.

extra1 ()

Zwraca typ: nie zwraca wartości

Wywołanie tej metody symuluje naciśnięcie dodatkowego przycisku (extra1). Kod w atrybucie onextra1 zostanie wywołany.

extra2 ()

Zwraca typ: nie zwraca wartości

Wywołanie tej metody symuluje naciśnięcie dodatkowego przycisku (extra2). Kod w atrybucie onextra2 zostanie wywołany.

getButton ( typ )

Zwraca typ: element button

Zwraca element button o zadanym typie, znajdujący się w okienku dialogowym.

getPageById ( pageID )

Zwraca typ: element wizardpage

Zwraca element wizardpage przesyłając go do określonej pageID.

goTo ( pageID )

Zwraca typ: nie zwraca wartości

Ta metoda jest stosowana do zmiany, która strona jest aktualnie wyświetlana, określona poprzez argument pageID. Strona będzie zmieniona niezależnie od własności canAdvance lub canRewind. Atrybuty onwizardback i onwizardnext nie są wywoływane podczas użycia tej metody.

rewind ()

Zwraca typ: nie zwraca wartości

Wywołaj tą metodę, aby przejść wstecz na stronie. Jest równoważna naciśnięciu przycisku Wstecz. Własność canRewind musi być ustawiona na true dla strony, która będzie zmieniona. Kod w atrybucie onwizardback jest wywołany przed zmianą strony.

[edytuj] Podobne

wizardpage