فلارابي3 هو مكون (.mxp) يدعم اللغة العربية في الفلاش ويمكن من عرض النص العربي أو الفارسي أو الأوردي مع النصوص اللاتينية مثل الإنجليزية والفرنسية والإسبانية والإيطالية في ملفات swf. في وقت التشغيل. فلارابي3 يمكن إستخدامه في الفلاش بدءاً من Flash MX 2004 ويمكن عرضه على Flash player 6 فما فوقه (Actionscript 2).

*- فلارابي3 يدعم الآن اللغة العربية والفارسية والأوردية بالإضافة إلى اللغات اللاتينية مثل الإنجليزية والفرنسية والإسبانية والإيطالية.

*- فلارابي3 يدعم خاصية التشكيل في النص العربي.

*- يجب إستخدام TextFormat مع فلارابي3 لتعيين نوع الفونت وحجمه وتنسيقه، وسيتم تطبيق تنسيق الـ TextFormat على الحقل النصي كله، أما إستخدام أكثر من TextFormat في نفس الحقل النصي فهو غير مدعم.

*- فلارابي3 يدعم خاصية embedFonts والتي يمكن بها تضمين فونت عربي داخل ملف الفلاش وذلك يجعل النص مقروء حتى ولو لم يدعم جهازالمستخدم اللغة العربية. ولكن نتيجة لطبيعة الفونتات المختلفة ففلارابي يدعم فقط بعض الفونتات مثل Traditional Arabic و Andalous. عند إستخدام خاصية "embedFonts = true" يجب أن يكون هناك فونت في المكتبة بنفس اسم الفونت المحدد في "TextFormat.font" .

*- فلارابي3 يدعم الـ Html Tags التالية فقط "<font>" (color attribute only), "<u>", "<a>". الـ Html Tags المتداخلة والتي تحمل نفس الإسم غير مدعمة، مثلاً:

<font color="blue">Flaraby supports <font color="red">Html</font> tags</font>

يجب أن تكون الـ Html Tags منسقة بشكل جيد.

*- نظراً لأن الفلاش لا يدعم خاصية Right-To-Left في الحقل النصي فإن فلارابي3 يقوم بعمليات معقدة لمحاولة حل هذه المشكلة، فيجب تجنب إستخدام نص كبير نسبياً لأنه كلما زاد النص كلما زادت العمليات اللازمة لعرض النص وبالتالي زاد الإحتياج إلى الوقت لتنفيذ تلك العمليات وعرضها على الشاشة.

*- فلارابي3 غير متوافق مع Actionscript 3، فهو يعمل فقط مع Actionscript 2 على ال الـ Flash player 6 فما فوقه. لوكنت تستعمل Flash CS3 يجب عليك حفظ ملفك كـ Flash 8، مع Actionscript 2 لكي تستطيع رؤية Flaraby3 في الـ Components panel ومن ثم إستعماله.

*- Flaraby3 now supports Arabic, Persian or Urdu, in addition to Latin languages like English, French, Spanish and Italian.

*- Flaraby3 supports Tashkeel in Arabic text.

*- You MUST use a TextFormat object with Flaraby3 to specify which font to use, it's size and alignment. These TextFormat properties will be applied to the whole textField, ie. Multiple text formats are NOT supported in the same textField.

*- Flaraby3 supports the "embedFonts" property which enables the .swf file to display the Arabic text even if the target user doesn't have Arabic language installed. However, due to the way the fonts are made, only some fonts succeed to show correctly, examples are "Traditional Arabic" and "Andalous". If you use the "embedFonts = true", a Font must exists in the Library, with a linkage name to be called from within the textFormat object.

*- Supported Html Tags are "<font>" (color attribute only), "<u>", "<a>". Nested tags with the same tag Name are not supported, eg. <font color="blue">Flaraby supports <font color="red">Html</font> tags</font>. Also tags must be well formated.

*- You should take into consideration the fact that Flash doesn't support Right-To-Left in the TextField, so you shouldn't use relatively large amount of text for Flaraby3 to render, due to the complexity of the operations needed to properly render the text , and hence the time to accomplish these operations.

