Class Document

Dokument

Reprezentacja dokumentu XML.

Metody

Metoda	Zwracany typ	Krótki opis
addContent(content)	Document	Dołącza podany węzeł na końcu dokumentu.
addContent(index, content)	Document	Wstawia dany węzeł pod podanym indeksem wśród wszystkich węzłów, które są bezpośrednimi elementami podrzędnymi dokumentu.
cloneContent()	Content[]	Tworzy niepowiązane kopie wszystkich węzłów, które są bezpośrednimi elementami podrzędnymi dokumentu.
detachRootElement()	Element|null	Odłącza i zwraca węzeł główny Element dokumentu.
getAllContent()	Content[]	Pobiera wszystkie węzły, które są bezpośrednimi elementami podrzędnymi dokumentu.
getContent(index)	Content|null	Pobiera węzeł o podanym indeksie spośród wszystkich węzłów, które są bezpośrednimi elementami podrzędnymi dokumentu.
getContentSize()	Integer	Zwraca liczbę węzłów, które są bezpośrednimi elementami podrzędnymi dokumentu.
getDescendants()	Content[]	Pobiera wszystkie węzły, które są bezpośrednimi lub pośrednimi elementami podrzędnymi dokumentu, w kolejności, w jakiej występują w dokumencie.
getDocType()	DocType|null	Pobiera deklarację DocType dokumentu.
getRootElement()	Element|null	Pobiera węzeł główny Element dokumentu.
hasRootElement()	Boolean	Określa, czy dokument ma węzeł główny Element.
removeContent()	Content[]	Usuwa wszystkie węzły, które są bezpośrednimi elementami podrzędnymi dokumentu.
removeContent(content)	Boolean	Usuwa podany węzeł, jeśli jest on bezpośrednim elementem podrzędnym dokumentu.
removeContent(index)	Content|null	Usuwa węzeł o podanym indeksie spośród wszystkich węzłów, które są bezpośrednimi elementami podrzędnymi dokumentu.
setDocType(docType)	Document	Ustawia deklarację DocType dokumentu.
setRootElement(element)	Document	Ustawia węzeł główny Element dokumentu.

Szczegółowa dokumentacja

addContent(content)

Dołącza podany węzeł na końcu dokumentu. Argument content może być obiektem Content lub dowolnym obiektem węzła, który odpowiada typowi wymienionemu w ContentType. Pamiętaj jednak, że dokument może mieć tylko jeden węzeł podrzędny Element, który jest węzłem głównym Element.

Parametry

Nazwa	Typ	Opis
content	Content	Węzeł do dołączenia.

Powrót

Document – dokument do łączenia.

---

addContent(index, content)

Wstawia dany węzeł pod podanym indeksem wśród wszystkich węzłów, które są bezpośrednimi elementami podrzędnymi dokumentu. Argument content może być obiektem Content lub dowolnym obiektem węzła, który odpowiada typowi wymienionemu w ContentType. Pamiętaj jednak, że dokument może mieć tylko jeden węzeł podrzędny Element, który jest domyślnie węzłem głównym Element.

Parametry

Nazwa	Typ	Opis
index	Integer	Indeks, pod którym węzeł ma zostać wstawiony wśród wszystkich węzłów będących bezpośrednimi elementami podrzędnymi dokumentu.
content	Content	Węzeł do wstawienia.

Powrót

Document – dokument do łączenia.

---

cloneContent()

Tworzy niepowiązane kopie wszystkich węzłów, które są bezpośrednimi elementami podrzędnymi dokumentu.

Powrót

Content[] – tablica niepowiązanych kopii wszystkich węzłów, które są bezpośrednimi elementami podrzędnymi dokumentu.

---

detachRootElement()

Odłącza i zwraca węzeł główny Element dokumentu. Jeśli dokument nie ma węzła głównego Element, ta metoda zwraca wartość null.

Powrót

Element|null – odłączony węzeł Element lub null, jeśli dokument nie ma węzła głównegoElement.

---

getAllContent()

Pobiera wszystkie węzły, które są bezpośrednimi elementami podrzędnymi dokumentu.

