تمثيل لمستند XML
الطُرق
| الطريقة | نوع القيمة التي تم إرجاعها | وصف قصير |
|---|---|---|
add | Document | تُلحق هذه الطريقة العقدة المحدّدة بنهاية المستند. |
add | Document | تُدرج هذه الطريقة العقدة المحدّدة في الفهرس المحدّد بين جميع العُقد التي تكون عناصر ثانوية مباشرة للمستند. |
clone | Content[] | تنشئ هذه الطريقة نُسخًا غير مرفقة من جميع العُقد التي تكون عناصر فرعية مباشرة للمستند. |
detach | Element|null | يفصل عقدة Element الجذر الخاصة بالمستند ويعرضها. |
get | Content[] | تعرض هذه الطريقة جميع العُقد التي تكون عناصر فرعية مباشرة للمستند. |
get | Content|null | تعرض هذه الطريقة العقدة في الفهرس المحدّد من بين جميع العُقد التي تكون عناصر ثانوية مباشرة للمستند. |
get | Integer | تعرض هذه السمة عدد العُقد التي تكون عناصر فرعية مباشرة للمستند. |
get | Content[] | تعرض هذه الطريقة جميع العُقد التي تكون عناصر فرعية مباشرة أو غير مباشرة للمستند، وذلك بالترتيب الذي تظهر به في المستند. |
get | Doc | تعرض هذه السمة Doc تعريف المستند. |
get | Element|null | تعرض هذه السمة عقدة الجذر Element للمستند. |
has | Boolean | تحدّد هذه السمة ما إذا كان المستند يتضمّن عقدة Element جذرية. |
remove | Content[] | تزيل هذه الطريقة جميع العُقد التي تكون عناصر فرعية مباشرة للمستند. |
remove | Boolean | يزيل العقدة المحدّدة، إذا كانت العقدة عنصرًا فرعيًا مباشرًا للمستند. |
remove | Content|null | يزيل العقدة في الفهرس المحدّد من بين جميع العُقد التي تكون عناصر فرعية مباشرة للمستند. |
set | Document | تضبط هذه السمة تعريف Doc للمستند. |
set | 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()
getAllContent()
تعرض هذه الطريقة جميع العُقد التي تكون عناصر فرعية مباشرة للمستند.
الإرجاع
Content[]: مصفوفة تتضمّن جميع العُقد التي تكون عناصر ثانوية مباشرة للمستند.
getContent(index)
تعرض هذه الطريقة العقدة في الفهرس المحدّد من بين جميع العُقد التي تكون عناصر ثانوية مباشرة للمستند. إذا لم تكن هناك عقدة في الفهرس المحدّد، تعرض هذه الطريقة null.
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
index | Integer | تشير إلى فهرس العقدة بين جميع العُقد التي تكون عناصر ثانوية مباشرة للمستند. |
الإرجاع
Content|null — العقدة، أو null إذا لم تكن هناك عقدة في الفهرس المحدّد
getContentSize()
تعرض هذه السمة عدد العُقد التي تكون عناصر فرعية مباشرة للمستند.
الإرجاع
Integer: عدد العُقد التي تمثّل العناصر الفرعية المباشرة للمستند.
getDescendants()
تعرض هذه الطريقة جميع العُقد التي تكون عناصر فرعية مباشرة أو غير مباشرة للمستند، وذلك بالترتيب الذي تظهر به في المستند.
الإرجاع
Content[]: مصفوفة تضمّ جميع العُقد التي تكون عناصر ثانوية مباشرة أو غير مباشرة للمستند.
getDocType()
getRootElement()
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 نفسها التي يتم ضبطها.
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
doc | Doc | Document المطلوب ضبطه |
الإرجاع
Document: المستند، للسلسلة