AlloyUI - API Docs

  • API Docs for Version: 3.1.0-deprecated.60

    • Show:

    Text.WordBreak Class

    Defined in: yui3/src/text/js/text-wordbreak.js:9
    Module: text-wordbreak
    Parent Module: text

    <p> Provides utility methods for splitting strings on word breaks and determining whether a character index represents a word boundary, using the generic word breaking algorithm defined in the Unicode Text Segmentation guidelines (<a href="http://unicode.org/reports/tr29/#Word_Boundaries">Unicode Standard Annex #29</a>). </p>

    <p> This algorithm provides a reasonable default for many languages. However, it does not cover language or context specific requirements, and it does not provide meaningful results at all for languages that don't use spaces between words, such as Chinese, Japanese, Thai, Lao, Khmer, and others. Server-based word breaking services usually provide significantly better results with better performance. </p>

    Index

    Methods

    Methods

    _classify

    (
    • string
    )
    Array protected static

    Defined in yui3/src/text/js/text-wordbreak.js:196

    Returns a character classification map for the specified string.

    Parameters:

    • string String

      String to classify.

    Returns:

    Array:

    Classification map.

    _isWordBoundary

    (
    • map
    • index
    )
    Boolean protected static

    Defined in yui3/src/text/js/text-wordbreak.js:234

    <p> Returns <code>true</code> if there is a word boundary between the specified character index and the next character index (or the end of the string). </p>

    <p> Note that there are always word breaks at the beginning and end of a string, so <code>_isWordBoundary('', 0)</code> and <code>_isWordBoundary('a', 0)</code> will both return <code>true</code>. </p>

    Parameters:

    • map Array

      Character classification map generated by <code>_classify</code>.

    • index Number

      Character index to test.

    Returns:

    Boolean:

    getUniqueWords

    (
    • string
    • options
    )
    Array static

    Defined in yui3/src/text/js/text-wordbreak.js:154

    Returns an array containing only unique words from the specified string. For example, the string <code>'foo bar baz foo'</code> would result in the array <code>['foo', 'bar', 'baz']</code>.

    Parameters:

    • string String

      String to split.

    • options Object

      (optional) Options (see <code>getWords()</code> for details).

    Returns:

    Array:

    Array of unique words.

    getWords

    (
    • string
    • options
    )
    Array static

    Defined in yui3/src/text/js/text-wordbreak.js:75

    Splits the specified string into an array of individual words.

    Parameters:

    • string String

      String to split.

    • options Object

      (optional) Options object containing zero or more of the following properties:

      <dl> <dt>ignoreCase (Boolean)</dt> <dd> If <code>true</code>, the string will be converted to lowercase before being split. Default is <code>false</code>. </dd>

      <dt>includePunctuation (Boolean)</dt> <dd> If <code>true</code>, the returned array will include punctuation characters. Default is <code>false</code>. </dd>

      <dt>includeWhitespace (Boolean)</dt> <dd> If <code>true</code>, the returned array will include whitespace characters. Default is <code>false</code>. </dd> </dl>

    Returns:

    Array:

    Array of words.

    isWordBoundary

    (
    • string
    • index
    )
    Boolean static

    Defined in yui3/src/text/js/text-wordbreak.js:170

    <p> Returns <code>true</code> if there is a word boundary between the specified character index and the next character index (or the end of the string). </p>

    <p> Note that there are always word breaks at the beginning and end of a string, so <code>isWordBoundary('', 0)</code> and <code>isWordBoundary('a', 0)</code> will both return <code>true</code>. </p>

    Parameters:

    • string String

      String to test.

    • index Number

      Character index to test within the string.

    Returns:

    Boolean:

    <code>true</code> for a word boundary, <code>false</code> otherwise.