Global

Members

addBottomBar :function

Adds a bottom bar to the application window.
Type:
  • function
Source:

addTab :function

Adds a new browser tab in the given application window.
Type:
  • function
Source:

bottomBars

Maps windows to their bottom bar info.
Source:

classHidden :string

Random element class, to be used for object tabs that are hidden.
Type:
  • string
Source:

classVisibleBottom :string

Random element class, to be used for object tabs displayed at the bottom of the plugin content.
Type:
  • string
Source:

classVisibleTop :string

Random element class, to be used for object tabs displayed on top of the plugin content.
Type:
  • string
Source:

contentContextMenu :String|Array.<String>

The ID (or a list of possible IDs) of the content area context menu.
Type:
  • String | Array.<String>
Source:

defaultToolbarPosition :Object

Determines the default placement of the toolbar icon via object properties parent, before and after.
Type:
  • Object
Source:

delayInitialization :Boolean

HACK: In some applications the window finishes initialization during load event processing which makes an additional delay necessary. This flag indicates that.
Type:
  • Boolean
Source:

detachedBottombar :Window

Window containing the detached list of blockable items.
Type:
  • Window
Source:

eventHandlers :Array

List of event handers to be registered for each window. For each event handler the element ID, event and the actual event handler are listed.
Type:
  • Array
Source:

filtersRecordID :String

ID of the only record stored
Type:
  • String
Source:

getBrowser :function

Retrieves the browser element for an application window.
Type:
  • function
Source:

notificationTimer :nsITimer

Timer used to delay notification handling.
Type:
  • nsITimer
Source:

notifiers :Map.<number, RequestNotifier>

Active RequestNotifier instances by their ID
Type:
Source:

optionsObserver :nsIObserver

Object initializing add-on options, observes add-on manager notifications about add-on options being opened.
Type:
  • nsIObserver
Source:

pageWhitelist :Filter

Filter corresponding with "disable on site" menu item (set in fillIconMenu()).
Type:
  • Filter
Source:

progressListeners

Maps windows to a list of progress listeners.
Source:

removeBottomBar :function

Removes the bottom bar from the application window.
Type:
  • function
Source:

sessionRestoreObserver :SessionRestoreObserver

Session restore observer instance, stored to prevent it from being garbage collected.
Type:
Source:

siteWhitelist :Filter

Filter corresponding with "disable on site" menu item (set in fillIconMent()).
Type:
  • Filter
Source:

statusbarPosition :Object

The properties parent, before, after determine the placement of the status bar icon.
Type:
  • Object
Source:

SyncServiceObserver

Listens to notifications from Sync service.
Source:

toolsMenu :Object

The properties parent, before, after determine the placement of the Tools submenu.
Type:
  • Object
Source:

trackerInstance

Hack to allow store to use the tracker - store tracker pointer globally.
Source:

Methods

addBrowserLocationListener(window, callback, ignoreSameDoc)

Makes sure that a function is called whenever the displayed browser location changes.
Parameters:
Name Type Description
window
callback
ignoreSameDoc
Source:

getCurrentLocation(window)

Retrieves the current browser location for an application window.
Parameters:
Name Type Description
window
Source:

getHostname(url)

Extracts the hostname from a URL (might return null).
Parameters:
Name Type Description
url
Source:

getSitekey()

Retrieves and validates the sitekey for a frame structure.
Source:

getWindowLocation(wnd) → {String}

Retrieves the location of a window.
Parameters:
Name Type Description
wnd nsIDOMWindow
Source:
Returns:
window location or null on failure
Type
String

isKnownWindow(window)

Checks whether an application window is known and should get Adblock Plus user interface elements.
Parameters:
Name Type Description
window
Source:

isThirdParty(location, docDomain)

Checks whether the location's origin is different from document's origin.
Parameters:
Name Type Description
location
docDomain
Source:

removeBrowserLocationListener(window, callback)

Removes a location listener registered for a window.
Parameters:
Name Type Description
window
callback
Source:

removeBrowserLocationListeners(window)

Removes all location listeners registered for a window, to be called on cleanup.
Parameters:
Name Type Description
window
Source:

RequestNotifier(outerWindowID, listener, listenerObjopt)

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.
Parameters:
Name Type Attributes Description
outerWindowID Integer ID of the window to attach the notifier to
listener function listener to be called whenever a new request is found
listenerObj Object <optional>
"this" pointer to be used when calling the listener
Source:

SessionRestoreObserver(callback)

Observer waiting for the browsing session to be restored on startup.
Parameters:
Name Type Description
callback
Source:

Type Definitions

StatData

Type:
  • object
Properties:
Name Type Description
exists boolean true if the file exists
lastModified number file modification time in milliseconds
Source:

TextSink(line)

Parameters:
Name Type Description
line string
Source: