Class Index | File Index

Modules


Panels


Templates


Services (XPCOM)


Libraries


All Classes


Report Doc Issue | How To Comment Firebug Code

Class window.Firebug

Represents the main Firebug application object. An instance of this object is created for each browser window (browser.xul).

Defined in: firebug.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Method Summary
Method Attributes Method Name and Description
<static>  
window.Firebug.getActivablePanelTypes()
Returns all panel types, whose activation can be toggled
<static>  
window.Firebug.getContext()
Get context for the current website
<static>  
window.Firebug.getElementPanel(element)
Takes an element from a panel document and finds the owning panel.
<static>  
window.Firebug.getFirebugFrameParent()
Returns parent of the firebugFrame.xul frame.
<static>  
window.Firebug.getPanelState(panel)
Gets an object containing the state of the panel from the last time it was displayed before one or more page reloads.
<static>  
window.Firebug.getRepNode(node)
The child node that has a repObject
<static>  
window.Firebug.initializeUI(detachArgs)
Called when the UI is ready to be initialized, once the panel browsers are loaded, but before any contexts are created.
<static>  
window.Firebug.internationalizeUI(doc)
Substitute strings in the UI, with fall back to en-US
<static>  
window.Firebug.registerPreference(name, value)
Set a default value for a preference into the firebug preferences list.
<static>  
window.Firebug.registerStylesheet(styleURI)
Allows registering of custom stylesheet coming from extension.
<static>  
window.Firebug.selectContext(context)
This method syncs the UI to a context
<static>  
window.Firebug.showContext(browser, context)
Primary function to re-show firebug due to visiting active site.
<static>  
window.Firebug.shutdown()
called in browser when Firefox closes and in externalMode when fbs gets quitApplicationGranted.
<static>  
window.Firebug.toggleBar(forceOpen:, panelName:)
Primary function to activate or minimize firebug.
<static>  
window.Firebug.toggleDetachBar(forceOpen:, reopenInBrowser:)
function to switch between detached and inbrowser modes.
Class Detail
window.Firebug()
Method Detail
<static> {Object} window.Firebug.getActivablePanelTypes()
Returns all panel types, whose activation can be toggled
Returns:
{Object} Activable panel types

<static> window.Firebug.getContext()
Get context for the current website

<static> window.Firebug.getElementPanel(element)
Takes an element from a panel document and finds the owning panel.
Parameters:
element

<static> window.Firebug.getFirebugFrameParent()
Returns parent of the firebugFrame.xul frame. The actual parent depends on whether Firebug is attached or detached. attached -> browser.xul detached -> firebug.xul

<static> window.Firebug.getPanelState(panel)
Gets an object containing the state of the panel from the last time it was displayed before one or more page reloads. The 'null' return here is a too-subtle signal to the panel code in bindings.xml. Note that panel.context may not have a persistedState, but in addition the persisted state for panel.name may be null.
Parameters:
panel

<static> window.Firebug.getRepNode(node)
The child node that has a repObject
Parameters:
node

<static> window.Firebug.initializeUI(detachArgs)
Called when the UI is ready to be initialized, once the panel browsers are loaded, but before any contexts are created.
Parameters:
detachArgs

<static> window.Firebug.internationalizeUI(doc)
Substitute strings in the UI, with fall back to en-US
Parameters:
doc

<static> window.Firebug.registerPreference(name, value)
Set a default value for a preference into the firebug preferences list.
Parameters:
name
preference name, possibly dot segmented, will be stored under extensions.firebug.
value
default value of preference
Returns:
true if default set, else false

<static> window.Firebug.registerStylesheet(styleURI)
Allows registering of custom stylesheet coming from extension. The stylesheet is then used automatially thorough Firebug UI.
Parameters:
{Object} styleURI
URI of the stylesheet.

<static> window.Firebug.selectContext(context)
This method syncs the UI to a context
Parameters:
context
to become the active and visible context

<static> window.Firebug.showContext(browser, context)
Primary function to re-show firebug due to visiting active site. Unlike toggleBar, we are trying to obey the current placement, not change it.
Parameters:
browser
context

<static> window.Firebug.shutdown()
called in browser when Firefox closes and in externalMode when fbs gets quitApplicationGranted.

<static> window.Firebug.toggleBar(forceOpen:, panelName:)
Primary function to activate or minimize firebug. Used by
  1. the status bar icon click action
  2. the activation button (within Firebug.xul) click action
Parameters:
forceOpen:
don't minimize, stay open if open.
panelName:
eg 'script', to select a specific panel.

<static> window.Firebug.toggleDetachBar(forceOpen:, reopenInBrowser:)
function to switch between detached and inbrowser modes.
Parameters:
forceOpen:
should not be closed, stay open if open or open it.
reopenInBrowser:
switch from detahced to inbrowser mode.

Documentation generated by JsDoc Toolkit 2.3.0 on Sat Jan 05 2013 23:10:39 GMT+0100 (CET)