FrameTrail API Docs

  • for FrameTrail Version: 0.8.1

    • Modules & Types

    Show:

    ResourceManager Module

    Defined in: frametrail/_shared/modules/ResourceManager/module.js:6
    Module: Shared

    I am the ResourceManager.

    I contain the business logic for managing all Resources and rendering lists of them for display.

    I am closely connected with ViewResource.

    Methods

    bytesToSize

    (
    • bytes
    )

    Defined in frametrail/_shared/modules/ResourceManager/module.js:512

    I calculate from the numeric bytesize a human readable string

    Parameters:

    Returns:

    String

    checkResourceInput

    (
    • uriValue
    • nameValue
    )

    Defined in frametrail/_shared/modules/ResourceManager/module.js:527

    I perform some client-side validations on an URI input field

    Parameters:

    Returns:

    createResource

    (
    • src
    • type
    • name
    • thumb
    )

    Defined in frametrail/_shared/modules/ResourceManager/module.js:652

    PLEASE DOCUMENT THIS.

    Parameters:

    Returns:

    r

    deleteResource

    (
    • projectID
    • resourceID
    • successCallback
    • cancelCallback
    )

    Defined in frametrail/_shared/modules/ResourceManager/module.js:679

    I delete a resource from the server.

    Parameters:

    getCompleteList

    (
    • targetElement
    )
    private

    Defined in frametrail/_shared/modules/ResourceManager/module.js:785

    I am the method choosen, when ResourceManager/renderList is called with filter set to false.

    I update the resource database and the render the result into the targetElement

    Parameters:

    getFilteredList

    (
    • targetElement
    • projectID
    • key
    • condition
    • value
    )
    private

    Defined in frametrail/_shared/modules/ResourceManager/module.js:824

    I am the method choosen, when ResourceManager/renderList is called with filter set to true.

    The server will be asked to return a list of resources, which meet the requierements specified with key, considition, value (e.g. "type" "==" "video" ). See the server docs for more details!

    Parameters:

    renderList

    (
    • targetElement
    • filter
    • projectID
    • key
    • condition
    • value
    )

    Defined in frametrail/_shared/modules/ResourceManager/module.js:714

    I render a list of thumbnails for either all resource items of the project, or a narrowed down set of them.

    The targetElement should be a <div> or likewise, and will afterwards contain the elements which were rendered from e.g. ResourceImage/renderThumb

    If filter is true, then the method will ask the server only for a list of resources which meet the key-condition-value requirements (e.g. "type" "==" "video"). See also server docs!

    Note: projectID must be set!

    Parameters:

    renderResourcePicker

    (
    • targetElement
    )

    Defined in frametrail/_shared/modules/ResourceManager/module.js:880

    I render into the targetElement, which should be a <div> or likewise, a set of thumbnails. These thumbnails are draggable in the <div id="MainContainer"> to allow drop actions into timelines or into the overlay container.

    Parameters:

    renderResult

    (
    • targetElement
    • array
    )
    private

    Defined in frametrail/_shared/modules/ResourceManager/module.js:755

    I call the .renderThumb method for all Resource data objects in the array (e.g. ResourceImage/renderThumb) and append the returned element to targetElement.

    Parameters:

    success

    ()

    Defined in frametrail/_shared/modules/ResourceManager/module.js:313

    Description

    Returns:

    updateResourceDatabase

    ()

    Defined in frametrail/_shared/modules/ResourceManager/module.js:25

    I tell the Database to reload the index data.

    uploadResource

    (
    • successCallback
    • onlyVideo
    )

    Defined in frametrail/_shared/modules/ResourceManager/module.js:55

    I open a jquery UI dialog, which allows the user to upload a new resource. When the onlyVideo parameter is set to true, I allow only uploads of videos (needed during creation of a new hypervideo)

    Parameters: