Class Index | File Index

Classes


Class AddressFmt

Create a new formatter object to format physical addresses in a particular way. The options object may contain the following properties, both of which are optional:


Defined in: ilib-full-dyn.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
AddressFmt(options)
Method Summary
Method Attributes Method Name and Description
 
format(address)
This function formats a physical address (Address instance) for display.
Class Detail
AddressFmt(options)
Parameters:
{Object} options
options that configure how this formatter should work Returns a formatter instance that can format multiple addresses.
Method Detail
format(address)
This function formats a physical address (Address instance) for display. Whitespace is trimmed from the beginning and end of final resulting string, and multiple consecutive whitespace characters in the middle of the string are compressed down to 1 space character. If the Address instance is for a locale that is different than the locale for this formatter, then a hybrid address is produced. The country name is located in the correct spot for the current formatter's locale, but the rest of the fields are formatted according to the default style of the locale of the actual address. Example: a mailing address in China, but formatted for the US might produce the words "People's Republic of China" in English at the last line of the address, and the Chinese-style address will appear in the first line of the address. In the US, the country is on the last line, but in China the country is usually on the first line.
Parameters:
{Address} address
Address to format

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