documentation

Documentation generator: JsDoc Toolkit 2.4.0
Template: Wink 1.0
Generated on:

File Index

  • mask.js

    Implements a mask (a layer above a given element)
    Author:
    Jerome GIRAUD
  • menu.js

    Displays an iPhone-like popup menu
    Author:
    Frédéric MOULIS
  • cube.js

    Implements a Cube. The Cube allows to display a cube shape and to interact with it. The cube faces are nodes builded and managed by the user, so the user can integrate various contents. The size, the position and the rotation axis are parameters that make the cube to be configurable.
    Author:
    Sylvain LALANDE
  • newsticker.js

    Implement a news-ticker container
    Author:
    Jerome GIRAUD
  • matrix.js

    math matrix library - a wink.math extension.
    Author:
    Sylvain LALANDE
  • progressbar.js

    Implement a progress bar
    Author:
    Jerome GIRAUD
  • opener.js

    Implements an image opener. Creates an "image opener" with a 3D rendering
    Author:
    Jerome GIRAUD
  • flipdisc.js

    The Flip Disc allows the user to browse a list of images. The user can rotate the first image to display the next or previous image, following the angle of rotation.
    Author:
    Sylvain LALANDE
  • wall.js

    Creates a 3D wall (3 rows of images) Displays a 3D wall on the screen. The wall is composed of 3 rows of images. The wall is being moved with its right and left directional arrows
    Author:
    Jerome GIRAUD
  • popup.js

    Implements a popup component
    Author:
    Frédéric MOULIS, JF CUNAT, Sylvain LALANDE
  • spinner.js

    Implement a spinner
    Author:
    Frederic MOULIS
  • slideshow.js

    Implements a slideshow based on the html canvas tag.
    Author:
    Sylvain LALANDE
  • togglebutton.js

    Implements a toggle button
    Author:
    Frédéric MOULIS
  • dnd.js

    Implements a Drag and Drop management systems. It is based on a dnd object which will handle sources and targets. Sources are objects that can be moved over the page. Each source MUST define its own behaviour on the user drag (e.g.: creation of an avatar) Targets are objects that can react when particular sources are dropped over them (it defines its own events). A target MUST also define what will be its behaviour when a source is over it or not. When a source is dropped on a target, the dnd object fires the event defined by the target.
    Author:
    Jerome GIRAUD
  • json.js

    JSON utility
    Author:
    Jerome GIRAUD
  • feat_css.js

    css features detection.
    Author:
    Sylvain LALANDE
  • feat_dom.js

    dom features detection.
    Author:
    Sylvain LALANDE
  • window.js

    Implements the window component that captures resize and scroll events and warns listeners of changes. It Handles these properties: screenWidth, screenHeight, fullWidth, fullHeight, width, height, orientation
    Author:
    Sylvain LALANDE
  • scrolltorefresh.js

    Enables to trigger a refresh state, using a scroller, at the top or the bottom of the content.
    Author:
    Sylvain LALANDE
  • scrolltoload.js

    A plugin that allows to manage the expansion of the content during the scroll.
    Author:
    Sylvain LALANDE
  • feat.js

    The wink feature detection provider.
    Author:
    Sylvain LALANDE
  • audioplayer.js

    Implements an audio player
    Author:
    Jerome GIRAUD
  • gesturerecognizer.js

    Implements a 2D Gesture recognition engine. Gesture recognition engine based on the $1 gesture recognition algorithm (Wobbrock, J.O., Wilson, A.D. and Li, Y. (2007). Gestures without libraries, toolkits or training: A $1 recognizer for user interface prototypes. Proceedings of the ACM Symposium on User Interface Software and Technology (UIST '07). Newport, Rhode Island (October 7-10, 2007). New York: ACM Press, pp. 159-168.). The user can define its own recognition templates (a template generator has been included in the test directory that will allow ou to generate the templates from a mobile device)
    Author:
    Jerome GIRAUD
  • gesture.js

    Implements a Gesture management system. Determines whether some gestures (with exactly 2 fingers) are performed on the nodes and if so, inform the listeners. Gestures that can be listened are referenced in the "_knownGestures" attribute below. The notifications to the listeners include parameters that depends on gesture type.
    Author:
    Sylvain LALANDE
  • topics.js

    Implements an event management system based on a publish/subscribe mechanism
    Author:
    Jerome GIRAUD
  • event.js

    The Event object is an encapsulation of an event. Only the touch object has to create such events. It can thus be seen as an only readable object.
    Author:
    Sylvain LALANDE
  • coverflow.js

    Implements a Cover Flow. The Cover Flow allows the user to browse a list of items ; each item consisting of an image, and perhaps a title, a rear face or an action to invoke when it is selected. It is developed to be as flexible and configurable as possible, so the user can enable or disable some graphical options to adapt visual rendering. The user must pay attention to the fact that the parameters significantly affect performance (number of covers, reflected and displayTitle especially). Developed to be as flexible and configurable as possible.
    Author:
    Sylvain LALANDE
  • trace.js

    Implements a tracer that allows to erase the trace after a specified time.
    Author:
    Sylvain LALANDE
  • inertia.js

    The Inertia component provides, through collaboration with a Movement Tracker, datas calculated from the inertia of a movement.
    Author:
    Sylvain LALANDE
  • amd.js

    Wink AMD loader
    Author:
    Jerome GIRAUD
  • ua.js

    Object providing a layer of abstraction with all specifics related to the platform hosting the code.
    Author:
    Sylvain LALANDE
  • feat_audio.js

    audio features detection.
    Author:
    Sylvain LALANDE
  • gearsdb.js

    Implements the database management methods for the Iphone
    Author:
    Jerome GIRAUD
  • safaridb.js

    Implements the database management methods for the Iphone
    Author:
    Jerome GIRAUD
  • storage.js

    Implements a access layer to the local storage mechanism. Must be used with a DB plugin (e.g.: SafariDB, GearsDB...)
    Author:
    Jerome GIRAUD
  • animation.js

    The animation utilities
    Author:
    Sylvain LALANDE
  • 2dfx.js

    Object providing a layer of abstraction with all specifics related to the css rules.
    Author:
    Sylvain LALANDE
  • feat_event.js

    event features detection.
    Author:
    Sylvain LALANDE
  • 3dfx.js

    The 3d fx object is an extension of wink.fx (2d fx) that allows more advanced transformations (e.g.: simple or composed 3d transformations). Because a change of scale followed by a translation does not give the same result if you reverse the two transformations, the main role is to simplify the implementation of composed transformations, it is made by using a user-defined order.
    Author:
    Sylvain LALANDE
  • feat_graphic.js

    graphic features detection.
    Author:
    Sylvain LALANDE
  • sharingwheel.js

    A plugin to display a wheel that can be used to share items
    Author:
    Jerome GIRAUD
  • feat_json.js

    json features detection.
    Author:
    Sylvain LALANDE
  • asyncpanels.js

    A plugin to asynchroneously load contents with the sliding panels
    Author:
    Jerome GIRAUD
  • feat_video.js

    video features detection.
    Author:
    Sylvain LALANDE
  • error.js

    Implements an error management system
    Author:
    Jerome GIRAUD
  • tagcloud.js

    Implements a Tag Cloud. The tag cloud is a generic name for a graphical representation of a set of objects defined by user : the tags. The representation takes the form of a sphere or a circle in 3D. Each tag is an object containing at least one identifier of a node (the view) and a rating (how can impact be displayed). The user can interact with the tag cloud rotating it around one or more axes, the depth and the rating has an impact when the size of the tag and makes the visual effect expected.
    Author:
    Sylvain LALANDE
  • kernel.js

    Definition of the wink object to use in conjunction with an AMD loader
    Author:
    Jerome GIRAUD
  • mediawheel.js

    Implements a media wheel
    Author:
    Sylvain LALANDE
  • videoplayer.js

    Implements a video player
    Author:
    Jerome GIRAUD
  • dom.js

    Deprecated HTML Elements extensions
    Author:
    Sylvain LALANDE
  • wink.cache.js

    This is the 'easy caching' mechanism of wink. It gives you the possibility to load and store your CSS and JS resources into the device's local database. It can be used at the page startup or afterwards
    Author:
    Julien VAN DEN BOSSCHE, Jerome GIRAUD, Sylvain LALANDE
  • cssloader.js

    Implement a stylesheet loader utility. You can preload stylesheets using the load method.
    Author:
    Jerome GIRAUD
  • history.js

    Browser history management. Handle the 'back' and 'forward' buttons of the browser by checking the URL hash changes. User can add new elements to the history and be notified when the user clicks on the 'back' or 'forward' buttons.
    Author:
    Jerome GIRAUD
  • imagesloader.js

    Implement an image loader utility
    Author:
    Jerome GIRAUD
  • search.js

    The Search object allows you to process searches in an HTML document and browse search results.
    Author:
    Frédéric MOULIS
  • jsloader.js

    Implement a script loader utility
    Author:
    Jerome GIRAUD
  • movementtracker.js

    Implements a Movement Tracker. The Movement Tracker follows the touch movement performed on a node. It listens to touch events and elaborates a movement which consists of points statements sequence. Each point statement includes these informations : a position, a direction, a distance and a duration.
    Author:
    Sylvain LALANDE
  • touch.js

    The Touch object provides a layer of abstraction with all event listeners and listened elements. It manages the events of the finger or the mouse so that the caller does not care about the target platform. When events occur, the touch object handles them invoking callbacks with the resulting event and associated arguments.
    Author:
    Sylvain LALANDE
  • feat_api.js

    Api features detection.
    Author:
    Sylvain LALANDE
  • json.extended.js

    JSON stringification - a wink.json extension.
    Author:
    Mathieu HELIOT
  • smartloader.js

    Implement a smart loader utility. You can preload scripts, styles and images using the load method. The smart loader uses a progress bar to give the user a feedback on the current load
    Author:
    Jerome GIRAUD
  • ga.js

    Implement a Google Analytics statistic tracker object
    Author:
    Patrick BOSSE
  • tracking.js

    Implements a tracking object
    Author:
    Patrick BOSSE
  • xhr.js

    XHR utility
    Author:
    Jerome GIRAUD
  • geolocation.js

    Implements a geographical locator
    Author:
    Sylvain LALANDE
  • input.js

    Implements a customizable input field
    Author:
    Jerome GIRAUD
  • accordion.js

    Implement an accordion container. Creates an accordion container with sliding sections
    Author:
    Jerome GIRAUD
  • fixedlayout.js

    The Fixed layout implements a layout with "fixed" header and/or footer. There are two implementations depending on whether the fixed position is supported. If it is supported, then it is a native behavior that does not include public property.
    Author:
    Donatien LEBARBIER, Sylvain LALANDE
  • fixedlayout_wp75.js

    Windows Phone Fixed layout implementation.
    Author:
    Donatien LEBARBIER
  • flippage.js

    Implements a flippage layout Creates a Flippage display. You can navigate through pages with your finger or just use the "flipForward" and "flipTo" methods
    Author:
    Jerome GIRAUD
  • modalwindow.js

    Implements a Modal Window. A modal window can make a content as an icon, this content can be displayed as a window. An icon is optionally movable, is associated with an image and the transition time between the view as an icon and the view as content is customizable.
    Author:
    Sylvain LALANDE
  • scroller.js

    Implements a Scroller with inertia capability. The Scroller allows to scroll vertically or horizontally a content ; it prevents the native scroll.
    Author:
    Sylvain LALANDE
  • slidingpanels.js

    Implement a sliding container Create a sliding panels container container with which you can navigate through pages with an Iphone like UX
    Author:
    Jerome GIRAUD
  • tabcontainer.js

    Implement a tab container Create a tab container. You can navigate through the tabs by clicking on the arrows on each side of the tabs or directly by sliding on the tabs
    Author:
    Jerome GIRAUD
  • tabcontainer_wp75.js

    Windows Phone Tab container implementation
    Author:
    Donatien LEBARBIER
  • windows.js

    Implement a windows container Create a windows container container with which you can navigate through pages
    Author:
    Jerome GIRAUD
  • carousel.js

    Implements a carousel
    Author:
    Jerome GIRAUD, William MARKLE
  • carousel_wp75.js

    Carousel implementation for Windows Phone
    Author:
    Jerome GIRAUD
  • colorpicker.js

    Implement a colorpicker.
    Author:
    Jerome GIRAUD
  • cspinner.js

    Implements a configurable spinner based on a canvas
    Author:
    Sylvain LALANDE
  • datepicker.js

    Implement a datepicker
    Author:
    Jerome GIRAUD
  • basics.js

    math basics library.
    Author:
    Sylvain LALANDE
  • base.js

    Wink main object and core methods
    Author:
    Jerome GIRAUD
  • layer.js

    Implement a semitransparent layer
    Author:
    Jerome GIRAUD
  • geometric.js

    math geometric library - a wink.math extension.
    Author:
    Sylvain LALANDE
  • ../../_base/\_base\test\unitTests\tests.js

  • ../../_base/\_dom\test\unitTests\tests.js

  • ../../_base/\_feat\test\unitTests\tests.js

  • ../../_base/\json\test\unitTests\tests.js

  • ../../_base/\topics\test\unitTests\tests.js

  • ../../_base/\ua\test\unitTests\tests.js

  • ../../_cache/\js\wink.cache.indexedDatabase.js

  • ../../_cache/\js\wink.cache.localStorage.js

  • ../../_cache/\js\wink.cache.sqlDatabase.js

  • ../../_cache/\test\resources\test.js

  • ../../_cache/\test\resources\test2.js

  • ../../_cache/\test\unitTests\resource.js

  • ../../_cache/\test\unitTests\tests.js

  • ../../fx/\_xy\test\unitTests\tests.js

  • ../../math/\_basics\test\unitTests\tests.js

  • ../../math/\_geometric\test\unitTests\tests.js

  • ../../mm/\audioplayer\resources\en_EN\audioplayer.js

  • ../../mm/\audioplayer\resources\fr_FR\audioplayer.js

  • ../../mm/\videoplayer\resources\en_EN\videoplayer.js

  • ../../mm/\videoplayer\resources\fr_FR\videoplayer.js

  • ../../net/\cssloader\test\unitTests\tests.js

  • ../../net/\imagesloader\test\unitTests\tests.js

  • ../../net/\jsloader\test\files\test1.js

  • ../../net/\jsloader\test\files\test2.js

  • ../../net/\jsloader\test\unitTests\resource.js

  • ../../net/\jsloader\test\unitTests\tests.js

  • ../../net/\xhr\test\unitTests\tests.js

  • ../../ui/\xy\datepicker\resources\en_EN\datepicker.js

  • ../../ui/\xy\datepicker\resources\fr_FR\datepicker.js

  • ../../ui/\xy\layer\test\unitTests\tests.js

  • ../../ui/\xy\popup\resources\en_EN\popup.js

  • ../../ui/\xy\popup\resources\fr_FR\popup.js

  • ../../ux/\touch\test\unitTests\tests.js