*- Flaraby3 is NOT compatible with Actionscript 3, it only works on Actionscript 2 on Flash players from 6 and above. If you are using Flash CS3, your document should be saved as Flash 8, with Actionscript 2, to be able to see Flaraby3 in the Components panel and use it.

Flaraby3 is available in two editions: Flaraby3 (Commercial) and Flaraby3Lite (Free). The table below shows a comparison between the 2 editions:







Flaraby3Lite (.mxp) is available for download for free.
Double click the (.mxp) file to open into "Extension Manager" and install.





English:
========

This is the license for Flaraby3 component:
This is a 'per developer' license, meaning once Flaraby3 purchased it should only be used by 'one' developer , but can be installed on any number of devices: PCs, Mobiles, Pocket PCs, ...
Flaraby3 is a Flash/Flex component (.swc) that enables bidirectional Arabic, Persian or Urdu and Latin text in .swf files at runtime. Flaraby3 can be used starting from Flash MX 2004 and above, and can work on Flash player 6 and above (Actionscript 2).

-------------
You may
-------------
1- You may use Flaraby3 component in your commerical and/or non-commercial flash (.swf) products.

-------------
You may NOT
-------------
1- You may NOT use Flaraby3 component in ANYTHING that is againest Islam or Islamic teachings.
2- You may NOT distribute, redistribute, sell or resell Flaraby3 component or any part of its contents.

---------------------------------------------------------------------------------------

Support info
============

http://www.arabicode.com
shagarah@gmail.com

---------------------------------------------------------------------------------------

والله هو الرقيب
Allah is the observer

---------------------------------------------------------------------------------------


English:
--------

By downloading Flaraby3Lite, you agree on the following terms and conditions:
1- You can use Flaraby3Lite as much as you like, under the condition that you include the 2 files (readme.txt و license.txt) with every .swf file inwhich you used Flaraby3Lite.
2- You may only redistribute Flaraby3Lite.zip as Free product, and you may not ever resell it. The redistributed file (Flaraby3Lite.zip) must contain these files:
Flaraby3Lite.swc
license.txt
readme.txt

---------------------------------------------------------------------------------------

والله هو الرقيب
Allah is the observer
---------------------------------------------------------------------------------------

• addPersianSupport():Boolean
  • تضيف الدعم للفارسية في Flaraby3
  • لاحظ أنه إذا كانت الأوردية مدعمة بالفعل (تم إستخدام addUrduSupport()) فإن دعم الفارسية سيضاف تلقائياً ولا حاجة لإستخدام هذه الوظيفة
  • تعيد true عند النجاح أو false بخلاف ذلك
  
  
  • Adds Persian support to Flaraby3
  • Note that if Urdu support already exists (addUrduSupport() method was previously called), Persian support is automaticaly added, so no need to use this function
  • Returns true on success or false otherwise


• removePersianSupport():Boolean
  • تلغي الدعم للفارسية من Flaraby3
  • لاحظ أنه إذا كانت الأوردية مدعمة بالفعل (تم إستخدام addUrduSupport()) فإن دعم الفارسية لا يمكن إلغاؤه
  • تعيد true عند النجاح أو false بخلاف ذلك
  
  
  • Removes Persian support from Flaraby3
  • Note that if Urdu support already exists (addUrduSupport() method was previously called), Persian support cannot be removed.
  • Returns true on success or false otherwise


• addUrduSupport():Void
  • تضيف الدعم للأوردية في Flaraby3
  • تضيف الدعم للفارسية تلقائياً
  • تعيد لا شئ
  
  
  • Adds Urdu support to Flaraby3
  • Automaticaly adds Persian support
  • Returns true on success or false otherwise


• removeUrduSupport():Void
  • تلغي الدعم للأوردية من Flaraby3
  • تلغي الدعم للفارسية تلقائياً
  • تعيد لا شئ
  
  
  • Removes Urdu support from Flaraby3
  • Automaticaly removes Persian support
  • Returns nothing


