FUEL/0.2/API: Difference between revisions

From MozillaWiki
< FUEL‎ | 0.2
Jump to navigation Jump to search
No edit summary
(Updated the Bookmark API and removed the Database API.)
Line 5: Line 5:
'''Properties:'''
'''Properties:'''
* <code>'''browser'''</code> is a <code>Browser</code>
* <code>'''browser'''</code> is a <code>Browser</code>
* <code>'''bookmarks'''</code> is a <code>Bookmarks</code>
* <code>'''bookmarks'''</code> is a <code>BookmarkFolder</code>


=== <code>Browser</code> ===
=== <code>Browser</code> ===
Line 37: Line 37:
* <code>'''close'''()</code>
* <code>'''close'''()</code>


=== <code>Bookmarks</code> ===
=== <code>BookmarkFolder</code> ===


'''Properties:'''
'''Properties:'''
* <code>'''all'''</code> is an <code>Array&lt;Bookmark&gt;</code>
* <code>'''title'''</code> is a <code>String</code> (Getter/Setter)
* <code>'''desc'''</code> is a <code>String</code> (Getter/Setter)
* <code>'''parent'''</code> is a <code>BookmarkFolder</code> (Getter)
* <code>'''all'''</code> is an <code>Array&lt;Bookmark|BookmarkFolder&gt;</code> (Getter)


'''Methods:'''
'''Methods:'''
* <code>'''add'''( Bookmark )</code>
* <code>'''add'''( String, String ) returns a <code>Bookmark</code></code>
* <code>'''remove'''( Bookmark )</code>
* <code>'''addlive'''( String, String ) returns a <code>Bookmark</code></code>
* <code>'''addfolder'''( String ) returns a <code>BookmarkFolder</code></code>


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


'''Properties:'''
'''Properties:'''
Line 52: Line 56:
* <code>'''url'''</code> is a <code>String</code> (Getter/Setter)
* <code>'''url'''</code> is a <code>String</code> (Getter/Setter)
* <code>'''desc'''</code> is a <code>String</code> (Getter/Setter)
* <code>'''desc'''</code> is a <code>String</code> (Getter/Setter)
* <code>'''parent'''</code> is a <code>Bookmark</code> (Getter/Setter)
* <code>'''type'''</code> is a <code>String</code> (''livemark''|''bookmark'') (Getter)
* <code>'''type'''</code> is a <code>String</code> (''container''|''folder''|''livemark''|''bookmark'') (Getter/Setter)
* <code>'''parent'''</code> is a <code>BookmarkFolder</code> (Getter)
* <code>'''all'''</code> is an <code>Array&lt;Bookmark&gt;</code>
 
=== <code>Database( String )</code> ===
 
'''Methods:'''
* <code>'''prepare'''( String )</code> returns a <code>DatabaseQuery</code>
 
=== <code>DatabaseQuery</code> ===


'''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>

Revision as of 00:14, 11 May 2007

< FUEL/0.2

Application

Properties:

  • browser is a 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
  • prev is a Tab
  • url is a String (Getter/Setter)
  • index is a Number (Getter/Setter)

Methods:

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

BookmarkFolder

Properties:

  • title is a String (Getter/Setter)
  • desc is a String (Getter/Setter)
  • parent is a BookmarkFolder (Getter)
  • all is an Array<Bookmark|BookmarkFolder> (Getter)

Methods:

  • add( String, String ) returns a Bookmark
  • addlive( String, String ) returns a Bookmark
  • addfolder( String ) returns a BookmarkFolder

Bookmark()

Properties:

  • title is a String (Getter/Setter)
  • url is a String (Getter/Setter)
  • desc is a String (Getter/Setter)
  • type is a String (livemark|bookmark) (Getter)
  • parent is a BookmarkFolder (Getter)

Methods:

  • remove()
Retrieved from "https://wiki.mozilla.org/index.php?title=FUEL/0.2/API&oldid=56509"