FUEL/0.2/API: Difference between revisions

From MozillaWiki
< FUEL‎ | 0.2
Jump to navigation Jump to search
(update to match reality)
No edit summary
Line 4: Line 4:


'''Properties:'''
'''Properties:'''
* <code>'''toolbars'''</code> is a <code>Toolbars</code>
* <code>'''browser'''</code> is a <code>Browser</code>
* <code>'''bookmarks'''</code> is a <code>Bookmarks</code>


'''Methods:'''
=== <code>Browser</code> ===
<div style="background:#EEE;border:1px solid #CCC;color:#888;">
* <code>'''findToolbar'''( String )</code> returns an <code>Array&lt;Toolbar&gt;</code>
* <code>'''hasToolbar'''( String|Toolbar )</code> returns a <code>Boolean</code>
* <code>'''getToolbar'''( String )</code> returns a <code>Toolbar</code>
</div>
 
=== <code>Toolbars</code> ===
 
'''Methods:'''
* <code>'''find'''( Object )</code> returns an <code>Array&lt;Toolbar&gt;</code>
* <code>'''has'''( String|Toolbar )</code> returns a <code>Boolean</code>
* <code>'''get'''( String )</code> returns a <code>Toolbar</code>
 
=== <code>Toolbar( String )</code> ===


'''Properties:'''
'''Properties:'''
* <code>'''id'''</code> is a <code>String</code>
* <code>'''tabs'''</code> is an <code>Array&lt;Tab&gt;</code>
* <code>'''creator'''</code> is an <code>Application|Extension</code>
* <code>'''widgets'''</code> is an <code>Array&lt;Widget&gt;</code>
* <code>'''events'''</code> is an <code>Events</code>
* <code>'''events'''</code> is an <code>Events</code>
* <code>'''prefs'''</code> is a <code>Preferences</code>
* <code>'''activeTab'''</code> is a <code>Tab</code>


'''Methods:'''
'''Methods:'''
* <code>'''has'''( String|Widget )</code> returns a <code>Boolean</code>
* <code>'''insertBefore'''( Tab, Tab )</code>
* <code>'''get'''( String )</code> returns a <code>Widget</code>
* <code>'''append'''( Tab )</code>
* <code>'''insert'''( Widget, Widget )</code>
* <code>'''open'''( String )</code> returns a <code>Tab</code>
* <code>'''append'''( Widget )</code>
<div style="background:#EEE;border:1px solid #CCC;color:#888;">
* <code>'''addEvent'''( String, Function )</code>
* <code>'''removeEvent'''( String, Function )</code>
* <code>'''hasPref'''( String )</code> returns a <code>Boolean</code>
* <code>'''getPref'''( String, Object )</code> returns an <code>Object</code>
* <code>'''setPref'''( String, Object )</code>
</div>


=== <code>Widget</code> ===
=== <code>Tab</code> ===


'''Properties:'''
'''Properties:'''
* <code>'''id'''</code> is a <code>String</code>
* <code>'''browser'''</code> is a <code>Browser</code>
* <code>'''creator'''</code> returns a <code>Application|Extension</code>
* <code>'''events'''</code> is an <code>Events</code>
* <code>'''container'''</code> returns a <code>Toolbar</code>
* <code>'''document'''</code> is a <code>DOMDocument</code>
 
* <code>'''window'''</code> is a <code>DOMWindow</code>
=== <code>ToolbarButton( String )</code> inherits from <code>Widget</code> ===
* <code>'''active'''</code> is a <code>Boolean</code>
 
* <code>'''next'''</code> is a <code>Tab</code>
'''Properties:'''
* <code>'''prev'''</code> is a <code>Tab</code>
* <code>'''id'''</code> is a <code>String</code>
* <code>'''url'''</code> is a <code>String</code> (Getter/Setter)
* <code>'''creator'''</code> returns a <code>Application|Extension</code>
* <code>'''index'''</code> is a <code>Number</code> (Getter/Setter)
* <code>'''container'''</code> returns a <code>Toolbar</code>
 
=== <code>Extension( String )</code> ===
 
'''Properties:'''
* <code>'''toolbars'''</code> is a <code>Toolbars</code>
* <code>'''widgets'''</code> is an <code>Array&lt;Widget&gt;</code>


'''Methods:'''
'''Methods:'''
<div style="background:#EEE;border:1px solid #CCC;color:#888;">
* <code>'''query'''( String )</code> returns an <code>Array&lt;DOMElement&gt;</code>
</div>
* <code>'''focus'''()</code>
* <code>'''close'''()</code>


=== <code>Browser</code> ===
=== <code>Bookmarks</code> ===
 
'''Properties:'''
* <code>'''current'''</code> is a <code>BrowserTab</code> (Getter/Setter)
 
'''Methods:'''
* <code>'''find'''( Object )</code> returns <code>Array&lt;BrowserTab&gt;</code>
* <code>'''open'''( String )</code>
* <code>'''add'''( BrowserTab )</code>
* <code>'''remove'''( BrowserTab )</code>
 
=== <code>BrowserTab</code> ===


'''Properties:'''
'''Properties:'''
* <code>'''window'''</code> is a <code>DOMWindow</code> (Getter)
* <code>'''all'''</code> is an <code>Array&lt;Bookmark&gt;</code>
* <code>'''document'''</code> is a <code>DOMDocument</code> (Getter)
* <code>'''location'''</code> is a <code>String</code> (Getter/Setter)


'''Methods:'''
'''Methods:'''
* <code>'''select'''( Object )</code> returns <code>Array&lt;DOMElement&gt;</code>
* <code>'''close'''()</code>
=== <code>Bookmarks</code> ===
'''Methods:'''
* <code>'''find'''( Object )</code> returns <code>Array&lt;Bookmark&gt;</code>
* <code>'''add'''( Bookmark )</code>
* <code>'''add'''( Bookmark )</code>
* <code>'''remove'''( Bookmark )</code>
* <code>'''remove'''( Bookmark )</code>
Line 103: Line 54:
* <code>'''parent'''</code> is a <code>Bookmark</code> (Getter/Setter)
* <code>'''parent'''</code> is a <code>Bookmark</code> (Getter/Setter)
* <code>'''type'''</code> is a <code>String</code> (''container''|''folder''|''livemark''|''bookmark'') (Getter/Setter)
* <code>'''type'''</code> is a <code>String</code> (''container''|''folder''|''livemark''|''bookmark'') (Getter/Setter)
 
* <code>'''all'''</code> is an <code>Array&lt;Bookmark&gt;</code>
'''Methods:'''
* <code>'''find'''( Object )</code> returns <code>Array&lt;Bookmark&gt;</code>


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

Revision as of 17:24, 10 May 2007

< FUEL/0.2

Application

Properties:

  • browser is a Browser
  • bookmarks is a Bookmarks

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()

Bookmarks

Properties:

  • all is an Array<Bookmark>

Methods:

  • add( Bookmark )
  • remove( Bookmark )

Bookmark( Object )

Properties:

  • title is a String (Getter/Setter)
  • url is a String (Getter/Setter)
  • desc is a String (Getter/Setter)
  • parent is a Bookmark (Getter/Setter)
  • type is a String (container|folder|livemark|bookmark) (Getter/Setter)
  • all is an Array<Bookmark>

Database( String )

Methods:

  • prepare( String ) returns a DatabaseQuery

DatabaseQuery

Methods:

  • execute( Object, ..., ObjectN )
  • hasNext() returns a Boolean
  • next() returns an Object
Retrieved from "https://wiki.mozilla.org/index.php?title=FUEL/0.2/API&oldid=56467"