Class Document

سند

نمایشی از یک سند XML.

روش‌ها

روش نوع بازگشتی شرح مختصر
add Content(content) Document گره داده شده را به انتهای سند اضافه می‌کند.
add Content(index, content) Document گره داده شده را در اندیس داده شده، در میان تمام گره‌هایی که فرزند بلافصل سند هستند، درج می‌کند.
clone Content() Content[] کپی‌های غیراتصالی از تمام گره‌هایی که فرزندان بلافصل سند هستند، ایجاد می‌کند.
detach Root Element() Element |null گره Element ریشه سند را جدا کرده و برمی‌گرداند.
get All Content() Content[] تمام گره‌هایی که فرزند بلافصل سند هستند را دریافت می‌کند.
get Content(index) Content |null گره موجود در اندیس داده شده را از بین تمام گره‌هایی که فرزند بلافصل سند هستند، برمی‌گرداند.
get Content Size() Integer تعداد گره‌هایی که فرزند بلافصل سند هستند را برمی‌گرداند.
get Descendants() Content[] تمام گره‌هایی که فرزندان مستقیم یا غیرمستقیم سند هستند را به ترتیبی که در سند ظاهر می‌شوند، برمی‌گرداند.
get Doc Type() Doc Type |null نوع سند Doc Type را دریافت می‌کند.
get Root Element() Element |null گره Element ریشه سند را دریافت می‌کند.
has Root Element() Boolean تعیین می‌کند که آیا سند دارای گره Element ریشه است یا خیر.
remove Content() Content[] تمام گره‌هایی که فرزند بلافصل سند هستند را حذف می‌کند.
remove Content(content) Boolean اگر گره، فرزند بلافصل سند باشد، گره داده شده را حذف می‌کند.
remove Content(index) Content |null گره موجود در اندیس داده شده را از بین تمام گره‌هایی که فرزند بلافصل سند هستند، حذف می‌کند.
set Doc Type(docType) Document نوع سند Doc Type را تعیین می‌کند.
set Root Element(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 جدا شده، یا اگر سند گره Element ریشه نداشته باشد، null .

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 ریشه، یا اگر سند گره Element ریشه نداشته باشد، null .

hasRootElement()

تعیین می‌کند که آیا سند دارای گره Element ریشه است یا خیر.

بازگشت

Boolean - اگر سند دارای گره Element ریشه باشد، true و در غیر این صورت، 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 Type Doc Type Document Type که باید تنظیم شود.

بازگشت

Document — سند، برای زنجیر کردن.

setRootElement(element)

گره Element ریشه سند را تنظیم می‌کند. اگر سند از قبل دارای گره Element ریشه باشد، این متد گره قدیمی را بازنویسی می‌کند.

پارامترها

نام نوع توضیحات
element Element گره Element ریشه که باید تنظیم شود.

بازگشت

Document — سند، برای زنجیر کردن.