Class Document

Dokument

Reprezentacja dokumentu XML.

Metody

MetodaZwracany typKrótki opis
addContent(content)DocumentDołącza dany węzeł na końcu dokumentu.
addContent(index, content)DocumentWstawia dany węzeł w danym indeksie wśród wszystkich węzłów, które są bezpośrednimi węzłami podrzędnymi dokumentu.
cloneContent()Content[]Tworzy niedołączone kopie wszystkich węzłów, które są bezpośrednimi elementami podrzędnymi dokumentu.
detachRootElement()ElementOdłącza i zwraca główny węzeł Element dokumentu.
getAllContent()Content[]Pobiera wszystkie węzły, które są bezpośrednimi węzłami podrzędnymi dokumentu.
getContent(index)ContentPobiera węzeł o podanym indeksie ze wszystkich węzłów, które są bezpośrednimi węzłami podrzędnymi dokumentu.
getContentSize()IntegerPobiera 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()DocTypePobiera deklarację DocType dokumentu.
getRootElement()ElementPobiera główny węzeł Element dokumentu.
hasRootElement()BooleanOkreśla, czy dokument ma główny węzeł Element.
removeContent()Content[]Usuwa wszystkie węzły, które są bezpośrednimi węzłami podrzędnymi dokumentu.
removeContent(content)BooleanUsuwa dany węzeł, jeśli jest on bezpośrednim elementem podrzędnym dokumentu.
removeContent(index)ContentUsuwa węzeł w danym indeksie ze wszystkich węzłów, które są bezpośrednimi węzłami podrzędnymi dokumentu.
setDocType(docType)DocumentUstawia deklarację DocType dokumentu.
setRootElement(element)DocumentUstawia główny węzeł Element dokumentu.

Szczegółowa dokumentacja

addContent(content)

Dołącza dany węzeł na końcu dokumentu. Argumentem content może być obiekt Content lub dowolny obiekt węzła odpowiadający typowi wymienionemu w ContentType. Zwróć jednak uwagę, że dokument może mieć tylko 1 węzeł podrzędny Element, który jest domyślnie głównym węzłem Element.

Parametry

NazwaTypOpis
contentContentwęzeł, który ma zostać dołączony

Powroty

Document – dokument do tworzenia łańcuchów,


addContent(index, content)

Wstawia dany węzeł w danym indeksie wśród wszystkich węzłów, które są bezpośrednimi węzłami podrzędnymi dokumentu. Argumentem content może być obiekt Content lub dowolny obiekt węzła odpowiadający typowi wymienionemu w ContentType. Pamiętaj jednak, że dokument może mieć tylko 1 węzeł podrzędny Element, który jest domyślnie głównym węzłem Element.

Parametry

NazwaTypOpis
indexIntegerindeks, w którym należy wstawić węzeł wśród wszystkich węzłów, które są bezpośrednimi elementami podrzędnymi dokumentu
contentContentwęzeł do wstawienia

Powroty

Document – dokument do tworzenia łańcuchów,


cloneContent()

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

Powroty

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


detachRootElement()

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

Powroty

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


getAllContent()

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

Powroty

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


getContent(index)

Pobiera węzeł o podanym indeksie ze wszystkich węzłów, które są bezpośrednimi węzłami podrzędnymi dokumentu. Jeśli o danym indeksie nie ma węzła, ta metoda zwraca null.

Parametry

NazwaTypOpis
indexIntegerindeks węzła spośród wszystkich węzłów, które są bezpośrednimi elementami podrzędnymi dokumentu

Powroty

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


getContentSize()

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

Powroty

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.

Powroty

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.

Powroty

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


getRootElement()

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

Powroty

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


hasRootElement()

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

Powroty

Booleantrue, jeśli dokument ma główny węzeł Element; false, jeśli nie jest


removeContent()

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

Powroty

Content[] – tablica wszystkich węzłów, które były bezpośrednimi elementami podrzędnymi dokumentu, zanim zostały usunięte


removeContent(content)

Usuwa dany węzeł, jeśli jest on bezpośrednim elementem podrzędnym dokumentu. Argumentem content może być obiekt Content lub dowolny obiekt węzła odpowiadający typowi wymienionemu w ContentType.

Parametry

NazwaTypOpis
contentContentwęzeł do usunięcia

Powroty

Booleantrue, jeśli węzeł był bezpośrednim węzłem podrzędnym i został usunięty; w przeciwnym razie false


removeContent(index)

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

Parametry

NazwaTypOpis
indexIntegerindeks węzła spośród wszystkich węzłów, które są bezpośrednimi elementami podrzędnymi dokumentu

Powroty

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


setDocType(docType)

Ustawia deklarację DocType dokumentu. Jeśli dokument ma już inny węzeł DocType, ta metoda zastępuje stary węzeł. Ta metoda zgłasza wyjątek, jeśli dokument zawiera już ustawiany węzeł DocType.

Parametry

NazwaTypOpis
docTypeDocTypeDocumentType do ustawienia

Powroty

Document – dokument do tworzenia łańcuchów,


setRootElement(element)

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

Parametry

NazwaTypOpis
elementElementgłówny węzeł Element do ustawienia

Powroty

Document – dokument do tworzenia łańcuchów,