Class Index | File Index

Classes


Built-In Namespace _global_

Field Summary
Field Attributes Field Name and Description
 
List of explicitly supported content types
 
Shared CombinedMatcher instance that should usually be used.
 
ID of the only record stored
 
Version number of the filter storage file format.
 
List of content types that aren't associated with a visual document area
 
Weave tracker class (is set when Weave is initialized).
Method Summary
Method Attributes Method Name and Description
 
 
ABPStore(name)
 
ABPTracker(name)
 
addFilter(filter)
Notifies Matcher instances or ElemHide object about a new filter if necessary.
 
Executed on first run, adds a filter subscription and notifies that user about that.
 
addSubscriptionFilters(subscription)
Joins subscription's filters to the subscription without any notifications.
 
 
 
Checks whether any subscriptions need to be downloaded and starts the download if necessary.
 
Wraps a subscription into IAdblockPlusSubscription structure.
 
Sets up getter/setter on Prefs object for a boolean preference.
 
Sets up getter/setter on Prefs object for an integer preference.
 
defineProperty(name, defaultValue, readFunc, writeFunc)
Sets up getter/setter on Prefs object for preference.
 
Sets up getter/setter on Prefs object for a string preference.
 
 
extractImageURL(computedStyle, property)
Extracts the URL of the image from a CSS property.
 
filterSort(a, b)
 
Calls ElemHide.apply() if necessary.
 
Extracts the hostname from a URL (might return null).
 
Retrieves the location of a window.
 
 
IO.readFromFile() listener to parse filter data.
 
init()
Initializes app integration module
 
Initializes options in add-on manager when they show up.
 
isThirdParty(location, docDomain)
Checks whether the location's origin is different from document's origin.
 
Function called whenever the mouse enters or leaves an object.
 
Function called whenever the mouse enters or leaves an object tab.
 
Function called for paint events of the object tab window.
 
onCreateOptions(wrapper, event)
 
onFilterChange(action, filter, newValue, oldValue)
Filter change listener
 
Generic notification listener
 
onSubscriptionChange(action, subscription, newValue, oldValue)
Subscription change listener
 
Function temporarily replacing Utils.schedulePostProcess() function, will set needPostProcess variable instead of actually scheduling post-processing (for the case that post-processing has to be done in a remote process).
 
readFile(sourceFile, backupIndex)
 
readFilters(subscription, text, errorCallback)
Extracts a list of filters from text returned by a server.
 
refilterNode(node, entry)
Re-checks filters on an element.
 
Adds observers to keep various properties of Prefs object updated.
 
Updates displayed status for all application windows (on prefs or filters change).
 
removeFilter(filter)
Notifies Matcher instances or ElemHide object about removal of a filter if necessary.
 
 
Removes subscription's filters from the subscription without any notifications.
 
Removes an application window from the tracked list.
 
renameBackup(index)
 
RequestEntry(node, topWnd, contentType, docDomain, thirdParty, location, filter)
 
RequestNotifier(wnd, listener, listenerObj)
Creates a notifier object for a particular window.
 
setError(subscription, channelStatus, responseStatus, downloadURL, error, isBaseLocation, manual)
Handles an error during a subscription download.
 
setSubscription(url, title)
 
Tests whether image manager context menu entry should be hidden with user's current preferences.
 
 
Triggers preference listeners whenever a preference is changed.
 
 
updateFunction(action, items)
 
 
Field Detail
{Array of String} contentTypes
List of explicitly supported content types
Defined in: ContentPolicy.jsm.

{CombinedMatcher} defaultMatcher
Shared CombinedMatcher instance that should usually be used.
Defined in: Matcher.jsm.

{String} filtersRecordID
ID of the only record stored
Defined in: Sync.jsm.

{Integer} formatVersion
Version number of the filter storage file format.
Defined in: FilterStorage.jsm.

{Array of String} nonVisualTypes
List of content types that aren't associated with a visual document area
Defined in: ContentPolicy.jsm.

Tracker
Weave tracker class (is set when Weave is initialized).
Defined in: Sync.jsm.
Method Detail
ABPEngine()

Defined in: Sync.jsm.

ABPStore(name)

Defined in: Sync.jsm.
Parameters:
name

