FUEL/0.2/API

From MozillaWiki
< FUEL‎ | 0.2
Jump to: navigation, search

< FUEL/0.2

Official FUEL documentation is here, on Mozilla Developer Center

Application

Properties:

  • activeBrowser is a Browser
  • browsers is an Array<Browser>
  • bookmarks is a BookmarkFolder

Browser

Properties:

  • tabs is an Array<Tab>
  • events is an Events
  • activeTab is a Tab

Methods:

  • insertBefore( Tab, Tab )
  • append( Tab )
  • open( String ) returns a Tab

Tab

Properties:

  • browser is a Browser
  • events is an Events
  • document is a DOMDocument
  • window is a DOMWindow
  • active is a Boolean
  • next is a Tab (Getter/Setter)
  • prev is a Tab (Getter/Setter)
  • url is a String (Getter/Setter)
  • index is a Number (Getter/Setter)

Methods:

  • query( String ) returns an Array<DOMElement>
  • focus()
  • close()

Annotations

Methods:

  • has( String ) returns boolean
  • get( String ) returns value of annotation (string, boolean or number)
  • set( String, String, Integer ) sets value of annotation
  • remove( String ) removes the named annotation

BookmarkFolder

Properties:

  • title is a String (Getter/Setter)
  • type is a String (Getter)
  • description is a String (Getter/Setter)
  • parent is a BookmarkFolder (Getter)
  • all is an Array<Bookmark|BookmarkFolder> (Getter)
  • annotations is an Annotations (Getter)
  • events is an Event (Getter)

Methods:

  • addBookmark( String, String ) returns a Bookmark
  • addLivemark( String, String ) returns a Bookmark
  • addFolder( String ) returns a BookmarkFolder
  • remove() removes this folder

Bookmark

Properties:

  • title is a String (Getter/Setter)
  • type is a String (livemark|bookmark|separator) (Getter)
  • uri is a String (Getter/Setter)
  • description is a String (Getter/Setter)
  • keyword is a String (Getter/Setter)
  • parent is a BookmarkFolder (Getter)
  • annotations is an Annotations (Getter)
  • events is an Event (Getter)

Methods:

  • remove()