FUEL/0.2/API: Difference between revisions

From MozillaWiki
< FUEL‎ | 0.2
Jump to navigation Jump to search
(update to match reality)
(update to match reality)
Line 13: Line 13:
</div>
</div>


=== <code>Extension( String )</code> ===
=== <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>'''storage'''</code> is a <code>SessionStorage</code>
* <code>'''id'''</code> is a <code>String</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>'''prefs'''</code> is a <code>Preferences</code>


'''Methods:'''
'''Methods:'''
* <code>'''has'''( String|Widget )</code> returns a <code>Boolean</code>
* <code>'''get'''( String )</code> returns a <code>Widget</code>
* <code>'''insert'''( Widget, Widget )</code>
* <code>'''append'''( Widget )</code>
<div style="background:#EEE;border:1px solid #CCC;color:#888;">
<div style="background:#EEE;border:1px solid #CCC;color:#888;">
* <code>'''hasStore'''( String )</code> returns a <code>Boolean</code>
* <code>'''addEvent'''( String, Function )</code>
* <code>'''getStore'''( String )</code> returns an <code>String</code>
* <code>'''removeEvent'''( String, Function )</code>
* <code>'''setStore'''( String, String )</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>
</div>


=== <code>SessionStorage</code> ===
=== <code>Widget</code> ===
 
'''Properties:'''
* <code>'''id'''</code> is a <code>String</code>
* <code>'''creator'''</code> returns a <code>Application|Extension</code>
* <code>'''container'''</code> returns a <code>Toolbar</code>
 
=== <code>ToolbarButton( String )</code> inherits from <code>Widget</code> ===
 
'''Properties:'''
* <code>'''id'''</code> is a <code>String</code>
* <code>'''creator'''</code> returns a <code>Application|Extension</code>
* <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:'''
* <code>'''has'''( String )</code> returns a <code>Boolean</code>
<div style="background:#EEE;border:1px solid #CCC;color:#888;">
* <code>'''get'''( String )</code> returns an <code>String</code>
</div>
* <code>'''set'''( String, String )</code>


=== <code>Browser</code> ===
=== <code>Browser</code> ===

Revision as of 17:39, 6 February 2007

< FUEL/0.2

Application

Properties:

  • toolbars is a Toolbars

Methods:

  • findToolbar( String ) returns an Array<Toolbar>
  • hasToolbar( String|Toolbar ) returns a Boolean
  • getToolbar( String ) returns a Toolbar

Toolbars

Methods:

  • find( Object ) returns an Array<Toolbar>
  • has( String|Toolbar ) returns a Boolean
  • get( String ) returns a Toolbar

Toolbar( String )

Properties:

  • id is a String
  • creator is an Application|Extension
  • widgets is an Array<Widget>
  • events is an Events
  • prefs is a Preferences

Methods:

  • has( String|Widget ) returns a Boolean
  • get( String ) returns a Widget
  • insert( Widget, Widget )
  • append( Widget )
  • addEvent( String, Function )
  • removeEvent( String, Function )
  • hasPref( String ) returns a Boolean
  • getPref( String, Object ) returns an Object
  • setPref( String, Object )

Widget

Properties:

  • id is a String
  • creator returns a Application|Extension
  • container returns a Toolbar

ToolbarButton( String ) inherits from Widget

Properties:

  • id is a String
  • creator returns a Application|Extension
  • container returns a Toolbar

Extension( String )

Properties:

  • toolbars is a Toolbars
  • widgets is an Array<Widget>

Methods:

Browser

Properties:

  • current is a BrowserTab (Getter/Setter)

Methods:

  • find( Object ) returns Array<BrowserTab>
  • open( String )
  • add( BrowserTab )
  • remove( BrowserTab )

BrowserTab

Properties:

  • window is a DOMWindow (Getter)
  • document is a DOMDocument (Getter)
  • location is a String (Getter/Setter)

Methods:

  • select( Object ) returns Array<DOMElement>
  • close()

Bookmarks

Methods:

  • find( Object ) returns Array<Bookmark>
  • 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)

Methods:

  • find( Object ) returns Array<Bookmark>

Database( String )

Methods:

  • prepare( String ) returns a DatabaseQuery

DatabaseQuery

Methods:

  • execute( Object, ..., ObjectN )
  • hasNext() returns a Boolean
  • next() returns an Object