Class AjxStringUtil

Object
   |
   +--AjxStringUtil

class AjxStringUtil

This class provides static methods to perform miscellaneous string-related utility functions.
Defined in AjxStringUtil.js

Author: Ross Dargahi , Roland Schemers , Conrad Damon

Field Detail

_INDENT

<static> Object _INDENT

_LF

<static> Object _LF

_NO_LIST

<static> Object _NO_LIST

Converts a HTML document represented by a DOM tree to text There has got to be a better way of doing this!

_NON_WHITESPACE

<static> Object _NON_WHITESPACE

_ORDERED_LIST

<static> Object _ORDERED_LIST

_UNORDERED_LIST

<static> Object _UNORDERED_LIST

BLANK_RE

<static> Object BLANK_RE

BRACKET_RE

<static> Object BRACKET_RE

COLON_RE

<static> Object COLON_RE

COMPRESS_RE

<static> Object COMPRESS_RE

ELLIPSIS

<static> Object ELLIPSIS

ENCODE_MAP

<static> Object ENCODE_MAP

HTML-encodes a string.

HDR_RE

<static> Object HDR_RE

IS_PRINT_CODE

<static> Object IS_PRINT_CODE

Returns true if the character for the given key is considered printable.

LINE_RE

<static> Object LINE_RE

MSG_SEP_RE

<static> Object MSG_SEP_RE

PREFIX_RE

<static> Object PREFIX_RE

SHIFT_CHAR

<static> Object SHIFT_CHAR

Returns the character for the given key, taking the shift key into consideration.

SIG_RE

<static> Object SIG_RE

SPACE_ENCODE_MAP

<static> Object SPACE_ENCODE_MAP

HTML-encodes a string.

TRIM_RE

<static> Object TRIM_RE

Removes white space from the beginning and end of a string, optionally compressing internal white space. By default, white space is defined as a sequence of Unicode whitespace characters (\s in regexes). Optionally, the user can define what white space is by passing it as an argument.

TODO: add left/right options

AjxStringUtil

AjxStringUtil()

Does nothing (static class).

Author: Ross Dargahi , Roland Schemers , Conrad Damon

_linesToSkip

<static> Object _linesToSkip(lines, i)

_nextNonBlankLineIndex

<static> Object _nextNonBlankLineIndex(lines, i)

_traverse

<static> Object _traverse(el, text, idx, listType, listLevel, bulletNum, ctxt)

_trimBlankLines

<static> Object _trimBlankLines(text, eol)

calcDIV

<static> Object calcDIV()

clip

<static> Object clip(origString, pixelWidth, className)

Clips a string at "pixelWidth" using using "className" on hidden 'AjxStringUtil._calcDIV'. Returns "origString" with "..." appended if clipped. NOTE: The same CSS style ("className") must be assigned to both the intended display area and the hidden 'AjxStringUtil._calcDIV'. "className" is optional; if supplied, it will be assigned to 'AjxStringUtil._calcDIV' to handle different CSS styles ("className"s) on same page. NOTE2: MSIE Benchmark - clipping an average of 17 characters each over 190 iterations averaged 27ms each (5.1 seconds total for 190)

convertHtml2Text

<static> Object convertHtml2Text(domRoot)

convertToHtml

<static> Object convertToHtml(str)

diffPoint

<static> Object diffPoint(str1, str2)

Does a diff between two strings, returning the index of the first differing character.

Parameters:
str1 - a string
str2 - another string

Returns:
the index at which they first differ

getTopLevel

<static> Object getTopLevel(text, eol)

Returns a list of chunks of top-level content in a message body. Top-level content is what was actually typed by the sender. We attempt to exclude quoted content and signatures. The following lines/blocks (and variants) and any text after them are ignored: ----- Original Message ----- ----- Forwarded Message ----- -- some signature text ______________________________ | | Outlook 2003 does this From: | Lines that begin with a prefix character (">" or "|") are ignored. The following lines/blocks are ignored if they precede a line that begins with a prefix character: Fred Flintstone
Parameters:
text - a message body
eol - the eol sequence, defaults to '\n'

---

getUnitsFromSizeString

<static> Object getUnitsFromSizeString(sizeString)

---

htmlEncode

<static> Object htmlEncode(str, includeSpaces)

---

htmlEncodeSpace

<static> Object htmlEncodeSpace(str)

---

isPrintKey

<static> Object isPrintKey(keycode)

---

makeString

<static> Object makeString(val)

---

nl2br

<static> Object nl2br(str)

---

regExEscape

<static> Object regExEscape(str)

---

repeat

<static> Object repeat(str, num)

Returns the string repeated the given number of times.
Parameters:
str - a string
num - number of times to repeat the string

---

resolve

<static> Object resolve(str, values)

DEPRECATED Replaces variables in a string with values from a list. The variables are denoted by a '$' followed by a number, starting from 0. For example, a string of "Hello $0, meet $1" with a list of ["Harry", "Sally"] would result in the string "Hello Harry, meet Sally".
Parameters:
str - the string to resolve
values - an array of values to interpolate
Returns:
a string with the variables replaced

---

shiftChar

<static> Object shiftChar(keycode, shifted)

---

split

<static> Object split(str, dels)

Splits a string, ignoring delimiters that are in quotes or parentheses. Comma is the default split character, but the user can pass in a string of multiple delimiters. It can handle nested parentheses, but not nested quotes.

TODO: handle escaped quotes

Parameters:
str - the string to split
dels - an optional string of delimiter characters
Returns:
an array of strings

---

trim

<static> Object trim(str, compress, space)

---

urlEncode

<static> Object urlEncode(str)

URL-encodes a string. Replace spaces with + then escape and any + become %2B for for transport in URL's.
Parameters:
str - the string to encode

---

wordWrap

<static> Object wordWrap(text, len, pre, eol, breakOkay, compress)

Wraps text to the given length and quotes it, breaking on space when possible. Preserves line breaks. At this point, it assumes that the text to be wrapped is raw text, not HTML, and that line returns are represented by '\n'. Wrapping is optionally done across line returns that appear in paragraphs.
Parameters:
text - the text to be wrapped
len - the desired line length of the wrapped text, defaults to 80
pre - an optional string to prepend to each line (useful for quoting)
eol - the eol sequence for each wrapped line, defaults to '\n'
breakOkay - whether long words (longer than len) can be broken, default is false
compress - remove single returns within a paragraph before wrapping
Returns:
the wrapped/quoted text

---

wrap

<static> Object wrap(origString, pixelWidth, className)

Forces a string to wrap at "pixelWidth" using "className" on hidden 'AjxStringUtil._calcDIV'. Returns "origString" with "<br>" tags inserted to force wrapping. Breaks string on embedded space characters, EOL ("/n") and "<br>" tags when possible.
Returns:
"origString" with "<br>" tags inserted to force wrapping.

---

xmlAttrDecode

<static> Object xmlAttrDecode(str)

---

xmlAttrEncode

<static> Object xmlAttrEncode(str)

---

xmlDecode

<static> Object xmlDecode(str)

---

xmlEncode

<static> Object xmlEncode(str)

---

Overview  File   Class  Tree  Index  Help
PREV CLASS  NEXT CLASS	FRAMES    NO FRAMES
SUMMARY: FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

Documentation generated by JSDoc on Thu Apr 27 13:58:41 2006