FUEL/0.2/API: Difference between revisions

From MozillaWiki
< FUEL‎ | 0.2
Jump to navigation Jump to search
No edit summary
No edit summary
 
(13 intermediate revisions by 3 users not shown)
Line 1: Line 1:
< [[FUEL/0.2]]
__NOTOC__
__NOTOC__
<div class="note">Official FUEL documentation is [http://developer.mozilla.org/en/docs/FUEL here], on [http://developer.mozilla.org Mozilla Developer Center]</div>
=== <code>Application</code> ===
=== <code>Application</code> ===


'''Properties:'''
'''Properties:'''
* <code>'''storage'''</code> is a <code>SessionStorage</code>
* <code>'''activeBrowser'''</code> is a <code>Browser</code>
 
* <code>'''browsers'''</code> is an <code>Array<Browser></code>
'''Methods:'''
* <code>'''bookmarks'''</code> is a <code>BookmarkFolder</code>
<div style="background:#EEE;border:1px solid #CCC;color:#888;">
* <code>'''hasStore'''( String )</code> returns a <code>Boolean</code>
* <code>'''getStore'''( String )</code> returns an <code>String</code>
* <code>'''setStore'''( String, String )</code>
</div>


=== <code>Extension( String )</code> ===
=== <code>Browser</code> ===


'''Properties:'''
'''Properties:'''
* <code>'''storage'''</code> is a <code>SessionStorage</code>
* <code>'''tabs'''</code> is an <code>Array&lt;Tab&gt;</code>
* <code>'''events'''</code> is an <code>Events</code>
* <code>'''activeTab'''</code> is a <code>Tab</code>


'''Methods:'''
'''Methods:'''
<div style="background:#EEE;border:1px solid #CCC;color:#888;">
* <code>'''insertBefore'''( Tab, Tab )</code>
* <code>'''hasStore'''( String )</code> returns a <code>Boolean</code>
* <code>'''append'''( Tab )</code>
* <code>'''getStore'''( String )</code> returns an <code>String</code>
* <code>'''open'''( String )</code> returns a <code>Tab</code>
* <code>'''setStore'''( String, String )</code>
</div>


=== <code>SessionStorage</code> ===
=== <code>Tab</code> ===
 
'''Properties:'''
* <code>'''browser'''</code> is a <code>Browser</code>
* <code>'''events'''</code> is an <code>Events</code>
* <code>'''document'''</code> is a <code>DOMDocument</code>
* <code>'''window'''</code> is a <code>DOMWindow</code>
* <code>'''active'''</code> is a <code>Boolean</code>
* <code>'''next'''</code> is a <code>Tab</code> (Getter/Setter)
* <code>'''prev'''</code> is a <code>Tab</code> (Getter/Setter)
* <code>'''url'''</code> is a <code>String</code> (Getter/Setter)
* <code>'''index'''</code> is a <code>Number</code> (Getter/Setter)


'''Methods:'''
'''Methods:'''
* <code>'''has'''( String )</code> returns a <code>Boolean</code>
* <code>'''query'''( String )</code> returns an <code>Array&lt;DOMElement&gt;</code>
* <code>'''get'''( String )</code> returns an <code>String</code>
* <code>'''focus'''()</code>
* <code>'''set'''( String, String )</code>
* <code>'''close'''()</code>


=== <code>Bookmarks</code> ===
=== <code>Annotations</code> ===


'''Methods:'''
'''Methods:'''
* <code>'''find'''( Object )</code> returns <code>Array&lt;Bookmark&gt;</code>
* <code>'''has'''( String )</code> returns boolean
* <code>'''add'''( Bookmark )</code>
* <code>'''get'''( String )</code> returns value of annotation (string, boolean or number)
* <code>'''remove'''( Bookmark )</code>
* <code>'''set'''( String, String, Integer )</code> sets value of annotation
* <code>'''remove'''( String )</code> removes the named annotation


=== <code>Bookmark( Object )</code> ===
=== <code>BookmarkFolder</code> ===


'''Properties:'''
'''Properties:'''
* <code>'''title'''</code> is a <code>String</code> (Getter/Setter)
* <code>'''title'''</code> is a <code>String</code> (Getter/Setter)
* <code>'''url'''</code> is a <code>String</code> (Getter/Setter)
* <code>'''type'''</code> is a <code>String</code> (Getter)
* <code>'''desc'''</code> is a <code>String</code> (Getter/Setter)
* <code>'''description'''</code> is a <code>String</code> (Getter/Setter)
* <code>'''parent'''</code> is a <code>Bookmark</code> (Getter/Setter)
* <code>'''parent'''</code> is a <code>BookmarkFolder</code> (Getter)
* <code>'''type'''</code> is a <code>String</code> (''container''|''folder''|''livemark''|''bookmark'') (Getter/Setter)
* <code>'''all'''</code> is an <code>Array&lt;Bookmark|BookmarkFolder&gt;</code> (Getter)
* <code>'''annotations'''</code> is an <code>Annotations</code> (Getter)
* <code>'''events'''</code> is an <code>Event</code> (Getter)


'''Methods:'''
'''Methods:'''
* <code>'''find'''( Object )</code> returns <code>Array&lt;Bookmark&gt;</code>
* <code>'''addBookmark'''( String, String )</code> returns a <code>Bookmark</code>
* <code>'''addLivemark'''( String, String )</code> returns a <code>Bookmark</code>
* <code>'''addFolder'''( String )</code> returns a <code>BookmarkFolder</code>
* <code>'''remove'''()</code> removes this folder


=== <code>Database( String )</code> ===
=== <code>Bookmark</code> ===


'''Methods:'''
'''Properties:'''
* <code>'''prepare'''( String )</code> returns a <code>DatabaseQuery</code>
* <code>'''title'''</code> is a <code>String</code> (Getter/Setter)
 
* <code>'''type'''</code> is a <code>String</code> (''livemark''|''bookmark''|''separator'') (Getter)
=== <code>DatabaseQuery</code> ===
* <code>'''uri'''</code> is a <code>String</code> (Getter/Setter)
* <code>'''description'''</code> is a <code>String</code> (Getter/Setter)
* <code>'''keyword'''</code> is a <code>String</code> (Getter/Setter)
* <code>'''parent'''</code> is a <code>BookmarkFolder</code> (Getter)
* <code>'''annotations'''</code> is an <code>Annotations</code> (Getter)
* <code>'''events'''</code> is an <code>Event</code> (Getter)


'''Methods:'''
'''Methods:'''
* <code>'''execute'''( Object, ..., ObjectN )</code>
* <code>'''remove'''()</code>
* <code>'''hasNext'''()</code> returns a <code>Boolean</code>
* <code>'''next'''()</code> returns an <code>Object</code>

Latest revision as of 02:20, 22 August 2007

< 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()
Retrieved from "https://wiki.allizom.org/index.php?title=FUEL/0.2/API&oldid=66030"