Class com.gContactSync.ABOverlay

Defined in: ABOverlay.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	com.gContactSync.ABOverlay() The Address Book window overlay overrides certain functions to add gContactSync fields to the address book.

Field Summary
Field Attributes	Field Name and Description
<static>	com.gContactSync.ABOverlay.links Special links for various IM protocols Format: Type (from Google): protocol

Method Summary
Method Attributes	Method Name and Description
<static>	com.gContactSync.ABOverlay.addResetContext() Adds a 'Reset' menuitem to the Address Book contaxt menu for the list on the left side of the Address Book window.
<static>	com.gContactSync.ABOverlay.addTreeCols() Adds treecol elements to the address book results tree that shows cards in the currently selected directory.
<static>	com.gContactSync.ABOverlay.collapseAddress(aPrefix) Collapses (hides) the old components of an address: Address Line 1 and 2, the City, State Zip line, and the Country of the given type (Home or Work).
<static>	com.gContactSync.ABOverlay.fixDescriptionStyle() Fixes the description style as set (accidentally?) by the Duplicate Contacts Manager extension in duplicateContactsManager.css It appears that the new description style was applied to addressbook.xul on accident when it was meant only for duplicateEntriesWindow.xul
<static>	com.gContactSync.ABOverlay.getVisible(aCard, aArray, aVisible, aUseTypeLabel) A helper method for myDisplayCardViewPane that iterates through an array of attributes and returns true if at least one of them is present in the given card.
<static>	com.gContactSync.ABOverlay.hideNodes(aArray) Hides all of the nodes based on the array.
<static>	com.gContactSync.ABOverlay.initialize() Called when the overlay is loaded and overrides some methods to add gContactSync fields.
<static>	com.gContactSync.ABOverlay.makeDescElement(aName, aClass) Makes and returns a element of the given class and with an ID of aName with a prefix of "cv"
<static>	com.gContactSync.ABOverlay.myDisplayCardViewPane(aCard) Updates the Card View pane boxes and headers for whether or not they should be visible based on additional attributes added by gContactSync.
<static>	com.gContactSync.ABOverlay.myOnLoadCardView() Sets up a few nodes and labels in addition to what the OnLoadCardView function does in abCardViewOverlay.js.
<static>	com.gContactSync.ABOverlay.mySetAbView(aURI, aSearchView, aSortCol, aSortDir) Modifies the SetAbView function.
<static>	com.gContactSync.ABOverlay.replaceToSelectedAB() Updates the LastModifiedDate of all contacts in the selected AB.
<static>	com.gContactSync.ABOverlay.resetSelectedAB() Resets the currently selected address book after showing a confirmation dialog.
<static>	com.gContactSync.ABOverlay.setupButton() Sets up the Sync button to go between the Write and Delete buttons and adds a separator between Sync and Delete.
<static>	com.gContactSync.ABOverlay.showNodes(aArray) Shows all of the nodes based on the array.

Class Detail

com.gContactSync.ABOverlay()

The Address Book window overlay overrides certain functions to add gContactSync fields to the address book.

Field Detail

<static> com.gContactSync.ABOverlay.links

Special links for various IM protocols Format: Type (from Google): protocol

Method Detail

<static> com.gContactSync.ABOverlay.addResetContext()

Adds a 'Reset' menuitem to the Address Book contaxt menu for the list on the left side of the Address Book window.

<static> com.gContactSync.ABOverlay.addTreeCols()

Adds treecol elements to the address book results tree that shows cards in the currently selected directory. These treecols allow the user to show and sort by extra attributes that are added by this extension. This will only work after Bug 413260 landed, so in Thunderbird 3.0b1pre and after.

<static> com.gContactSync.ABOverlay.collapseAddress(aPrefix)

Collapses (hides) the old components of an address: Address Line 1 and 2, the City, State Zip line, and the Country of the given type (Home or Work).

Parameters:
aPrefix: {string} The type of address. Must be 'Home' or 'Work'.

<static> {boolean} com.gContactSync.ABOverlay.fixDescriptionStyle()

Fixes the description style as set (accidentally?) by the Duplicate Contacts Manager extension in duplicateContactsManager.css It appears that the new description style was applied to addressbook.xul on accident when it was meant only for duplicateEntriesWindow.xul

Returns:: {boolean} true if the description style was removed.

<static> {boolean} com.gContactSync.ABOverlay.getVisible(aCard, aArray, aVisible, aUseTypeLabel)

A helper method for myDisplayCardViewPane that iterates through an array of attributes and returns true if at least one of them is present in the given card.

Parameters:
aCard: {nsIAbCard} The card whose attributes are checked.
aArray: {array} The array of attributes to check for in the card.
aVisible: {boolean} Optional. True if the element was previously visible.
aUseTypeLabel: {boolean} Optional. True if the labels should be the type of the attribute instead of the attribute's name.

Returns:: {boolean} True if at least one attribute in aArray is present in aCard.

<static> com.gContactSync.ABOverlay.hideNodes(aArray)

Hides all of the nodes based on the array. The node must be a propery of cvData with the same name as the element in aArray prefixed with a 'cv'. For example, to hide cvData.cvHomeAddress the element would be 'HomeAddress'.

Parameters:
{array} aArray: An array of names as described above.

<static> com.gContactSync.ABOverlay.initialize()

Called when the overlay is loaded and overrides some methods to add gContactSync fields.

<static> {XML} com.gContactSync.ABOverlay.makeDescElement(aName, aClass)

Makes and returns a element of the given class and with an ID of aName with a prefix of "cv"

Parameters:
aName: {string} The ID of the element that will be prefixed with a "cv"
aClass: {string} The class of the element.

Returns:: {XML} A new element.

<static> com.gContactSync.ABOverlay.myDisplayCardViewPane(aCard)

Updates the Card View pane boxes and headers for whether or not they should be visible based on additional attributes added by gContactSync. Links the third and fourth e-mail address as well as the "other" address. Should be set to override the DisplayCardViewPane function in abCardViewOverlay.js. Requires that the original function should be set as the com.gContactSync.originalDisplayCardViewPane variable.

Parameters:
aCard: {nsIAbCard} The card being viewed.

<static> com.gContactSync.ABOverlay.myOnLoadCardView()

Sets up a few nodes and labels in addition to what the OnLoadCardView function does in abCardViewOverlay.js. Should be run when the Overlay is loaded.

<static> com.gContactSync.ABOverlay.mySetAbView(aURI, aSearchView, aSortCol, aSortDir)

Modifies the SetAbView function. Unused

Parameters:
aURI
aSearchView
aSortCol
aSortDir

<static> com.gContactSync.ABOverlay.replaceToSelectedAB()

Updates the LastModifiedDate of all contacts in the selected AB.

<static> com.gContactSync.ABOverlay.resetSelectedAB()

Resets the currently selected address book after showing a confirmation dialog.

<static> {boolean} com.gContactSync.ABOverlay.setupButton()

Sets up the Sync button to go between the Write and Delete buttons and adds a separator between Sync and Delete.

Returns:: {boolean} True if the button was added manually.

<static> com.gContactSync.ABOverlay.showNodes(aArray)

Shows all of the nodes based on the array. The node must be a propery of cvData with the same name as the element in aArray prefixed with a 'cv'. For example, to show cvData.cvHomeAddress the element would be 'HomeAddress'.

Parameters:
aArray: {array} An array of names as described above.

Classes

Class com.gContactSync.ABOverlay