• convertArabicString(inputStr:String, tF:TextField, tfrmt:TextFormat):String
  • الوظيفة الأساسية في Flaraby3, تستخدم لإظهار النص الثنائى الإتجاه من اليمين إلى الشمال أومن الشمال إلى اليمين. يمكن تحويل النص العربي أو الالفارسي أو الأوردي أو الإنجليزي أو الفرنسي و الإسباني أو الإيطالي أو مزيج من كل ذلك
  • inputStr: النص المراد تحويله
  • tF: الحقل النصي الذي سيظهر فيه النص
  • tfrmt: الـ TextFormat المستخدم لإعطاء النص خصائصه من اسم الـ font و حجمه و تنسيقه. يجب أن يكون هناك font موجود في الـ library وله linkage identifier لإستخدامه في TextFormat.font
  • تعيد inputStr وقد تم تحويلها لتظهر بشكل جيد في ملف الـ swf
  
  
  • The main function in Flaraby3, used to render bidirectional RTL or LTR text, including Arabic, Persian, Urdu, English, French, Spanish and Italian
  • inputStr: the string to be converted
  • tF: the target text field in which text would be rendered
  • tfrmt: the TextFormat object that gives text its properties, like: Font name, size and alignment. A font must exist in the library with a linkage identifier to be used in TextFormat.font
  • Returns inputStr converted to a formatted string properly rendered in the swf file


• convertArabicChar(p:Number, str:String):String
  • تقوم بتحويل حرف ASCII عربي أو فارسي أو أوردي إلى حرف Unicode بحسب موقعه في النص
  • p: موقع الحرف في النص
  • str: النص أو الكلمة الموجود بها الحرف
  • تعيد حرف Unicode عربي أو فارسي أو أوردي
  
  
  • Converts an ASCII character (Arabic/Persian/Urdu) to a Unicode one (Arabic/Persian/Urdu) depending on its position in str
  • p: position of character in str
  • str: string/word in which the character exists
  • Returns a Unicode Arabic/Persian/Urdu character


• isArabic(char:String):Boolean
  • تحدد ما إذا كان الحرف هو عربي أو فارسي أو أوردي
  • char: الحرف المراد التأكد منه
  • تعيد true أو false
  
  
  • Finds whether the specified character is an Arabic/Persian/Urdu character
  • char: the character to be checked
  • Returns true or false


• isLatin(char:String):Boolean
  • تحدد ما إذا كان الحرف هو لاتيني (إنجليزي أو فرنسي أو إسباني أو إيطالي)
  • char: الحرف المراد التأكد منه
  • تعيد true أو false
  
  
  • Finds whether the specified character is a Latin (English/French/Spanish/Italian)
  • char: the character to be checked
  • Returns true or false


• isDigit(char:String):Boolean
  • تحدد ما إذا كان الحرف هو عدد
  • char: الحرف المراد التأكد منه
  • تعيد true أو false
  
  
  • Finds whether the specified character is a Digit
  • char: the character to be checked
  • Returns true or false


• isPunc(char:String):Boolean
  • تحدد ما إذا كان الحرف هو علامة. العلامة هي كل ما هو ليس بعربي أو فارسي أو أوردي أو لاتيني أو عدد ويشمل المسافة
  • char: الحرف المراد التأكد منه
  • تعيد true أو false
  
  
  • Finds whether the specified character is a Punctuation. A punctuation is considered a non Arabic, Persian, Urdu, Latin or digit character including space
  • char: the character to be checked
  • Returns true or false


• isTag(str:String):Boolean
  • تحدد ما إذا كان الحرف هو tag. الـ tag هو أي نص يبدأ بـ ">" وينتهي بـ "<"
  • char: الحرف المراد التأكد منه
  • تعيد true أو false
  
  
  • Finds whether the specified string is a tag. A tag is considered any string with a "<" at the start and a ">" at the end
  • str: the string to be checked
  • Returns true or false


• removeTags(str:String):Object
  • تستخلص النص من نص محوط بـ tag.
    مثال:
    removeTags("<a href='path/to/link'>وصلة ما</a>")
    تعيد:
    "وصلة ما"
  • str: النص المحوط بـ tag
  • تعيد النص المستخلص أو false لو لم تكن str نص محوط بـ tag
  
  
  • Extracts the string part of a tagged string.
    Example:
    removeTags("<a href='path/to/link'>Some Link</a>")
    returns:
    "Some Link"
  • str: the tagged string
  • Returns the extracted string or false if the string is not a tag


