Class Index | File Index

Classes


Class ScriptInfo

Create a new script info instance. This class encodes information about scripts, which are sets of characters used in a writing system.

The options object may contain any of the following properties:


Defined in: ilib-full-dyn.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ScriptInfo(script, options)
Method Summary
Method Attributes Method Name and Description
<static>  
ScriptInfo.getAllScripts(sync, loadParams, onLoad)
Return an array of all ISO 15924 4-letter identifier script identifiers that this copy of ilib knows about.
 
Return true if this script uses lower- and upper-case characters.
 
Return the 4-letter ISO 15924 identifier associated with this script.
 
Get the ISO 15924 code number associated with this script.
 
Get the long identifier assciated with this script.
 
Get the name of this script in English.
 
Return true if this script typically requires an input method engine to enter its characters.
 
Return the usual direction that text in this script is written in.
Class Detail
ScriptInfo(script, options)
Parameters:
{string} script
The ISO 15924 4-letter identifier for the script
{Object} options
parameters to initialize this matcher
Method Detail
<static> {Array.<string>} ScriptInfo.getAllScripts(sync, loadParams, onLoad)
Return an array of all ISO 15924 4-letter identifier script identifiers that this copy of ilib knows about.
Parameters:
{boolean} sync
whether to find the available ids synchronously (true) or asynchronously (false)
{Object} loadParams
arbitrary object full of properties to pass to the loader
{function(Array.)} onLoad
callback function to call when the data is finished loading
Returns:
{Array.<string>} an array of all script identifiers that this copy of ilib knows about

{boolean} getCasing()
Return true if this script uses lower- and upper-case characters.
Returns:
{boolean} true if this script uses letter case

{string} getCode()
Return the 4-letter ISO 15924 identifier associated with this script.
Returns:
{string} the 4-letter ISO code for this script

{number} getCodeNumber()
Get the ISO 15924 code number associated with this script.
Returns:
{number} the ISO 15924 code number

{string} getLongCode()
Get the long identifier assciated with this script.
Returns:
{string} the long identifier of this script

{string} getName()
Get the name of this script in English.
Returns:
{string} the name of this script in English

{boolean} getNeedsIME()
Return true if this script typically requires an input method engine to enter its characters.
Returns:
{boolean} true if this script typically requires an IME

{string} getScriptDirection()
Return the usual direction that text in this script is written in. Possible return values are "rtl" for right-to-left, "ltr" for left-to-right, and "ttb" for top-to-bottom.
Returns:
{string} the usual direction that text in this script is written in

Documentation generated by JsDoc Toolkit 2.4.0 on Tue Feb 02 2016 15:53:55 GMT-0800 (PST)