ABPTracker(name)

Defined in: Sync.jsm.
Parameters:
name

addFilter(filter)
Notifies Matcher instances or ElemHide object about a new filter if necessary.
Defined in: FilterListener.jsm.
Parameters:
{Filter} filter
filter that has been added

addSubscription()
Executed on first run, adds a filter subscription and notifies that user about that.
Defined in: AppIntegration.jsm.

addSubscriptionFilters(subscription)
Joins subscription's filters to the subscription without any notifications.
Defined in: FilterStorage.jsm.
Parameters:
{Subscription} subscription
filter subscription that should be connected to its filters

allowAcceptableAds(allow)

Defined in: AppIntegrationFennec.jsm.
Parameters:
{Boolean} allow

callback()

Defined in: Synchronizer.jsm.

checkSubscriptions()
Checks whether any subscriptions need to be downloaded and starts the download if necessary.
Defined in: Synchronizer.jsm.

{IAdblockPlusSubscription} createSubscriptionWrapper(subscription)
Wraps a subscription into IAdblockPlusSubscription structure.
Defined in: Public.jsm.
Parameters:
{Subscription} subscription

defineBooleanProperty(name)
Sets up getter/setter on Prefs object for a boolean preference.
Defined in: Prefs.jsm.
Parameters:
{String} name

defineIntegerProperty(name)
Sets up getter/setter on Prefs object for an integer preference.
Defined in: Prefs.jsm.
Parameters:
{String} name

defineProperty(name, defaultValue, readFunc, writeFunc)
Sets up getter/setter on Prefs object for preference.
Defined in: Prefs.jsm.
Parameters:
{String} name
defaultValue
{Function} readFunc
{Function} writeFunc

defineStringProperty(name)
Sets up getter/setter on Prefs object for a string preference.
Defined in: Prefs.jsm.
Parameters:
{String} name

dummy()

Defined in: AppIntegration.jsm.

extractImageURL(computedStyle, property)
Extracts the URL of the image from a CSS property.
Defined in: AppIntegration.jsm.
Parameters:
{CSSStyleDeclaration} computedStyle
{String} property

filterSort(a, b)

Defined in: AppIntegration.jsm.
Parameters:
a
b

flushElemHide()
Calls ElemHide.apply() if necessary.
Defined in: FilterListener.jsm.

{String} getHostname(url)
Extracts the hostname from a URL (might return null).
Defined in: ContentPolicy.jsm.
Parameters:
{String} url

{String} getWindowLocation(wnd)
Retrieves the location of a window.
Defined in: ContentPolicy.jsm.
Parameters:
wnd
{nsIDOMWindow}
Returns:
{String} window location or null on failure

handler()

Defined in: AppIntegration.jsm.

INIParser()
IO.readFromFile() listener to parse filter data.
Defined in: FilterStorage.jsm.

init()
Initializes app integration module
Defined in: AppIntegration.jsm.

initOptionsDoc(doc)
Initializes options in add-on manager when they show up.
Defined in: AppIntegration.jsm.
Parameters:
{Document} doc

{Boolean} isThirdParty(location, docDomain)
Checks whether the location's origin is different from document's origin.
Defined in: ContentPolicy.jsm.
Parameters:
{nsIURI} location
{String} docDomain

objectMouseEventHander(event)
Function called whenever the mouse enters or leaves an object.
Defined in: ObjectTabs.jsm.
Parameters:
{Event} event

objectTabEventHander(event)
Function called whenever the mouse enters or leaves an object tab.
Defined in: ObjectTabs.jsm.
Parameters:
{Event} event

objectWindowEventHandler(event)
Function called for paint events of the object tab window.
Defined in: ObjectTabs.jsm.
Parameters:
{Event} event

onCreateOptions(wrapper, event)

Defined in: AppIntegrationFennec.jsm.
Parameters:
wrapper
event

onFilterChange(action, filter, newValue, oldValue)
Filter change listener
Defined in: FilterListener.jsm.
Parameters:
action
filter
newValue
oldValue

onGenericChange(action)
Generic notification listener
Defined in: FilterListener.jsm.
Parameters:
action

