Class Document

מסמך

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

Methods

שיטה	סוג הערך המוחזר	תיאור קצר
addContent(content)	Document	הוספת הצומת הנתון לסוף המסמך.
addContent(index, content)	Document	הוספת הצומת הנתון לאינדקס הנתון, מבין כל הצמתים שהם צאצאים מיידיים של המסמך.
cloneContent()	Content[]	יצירת עותקים לא מצורפים של כל הצמתים שהם צאצאים מיידיים של המסמך.
detachRootElement()	Element	הפונקציה מנתקת את צומת השורש Element של המסמך ומחזירה אותו.
getAllContent()	Content[]	הפונקציה מקבלת את כל הצמתים שהם צאצאים מיידיים של המסמך.
getContent(index)	Content	הפונקציה מקבלת את הצומת שבאינדקס הנתון מבין כל הצמתים שהם צאצאים מיידיים של המסמך.
getContentSize()	Integer	הפונקציה מקבלת את מספר הצמתים שהם צאצאים מיידיים של המסמך.
getDescendants()	Content[]	הפונקציה מקבלת את כל הצמתים שהם צאצאים ישירים או עקיפים של המסמך, לפי הסדר שבו הם מופיעים במסמך.
getDocType()	DocType	הפונקציה מקבלת את ההצהרה DocType של המסמך.
getRootElement()	Element	הפונקציה מקבלת את הצומת Element של שורש המסמך.
hasRootElement()	Boolean	הפונקציה קובעת אם למסמך יש צומת Element ברמה הבסיסית (root).
removeContent()	Content[]	הסרה של כל הצמתים שהם צאצאים מיידיים של המסמך.
removeContent(content)	Boolean	הסרת הצומת הנתון, אם הצומת הוא צאצא מיידי של המסמך.
removeContent(index)	Content	הסרת הצומת שבאינדקס הנתון מבין כל הצמתים שהם צאצאים מיידיים של המסמך.
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 – הצומת Element שמוּקע, או null אם למסמך אין צומת Element ברמה הבסיסית

---

getAllContent()

הפונקציה מקבלת את כל הצמתים שהם צאצאים מיידיים של המסמך.

חזרה

Content[] – מערך של כל הצמתים שהם צאצאים מיידיים של המסמך

---

getContent(index)

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

פרמטרים

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

חזרה

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

---

getContentSize()

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

חזרה

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

---

getDescendants()

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

חזרה

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

---

getDocType()

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

חזרה

DocType – הצומת DocumentType, או null אם למסמך אין צומת DocumentType

---

getRootElement()

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

חזרה

Element – צומת השורש Element, או null אם למסמך אין צומת שורש Element

---

hasRootElement()

הפונקציה קובעת אם למסמך יש צומת Element ברמה הבסיסית (root).

חזרה

Boolean — true אם למסמך יש צומת Element ברמה הבסיסית, false אם לא

---

removeContent()

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

חזרה

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

---

removeContent(content)

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

פרמטרים

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

חזרה

Boolean — true אם הצומת היה צאצא מיידי והוסר, false אם לא

---

removeContent(index)

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

פרמטרים

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

חזרה

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

---

setDocType(docType)

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

פרמטרים

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

חזרה

Document – המסמך, לצורך קישור

---

setRootElement(element)

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

פרמטרים

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

חזרה

Document – המסמך, לצורך קישור