Class Document

מסמך

ייצוג של מסמך XML.

Methods

שיטה	סוג הערך שמוחזר	תיאור קצר
addContent(content)	Document	מוסיף את הצומת הנתון לסוף המסמך.
addContent(index, content)	Document	מוסיף את הצומת הנתון באינדקס הנתון בין כל הצמתים שהם צאצאים ישירים של המסמך.
cloneContent()	Content[]	יוצר עותקים לא מצורפים של כל הצמתים שהם צאצאים ישירים של המסמך.
detachRootElement()	Element|null	מנתק את צומת השורש Element של המסמך ומחזיר אותו.
getAllContent()	Content[]	מחזירה את כל הצמתים שהם צאצאים ישירים של המסמך.
getContent(index)	Content|null	מחזירה את הצומת באינדקס הנתון מבין כל הצמתים שהם צאצאים ישירים של המסמך.
getContentSize()	Integer	הפונקציה מחזירה את מספר הצמתים שהם צאצאים ישירים של המסמך.
getDescendants()	Content[]	מחזירה את כל הצמתים שהם צאצאים ישירים או עקיפים של המסמך, לפי הסדר שבו הם מופיעים במסמך.
getDocType()	DocType|null	מחזירה את DocTypeההצהרה של המסמך.
getRootElement()	Element|null	מחזירה את צומת השורש Element של המסמך.
hasRootElement()	Boolean	הפונקציה קובעת אם במסמך יש צומת Element בסיס.
removeContent()	Content[]	הסרת כל הצמתים שהם צאצאים ישירים של המסמך.
removeContent(content)	Boolean	הפונקציה מסירה את הצומת שצוין, אם הצומת הוא צאצא ישיר של המסמך.
removeContent(index)	Content|null	הפונקציה מסירה את הצומת באינדקס הנתון מבין כל הצמתים שהם צאצאים ישירים של המסמך.
setDocType(docType)	Document	הגדרת ההצהרה DocType של המסמך.
setRootElement(element)	Document	הגדרת צומת השורש Element של המסמך.

תיעוד מפורט

addContent(content)

מוסיף את הצומת הנתון לסוף המסמך. הארגומנט content יכול להיות אובייקט Content או כל אובייקט צומת שמתאים לסוג שמופיע ב-ContentType. עם זאת, שימו לב שלמסמך יכול להיות רק צומת צאצא אחד Element שהוא צומת הבסיס Element.

פרמטרים

שם	סוג	תיאור
content	Content	הצומת לצירוף.

חזרה

‫Document — המסמך, לשרשור.

---

addContent(index, content)

מוסיף את הצומת הנתון באינדקס הנתון בין כל הצמתים שהם צאצאים ישירים של המסמך. הארגומנט content יכול להיות אובייקט Content או כל אובייקט צומת שתואם לסוג שמופיע ב-ContentType. עם זאת, למסמך יכול להיות רק צומת צאצא אחד Element, שהוא צומת הבסיס Element.

פרמטרים

שם	סוג	תיאור
index	Integer	האינדקס שבו צריך להוסיף את הצומת בין כל הצמתים שהם צאצאים ישירים של המסמך.
content	Content	הצומת להוספה.

חזרה

‫Document — המסמך, לשרשור.

---

cloneContent()

יוצר עותקים לא מצורפים של כל הצמתים שהם צאצאים ישירים של המסמך.

חזרה

‫Content[] — מערך של עותקים לא מצורפים של כל הצמתים שהם צאצאים ישירים של המסמך.

---

detachRootElement()

מנתק את צומת השורש Element של המסמך ומחזיר אותו. אם במסמך אין צומת בסיס Element, השיטה הזו מחזירה null.

חזרה

‫Element|null — הצומת המנותק Element, או null אם במסמך אין צומת Element שורש.

---

getAllContent()

מחזירה את כל הצמתים שהם צאצאים ישירים של המסמך.

חזרה

‫Content[] — מערך של כל הצמתים שהם צאצאים ישירים של המסמך.

---

getContent(index)

מחזירה את הצומת באינדקס הנתון מבין כל הצמתים שהם צאצאים ישירים של המסמך. אם אין צומת באינדקס הנתון, השיטה הזו מחזירה null.

פרמטרים

שם	סוג	תיאור
index	Integer	האינדקס של הצומת בין כל הצמתים שהם צאצאים ישירים של המסמך.

חזרה

‫Content|null – הצומת, או null אם אין צומת באינדקס הנתון.

---

getContentSize()

הפונקציה מחזירה את מספר הצמתים שהם צאצאים ישירים של המסמך.

חזרה

‫Integer – מספר הצמתים שהם צאצאים ישירים של המסמך.

---

getDescendants()

מחזירה את כל הצמתים שהם צאצאים ישירים או עקיפים של המסמך, לפי הסדר שבו הם מופיעים במסמך.

חזרה

‫Content[] — מערך של כל הצמתים שהם צאצאים ישירים או עקיפים של המסמך.

---

getDocType()

מחזירה את DocTypeההצהרה של המסמך. אם במסמך אין צומת DocumentType, הפונקציה הזו מחזירה null.

חזרה

‫DocType|null – הצומת DocumentType, או null אם במסמך אין צומת DocumentType.

---

getRootElement()

מחזירה את צומת השורש Element של המסמך. אם במסמך אין צומת Element בסיס, השיטה הזו מחזירה null.

חזרה

‫Element|null — צומת הבסיס Element, או null אם למסמך אין צומת בסיס Element.

---

hasRootElement()

הפונקציה קובעת אם במסמך יש צומת Element בסיס.

חזרה

‫Boolean – true אם במסמך יש צומת בסיס Element; false אם לא.

---

removeContent()

הסרת כל הצמתים שהם צאצאים ישירים של המסמך.

חזרה

‫Content[] — מערך של כל הצמתים שהיו צאצאים ישירים של המסמך לפני שהוסרו.

---

removeContent(content)

הפונקציה מסירה את הצומת שצוין, אם הצומת הוא צאצא ישיר של המסמך. הארגומנט content יכול להיות אובייקט Content או כל אובייקט צומת שתואם לסוג שמופיע ב-ContentType.

פרמטרים

שם	סוג	תיאור
content	Content	הצומת שרוצים להסיר.

חזרה

‫Boolean — true אם הצומת היה צאצא ישיר והוסר; false אם לא.

---

removeContent(index)

הפונקציה מסירה את הצומת באינדקס הנתון מבין כל הצמתים שהם צאצאים ישירים של המסמך. אם אין צומת באינדקס הנתון, השיטה הזו מחזירה null.

פרמטרים

שם	סוג	תיאור
index	Integer	האינדקס של הצומת בין כל הצמתים שהם צאצאים ישירים של המסמך.

חזרה

‫Content|null — הצומת שהוסר, או null אם אין צומת באינדקס הנתון.

---

setDocType(docType)

הגדרת ההצהרה DocType של המסמך. אם במסמך כבר יש צומת DocType אחר, השיטה הזו מחליפה את הצומת הישן. השיטה הזו יוצרת חריגה אם המסמך כבר מכיל את אותו צומת DocType שמוגדר.

פרמטרים

שם	סוג	תיאור
docType	DocType	ה-DocumentType שצריך להגדיר.

חזרה

‫Document — המסמך, לשרשור.

---

setRootElement(element)

הגדרת צומת השורש Element של המסמך. אם במסמך כבר יש צומת Element root, השיטה הזו מחליפה את הצומת הישן.

פרמטרים

שם	סוג	תיאור
element	Element	צומת הבסיס Element שצריך להגדיר.

חזרה

‫Document — המסמך, לשרשור.