דף זה תורגם על ידי Cloud Translation API.

Class Document

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

שיטות

שיטה	סוג הערך שמוחזר	תיאור קצר
`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` ברמה הבסיסית.
`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 של המסמך. אם אין למסמך צומת ברמה הבסיסית (root) מסוג 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 ברמה הבסיסית.

החזרות

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`	את הצומת הבסיסי (root) `Element` שצריך להגדיר

החזרות

Document – המסמך, לשרשור