• getStringWidth(str:String):Number
  • تحسب عرض النص str
  • يجب إستخدامها بعد إستخدام وظيفة convertArabicString()
  • str: النص المراد معرفة عرضه
  • تعيد رقم يمثل عرض النص str
  
  
  • Computes the width of the string str
  • Must be called after a call to convertArabicString() method
  • str: the string to return its width
  • Returns a number representing the width of str


• getCharArrWidth(arr:Array):Number
  • تحسب عرض مصفوفة من الحروف أو النصوص
  • يجب إستخدامها بعد إستخدام وظيفة convertArabicString()
  • str: المصفوفة المراد معرفة عرض ما بها من حروف أو نصوص
  • تعيد رقم يمثل عرض ما بالمصفوفة
  
  
  • Computes the width of an array of strings/characters
  • Must be called after a call to convertArabicString() method
  • str: the array of strings/characters to return their width
  • Returns a number representing the width of the array of strings/characters


• replaceNewlines(str:String):String
  • تقوم بإستبدال الحروف المحددة لنهايات السطور في النص
  • لو html=true; أو multiline=false; تحول كل الحروف المحددة لنهايات السطور (\r\n, \r, \n) إلى " "
  • لو multiline=true; و html=false; تحول الحروف المحددة لنهايات السطور \r\n, \r إلى "\n"
  • str: النص المراد تحويله
  • تعيد نص به الحروف المحددة لنهايات السطور مستبدلة
  
  
  • Replaces newline characters in str
  • If html=true; or multiline=false; all newline characters (\r\n, \r, \n) will be converted to " "
  • If multiline=true; and html=false; newline characters \r\n, \r will be converted to "\n"
  • str: the string to be replaced
  • Returns a string with newlines replaced


• getLines():Array
  • يجب إستخدامها بعد إستخدام وظيفة convertArabicString()
  • تعيد مصفوفة من السطور الناتجة
  
  
  • Must be called after a call to convertArabicString() method
  • Returns an array of lines representing the converted string lines


• getDir():String
  • تعيد الإتجاه الحالي للنص وهو إما من اليمين إلى الشمال أو من الشمال إل اليمين. والإتجاه هو نص مكون من: "RTL" (مبدئي) أو "LTR"
  
  
  • Returns the current direction setting, either Right-to-Left or Left-to-Right. The direction is a string either: "RTL" (default) or "LTR"


• setDir(dir):Void
  • تحدد إتجاه النص وهو إما من اليمين إلى الشمال أو من الشمال إل اليمين
  • dir: إتجاه النص وهو نص مكون من: "RTL" (مبدئي) أو "LTR"
  • تعيد لا شئ
  
  
  • Sets the output text direction, either Right-to-Left or Left-to-Right
  • dir: The direction of the output text, either: "RTL" (default) or "LTR"
  • Returns nothing


• getExtraTextWidth():Number
  • تعيد رقم يمثل عرض إضافي للنص يحدد من خلال المستخدم (مبدئياً = -1)
  
  
  • Returns a number representing the extra text width specified by user (default = -1)


• setExtraTextWidth(w:Number):Void
  • تحدد عرض إضافي للنص w
  • العرض الإضافي للنص هو عرض إضافي يمكن إضافته في حالة أن النص لا تظهر فيه السطور بشكل جيد عند التجربة بالإعدادات الحالية مثل (font و size)
  • w: عرض إضافي للنص
  • بشكل عام، القيم من 1 إلى 3 تصلح النص
  • تعيد لا شئ
  
  
  • Sets the extra text width number w
  • Extra text width is an extra width that can be added in case experiments showed that the text is not well wrapped using current settings (font and size)
  • w: extra text width
  • In general, a value of 1 to 3 should fix the text wrap
  • Returns nothing


