FrameTrail API Docs

  • for FrameTrail Version: 0.8.1

    • Modules & Types

    Show:

    Titlebar Module

    Defined in: frametrail/player/modules/Titlebar/module.js:6
    Module: Player

    I am the Titlebar. I provide a place for a title text, and for two buttons (opening the Sidebar and – YET TO IMPLEMENT – the social sharing widgets).

    Methods

    changeUserLogin

    (
    • loggedIn
    )

    Defined in frametrail/player/modules/Titlebar/module.js:132

    I react to a change in the global state "loggedIn"

    Parameters:

    create

    ()

    Defined in frametrail/player/modules/Titlebar/module.js:50

    I am called from Interface/create().

    I set up my interface elements.

    toggleEditMode

    (
    • editMode
    • oldEditMode
    )

    Defined in frametrail/player/modules/Titlebar/module.js:111

    I react to a change in the global state "editMode"

    Parameters:

    toggleSidebarOpen

    (
    • opened
    )

    Defined in frametrail/player/modules/Titlebar/module.js:72

    I make changes to my CSS, when the global state "sidebarOpen" changes.

    Parameters:

    toogleUnsavedChanges

    (
    • aBoolean
    )

    Defined in frametrail/player/modules/Titlebar/module.js:95

    I make changes to my CSS, when the global state "unsavedChanges" changes.

    Parameters:

    Attributes

    height

    Number readonly

    Defined in frametrail/player/modules/Titlebar/module.js:174

    I am the height of the title bar in pixel.

    title

    String

    Defined in frametrail/player/modules/Titlebar/module.js:164

    I am the text, which should be shown in the title bar.