توجه
فضای نام ted تنها از طریق کتابخانه ها در دسترس خواهد بود. برای آشنایی بیشتر با کتابخانه ها به بارگذاری کتابخانه ها
مراجعه نمایید
فریم ورک تد جی اس (2ed) متشکل از دو قسمت اصلی می باشد. یکی فضای نام tedApi که از ابتدا در باره این فضای نام توضیحاتی داده شد و در قسمت های بعد نیز توابع انتهایی آن گفته می شود و دیگری ted که هسته اصلی این فریم ورک می باشد. این هسته ، فرایند ایجاد و مدیریت عناصر ، شاخصه ها (Attributes) ، نود های متنی و نود های توضیحات را بر عهده دارد و آن را تسهیل می نماید.
در این قسمت با بخشی از توابع کمکی مانند توابع آماده ساز و رخداد های پردازش و همچنین توابع پردازشی و بازگردانی آشنا می شوید.
فضای نام ted تنها از طریق کتابخانه ها در دسترس خواهد بود. برای آشنایی بیشتر با کتابخانه ها به بارگذاری کتابخانه ها
مراجعه نمایید
توابع آماده ساز یا (ready functions) دسته از توابع هستند که از طریق آن می توان پس از تکمیل فرایند رندرینگ و پردازش صفحه ، به عناصر ایجاد شده در DOM دسترسی داشت.
توابع زیر همگی یک فرایند را با تفاوت های کوچکی اجرا می نمایند:
این تابع رخدادهای زمانی (setInterval) ایجاد می کند . رخداد زمانی بر اساس مدل طراحی زبان جاوا اسکریپت پس از اتمام فرایندهای همزمان (synchronous) به اجرا در خواهد آمد.
هر عنصر در یک رخداد زمانی در دسترس خواهد بود که به آن معناست ، پردازش به صورت ناهمزمان (asynchronous) خواهد بود.
this در تابع فراخوان ، به عنصر جاری اشاره دارد
ted.eachReady(
callback : function
) : voidاین تابع همانند تابع eachReady عمل می نماید با این تفاوت که ، بررسی عناصر در یک خط اجرای همزمان اجرا خواهد شد.
this در تابع فراخوان ، به عنصر جاری اشاره دارد
ted.ready(
callback : function
) : voidتابع nodeReady عمل کرد متفاوت تری نسبت به توابع بالا دارد. این تابع برخلاف توابع بالا تمامی نودها را از جمله نود های متنی و نود های توضیحات بررسی می نماید.
در تابع فراخوان (callback) ، مقدار this نود جاری خواهد بود
تابع فراخوان (callback) دارای دو آرگمان ورودی می باشد. اولین آرگمان شماره ترتیب نود و دومین آرگمان ، درصد پیشرفت بررسی از تعداد کل نود ها می باشد
تابع فراخوان انتهایی (endCallback) پس از اتمام فرایند بررسی اجرا خواهد شد
ted.nodeReady(
callback : function( current_number : number , current_percentage : number ) ,
endCallback : function
) : voidعملکردی یکسان با tedApi.docReady دارد. (رجوع شود به توضیحات)
رخداد های پردازش ، مجموعه ای توابع می باشند که می توان مشخص نمود ، در هر یک از حالت های پردازش نود زیر چه عملیاتی انجام شود.
این رخداد عملیات های درخواستی را قبل از شروع به پردازش یک نود اجرا می نماید ، در زمانی که بر روی نود تغییری انجام نشده و داده ای خوانده نشده است.
تابع فراخوان دارای یک آرگمان ورودی است که از نوع boolean می باشد . این مقدار یک مقدار اختیاری است که از طریق تابع compile قابل ارسال می باشد.
مقدار this به نود جاری اشاره دارد
ted.beforeCompile(
callback : function( option : boolean )
) : voidاین رخداد نیز همانند beforeCompile ، قبل از شروع به پردازش اجرا می شود با این تفاوت که تنها پیش از پردازش خود عنصر اجرا می شود. پردازش عناصر مرحله ای انجام میگیرد. ابتدا پردازش مشخصه ها (Attributes) و سپس پردازش خود عنصر و این رخداد پس از پردازش مشخصه ها انجام می پذیرد.
تابع فراخوان دارای یک آرگمان ورودی است که از نوع boolean می باشد . این مقدار یک مقدار اختیاری است که از طریق تابع compile قابل ارسال می باشد.
مقدار this به نود جاری اشاره دارد
ted.beforeElementRun(
callback : function( option : boolean )
) : voidرخداد afterCompile درست برخلاف رویداد های بالا ، پس از اتمام فرایند پردازش نود اجرا می گردد.
تابع فراخوان دارای یک آرگمان ورودی است که از نوع boolean می باشد . این مقدار یک مقدار اختیاری است که از طریق تابع compile قابل ارسال می باشد.
مقدار this به نود جاری اشاره دارد
ted.afterCompile(
callback : function( option : boolean )
) : voidرخداد EndCompile همانطور که از نامش پیداست پس از اتمام فرایند پردازش اجرا می گردد.
این رخداد تنها در اجرای نخست پردازش و در هر بار بارگذاری یک کتابخانه اجرا می گردد که در انتهای اجرای کامپایل اجزای کتابخانه فرایند اجرا می گردد.
ted.EndCompile(
callback : function
) : voidرخداد onCompile بر خلاف رخداد های قبل ، در فضای نام tedApi قرار دارد . این رخداد قبل از شروع فرایند پردازش نود اجرا می گردد.
تابع فراخوان دو آرگمان دریافت می نماید. اولین آرگمان شماره ترتیب نود و دومین آرگمان درصد پیشرفت پردازش می باشد
مقدار this به نمونه از __GLOBALS__ اشاره دارد که عنصر جاری را در بر دارد
این رخداد تنها در اجرای نخست پردازش و در هر بار بارگذاری یک کتابخانه اجرا می گردد که در انتهای اجرای کامپایل اجزای کتابخانه فرایند اجرا می گردد.
tedApi.onCompile(
callback : function( node_number , current_percentage )
) : voidتابع پشتیبان گیر وظیفه دارد تا تمامی اطلاعات نود یک پشتیبان تهیه نماید تا در مواقع لزوم ، نود را به حالت ابتدایی بازگرداند. این مقادیر پشتیبان درون ساختار DOM خود نود ذخیره می گردد.
مانند عناصر که مقدار innerHTML و خصوصیت های عنصر ذخیره می گردد و یا نود های متنی یا نود های توضیحات که مقدار درون آن ذخیره می گردد.
پس از یک بار پشتیبان گیری از هر نود ، دیگر قادر به پشتیبان گیری نخواهید بود و به اصطلاح پشتیبان گیری lock شده است.
برای رفع lock می بایست مقدار true را به عنوان آرگمان دوم تابع ارسال نمایید
درصورت موفقیت 1 و در غیر این صورت 0 بازگردانده می شود
ted.backup(
node : HTMLNode ,
//optional , Default : false
unlock : bolean
) : numberپس از پشتیبان گیری از نود ، حال می توان درصورت ناموفق بودن تغییرات بر روی نود ، آن را به حالت ابتدایی بازگرداند. این فرایند محدودیت ندارد.
درصورت موفقیت 1 و در غیر این صورت 0 بازگردانده می شود
ted.returnBack(
node : HTMLNode
) : numberتابع پردازش وظیفه اصلی پردازش را بر عهده دارد. این تابع با نام compile ، در هر دو فضای نام ted و tedApi وجود دارد.
تفاوت این دو در این است که تابع موجود در فضای نام ted تنها بر روی یک سطح از نود پردازش انجام می دهد و اما تابع موجود در فضای نام tedApi بر روی عنصر و فرزندانش پردازش را انجام می دهد.
تابع پردازش در فضای نام ted آرگمان اختیاری نیز دارد که همان آرگمان اختیاری boolean می باشد که به رخداد ها ارسال می گردد.
tedted.compile(
node : HTMLNode ,
//optional , Default : false
option : boolean
) : voidtedApitedApi.compile(
node : string | HTMLElement
) : number
درصورت موفقیت 1 و در غیر این صورت 0 بازگردانده می شود