FUEL/0.1/API: Difference between revisions

From MozillaWiki
< FUEL‎ | 0.1
Jump to navigation Jump to search
No edit summary
Line 11: Line 11:
'''Methods:'''
'''Methods:'''
<div style="background:#EEE;border:1px solid #CCC;color:#888;">
<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>'''hasToolbar'''( String|Toolbar )</code> returns a <code>Boolean</code>
* <code>'''getToolbar'''( String )</code> returns a <code>Toolbar</code>
* <code>'''getToolbar'''( String )</code> returns a <code>Toolbar</code>
* <code>'''insertToolbar'''( Toolbar, Toolbar )</code>
* <code>'''appendToolbar'''( Toolbar )</code>
* <code>'''addExtension'''( Extension )</code>
* <code>'''addExtension'''( Extension )</code>
* <code>'''removeExtension'''( Extension )</code>
* <code>'''removeExtension'''( Extension )</code>
Line 36: Line 35:
* <code>'''has'''( String|Toolbar )</code> returns a <code>Boolean</code>
* <code>'''has'''( String|Toolbar )</code> returns a <code>Boolean</code>
* <code>'''get'''( String )</code> returns a <code>Toolbar</code>
* <code>'''get'''( String )</code> returns a <code>Toolbar</code>
* <code>'''insert'''( Toolbar, Toolbar )</code>
* <code>'''append'''( Toolbar )</code>


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

Revision as of 22:37, 12 January 2007

< FUEL/0.1

Application

Properties:

  • toolbars is a Toolbars
  • extensions is an Extensions
  • events is an Events
  • prefs is a Preferences

Methods:

  • findToolbar( String ) returns an Array<Toolbar>
  • hasToolbar( String|Toolbar ) returns a Boolean
  • getToolbar( String ) returns a Toolbar
  • addExtension( Extension )
  • removeExtension( Extension )
  • addEvent( String, Function )
  • removeEvent( String, Function )
  • hasPref( String ) returns a Boolean
  • getPref( String, Object ) returns an Object
  • setPref( String, Object )

Events

Methods:

  • add( String, Function )
  • remove( String, Function )

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

Extensions

Methods:

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

Extension( String )

Properties:

  • id is a String [readonly]
  • name is a String [readonly]
  • toolbars is a Toolbars
  • widgets is an Array<Widget>
  • events is a Events
  • prefs is a Preferences

Methods:

  • addEvent( String, Function )
  • removeEvent( String, Function )
  • hasPref( String ) returns a Boolean
  • getPref( String, Object ) returns an Object
  • setPref( String, Object )

Preferences

Properties:

  • events is an Events

Methods:

  • find( Object ) returns an Array<Object>
  • has( String ) returns a Boolean
  • get( String, Object ) returns an Object
  • set( String, Object )
  • reset( String )
  • addEvent( String, Function )
  • removeEvent( String, Function )