onSubscriptionChange(action, subscription, newValue, oldValue)
Subscription change listener
Defined in: FilterListener.jsm.
Parameters:
action
subscription
newValue
oldValue

postProcessReplacement(node)
Function temporarily replacing Utils.schedulePostProcess() function, will set needPostProcess variable instead of actually scheduling post-processing (for the case that post-processing has to be done in a remote process).
Defined in: AppIntegrationFennec.jsm.
Parameters:
node

readFile(sourceFile, backupIndex)

Defined in: FilterStorage.jsm.
Parameters:
sourceFile
backupIndex

{Array of Filter} readFilters(subscription, text, errorCallback)
Extracts a list of filters from text returned by a server.
Defined in: Synchronizer.jsm.
Parameters:
{DownloadableSubscription} subscription
subscription the info should be placed into
{String} text
server response
{Function} errorCallback
function to be called on error
Returns:
{Array of Filter}

refilterNode(node, entry)
Re-checks filters on an element.
Defined in: ContentPolicy.jsm.
Parameters:
{Node} node
{RequestEntry} entry

registerObservers()
Adds observers to keep various properties of Prefs object updated.
Defined in: Prefs.jsm.

reloadPrefs()
Updates displayed status for all application windows (on prefs or filters change).
Defined in: AppIntegration.jsm.

removeFilter(filter)
Notifies Matcher instances or ElemHide object about removal of a filter if necessary.
Defined in: FilterListener.jsm.
Parameters:
{Filter} filter
filter that has been removed

removeLastBackup()

Defined in: FilterStorage.jsm.

removeSubscriptionFilters(subscription)
Removes subscription's filters from the subscription without any notifications.
Defined in: FilterStorage.jsm.
Parameters:
{Subscription} subscription
filter subscription to be removed

removeWindow()
Removes an application window from the tracked list.
Defined in: AppIntegration.jsm.

renameBackup(index)

Defined in: FilterStorage.jsm.
Parameters:
index

RequestEntry(node, topWnd, contentType, docDomain, thirdParty, location, filter)

Defined in: RequestNotifier.jsm.
Parameters:
node
topWnd
contentType
docDomain
thirdParty
location
filter

RequestNotifier(wnd, listener, listenerObj)
Creates a notifier object for a particular window. After creation the window will first be scanned for previously saved requests. Once that scan is complete only new requests for this window will be reported.
Defined in: RequestNotifier.jsm.
Parameters:
{Window} wnd
window to attach the notifier to
{Function} listener
listener to be called whenever a new request is found
{Object} listenerObj Optional
"this" pointer to be used when calling the listener

setError(subscription, channelStatus, responseStatus, downloadURL, error, isBaseLocation, manual)
Handles an error during a subscription download.
Defined in: Synchronizer.jsm.
Parameters:
{DownloadableSubscription} subscription
subscription that failed to download
{Integer} channelStatus
result code of the download channel
{String} responseStatus
result code as received from server
{String} downloadURL
the URL used for download
{String} error
error ID in global.properties
{Boolean} isBaseLocation
false if the subscription was downloaded from a location specified in X-Alternative-Locations header
{Boolean} manual
true for a manually started download (should not trigger fallback requests)

setSubscription(url, title)

Defined in: AppIntegrationFennec.jsm.
Parameters:
url
title

shouldHideImageManager()
Tests whether image manager context menu entry should be hidden with user's current preferences.
Defined in: AppIntegration.jsm.
Returns:
Boolean

toggleFennecWhitelist(event)

Defined in: AppIntegrationFennec.jsm.
Parameters:
event

triggerListeners(name)
Triggers preference listeners whenever a preference is changed.
Defined in: Prefs.jsm.
Parameters:
{String} name

updateFennecStatusUI(wrapper)

Defined in: AppIntegrationFennec.jsm.
Parameters:
wrapper

updateFunction(action, items)

Defined in: AppIntegrationFennec.jsm.
Parameters:
action
items

updateSubscriptionList(wrapper)

Defined in: AppIntegrationFennec.jsm.
Parameters:
wrapper

writeFilters()

Defined in: FilterStorage.jsm.

Documentation generated by JsDoc Toolkit 2.3.2 on Wed May 09 2012 10:50:20 GMT+0000 (UTC)