• addListener(obj:Object):Void (New)
  • تضيف Listener أو منصت لأحداث فلارابي ويتم تنفيذ وظيفة خاصة بهذا المنصت بنفس إسم الحدث عند حدوثه ويتم تحديد هذه الوظيفة وما يجب فعله كرد فعل للحدث
  • obj: المنصت المراد إضافته
  • تعيد لا شئ
  
  
  • Adds a Listener to Flaraby3 events. An object method with the same name as the event would be fired once the event occurs to handle the desired event reaction
  • obj: the Listener to add
  • Returns nothing


• removeListener(obj:Object):Void (New)
  • تحذف منصت تم إضافته مسبقاً لأحداث فلارابي
  • obj: المنصت المراد حذفه
  • تعيد لا شئ
  
  
  • Removes a previously added Listener object to Flaraby3 events.
  • obj: the Listener to be removed
  • Returns nothing

• onFlaraby3Initialize
  • يتم إطلاقه عندما يتم الإنتهاء من تحضير فلارابي ليكون جاهزاً لإستخدام وظائفه
  
  
  • Fires when Flaraby3 finishes initialization and is ready to use it's methods


• onPersianAdd
  • يتم إطلاقه عندما يتم إضافة الدعم للغة الفارسية
  
  
  • Fires when Persian language support added


• onPersianRemove
  • يتم إطلاقه عندما يتم حذف الدعم للغة الفارسية
  
  
  • Fires when Persian language support removed


• onUrduAdd
  • يتم إطلاقه عندما يتم إضافة الدعم للغة الأوردية
  
  
  • Fires when Urdu language support added


• onUrduRemove
  • يتم إطلاقه عندما يتم حذف الدعم للغة الأوردية
  
  
  • Fires when Urdu language support removed


• onArabicStringConvert
  • يتم إطلاقه عندما يكمل فلارابي تحويل وإظهار النص المراد تحويله
  
  
  • Fires when Flaraby3 finishes converting and rendering the given string


• onDirChange
  • يتم إطلاقه عندما يتم تغيير إتجاه النص
  
  
  • Fires when Text direction is changed


• onExtraTextWidthChange
  • يتم إطلاقه عندما يتم تغيير العرض الإضافي للنص
  
  
  • Fires when Extra Text Width is changed

rootMC = this;
//
//Listener Object (Flaraby3 only)
var obj1 = new Object();
//
obj1.onFlaraby3Initialize = function(f)
{
      // 'f' is a reference to Flaraby3 instance
      trace(f +" is now initialized");
}
//Listener Object (Flaraby3 only)
var obj2 = new Object();
//
obj2.onDirChange = function(f)
{
      trace(f +" has changed text direction");
}
//
obj2.onArabicStringConvert = function(f)
{
      trace(f +" has converted the string");
}
//You can add a listener directly when initializing Flaraby3 to receive the "onFlaraby3Initialize" event
attachMovie("Flaraby3", "flrb", 2000, {_x:-1000, listeners:[obj1]});
//attachMovie("Flaraby3Lite", "flrb", 2000, {_x:-1000});
//
flrb.addListener(obj2);
//
txt = "بِسْمِ اللّهِ الرَّحْمـَنِ الرَّحِيمِ الْحَمْدُ للّهِ رَبِّ الْعَالَمِينَ الرَّحْمـنِ الرَّحِيمِ مَـالِكِ يَوْمِ الدِّينِ إِيَّاكَ نَعْبُدُ وإِيَّاكَ نَسْتَعِينُ اهدِنَــــا الصِّرَاطَ المُستَقِيمَ صِرَاطَ الَّذِينَ أَنعَمتَ عَلَيهِمْ غَيرِ المَغضُوبِ عَلَيهِمْ وَلاَ الضَّالِّينَ";
//
function convert()
{
      flrb.setDir("RTL");
      //
      rootMC.createTextField("output", 0, 0, 0, 400, 200);
      var tf = rootMC.output;
      tf.embedFonts = true;
      tf.multiline = true;
      //
      var frmt = new TextFormat();
      frmt.font = "Traditional Arabic";
      frmt.size = 16;
      frmt.align = "right";
      //
      var otp = flrb.convertArabicString(txt, tf, frmt);
      tf.text = otp;
      tf.setTextFormat(frmt);
}
//
convertButton.onRelease = convert;