mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-09-27 20:26:46 +00:00
c53685b865
Also removed a few redundant headings in class documentation comments. There is already an @class and it looks a bit odd in the generated pages: <h2>TextString</h2> <p>TextString</p> <p>This class provides a ...</p> Change-Id: Ie311c6993ed02e79272dbde71f6a1bc252ef3037
37 lines
940 B
JavaScript
37 lines
940 B
JavaScript
/*!
|
|
* UnicodeJS TextString class.
|
|
*
|
|
* @copyright 2013 UnicodeJS team and others; see AUTHORS.txt
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
*/
|
|
|
|
/**
|
|
* This class provides a simple interface to fetching plain text
|
|
* from a data source. The base class reads data from a string, but
|
|
* an extended class could provide access to a more complex structure,
|
|
* e.g. an array or an HTML document tree.
|
|
*
|
|
* @class unicodeJS.TextString
|
|
* @constructor
|
|
* @param {string} text Text
|
|
*/
|
|
unicodeJS.TextString = function UnicodeJSTextString( text ) {
|
|
this.text = text;
|
|
};
|
|
|
|
/* Methods */
|
|
|
|
/**
|
|
* Read character at specified position
|
|
*
|
|
* @method
|
|
* @param {number} position Position to read from
|
|
* @returns {string|null} Character, or null if out of bounds
|
|
*/
|
|
unicodeJS.TextString.prototype.read = function ( position ) {
|
|
if ( position < 0 || position >= this.text.length ) {
|
|
return null;
|
|
}
|
|
return this.text.charAt( position );
|
|
};
|