FUEL/0.2/API: Difference between revisions

882 bytes removed ,  22 August 2007
no edit summary
(update to match reality)
No edit summary
 
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
< [[FUEL/0.2]]
< [[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>'''toolbars'''</code> is a <code>Toolbars</code>
* <code>'''activeBrowser'''</code> is a <code>Browser</code>
* <code>'''browsers'''</code> is an <code>Array<Browser></code>
* <code>'''bookmarks'''</code> is a <code>BookmarkFolder</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> (Getter/Setter)
'''Properties:'''
* <code>'''prev'''</code> is a <code>Tab</code> (Getter/Setter)
* <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>Annotations</code> ===
 
'''Properties:'''
* <code>'''current'''</code> is a <code>BrowserTab</code> (Getter/Setter)


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


=== <code>BrowserTab</code> ===
=== <code>BookmarkFolder</code> ===


'''Properties:'''
'''Properties:'''
* <code>'''window'''</code> is a <code>DOMWindow</code> (Getter)
* <code>'''title'''</code> is a <code>String</code> (Getter/Setter)
* <code>'''document'''</code> is a <code>DOMDocument</code> (Getter)
* <code>'''type'''</code> is a <code>String</code> (Getter)
* <code>'''location'''</code> is a <code>String</code> (Getter/Setter)
* <code>'''description'''</code> is a <code>String</code> (Getter/Setter)
 
* <code>'''parent'''</code> is a <code>BookmarkFolder</code> (Getter)
'''Methods:'''
* <code>'''all'''</code> is an <code>Array&lt;Bookmark|BookmarkFolder&gt;</code> (Getter)
* <code>'''select'''( Object )</code> returns <code>Array&lt;DOMElement&gt;</code>
* <code>'''annotations'''</code> is an <code>Annotations</code> (Getter)
* <code>'''close'''()</code>
* <code>'''events'''</code> is an <code>Event</code> (Getter)
 
=== <code>Bookmarks</code> ===


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


=== <code>Bookmark( Object )</code> ===
=== <code>Bookmark</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> (''livemark''|''bookmark''|''separator'') (Getter)
* <code>'''desc'''</code> is a <code>String</code> (Getter/Setter)
* <code>'''uri'''</code> is a <code>String</code> (Getter/Setter)
* <code>'''parent'''</code> is a <code>Bookmark</code> (Getter/Setter)
* <code>'''description'''</code> is a <code>String</code> (Getter/Setter)
* <code>'''type'''</code> is a <code>String</code> (''container''|''folder''|''livemark''|''bookmark'') (Getter/Setter)
* <code>'''keyword'''</code> is a <code>String</code> (Getter/Setter)
 
* <code>'''parent'''</code> is a <code>BookmarkFolder</code> (Getter)
'''Methods:'''
* <code>'''annotations'''</code> is an <code>Annotations</code> (Getter)
* <code>'''find'''( Object )</code> returns <code>Array&lt;Bookmark&gt;</code>
* <code>'''events'''</code> is an <code>Event</code> (Getter)
 
=== <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>
canmove, Confirmed users, Bureaucrats and Sysops emeriti
2,798

edits