API Docs for: 0.1

Class UbuntuUI

Class defined in: core.js:27

UbuntuUI is the critical Ubuntu HTML5 framework class. You need to construct an UbuntuUI object and initialize it to have an Ubuntu HTML5 app. You then use this object to access Ubuntu HTML5 objects (and object methods) that correspond to the Ubuntu HTML5 DOM elements.

Note: The UbuntuUI object is "UI" in all API doc examples.

UbuntuUI( )
core.js:27
Example
 var UI = new UbuntuUI();
 window.onload = function () {
   UI.init();
   UI.pagestack.push('pageid');
   [...]
 };
Button button( id )
core.js:195

Gets an Ubuntu Button object

Parameters:
  • id <ID>
    • The element's id attrubute

Returns: <Button>
  • The Button with the specified id
Dialog dialog( id )
core.js:207

Gets an Ubuntu Dialog object

Parameters:
  • id <ID>
    • The element's id attrubute

Returns: <Dialog>
  • The Dialog with the specified id
Element getEl( object )
core.js:293

Gets the HTML element associated with an Ubuntu HTML5 JavaScript object

Parameters:
  • object <UbuntuObject>
    • An UbuntuUI widget object

Returns: <Element>
  • The HTML element
Header header( id )
core.js:232

Gets an Ubuntu Header object

Parameters:
  • id <ID>
    • The element's id attrubute

Returns: <Header>
  • The Header with the specified id
init( )
core.js:163

Required call that initializes the UbuntuUI object

List list( selector )
core.js:272

Gets an Ubuntu List

Parameters:
  • selector <Selector>
    • A selector that JavaScript querySelector method understands

Returns: <List>
Page page( id )
core.js:171

Gets an Ubuntu Page object

Parameters:
  • id <ID>
    • The element's id attrubute

Returns: <Page>
  • The Page with the specified id
Pagestack pagestack( )
core.js:284

Gets this UbuntuUI's single Pagestack object


Returns: <Pagestack>
  • The Pagestack
Popover popover( el, id )
core.js:219

Gets an Ubuntu Popover object

Parameters:
  • el <Element>
    • The element to which the Popover's position is relative
  • id <ID>
    • The element's id attrubute

Returns: <Popover>
  • The Popover with the specified id
Shape shape( id )
core.js:183

Gets an Ubuntu Shape object

Parameters:
  • id <ID>
    • The element's id attrubute

Returns: <Shape>
  • The Shape with the specified id
Tabs tabs( id )
core.js:244

Gets an Ubuntu Tabs object

Parameters:
  • id <ID>
    • The element's id attrubute

Returns: <Tabs>
  • The Tabs with the specified id
Toolbar toolbar( id )
core.js:260

Gets an Ubuntu Toolbar object

Parameters:
  • id <ID>
    • The element's id attrubute

Returns: <Toolbar>
  • The Toolbar with the specified id