Powrót

Content[] – tablica wszystkich węzłów, które są bezpośrednimi elementami podrzędnymi dokumentu.

---

getContent(index)

Pobiera węzeł o podanym indeksie spośród wszystkich węzłów, które są bezpośrednimi elementami podrzędnymi dokumentu. Jeśli pod danym indeksem nie ma węzła, ta metoda zwraca wartość null.

Parametry

Nazwa	Typ	Opis
index	Integer	Indeks węzła wśród wszystkich węzłów, które są bezpośrednimi elementami podrzędnymi dokumentu.

Powrót

Content|null – węzeł lub null, jeśli pod danym indeksem nie ma węzła.

---

getContentSize()

Zwraca liczbę węzłów, które są bezpośrednimi elementami podrzędnymi dokumentu.

Powrót

Integer – liczba węzłów, które są bezpośrednimi elementami podrzędnymi dokumentu.

---

getDescendants()

Pobiera wszystkie węzły, które są bezpośrednimi lub pośrednimi elementami podrzędnymi dokumentu, w kolejności, w jakiej występują w dokumencie.

Powrót

Content[] – tablica wszystkich węzłów, które są bezpośrednimi lub pośrednimi elementami podrzędnymi dokumentu.

---

getDocType()

Pobiera deklarację DocType dokumentu. Jeśli dokument nie zawiera węzła DocumentType, ta metoda zwraca wartość null.

Powrót

DocType|null – węzeł DocumentType lub null, jeśli dokument nie ma węzła DocumentType.

---

getRootElement()

Pobiera węzeł główny Element dokumentu. Jeśli dokument nie ma węzła głównego Element, ta metoda zwraca wartość null.

Powrót

Element|null – węzeł główny Element lub null, jeśli dokument nie ma węzła głównegoElement.

---

hasRootElement()

Określa, czy dokument ma węzeł główny Element.

Powrót

Boolean – true, jeśli dokument ma węzeł główny Element; false, jeśli nie.

---

removeContent()

Usuwa wszystkie węzły, które są bezpośrednimi elementami podrzędnymi dokumentu.

Powrót

Content[] – tablica wszystkich węzłów, które były bezpośrednimi elementami podrzędnymi dokumentu przed ich usunięciem.

---

removeContent(content)

Usuwa podany węzeł, jeśli jest on bezpośrednim elementem podrzędnym dokumentu. Argument content może być obiektem Content lub dowolnym obiektem węzła, który odpowiada typowi wymienionemu w ContentType.

Parametry

Nazwa	Typ	Opis
content	Content	Węzeł do usunięcia.

Powrót

Boolean – true jeśli węzeł był bezpośrednim elementem podrzędnym i został usunięty; false w przeciwnym razie.

---

removeContent(index)

Usuwa węzeł o podanym indeksie spośród wszystkich węzłów, które są bezpośrednimi elementami podrzędnymi dokumentu. Jeśli pod danym indeksem nie ma węzła, ta metoda zwraca wartość null.

Parametry

Nazwa	Typ	Opis
index	Integer	Indeks węzła wśród wszystkich węzłów, które są bezpośrednimi elementami podrzędnymi dokumentu.

Powrót

Content|null – usunięty węzeł lub null, jeśli pod danym indeksem nie ma węzła.

---

setDocType(docType)

Ustawia deklarację DocType dokumentu. Jeśli dokument zawiera już inny węzeł DocType, ta metoda zastąpi stary węzeł. Ta metoda zgłasza wyjątek, jeśli dokument zawiera już ten sam węzeł DocType, który jest ustawiany.

Parametry

Nazwa	Typ	Opis
docType	DocType	Wartość DocumentType do ustawienia.

Powrót

Document – dokument do łączenia.

---

setRootElement(element)

Ustawia węzeł główny Element dokumentu. Jeśli dokument ma już węzeł główny Element, ta metoda zastąpi stary węzeł.

Parametry

Nazwa	Typ	Opis
element	Element	Węzeł główny Element do ustawienia.

Powrót

Document – dokument do łączenia.