Class Document

Dokument

Reprezentacja dokumentu XML.

Metody

Metoda	Zwracany typ	Krótki opis
addContent(content)	Document	Dodaje 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 podrzędnymi dokumentu.
cloneContent()	Content[]	Tworzy kopie wszystkich nieprzypisanych węzłów, które są bezpośrednimi podrzędnymi dokumentu.
detachRootElement()	Element	Odłącza i zwraca węzeł główny Element dokumentu.
getAllContent()	Content[]	Pobiera wszystkie węzły, które są bezpośrednimi podrzędnymi dokumentu.
getContent(index)	Content	Pobiera węzeł o danym indeksie spośród wszystkich węzłów, które są bezpośrednimi podrzędnymi dokumentu.
getContentSize()	Integer	Pobiera liczbę węzłów, które są bezpośrednimi 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	Pobiera deklarację DocType dokumentu.
getRootElement()	Element	Pobiera główny Element węzeł 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 podrzędnymi dokumentu.
removeContent(content)	Boolean	Usuwa podany węzeł, jeśli jest on bezpośrednio podrzędnym węzłem dokumentu.
removeContent(index)	Content	Usuwa węzeł o danym indeksie spośród wszystkich węzłów, które są bezpośrednimi podrzędnymi dokumentu.
setDocType(docType)	Document	Ustawia deklarację DocType dokumentu.
setRootElement(element)	Document	Ustawia Element, czyli wierzchołek dokumentu.

Szczegółowa dokumentacja

addContent(content)

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

Parametry

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

Powrót

Document – dokument, do którego należy dołączyć dokument źródłowy.

---

addContent(index, content)

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

Parametry

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

Powrót

Document – dokument, do którego należy dołączyć dokument źródłowy.

---

cloneContent()

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

Powrót

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

---

detachRootElement()

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

Powrót

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

---

getAllContent()

Pobiera wszystkie węzły, które są bezpośrednimi 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 danym indeksie spośród wszystkich węzłów, które są bezpośrednimi podrzędnymi dokumentu. Jeśli w danym indeksie nie ma węzła, metoda zwraca null.

Parametry

Nazwa	Typ	Opis
index	Integer	indeks węzła wśród wszystkich węzłów będących bezpośrednimi podrzędnymi dokumentu;

Powrót

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

---

getContentSize()

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

Powrót

Integer – liczba węzłów, które są bezpośrednimi 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 ma węzła DocumentType, ta metoda zwraca null.

Powrót

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

---

getRootElement()

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

Powrót

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

---

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 w przeciwnym razie

---

removeContent()

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

Powrót

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

---

removeContent(content)

Usuwa podany węzeł, jeśli jest on bezpośrednio podrzędnym węzłem 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ł węzłem podrzędnym i został usunięty; false, jeśli nie

---

removeContent(index)

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

Parametry

Nazwa	Typ	Opis
index	Integer	indeks węzła wśród wszystkich węzłów będących bezpośrednimi podrzędnymi dokumentu;

Powrót

Content – węzeł, który został usunięty, lub null, jeśli w danym indeksie nie ma węzła.

---

setDocType(docType)

Ustawia deklarację DocType dokumentu. Jeśli dokument ma 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 ma być ustawiany.

Parametry

Nazwa	Typ	Opis
docType	DocType	DocumentType do ustawienia

Powrót

Document – dokument, do którego należy dołączyć dokument źródłowy.

---

setRootElement(element)

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

Parametry

Nazwa	Typ	Opis
element	Element	wierzchołkowy węzeł Element do ustawienia

Powrót

Document – dokument, do którego należy dołączyć dokument źródłowy.