Class Document

مستند

تمثيل لمستند XML

الطُرق

الطريقةنوع القيمة التي تم إرجاعهاوصف قصير
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.

المعلمات

الاسمالنوعالوصف
contentContentالعقدة المطلوب إلحاقها.

الإرجاع

Document: المستند، للسلسلة


addContent(index, content)

تُدرج هذه الطريقة العقدة المحدّدة في الفهرس المحدّد بين جميع العُقد التي تكون عناصر ثانوية مباشرة للمستند. يمكن أن تكون الوسيطة content عبارة عن عنصر Content أو أي عنصر عقدة يتوافق مع نوع مُدرَج في ContentType. يُرجى العِلم، مع ذلك، بأنّه لا يمكن أن يتضمّن المستند سوى عقدة Element فرعية واحدة، وهي ضمنيًا عقدة Element الجذرية.

المعلمات

الاسمالنوعالوصف
indexIntegerالفهرس الذي سيتم إدراج العقدة فيه بين جميع العُقد التي تمثّل عناصر فرعية مباشرة للمستند.
contentContentالعقدة المطلوب إدراجها.

الإرجاع

Document: المستند، للسلسلة


cloneContent()

تنشئ هذه الطريقة نُسخًا غير مرفقة من جميع العُقد التي تكون عناصر فرعية مباشرة للمستند.

الإرجاع

Content[]: مصفوفة من النُسخ غير المرفقة لجميع العُقد التي تمثّل العناصر الفرعية المباشرة للمستند.


detachRootElement()

يفصل عقدة Element الجذر الخاصة بالمستند ويعرضها. إذا لم يكن المستند يحتوي على عقدة جذر Element، ستعرض هذه الطريقة null.

الإرجاع

Element|null: عقدة Element المنفصلة، أو null إذا لم يكن للمستند عقدة Element جذر.


getAllContent()

تعرض هذه الطريقة جميع العُقد التي تكون عناصر فرعية مباشرة للمستند.

الإرجاع

Content[]: مصفوفة تتضمّن جميع العُقد التي تكون عناصر ثانوية مباشرة للمستند.


getContent(index)

تعرض هذه الطريقة العقدة في الفهرس المحدّد من بين جميع العُقد التي تكون عناصر ثانوية مباشرة للمستند. إذا لم تكن هناك عقدة في الفهرس المحدّد، تعرض هذه الطريقة null.

المعلمات

الاسمالنوعالوصف
indexIntegerتشير إلى فهرس العقدة بين جميع العُقد التي تكون عناصر ثانوية مباشرة للمستند.

الإرجاع

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 جذرية.

الإرجاع

Booleantrue إذا كان المستند يحتوي على عقدة جذر Element، وfalse إذا لم يكن كذلك.


removeContent()

تزيل هذه الطريقة جميع العُقد التي تكون عناصر فرعية مباشرة للمستند.

الإرجاع

Content[]: مصفوفة تتضمّن جميع العُقد التي كانت عناصر فرعية مباشرة للمستند قبل إزالتها.


removeContent(content)

تزيل هذه الطريقة العقدة المحدّدة، إذا كانت العقدة عنصرًا فرعيًا مباشرًا للمستند. يمكن أن تكون الوسيطة content كائن Content أو أي كائن عقدة يتوافق مع نوع مدرَج في ContentType.

المعلمات

الاسمالنوعالوصف
contentContentالعقدة التي ستتم إزالتها

الإرجاع

Booleantrue إذا كانت العقدة عنصرًا فرعيًا مباشرًا وتمت إزالتها، false إذا لم تكن كذلك.


removeContent(index)

يزيل العقدة في الفهرس المحدّد من بين جميع العُقد التي تكون عناصر فرعية مباشرة للمستند. إذا لم تكن هناك عقدة في الفهرس المحدّد، تعرض هذه الطريقة null.

المعلمات

الاسمالنوعالوصف
indexIntegerتشير إلى فهرس العقدة بين جميع العُقد التي تكون عناصر ثانوية مباشرة للمستند.

الإرجاع

Content|null: العقدة التي تمت إزالتها، أو null إذا لم تكن هناك عقدة في الفهرس المحدّد.


setDocType(docType)

تضبط هذه السمة تعريف DocType للمستند. إذا كان المستند يتضمّن عقدة DocType مختلفة، ستستبدل هذه الطريقة العقدة القديمة. تُصدر هذه الطريقة استثناءً إذا كان المستند يحتوي على عقدة DocType نفسها التي يتم ضبطها.

المعلمات

الاسمالنوعالوصف
docTypeDocTypeDocumentType المطلوب ضبطه

الإرجاع

Document: المستند، للسلسلة


setRootElement(element)

تضبط هذه السمة عقدة Element الجذرية للمستند. إذا كان المستند يتضمّن عقدة Element جذرية، ستستبدل هذه الطريقة العقدة القديمة.

المعلمات

الاسمالنوعالوصف
elementElementعقدة Element الجذر المطلوب ضبطها.

الإرجاع

Document: المستند، للسلسلة