KUMobile

API Docs for: 0.0.2

KUMobile.Library

Module: KUMobile

Contains all library related functions for loading and controlling the library page.

loadNextPage

()

Loads and displays the next set of library items.

Example:

KUMobile.Library.loadNextPage();

reinitialize

()

Reinitializes all properties of KUMobile.Library as if to restore a new/default instance.

Example:

KUMobile.Library.reinitialize();

lastValue

string

Represents the last value the user has searched for in the library

Default: ""

listQueue

Array private

Contains the current list of article DOM

  • tag items that still need to be added to the DOM (much faster to add all at once after load is done downloading). This helps prevent the application from seeming to hang or become unresponsive.

  • LOAD_THRESHOLD_PX

    int

    Designates the minimum number of pixels that the user can scroll (calculated from the bottom) before another load event is triggered.

    Default: 660

    loading

    boolean

    Is the library page loading?

    Default: false

    page

    int

    Current page number as referenced from the library website.

    Default: 0

    reachedEnd

    boolean

    Tells whether or not the user has reached the end of the scrolling.

    Default: false

    sentTimeout

    Object private

    Contains the last timeout call sent. This allows us to restart the timeout if the user re-searches in any way (dropdown, or searchbar). The major benefit of this is that it gives us the feeling of incremental searching, e.g we send a timeout of some milliseconds whenever the KEY_UP event triggers, as well as cancelling out the last timeout we sent.

    type

    string

    Type of searching for Kettering's library. Represents the method of searching that will be used by the system.

    Default: "GENERAL^SUBJECT^GENERAL^^words or phrase"

    typing

    boolean

    Is the user currently typing?

    Default: false

    categoryChange

    Triggered when the user does a change to the category drop down box. When this happens, we generally need to redo the search.

    directSearch

    Triggered when the user does a direct change. The direct change includes typing then changing focus or pressing the clear button. This is redundant to the incremental search event, except for the clear button!!

    incrementalSearch

    Triggered when the user does a key up event in order to simulate incremental searching for the attached search bar.

    pageCreate

    Triggered when the library page is first created based on jQuery Mobile pagecreate event. This is called after the page itself is created but before any jQuery Mobile styling is applied.

    pageInit

    Triggered when the library page is first initialized based on jQuery Mobile pageinit event. This is called after the page itself is created and initialized, therefore it is proper to do the event bindings here.

    scroll

    Triggered when regular scroll event happens in library scroller window. It is used to check if the user is near the bottom of the page, so more content can be loaded (simulate infinite scrolling).