3757 lines
131 KiB
JavaScript
3757 lines
131 KiB
JavaScript
var kendo = {
|
|
ui: {},
|
|
mobile: {ui: {}},
|
|
dataviz: {ui: {}},
|
|
data: {}
|
|
};
|
|
|
|
|
|
FX = function() { };
|
|
|
|
FX.prototype = {
|
|
|
|
|
|
|
|
|
|
kendoAnimate: function(duration,reverse,complete,show,hide) {
|
|
/// <summary>
|
|
/// Applies the specified animation effect/s to all selected elements and triggers the callback on every element when it completes its animation.
|
|
/// Uses transitions and transformations where available and falls back to jQuery animate where not. kendoAnimate can be used to run one of the provided
|
|
/// animation effects or you can define one yourself, using the same format.
|
|
/// </summary>
|
|
/// <param name="duration" type="Number" >The effect duration (speed) in milliseconds.</param>
|
|
/// <param name="reverse" type="Boolean" >Whether the effect should play backwards, useful when doing the same animation but with the opposite direction, like opening and closing.</param>
|
|
/// <param name="complete" type="Function" >Completion callback that should be called after animation completion. It gets fired for every animated element and is passed the said element as its only argument.</param>
|
|
/// <param name="show" type="Boolean" >Whether the element should be shown before animating.</param>
|
|
/// <param name="hide" type="Boolean" >Whether the element should be hidden after the animation completes.</param>
|
|
|
|
},
|
|
|
|
|
|
kendoStop: function(gotoEnd) {
|
|
/// <summary>
|
|
/// Stops the animation effect running on the specified elements and optionally jumps to the end and clears the animation effect queue.
|
|
/// In browsers that don't support transitions falls back to jQuery stop().This functionality is useful to avoid chaining many effects, causing them to run longer than expected.
|
|
/// </summary>
|
|
/// <param name="gotoEnd" type="Boolean" >Whether to jump to the animation end position when stopping or just leave the element at its current position.</param>
|
|
|
|
},
|
|
|
|
|
|
kendoAddClass: function(classes,options) {
|
|
/// <summary>
|
|
/// Adds a CSS class to the element, while doing a transition to the new state. If the browser doesn't support transitions,
|
|
/// the method falls back to jQuery addClass();
|
|
/// </summary>
|
|
/// <param name="classes" type="String" >A list of the classes that should be added to the element/s, separated by a space.</param>
|
|
/// <param name="options" type="" >An object containing several additional options, like duration and exclusive.</param>
|
|
|
|
},
|
|
|
|
|
|
kendoRemoveClass: function(classes,options) {
|
|
/// <summary>
|
|
/// Removes a CSS class from the element, while doing a transition to the new state. If the browser doesn't support transitions,
|
|
/// the method falls back to jQuery removeClass();
|
|
/// </summary>
|
|
/// <param name="classes" type="String" >A list of the classes that should be removed from the element/s, separated by a space.</param>
|
|
/// <param name="options" type="" >An object containing several additional options, like duration and exclusive.</param>
|
|
|
|
},
|
|
|
|
|
|
kendoToggleClass: function(classes,options,toggle) {
|
|
/// <summary>
|
|
/// Toggle a CSS class on the element, based on a flag, while doing a transition to the new state. If the browser doesn't support transitions,
|
|
/// the method falls back to jQuery toggleClass();
|
|
/// </summary>
|
|
/// <param name="classes" type="String" >A list of the classes that should be toggled on the element/s, separated by a space.</param>
|
|
/// <param name="options" type="" >An object containing several additional options, like duration and exclusive.</param>
|
|
/// <param name="toggle" type="Boolean" >A boolean flag to control the toggle - true to add or false to remove the CSS class. If omitted the method will assume the opposite state should be toggled.</param>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoFX = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the FX widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="FX">The FX instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoFX = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a FX widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
if (!kendo) {
|
|
kendo = {};
|
|
}
|
|
|
|
kendo.Class = function() { };
|
|
|
|
kendo.Class.prototype = {
|
|
|
|
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoClass = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.Class widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.Class">The kendo.Class instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoClass = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.Class widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.Color = function() { };
|
|
|
|
kendo.Color.prototype = {
|
|
|
|
|
|
|
|
|
|
diff: function() {
|
|
/// <summary>
|
|
/// Computes the relative luminance between two colors.
|
|
/// </summary>
|
|
/// <returns type="Number">The relative luminance.</returns>
|
|
|
|
},
|
|
|
|
|
|
equals: function() {
|
|
/// <summary>
|
|
/// Compares two color objects for equality.
|
|
/// </summary>
|
|
/// <returns type="Boolean">returns true if the two colors are the same. Otherwise, false</returns>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoColor = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.Color widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.Color">The kendo.Color instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoColor = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.Color widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.Layout = function() { };
|
|
|
|
kendo.Layout.prototype = {
|
|
|
|
|
|
|
|
|
|
showIn: function(container,view) {
|
|
/// <summary>
|
|
/// Renders the View element in the element specified by the selector
|
|
/// </summary>
|
|
/// <param name="container" type="String" >The selector of the container in which the view element will be appended.</param>
|
|
/// <param name="view" type="kendo.View" >The view instance that will be rendered.</param>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoLayout = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.Layout widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.Layout">The kendo.Layout instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoLayout = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.Layout widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.Observable = function() { };
|
|
|
|
kendo.Observable.prototype = {
|
|
|
|
|
|
|
|
|
|
bind: function(eventName,handler) {
|
|
/// <summary>
|
|
/// Attaches a handler to an event.
|
|
/// </summary>
|
|
/// <param name="eventName" type="String" >The name of the event.</param>
|
|
/// <param name="handler" type="Function" >A function to execute each time the event is triggered. That function should have a single parameter which will contain any event specific data.</param>
|
|
|
|
},
|
|
|
|
|
|
one: function(eventName,handler) {
|
|
/// <summary>
|
|
/// Attaches a handler to an event. The handler is executed only once.
|
|
/// </summary>
|
|
/// <param name="eventName" type="String" >The name of the event.</param>
|
|
/// <param name="handler" type="Function" >A function to execute each time the event is triggered. That function should have a single parameter which will contain any event specific data.</param>
|
|
|
|
},
|
|
|
|
|
|
trigger: function(eventName,eventData) {
|
|
/// <summary>
|
|
/// Executes all handlers attached to the given event.
|
|
/// </summary>
|
|
/// <param name="eventName" type="String" >The name of the event to trigger.</param>
|
|
/// <param name="eventData" type="Object" >Optional event data which will be passed as an argument to the event handlers.</param>
|
|
|
|
},
|
|
|
|
|
|
unbind: function(eventName,handler) {
|
|
/// <summary>
|
|
/// Remove a previously attached event handler.
|
|
/// </summary>
|
|
/// <param name="eventName" type="String" >The name of the event. If not specified all handlers of all events will be removed.</param>
|
|
/// <param name="handler" type="Function" >The handler which should no longer be executed. If not specified all handlers listening to that event will be removed.</param>
|
|
|
|
},
|
|
|
|
|
|
self: null
|
|
|
|
};
|
|
|
|
$.fn.getKendoObservable = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.Observable widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.Observable">The kendo.Observable instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoObservable = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.Observable widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.Router = function() { };
|
|
|
|
kendo.Router.prototype = {
|
|
|
|
|
|
|
|
|
|
start: function() {
|
|
/// <summary>
|
|
/// Activates the router binding to the URL fragment part changes.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
route: function(route,callback) {
|
|
/// <summary>
|
|
/// Specifies a callback for the given route. The route definition can contain bound parameters, optional segments, and route globbing.
|
|
/// The parsed parts of the URL are passed as parameters to the route callback. Query string parameters are parsed and passed as last argument of the callback function.
|
|
/// </summary>
|
|
/// <param name="route" type="String" >The route definition.</param>
|
|
/// <param name="callback" type="Function" >The callback to be executed when the route is matched.</param>
|
|
|
|
},
|
|
|
|
|
|
navigate: function(route,silent) {
|
|
/// <summary>
|
|
/// Navigates to the given route.
|
|
/// </summary>
|
|
/// <param name="route" type="String" >The route to navigate to.</param>
|
|
/// <param name="silent" type="Boolean" >If set to true, the router callbacks will not be called.</param>
|
|
|
|
},
|
|
|
|
|
|
destroy: function() {
|
|
/// <summary>
|
|
/// Unbinds the router instance listeners from the URL fragment part changes.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoRouter = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.Router widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.Router">The kendo.Router instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoRouter = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.Router widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.View = function() { };
|
|
|
|
kendo.View.prototype = {
|
|
|
|
|
|
|
|
|
|
destroy: function() {
|
|
/// <summary>
|
|
/// Removes the View element from the DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
render: function(container) {
|
|
/// <summary>
|
|
/// Renders the view contents. Accepts a jQuery selector (or jQuery object) to which the contents will be appended.
|
|
/// Alternatively, the render method can be called without parameters in order to retrieve the View element for manual insertion/further manipulation.
|
|
/// </summary>
|
|
/// <param name="container" type="jQuery" >(optional) the element in which the view element will be appended.</param>
|
|
/// <returns type="jQuery">the view element.</returns>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoView = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.View widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.View">The kendo.View instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoView = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.View widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// tagName — String (default: "div")
|
|
/// The tag used for the root element of the view.
|
|
///
|
|
/// wrap — Boolean (default: true)
|
|
/// If set to false, the view will not wrap its contents in a root element. In that case, the view element will point to the root element in the template.
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.data.Binder = function() { };
|
|
|
|
kendo.data.Binder.prototype = {
|
|
|
|
|
|
|
|
|
|
refresh: function() {
|
|
/// <summary>
|
|
/// Invoked by the Kendo UI MVVM framework when the bound view model value is changed. The binder should update the UI (HTML element or Kendo UI widget) to reflect the view model change.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoBinder = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.data.Binder widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.data.Binder">The kendo.data.Binder instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoBinder = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.data.Binder widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.data.DataSource = function() { };
|
|
|
|
kendo.data.DataSource.prototype = {
|
|
|
|
|
|
|
|
|
|
add: function(model) {
|
|
/// <summary>
|
|
/// Appends a data item to the data source.
|
|
/// </summary>
|
|
/// <param name="model" type="Object" >Either a kendo.data.Model instance or JavaScript object containing the data item field values.</param>
|
|
/// <returns type="kendo.data.Model">the data item which is inserted.</returns>
|
|
|
|
},
|
|
|
|
|
|
aggregate: function(value) {
|
|
/// <summary>
|
|
/// Gets or sets the aggregate configuration.
|
|
/// </summary>
|
|
/// <param name="value" type="Object" >The aggregate configuration. Accepts the same values as the aggregate option.</param>
|
|
/// <returns type="Array">the current aggregate configuration.</returns>
|
|
|
|
},
|
|
|
|
|
|
aggregates: function() {
|
|
/// <summary>
|
|
/// Returns the aggregate results.
|
|
/// </summary>
|
|
/// <returns type="Object">the aggregate results. There is a key for every aggregated field.</returns>
|
|
|
|
},
|
|
|
|
|
|
at: function(index) {
|
|
/// <summary>
|
|
/// Returns the data item at the specified index. The index is zero-based.
|
|
/// </summary>
|
|
/// <param name="index" type="Number" >The zero-based index of the data item.</param>
|
|
/// <returns type="kendo.data.ObservableObject">the data item at the specified index. Returns undefined if a data item is not found at the specified index.Returns a kendo.data.Model instance if the schema.model option is set.</returns>
|
|
|
|
},
|
|
|
|
|
|
cancelChanges: function(model) {
|
|
/// <summary>
|
|
/// Cancels any pending changes in the data source. Deleted data items are restored, new data items are removed and updated data items are restored to their initial state.
|
|
/// </summary>
|
|
/// <param name="model" type="kendo.data.Model" >The optional data item (model). If specified only the changes of this data item will be discarded. If omitted all changes will be discarded.</param>
|
|
|
|
},
|
|
|
|
|
|
data: function(value) {
|
|
/// <summary>
|
|
/// Gets or sets the data items of the data source.If the data source is bound to a remote service (via the transport option) the data method will return the service response.
|
|
/// Every item from the response is wrapped in a kendo.data.ObservableObject or kendo.data.Model (if the schema.model option is set).If the data source is bound to a JavaScript array (via the data option) the data method will return the items of that array.
|
|
/// Every item from the array is wrapped in a kendo.data.ObservableObject or kendo.data.Model (if the schema.model option is set).If the data source is grouped (via the group option or the group method) and the serverGrouping is set to true
|
|
/// the data method will return the group items.
|
|
/// </summary>
|
|
/// <param name="value" type="Object" >The data items which will replace the current ones in the data source. If omitted the current data items will be returned.</param>
|
|
/// <returns type="kendo.data.ObservableArray">the data items of the data source. Returns empty array if the data source hasn't been populated with data items via the read, fetch or query methods.</returns>
|
|
|
|
},
|
|
|
|
|
|
fetch: function(callback) {
|
|
/// <summary>
|
|
/// Reads the data items from a remote service (if the transport option is set) or from a JavaScript array (if the data option is set).
|
|
/// </summary>
|
|
/// <param name="callback" type="Function" >The optional function which is executed when the remote request is finished. The function context (available via the this keyword) will be set to the data source instance.</param>
|
|
|
|
},
|
|
|
|
|
|
filter: function(value) {
|
|
/// <summary>
|
|
/// Gets or sets the filter configuration.
|
|
/// </summary>
|
|
/// <param name="value" type="Object" >The filter configuration. Accepts the same values as the filter option.</param>
|
|
/// <returns type="Object">the current filter configuration.</returns>
|
|
|
|
},
|
|
|
|
|
|
get: function(id) {
|
|
/// <summary>
|
|
/// Gets the data item (model) with the specified id.
|
|
/// </summary>
|
|
/// <param name="id" type="Object" >The id of the model to look for.</param>
|
|
/// <returns type="kendo.data.Model">the model instance. Returns undefined if a model with the specified id is not found.</returns>
|
|
|
|
},
|
|
|
|
|
|
getByUid: function(uid) {
|
|
/// <summary>
|
|
/// Gets the data item (model) with the specified uid.
|
|
/// </summary>
|
|
/// <param name="uid" type="String" >The uid of the model to look for.</param>
|
|
/// <returns type="kendo.data.ObservableObject">the model instance. Returns undefined if a model with the specified uid is not found.</returns>
|
|
|
|
},
|
|
|
|
|
|
group: function(value) {
|
|
/// <summary>
|
|
/// Gets or sets the grouping configuration.
|
|
/// </summary>
|
|
/// <param name="value" type="Object" >The grouping configuration. Accepts the same values as the group option.</param>
|
|
/// <returns type="Array">the current grouping configuration.</returns>
|
|
|
|
},
|
|
|
|
|
|
hasChanges: function() {
|
|
/// <summary>
|
|
/// Cheks if the data itams have changed.
|
|
/// </summary>
|
|
/// <returns type="Boolean">returns true if the data items have changed. Otherwise, false.</returns>
|
|
|
|
},
|
|
|
|
|
|
indexOf: function(dataItem) {
|
|
/// <summary>
|
|
/// Gets the index of the specified data item.
|
|
/// </summary>
|
|
/// <param name="dataItem" type="kendo.data.ObservableObject" >The target data item.</param>
|
|
/// <returns type="Number">the index of the specified data item. Returns -1 if the data item is not found.</returns>
|
|
|
|
},
|
|
|
|
|
|
insert: function(index,model) {
|
|
/// <summary>
|
|
/// Inserts a data item in the data source at the specified index.
|
|
/// </summary>
|
|
/// <param name="index" type="Number" >The zero-based index at which the data item will be inserted.</param>
|
|
/// <param name="model" type="Object" >Either a kendo.data.Model instance or JavaScript object containing the field values.</param>
|
|
/// <returns type="kendo.data.Model">the data item which is inserted.</returns>
|
|
|
|
},
|
|
|
|
|
|
page: function(page) {
|
|
/// <summary>
|
|
/// Gets or sets the current page.
|
|
/// </summary>
|
|
/// <param name="page" type="Number" >The new page.</param>
|
|
/// <returns type="Number">the current page.</returns>
|
|
|
|
},
|
|
|
|
|
|
pageSize: function(size) {
|
|
/// <summary>
|
|
/// Gets or sets the current page size.
|
|
/// </summary>
|
|
/// <param name="size" type="Number" >The new page size.</param>
|
|
/// <returns type="Number">the current page size.</returns>
|
|
|
|
},
|
|
|
|
|
|
query: function(options) {
|
|
/// <summary>
|
|
/// Executes the specified query over the data items. Makes a HTTP request if bound to a remote service.
|
|
/// </summary>
|
|
/// <param name="options" type="" >The query options which should be applied.</param>
|
|
|
|
},
|
|
|
|
|
|
read: function(data) {
|
|
/// <summary>
|
|
/// Reads data items from a remote service (if the transport option is set) or from a JavaScript array (if the data option is set).
|
|
/// </summary>
|
|
/// <param name="data" type="Object" >Optional data to pass to the remote service.</param>
|
|
|
|
},
|
|
|
|
|
|
remove: function(model) {
|
|
/// <summary>
|
|
/// Removes the specified data item from the data source.
|
|
/// </summary>
|
|
/// <param name="model" type="kendo.data.Model" >The data item which should be removed.</param>
|
|
|
|
},
|
|
|
|
|
|
sort: function(value) {
|
|
/// <summary>
|
|
/// Gets or sets the sort order which will be applied over the data items.
|
|
/// </summary>
|
|
/// <param name="value" type="Object" >The sort configuration. Accepts the same values as the sort option.</param>
|
|
/// <returns type="Array">the current sort configuration.</returns>
|
|
|
|
},
|
|
|
|
|
|
sync: function() {
|
|
/// <summary>
|
|
/// Saves any data item changes.The sync method will request the remote service if:
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
total: function() {
|
|
/// <summary>
|
|
/// Gets the total number of data items. Uses schema.total if the transport.read option is set.
|
|
/// </summary>
|
|
/// <returns type="Number">the total number of data items. Returns the length of the array returned by the data method if schema.total or transport.read are not set.Returns 0 if the data source hasn't been populated with data items via the read, fetch or query methods.</returns>
|
|
|
|
},
|
|
|
|
|
|
totalPages: function() {
|
|
/// <summary>
|
|
/// Gets the number of available pages.
|
|
/// </summary>
|
|
/// <returns type="Number">the available pages.</returns>
|
|
|
|
},
|
|
|
|
|
|
view: function() {
|
|
/// <summary>
|
|
/// Returns the data items which correspond to the current page, filter, sort and group configuration.To ensure that data is available this method should be used within the change event handler or the fetch method.
|
|
/// </summary>
|
|
/// <returns type="kendo.data.ObservableArray">the data items. Returns groups if the data items are grouped (via the group option or the group method).</returns>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoDataSource = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.data.DataSource widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.data.DataSource">The kendo.data.DataSource instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoDataSource = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.data.DataSource widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// aggregate — Array
|
|
/// The aggregate(s) which are calculated when the data source populates with data. The supported aggregates are "average", "count", "max", "min" and "sum".
|
|
///
|
|
/// autoSync — Boolean (default: false)
|
|
/// If set to true the data source would automatically save any changed data items by calling the sync method. By default changes are not automatically saved.
|
|
///
|
|
/// batch — Boolean (default: false)
|
|
/// If set to true the data source will batch CRUD operation requests. For example updating two data items would cause one HTTP request instead of two. By default the data source
|
|
/// makes a HTTP request for every CRUD operation.
|
|
///
|
|
/// data — Array|String
|
|
/// The array of data items which the data source contains. The data source will wrap those items as kendo.data.ObservableObject or kendo.data.Model (if schema.model is set).Can be set to a string value if the schema.type option is set to "xml".
|
|
///
|
|
/// filter — Array|Object
|
|
/// The filter(s) which is (are) applied over the data items. By default no filter is applied.
|
|
///
|
|
/// group — Array|Object
|
|
/// The grouping configuration of the data source. If set the data items will be grouped when the data source is populated. By default grouping is not applied.
|
|
///
|
|
/// page — Number
|
|
/// The page of data which the data source will return when the view method is invoked or request from the remote service.
|
|
///
|
|
/// pageSize — Number
|
|
/// The number of data items per page.
|
|
///
|
|
/// schema — Object
|
|
/// The configuration used to parse the remote service response.
|
|
///
|
|
/// serverAggregates — Boolean (default: false)
|
|
/// If set to true the data source will leave the aggregate calculation to the remote service. By default the data source calculates aggregates client-side.
|
|
///
|
|
/// serverFiltering — Boolean (default: false)
|
|
/// If set to true the data source will leave the filtering implementation to the remote service. By default the data source performs filtering client-side.By default the filter is sent to the server following jQuery's conventions.For example the filter { logic: "and", filters: [ { field: "name", operator: "startswith", value: "Jane" } ] } is sent as:Use the parameterMap option to send the filter option in a different format.
|
|
///
|
|
/// serverGrouping — Boolean (default: false)
|
|
/// If set to true the data source will leave the grouping implementation to the remote service. By default the data source performs grouping client-side.By default the group is sent to the server following jQuery's conventions.For example the group { field: "category", dir: "desc" } is sent as:Use the parameterMap option to send the group option in a different format.
|
|
///
|
|
/// serverPaging — Boolean (default: false)
|
|
/// If set to true the data source will leave the data item paging implementation to the remote service. By default the data source performs paging client-side.The following options are sent to the server when server paging is enabled:Use the parameterMap option to send the paging options in a different format.
|
|
///
|
|
/// serverSorting — Boolean (default: false)
|
|
/// If set to true the data source will leave the data item sorting implementation to the remote service. By default the data source performs sorting client-side.By default the sort is sent to the server following jQuery's conventions.For example the sort { field: "age", dir: "desc" } is sent as:Use the parameterMap option to send the paging options in a different format.
|
|
///
|
|
/// sort — Array|Object
|
|
/// The sort order which will be applied over the data items. By default the data items are not sorted.
|
|
///
|
|
/// transport — Object
|
|
/// The configuration used to load and save the data items. A data source is remote or local based on the way of it retrieves data items.Remote data sources load and save data items from and to a remote end-point (a.k.a. remote service or server). The transport option describes the remote service configuration - URL, HTTP verb, HTTP headers etc.
|
|
/// The transport option can also be used to implement custom data loading and saving.Local data sources are bound to a JavaScript array via the data option.
|
|
///
|
|
/// type — String
|
|
/// If set the data source will use a predefined transport and/or schema. The only supported value is "odata" which supports the OData v.2 protocol.
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.data.HierarchicalDataSource = function() { };
|
|
|
|
kendo.data.HierarchicalDataSource.prototype = {
|
|
|
|
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoHierarchicalDataSource = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.data.HierarchicalDataSource widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.data.HierarchicalDataSource">The kendo.data.HierarchicalDataSource instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoHierarchicalDataSource = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.data.HierarchicalDataSource widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// schema — Object
|
|
/// The schema configuration. See the DataSource.schema configuration for all available options.
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.data.Model = function() { };
|
|
|
|
kendo.data.Model.prototype = {
|
|
|
|
|
|
|
|
|
|
bind: function() {
|
|
/// <summary>
|
|
/// Attaches a handler to an event. Examples and more info can be found in the bind section of the kendo.Observable API reference.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
editable: function(field) {
|
|
/// <summary>
|
|
/// Determines if the specified field is editable or not.
|
|
/// </summary>
|
|
/// <param name="field" type="String" >The field to check.</param>
|
|
/// <returns type="Boolean">true if the field is editable; false otherwise.</returns>
|
|
|
|
},
|
|
|
|
|
|
get: function() {
|
|
/// <summary>
|
|
/// Gets the value of the specified field. Inherited from kendo.data.ObservableObject. Examples and more info can be found in the get section of the
|
|
/// ObservableObject API reference.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
isNew: function() {
|
|
/// <summary>
|
|
/// Checks if the Model is new or not. The id field is used to determine if a model instance is new or existing one.
|
|
/// If the value of the field specified is equal to the default value (specified through the fields configuration) the model is considered as new.
|
|
/// </summary>
|
|
/// <returns type="Boolean">true if the model is new; false otherwise.</returns>
|
|
|
|
},
|
|
|
|
|
|
set: function() {
|
|
/// <summary>
|
|
/// Sets the value of the specified field. Inherited from kendo.data.ObservableObject. Examples and more info can be found in the set section of the
|
|
/// ObservableObject API reference.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
toJSON: function() {
|
|
/// <summary>
|
|
/// Creates a plain JavaScript object which contains all fields of the Model. Inherited from kendo.data.ObservableObject. Examples and more info can be found in the toJSON section of the
|
|
/// ObservableObject API reference.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoModel = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.data.Model widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.data.Model">The kendo.data.Model instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoModel = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.data.Model widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.data.Node = function() { };
|
|
|
|
kendo.data.Node.prototype = {
|
|
|
|
|
|
|
|
|
|
append: function(model) {
|
|
/// <summary>
|
|
/// Appends a new item to the children data source, and initializes it if necessary.
|
|
/// </summary>
|
|
/// <param name="model" type="Object" >The data for the new item</param>
|
|
|
|
},
|
|
|
|
|
|
level: function() {
|
|
/// <summary>
|
|
/// Gets the current nesting level of the node within the data source.
|
|
/// </summary>
|
|
/// <returns type="Number">the zero based level of the node.</returns>
|
|
|
|
},
|
|
|
|
|
|
load: function() {
|
|
/// <summary>
|
|
/// Loads the child nodes in the child data source, supplying the id of the Node to the request.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
loaded: function() {
|
|
/// <summary>
|
|
/// Gets or sets the loaded flag of the Node. Setting the loaded flag to false allows reloading of child items.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
parentNode: function() {
|
|
/// <summary>
|
|
/// Gets the parent node.
|
|
/// </summary>
|
|
/// <returns type="kendo.data.Node">the parent of the node; null if the node is a root node or doesn't have a parent.</returns>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoNode = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.data.Node widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.data.Node">The kendo.data.Node instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoNode = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.data.Node widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.data.ObservableArray = function() { };
|
|
|
|
kendo.data.ObservableArray.prototype = {
|
|
|
|
|
|
|
|
|
|
bind: function(eventName,handler) {
|
|
/// <summary>
|
|
/// Attaches an event handler for the specified event.
|
|
/// </summary>
|
|
/// <param name="eventName" type="String" >The name of the event.</param>
|
|
/// <param name="handler" type="Function" >The function which will be invoked when the event is raised.</param>
|
|
|
|
},
|
|
|
|
|
|
join: function(separator) {
|
|
/// <summary>
|
|
/// Joins all items of an ObservableArray into a string. Equivalent of
|
|
/// Array.prototype.join.
|
|
/// </summary>
|
|
/// <param name="separator" type="String" >Specifies the string to separate each item of the array. If omitted the array items are separated with a comma (,)</param>
|
|
|
|
},
|
|
|
|
|
|
parent: function() {
|
|
/// <summary>
|
|
/// Gets the parent of the array if such parent exists.
|
|
/// </summary>
|
|
/// <returns type="kendo.data.ObservableObject">the parent of the array; undefined if the array is not nested and doesn't have a parent.</returns>
|
|
|
|
},
|
|
|
|
|
|
pop: function() {
|
|
/// <summary>
|
|
/// Removes the last item from an array and returns that item. Equivalent of Array.prototype.pop.
|
|
/// </summary>
|
|
/// <returns type="Object">the item which was removed.</returns>
|
|
|
|
},
|
|
|
|
|
|
push: function() {
|
|
/// <summary>
|
|
/// Appends the given items to the array and returns the new length of the array. Equivalent of Array.prototype.push.
|
|
/// The new items are wrapped as ObservableObject if they are complex objects.
|
|
/// </summary>
|
|
/// <returns type="Number">the new length of the array.</returns>
|
|
|
|
},
|
|
|
|
|
|
slice: function(begin,end) {
|
|
/// <summary>
|
|
/// Returns a one-level deep copy of a portion of an array. Equivalent of
|
|
/// Array.prototype.slice.
|
|
/// The result of the slice method is not an instance of ObvservableArray. It is a regular JavaScript Array object.
|
|
/// </summary>
|
|
/// <param name="begin" type="Number" >Zero-based index at which to begin extraction.</param>
|
|
/// <param name="end" type="Number" >Zero-based index at which to end extraction. If end is omitted, slice extracts to the end of the sequence.</param>
|
|
|
|
},
|
|
|
|
|
|
splice: function(index,howMany) {
|
|
/// <summary>
|
|
/// Changes an ObservableArray, by adding new items while removing old items. Equivalent of
|
|
/// Array.prototype.splice
|
|
/// </summary>
|
|
/// <param name="index" type="Number" >Index at which to start changing the array. If negative, will begin that many elements from the end.</param>
|
|
/// <param name="howMany" type="Number" >An integer indicating the number of items to remove. If set to 0, no items are removed. In this case, you should specify at least one new item.</param>
|
|
/// <returns type="Array">containing the removed items. The result of the splice method is not an instance of ObvservableArray.</returns>
|
|
|
|
},
|
|
|
|
|
|
shift: function() {
|
|
/// <summary>
|
|
/// Removes the first item from an ObvservableArray and returns that item. Equivalent of Array.prototype.shift.
|
|
/// </summary>
|
|
/// <returns type="Object">the item which was removed.</returns>
|
|
|
|
},
|
|
|
|
|
|
toJSON: function() {
|
|
/// <summary>
|
|
/// Returns a JavaScript Array which represents the contents of the ObservableArray.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
unshift: function() {
|
|
/// <summary>
|
|
/// Adds one or more items to the beginning of an ObservableArray and returns the new length. Equivalent of Array.prototype.unshift.
|
|
/// </summary>
|
|
/// <returns type="Number">the new length of the array.</returns>
|
|
|
|
},
|
|
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoObservableArray = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.data.ObservableArray widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.data.ObservableArray">The kendo.data.ObservableArray instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoObservableArray = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.data.ObservableArray widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.data.ObservableObject = function() { };
|
|
|
|
kendo.data.ObservableObject.prototype = {
|
|
|
|
|
|
|
|
|
|
bind: function() {
|
|
/// <summary>
|
|
/// Attaches a handler to an event. Examples and more info can be found in the bind section of the
|
|
/// kendo.Observable API reference.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
get: function(name) {
|
|
/// <summary>
|
|
/// Gets the value of the specified field.
|
|
/// </summary>
|
|
/// <param name="name" type="String" >The name of the field whose value is going to be returned.</param>
|
|
/// <returns type="Object">the value of the specified field.</returns>
|
|
|
|
},
|
|
|
|
|
|
parent: function() {
|
|
/// <summary>
|
|
/// Gets the parent of the object if such parent exists.
|
|
/// </summary>
|
|
/// <returns type="kendo.data.ObservableObject">the parent of the object; undefined if the object is not nested and doesn't have a parent.</returns>
|
|
|
|
},
|
|
|
|
|
|
set: function(name,value) {
|
|
/// <summary>
|
|
/// Sets the value of the specified field.
|
|
/// </summary>
|
|
/// <param name="name" type="String" >The name of the field whose value is going to be returned.</param>
|
|
/// <param name="value" type="Object" >The new value of the field.</param>
|
|
|
|
},
|
|
|
|
|
|
toJSON: function() {
|
|
/// <summary>
|
|
/// Creates a plain JavaScript object which contains all fields of the ObservableObject.
|
|
/// </summary>
|
|
/// <returns type="Object">which contains only the fields of the ObservableObject.</returns>
|
|
|
|
},
|
|
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoObservableObject = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.data.ObservableObject widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.data.ObservableObject">The kendo.data.ObservableObject instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoObservableObject = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.data.ObservableObject widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.data.SchedulerDataSource = function() { };
|
|
|
|
kendo.data.SchedulerDataSource.prototype = {
|
|
|
|
|
|
|
|
|
|
expand: function(start,end) {
|
|
/// <summary>
|
|
/// Expands all recurring events in the data and returns a list of events for a specific period.
|
|
/// </summary>
|
|
/// <param name="start" type="Date" >The start date of the period.</param>
|
|
/// <param name="end" type="Date" >The end date of the period.</param>
|
|
/// <returns type="Array">the expanded list of scheduler events filtered by the specified start/end period.</returns>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoSchedulerDataSource = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.data.SchedulerDataSource widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.data.SchedulerDataSource">The kendo.data.SchedulerDataSource instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoSchedulerDataSource = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.data.SchedulerDataSource widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// schema — Object
|
|
/// The schema configuration of the SchedulerDataSource.
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.data.SchedulerEvent = function() { };
|
|
|
|
kendo.data.SchedulerEvent.prototype = {
|
|
|
|
|
|
|
|
|
|
clone: function(options) {
|
|
/// <summary>
|
|
/// Clones the scheduler event.
|
|
/// </summary>
|
|
/// <param name="options" type="Object" >Additional options passed to the SchedulerEvent constructor.</param>
|
|
/// <returns type="kendo.data.Scheduler">the cloned scheduler event.</returns>
|
|
|
|
},
|
|
|
|
|
|
duration: function() {
|
|
/// <summary>
|
|
/// Returns the scheduler event length in milliseconds.
|
|
/// </summary>
|
|
/// <returns type="Number">the length of the event.</returns>
|
|
|
|
},
|
|
|
|
|
|
expand: function(start,end,timeZoneId) {
|
|
/// <summary>
|
|
/// Expands the event for a specific period based on the recurrenceRule option.
|
|
/// </summary>
|
|
/// <param name="start" type="Date" >The start date of the occurrence period.</param>
|
|
/// <param name="end" type="Date" >The end date of the occurrence period.</param>
|
|
/// <param name="timeZoneId" type="String" >The time zone ID used to convert the recurrence rule dates.</param>
|
|
/// <returns type="Array">the list of the occurrences.</returns>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoSchedulerEvent = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.data.SchedulerEvent widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.data.SchedulerEvent">The kendo.data.SchedulerEvent instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoSchedulerEvent = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.data.SchedulerEvent widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// description — String (default: "")
|
|
/// The optional event description.
|
|
///
|
|
/// end — Date
|
|
/// The date at which the scheduler event ends. The end date is mandatory.
|
|
///
|
|
/// endTimezone — String (default: undefined)
|
|
/// The timezone of the end date. If not specified the timezone will be used.The complete list of the supported timezones is available in the List of IANA time zones Wikipedia page.
|
|
///
|
|
/// id — String|Number|Object
|
|
/// The mandatory unique identifier of the event.
|
|
///
|
|
/// isAllDay — Boolean (default: false)
|
|
/// If set to true the event is "all day". By default events are not all day.
|
|
///
|
|
/// recurrenceException — String (default: undefined)
|
|
/// The recurrence exceptions. A list of semicolon separated dates formatted using the yyyyMMddTHHmmssZ format string.
|
|
///
|
|
/// recurrenceId — String|Number|Object (default: undefined)
|
|
/// The id of the recurrence parent event. Required for events that are recurrence exceptions.
|
|
///
|
|
/// recurrenceRule — String (default: undefined)
|
|
/// The recurrence rule describing the recurring pattern of the event. The format follows the iCal specification.
|
|
///
|
|
/// start — Date
|
|
/// The date at which the scheduler event starts. The start date is mandatory.
|
|
///
|
|
/// startTimezone — String (default: undefined)
|
|
/// The timezone of the start date. If not specified the timezone will be used.The complete list of the supported timezones is available in the List of IANA time zones Wikipedia page.
|
|
///
|
|
/// title — String (default: "")
|
|
/// The title of the event which is displayed by the scheduler widget.
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.mobile.Application = function() { };
|
|
|
|
kendo.mobile.Application.prototype = {
|
|
|
|
|
|
|
|
|
|
changeLoadingMessage: function(text) {
|
|
/// <summary>
|
|
/// Changes the loading message.
|
|
/// </summary>
|
|
/// <param name="text" type="String" >New text of the loading animation.</param>
|
|
|
|
},
|
|
|
|
|
|
hideLoading: function() {
|
|
/// <summary>
|
|
/// Hide the loading animation.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
navigate: function(url,transition) {
|
|
/// <summary>
|
|
/// Navigate to local or to remote view.
|
|
/// </summary>
|
|
/// <param name="url" type="String" >The id or url of the view.</param>
|
|
/// <param name="transition" type="String" >Optional. The transition to apply when navigating. See View Transitions section for more information.</param>
|
|
|
|
},
|
|
|
|
|
|
scroller: function() {
|
|
/// <summary>
|
|
/// Get a reference to the current view's scroller widget instance.
|
|
/// </summary>
|
|
/// <returns type="kendo.mobile.ui.Scroller">the scroller widget instance.</returns>
|
|
|
|
},
|
|
|
|
|
|
showLoading: function() {
|
|
/// <summary>
|
|
/// Show the loading animation.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
skin: function(skin) {
|
|
/// <summary>
|
|
/// Change the current skin of the mobile application. When used without parameters, returns the currently used skin. Available as of Q2 2013.
|
|
/// </summary>
|
|
/// <param name="skin" type="String" >The skin name to switch to or empty string ("") to return to native.</param>
|
|
/// <returns type="String">Current skin in effect.</returns>
|
|
|
|
},
|
|
|
|
|
|
view: function() {
|
|
/// <summary>
|
|
/// Get a reference to the current view.
|
|
/// </summary>
|
|
/// <returns type="kendo.mobile.ui.View">the view instance.</returns>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoApplication = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.mobile.Application widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.mobile.Application">The kendo.mobile.Application instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoApplication = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.mobile.Application widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// hideAddressBar — Boolean (default: true)
|
|
/// Whether to hide the browser address bar. Supported only in iPhone and iPod. Doesn't affect standalone mode as there the address bar is always hidden.
|
|
///
|
|
/// updateDocumentTitle — Boolean (default: true)
|
|
/// Whether to update the document title.
|
|
///
|
|
/// initial — String
|
|
/// The id of the initial mobile View to display.
|
|
///
|
|
/// layout — String
|
|
/// The id of the default Application layout.
|
|
///
|
|
/// loading — String (default: ")
|
|
/// The text displayed in the loading popup. Setting this value to false will disable the loading popup.Note: The text should be wrapped inside tag.
|
|
///
|
|
/// platform — String
|
|
/// Which platform look to force on the application. Supported values are "ios" (meaning iOS 6 look), "ios7","android", "blackberry" and "wp8".
|
|
///
|
|
/// serverNavigation — Boolean
|
|
/// If set to true, the application will not use AJAX to load remote views.
|
|
///
|
|
/// skin — String
|
|
/// The skin to apply to the application. Currently, Kendo UI Mobile ships with a flat skin in addition to the native looking ones.
|
|
///
|
|
/// statusBarStyle — String (default: "black")
|
|
/// Set the status bar style meta tag in iOS used to control the styling of the status bar in a pinned to the Home Screen app. Available as of Q2 2013 SP.
|
|
///
|
|
/// transition — String
|
|
/// The default View transition.
|
|
///
|
|
/// webAppCapable — Boolean
|
|
/// Disables the default behavior of Kendo UI Mobile apps to be web app capable (open in a chromeless browser). Introduced in Q2 2013.
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.mobile.ui.ActionSheet = function() { };
|
|
|
|
kendo.mobile.ui.ActionSheet.prototype = {
|
|
|
|
|
|
|
|
|
|
close: function() {
|
|
/// <summary>
|
|
/// Close the ActionSheet.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
destroy: function() {
|
|
/// <summary>
|
|
/// Prepares the ActionSheet for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
open: function(target,context) {
|
|
/// <summary>
|
|
/// Open the ActionSheet.
|
|
/// </summary>
|
|
/// <param name="target" type="jQuery" >(optional) The target element of the ActionSheet, available in the callback methods.Notice The target element is mandatory on tablets, as the ActionSheet widget positions itself relative to opening element when a tablet is detected.</param>
|
|
/// <param name="context" type="Object" >(optional) The context of the ActionSheet, available in the callback methods.</param>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoActionSheet = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.mobile.ui.ActionSheet widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.mobile.ui.ActionSheet">The kendo.mobile.ui.ActionSheet instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoActionSheet = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.mobile.ui.ActionSheet widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// cancel — String (default: "Cancel")
|
|
/// The text of the cancel button.
|
|
///
|
|
/// popup — Object
|
|
/// The popup configuration options (tablet only).
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.mobile.ui.BackButton = function() { };
|
|
|
|
kendo.mobile.ui.BackButton.prototype = {
|
|
|
|
|
|
|
|
|
|
destroy: function() {
|
|
/// <summary>
|
|
/// Prepares the BackButton for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoBackButton = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.mobile.ui.BackButton widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.mobile.ui.BackButton">The kendo.mobile.ui.BackButton instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoBackButton = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.mobile.ui.BackButton widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.mobile.ui.Button = function() { };
|
|
|
|
kendo.mobile.ui.Button.prototype = {
|
|
|
|
|
|
|
|
|
|
badge: function(value) {
|
|
/// <summary>
|
|
/// Introduced in Q1 2013 SP Sets a badge on the Button with the specified value. If invoked without parameters, returns the current badge value. Set the value to false to remove the badge.
|
|
/// </summary>
|
|
/// <param name="value" type="Object" >The target value to be set or false to be removed.</param>
|
|
/// <returns type="String | kendo.mobile.ui.Button">the badge value if invoked without parameters, otherwise the Button object.</returns>
|
|
|
|
},
|
|
|
|
|
|
destroy: function() {
|
|
/// <summary>
|
|
/// Prepares the Button for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
enable: function(enable) {
|
|
/// <summary>
|
|
/// Changes the enabled state of the widget.
|
|
/// </summary>
|
|
/// <param name="enable" type="Boolean" >Whether to enable or disable the widget.</param>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoButton = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.mobile.ui.Button widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.mobile.ui.Button">The kendo.mobile.ui.Button instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoButton = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.mobile.ui.Button widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// badge — String
|
|
/// The badge of the button.
|
|
///
|
|
/// enable — Boolean (default: true)
|
|
/// If set to false the widget will be disabled and will not allow the user to click it. The widget is enabled by default.
|
|
///
|
|
/// icon — String
|
|
/// The icon of the button. It can be either one of the built-in icons, or a custom one.
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.mobile.ui.ButtonGroup = function() { };
|
|
|
|
kendo.mobile.ui.ButtonGroup.prototype = {
|
|
|
|
|
|
|
|
|
|
badge: function(button,value) {
|
|
/// <summary>
|
|
/// Introduced in Q1 2013 SP Sets a badge on one of the ButtonGroup buttons with the specified value. If invoked without parameters, returns the button's current badge value. Set the value to false to remove the badge.
|
|
/// </summary>
|
|
/// <param name="button" type="Object" >The target button specified either as a jQuery selector/object or as an button index.</param>
|
|
/// <param name="value" type="Object" >The target value to be set or false to be removed.</param>
|
|
/// <returns type="String|kendo.mobile.ui.Button">the badge value if invoked without parameters, otherwise the ButtonGroup object.</returns>
|
|
|
|
},
|
|
|
|
|
|
current: function() {
|
|
/// <summary>
|
|
/// Get the currently selected Button.
|
|
/// </summary>
|
|
/// <returns type="jQuery">the jQuery object representing the currently selected button.</returns>
|
|
|
|
},
|
|
|
|
|
|
destroy: function() {
|
|
/// <summary>
|
|
/// Prepares the ButtonGroup for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
select: function(li) {
|
|
/// <summary>
|
|
/// Select a Button.
|
|
/// </summary>
|
|
/// <param name="li" type="Object" >LI element or index of the Button.</param>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoButtonGroup = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.mobile.ui.ButtonGroup widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.mobile.ui.ButtonGroup">The kendo.mobile.ui.ButtonGroup instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoButtonGroup = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.mobile.ui.ButtonGroup widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// index — Number
|
|
/// Defines the initially selected Button (zero based index).
|
|
///
|
|
/// selectOn — String (default: default "down")
|
|
/// Sets the DOM event used to select the button. Accepts "up" as an alias for touchend, mouseup and MSPointerUp vendor specific events.By default, buttons are selected immediately after the user presses the button (on touchstart or mousedown or MSPointerDown, depending on the mobile device).
|
|
/// However, if the widget is placed in a scrollable view, the user may accidentally press the button when scrolling. In such cases, it is recommended to set this option to "up".
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.mobile.ui.DetailButton = function() { };
|
|
|
|
kendo.mobile.ui.DetailButton.prototype = {
|
|
|
|
|
|
|
|
|
|
destroy: function() {
|
|
/// <summary>
|
|
/// Prepares the DetailButton for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoDetailButton = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.mobile.ui.DetailButton widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.mobile.ui.DetailButton">The kendo.mobile.ui.DetailButton instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoDetailButton = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.mobile.ui.DetailButton widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.mobile.ui.Drawer = function() { };
|
|
|
|
kendo.mobile.ui.Drawer.prototype = {
|
|
|
|
|
|
|
|
|
|
destroy: function() {
|
|
/// <summary>
|
|
/// Prepares the Drawer for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
hide: function() {
|
|
/// <summary>
|
|
/// Hide the Drawer
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
show: function() {
|
|
/// <summary>
|
|
/// Show the Drawer
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoDrawer = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.mobile.ui.Drawer widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.mobile.ui.Drawer">The kendo.mobile.ui.Drawer instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoDrawer = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.mobile.ui.Drawer widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// position — String (default: 'left')
|
|
/// The position of the drawer. Can be left (default) or right.
|
|
///
|
|
/// swipeToOpen — Boolean (default: true)
|
|
/// If set to false, swiping the view will not activate the drawer. In this case, the drawer will only be open by a designated button
|
|
///
|
|
/// title — String
|
|
/// The text to display in the Navbar title (if present).
|
|
///
|
|
/// views — Array
|
|
/// A list of the view ids on which the drawer will appear. If omitted, the drawer will work on any view in the application.
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.mobile.ui.Layout = function() { };
|
|
|
|
kendo.mobile.ui.Layout.prototype = {
|
|
|
|
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoLayout = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.mobile.ui.Layout widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.mobile.ui.Layout">The kendo.mobile.ui.Layout instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoLayout = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.mobile.ui.Layout widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// id — String (default: null)
|
|
/// The id of the layout. Required
|
|
///
|
|
/// platform — String
|
|
/// The specific platform this layout targets. By default, layouts are displayed
|
|
/// on all platforms.
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.mobile.ui.ListView = function() { };
|
|
|
|
kendo.mobile.ui.ListView.prototype = {
|
|
|
|
|
|
|
|
|
|
append: function(dataItems) {
|
|
/// <summary>
|
|
/// Appends new items generated by rendering the given data items with the listview template to the bottom of the listview.
|
|
/// </summary>
|
|
/// <param name="dataItems" type="Array" ></param>
|
|
|
|
},
|
|
|
|
|
|
prepend: function(dataItems) {
|
|
/// <summary>
|
|
/// Prepends new items generated by rendering the given data items with the listview template to the top of the listview.
|
|
/// </summary>
|
|
/// <param name="dataItems" type="Array" ></param>
|
|
|
|
},
|
|
|
|
|
|
replace: function(dataItems) {
|
|
/// <summary>
|
|
/// Replaces the contents of the listview with the passed rendered data items.
|
|
/// </summary>
|
|
/// <param name="dataItems" type="Array" ></param>
|
|
|
|
},
|
|
|
|
|
|
remove: function(dataItems) {
|
|
/// <summary>
|
|
/// Removes the listview items which are rendered with the passed data items.
|
|
/// </summary>
|
|
/// <param name="dataItems" type="Array" ></param>
|
|
|
|
},
|
|
|
|
|
|
setDataItem: function(item,dataItem) {
|
|
/// <summary>
|
|
/// Re-renders the given listview item with the new dataItem provided. In order for the method to work as expected, the data items should be of type kendo.data.Model.
|
|
/// </summary>
|
|
/// <param name="item" type="jQuery" >The listview item to update</param>
|
|
/// <param name="dataItem" type="kendo.data.Model" >The new dataItem</param>
|
|
|
|
},
|
|
|
|
|
|
destroy: function() {
|
|
/// <summary>
|
|
/// Prepares the ListView for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
items: function() {
|
|
/// <summary>
|
|
/// Get the listview DOM element items
|
|
/// </summary>
|
|
/// <returns type="jQuery">The listview DOM element items</returns>
|
|
|
|
},
|
|
|
|
|
|
refresh: function() {
|
|
/// <summary>
|
|
/// Repaints the listview (works only in databound mode).
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
setDataSource: function(dataSource) {
|
|
/// <summary>
|
|
/// Sets the DataSource of an existing ListView and rebinds it.
|
|
/// </summary>
|
|
/// <param name="dataSource" type="kendo.data.DataSource" ></param>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoListView = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.mobile.ui.ListView widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.mobile.ui.ListView">The kendo.mobile.ui.ListView instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoListView = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.mobile.ui.ListView widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// appendOnRefresh — Boolean (default: false)
|
|
/// Used in combination with pullToRefresh. If set to true, newly loaded data will be appended on top when refreshing. Notice: not applicable if ListView is in a virtual mode.
|
|
///
|
|
/// autoBind — Boolean (default: true)
|
|
/// Indicates whether the listview will call read on the DataSource initially. If set to false, the listview will be bound after the DataSource instance fetch method is called.
|
|
///
|
|
/// dataSource — Object
|
|
/// Instance of DataSource or the data that the mobile ListView will be bound to.
|
|
///
|
|
/// endlessScroll — Boolean (default: false)
|
|
/// If set to true, the listview gets the next page of data when the user scrolls near the bottom of the view.
|
|
///
|
|
/// fixedHeaders — Boolean (default: false)
|
|
/// If set to true, the group headers will persist their position when the user scrolls through the listview.
|
|
/// Applicable only when the type is set to group, or when binding to grouped DataSource.Notice: fixed headers are not supported in virtual mode.
|
|
///
|
|
/// headerTemplate — String|Function (default: "#:value#")
|
|
/// The header item template (applicable when the type is set to group).
|
|
///
|
|
/// loadMore — Boolean (default: false)
|
|
/// If set to true, a button is rendered at the bottom of the listview. Tapping it fetches and displays the items from the next page of the DataSource.
|
|
///
|
|
/// loadMoreText — String (default: "Press to load more")
|
|
/// The text of the rendered load-more button (applies only if loadMore is set to true).
|
|
///
|
|
/// pullToRefresh — Boolean (default: false)
|
|
/// If set to true, the listview will reload its data when the user pulls the view over the top limit.
|
|
///
|
|
/// pullParameters — Function
|
|
/// A callback function used when the 'pullToRefresh' option is enabled. The result of the function will be send as additional parameters to the DataSource's next method.Notice: When the listview is in a virtual mode, the pull to refresh action removes the previously loaded items in the listview (instead of appending new records at the top).
|
|
/// Previously loaded pages in the DataSource are also discarded.
|
|
///
|
|
/// style — String (default: "")
|
|
/// The style of the widget. Can be either empty string(""), or inset.
|
|
///
|
|
/// template — String|Function (default: "#:data#")
|
|
/// The item template.
|
|
///
|
|
/// type — String (default: "flat")
|
|
/// The type of the control. Can be either flat (default) or group. Determined automatically in databound mode.
|
|
///
|
|
/// filterable — Boolean (default: false)
|
|
/// Indicates whether the filter input must be visible or not.
|
|
///
|
|
/// filterable — Object
|
|
/// Indicates whether the filter input must be visible or not.
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.mobile.ui.Loader = function() { };
|
|
|
|
kendo.mobile.ui.Loader.prototype = {
|
|
|
|
|
|
|
|
|
|
hide: function() {
|
|
/// <summary>
|
|
/// Hide the loading animation.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
show: function() {
|
|
/// <summary>
|
|
/// Show the loading animation.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoLoader = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.mobile.ui.Loader widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.mobile.ui.Loader">The kendo.mobile.ui.Loader instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoLoader = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.mobile.ui.Loader widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.mobile.ui.ModalView = function() { };
|
|
|
|
kendo.mobile.ui.ModalView.prototype = {
|
|
|
|
|
|
|
|
|
|
close: function() {
|
|
/// <summary>
|
|
/// Close the ModalView
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
destroy: function() {
|
|
/// <summary>
|
|
/// Prepares the ModalView for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
open: function(target) {
|
|
/// <summary>
|
|
/// Open the ModalView
|
|
/// </summary>
|
|
/// <param name="target" type="jQuery" >(optional) The target of the ModalView</param>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoModalView = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.mobile.ui.ModalView widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.mobile.ui.ModalView">The kendo.mobile.ui.ModalView instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoModalView = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.mobile.ui.ModalView widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// height — Number
|
|
/// The height of the ModalView container in pixels. If not set, the element style is used.
|
|
///
|
|
/// modal — Boolean (default: true)
|
|
/// When set to false, the ModalView will close when the user taps outside of its element.
|
|
///
|
|
/// width — Number
|
|
/// The width of the ModalView container in pixels. If not set, the element style is used.
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.mobile.ui.NavBar = function() { };
|
|
|
|
kendo.mobile.ui.NavBar.prototype = {
|
|
|
|
|
|
|
|
|
|
destroy: function() {
|
|
/// <summary>
|
|
/// Prepares the NavBar for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
title: function(value) {
|
|
/// <summary>
|
|
/// Update the title element text. The title element is specified by setting the role data attribute to view-title.
|
|
/// </summary>
|
|
/// <param name="value" type="String" >The text of title</param>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoNavBar = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.mobile.ui.NavBar widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.mobile.ui.NavBar">The kendo.mobile.ui.NavBar instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoNavBar = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.mobile.ui.NavBar widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.mobile.ui.Pane = function() { };
|
|
|
|
kendo.mobile.ui.Pane.prototype = {
|
|
|
|
|
|
|
|
|
|
destroy: function() {
|
|
/// <summary>
|
|
/// Prepares the Pane for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
hideLoading: function() {
|
|
/// <summary>
|
|
/// Hide the loading animation.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
navigate: function(url,transition) {
|
|
/// <summary>
|
|
/// Navigate the local or remote view.
|
|
/// </summary>
|
|
/// <param name="url" type="String" >The id or URL of the view.</param>
|
|
/// <param name="transition" type="String" >The transition to apply when navigating. See View Transitions for more information.</param>
|
|
|
|
},
|
|
|
|
|
|
showLoading: function() {
|
|
/// <summary>
|
|
/// Show the loading animation.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
view: function() {
|
|
/// <summary>
|
|
/// Get a reference to the current view.
|
|
/// </summary>
|
|
/// <returns type="kendo.mobile.ui.View">the view instance.</returns>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoPane = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.mobile.ui.Pane widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.mobile.ui.Pane">The kendo.mobile.ui.Pane instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoPane = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.mobile.ui.Pane widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// collapsible — Boolean (default: false)
|
|
/// Applicable when the pane is inside a SplitView. If set to true, the pane will be hidden when the device is in portrait position. The expandPanes SplitView method displays the hidden panes.The id of the initial mobile View to display.
|
|
///
|
|
/// initial — String
|
|
/// The id of the initial mobile View to display.
|
|
///
|
|
/// layout — String
|
|
/// The id of the default Pane Layout.
|
|
///
|
|
/// loading — String (default: "Loading...")
|
|
/// The text displayed in the loading popup. Setting this value to false will disable the loading popup.
|
|
///
|
|
/// portraitWidth — Number
|
|
/// Sets the pane width in pixels when the device is in portrait position.
|
|
///
|
|
/// transition — String
|
|
/// The default View transition.
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.mobile.ui.PopOver = function() { };
|
|
|
|
kendo.mobile.ui.PopOver.prototype = {
|
|
|
|
|
|
|
|
|
|
close: function() {
|
|
/// <summary>
|
|
/// Close the popover.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
destroy: function() {
|
|
/// <summary>
|
|
/// Prepares the PopOver for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
open: function(target) {
|
|
/// <summary>
|
|
/// Open the PopOver.
|
|
/// </summary>
|
|
/// <param name="target" type="jQuery" >The target of the Popover, to which the visual arrow will point to. This parameter is required for a tablet OS.</param>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoPopOver = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.mobile.ui.PopOver widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.mobile.ui.PopOver">The kendo.mobile.ui.PopOver instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoPopOver = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.mobile.ui.PopOver widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// pane — Object
|
|
/// The pane configuration options.
|
|
///
|
|
/// popup — Object
|
|
/// The popup configuration options.
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.mobile.ui.ScrollView = function() { };
|
|
|
|
kendo.mobile.ui.ScrollView.prototype = {
|
|
|
|
|
|
|
|
|
|
content: function(content) {
|
|
/// <summary>
|
|
/// Update the ScrollView HTML content.
|
|
/// </summary>
|
|
/// <param name="content" type="Object" >The new ScrollView content.</param>
|
|
|
|
},
|
|
|
|
|
|
destroy: function() {
|
|
/// <summary>
|
|
/// Prepares the ScrollView for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
refresh: function() {
|
|
/// <summary>
|
|
/// Redraw the mobile ScrollView pager. Called automatically on device orientation change event.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
scrollTo: function(page,instant) {
|
|
/// <summary>
|
|
/// Scroll to the given page. Pages are zero-based indexed.
|
|
/// </summary>
|
|
/// <param name="page" type="Number" >The page to scroll to.</param>
|
|
/// <param name="instant" type="Boolean" >If set to true, the ScrollView will jump instantly to the given page without any animation effects.</param>
|
|
|
|
},
|
|
|
|
|
|
setDataSource: function(dataSource) {
|
|
/// <summary>
|
|
/// Sets the DataSource of an existing ScrollView and rebinds it.
|
|
/// </summary>
|
|
/// <param name="dataSource" type="kendo.data.DataSource" ></param>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoScrollView = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.mobile.ui.ScrollView widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.mobile.ui.ScrollView">The kendo.mobile.ui.ScrollView instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoScrollView = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.mobile.ui.ScrollView widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// autoBind — Boolean (default: true)
|
|
/// If set to false the widget will not bind to the DataSource during initialization. In this case data binding will occur when the change event of the data source is fired. By default the widget will bind to the DataSource specified in the configuration.Applicable only in data bound mode.
|
|
///
|
|
/// bounceVelocityThreshold — Number (default: 1.6)
|
|
/// The velocity threshold after which a swipe will result in a bounce effect.
|
|
///
|
|
/// contentHeight — Number|String (default: "auto")
|
|
/// The height of the ScrollView content. Supports 100% if the ScrollView is embedded in a stretched view and the ScrollView element is an immediate child of the view element.
|
|
///
|
|
/// dataSource — Object
|
|
/// Instance of DataSource that the mobile ScrollView will be bound to. If DataSource is set, the widget will operate in data bound mode.
|
|
///
|
|
/// duration — Number (default: 400)
|
|
/// The milliseconds that take the ScrollView to snap to the current page after released.
|
|
///
|
|
/// emptyTemplate — String (default: "")
|
|
/// The template which is used to render the pages without content. By default the ScrollView renders a blank page.Applicable only in data bound mode.
|
|
///
|
|
/// enablePager — Boolean (default: true)
|
|
/// If set to true the ScrollView will display a pager. By default pager is enabled.
|
|
///
|
|
/// itemsPerPage — Number (default: 1)
|
|
/// Determines how many data items will be passed to the page template.Applicable only in data bound mode.
|
|
///
|
|
/// page — Number (default: 0)
|
|
/// The initial page to display.
|
|
///
|
|
/// pageSize — Number (default: 1)
|
|
/// Multiplier applied to the snap amount of the ScrollView. By default, the widget scrolls to the next screen when swipe. If the pageSize property is set to 0.5, the ScrollView will scroll by half of the widget width.Not applicable in data bound mode.
|
|
///
|
|
/// template — String (default: "#:data#")
|
|
/// The template which is used to render the content of pages. By default the ScrollView renders a div element for every page.Applicable only in data bound mode.
|
|
///
|
|
/// velocityThreshold — Number (default: 0.8)
|
|
/// The velocity threshold after which a swipe will navigate to the next page (as opposed to snapping back to the current page).
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.mobile.ui.Scroller = function() { };
|
|
|
|
kendo.mobile.ui.Scroller.prototype = {
|
|
|
|
|
|
|
|
|
|
animatedScrollTo: function(x,y) {
|
|
/// <summary>
|
|
/// Scrolls the scroll container to the specified location with animation. The arguments should be negative numbers.
|
|
/// </summary>
|
|
/// <param name="x" type="Number" >The horizontal offset in pixels to scroll to.</param>
|
|
/// <param name="y" type="Number" >The vertical offset in pixels to scroll to.</param>
|
|
|
|
},
|
|
|
|
|
|
destroy: function() {
|
|
/// <summary>
|
|
/// Prepares the Scroller for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
disable: function() {
|
|
/// <summary>
|
|
/// Disables the scrolling of the element.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
enable: function() {
|
|
/// <summary>
|
|
/// Enables the scrolling of the element after it has been disabled by calling disable.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
height: function() {
|
|
/// <summary>
|
|
/// Returns the viewport height of the scrollable element.
|
|
/// </summary>
|
|
/// <returns type="Number">the viewport height in pixels.</returns>
|
|
|
|
},
|
|
|
|
|
|
pullHandled: function() {
|
|
/// <summary>
|
|
/// Indicate that the pull event is handled (i.e. data from the server has been retrieved).
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
reset: function() {
|
|
/// <summary>
|
|
/// Scrolls the container to the top.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
scrollHeight: function() {
|
|
/// <summary>
|
|
/// Returns the height in pixels of the scroller content.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
scrollTo: function(x,y) {
|
|
/// <summary>
|
|
/// Scrolls the container to the specified location. The arguments should be negative numbers.
|
|
/// </summary>
|
|
/// <param name="x" type="Number" >The horizontal offset in pixels to scroll to.</param>
|
|
/// <param name="y" type="Number" >The vertical offset in pixels to scroll to.</param>
|
|
|
|
},
|
|
|
|
|
|
scrollWidth: function() {
|
|
/// <summary>
|
|
/// Returns the width in pixels of the scroller content.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoScroller = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.mobile.ui.Scroller widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.mobile.ui.Scroller">The kendo.mobile.ui.Scroller instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoScroller = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.mobile.ui.Scroller widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// zoom — Boolean (default: false)
|
|
/// If set to true, the user can zoom in/out the contents of the widget using the pinch/zoom gesture.
|
|
///
|
|
/// elastic — Boolean (default: true)
|
|
/// Weather or not to allow out of bounds dragging and easing.
|
|
///
|
|
/// pullOffset — Number (default: 140)
|
|
/// The threshold below which a releasing the scroller will trigger the pull event.
|
|
/// Has effect only when the pullToRefresh option is set to true.
|
|
///
|
|
/// pullTemplate — String (default: "Pull to refresh")
|
|
/// The message template displayed when the user pulls the scroller.
|
|
/// Has effect only when the pullToRefresh option is set to true.
|
|
///
|
|
/// pullToRefresh — Boolean (default: false)
|
|
/// If set to true, the scroller will display a hint when the user pulls the container beyond its top limit.
|
|
/// If a pull beyond the specified pullOffset occurs, a pull event will be triggered.
|
|
///
|
|
/// refreshTemplate — String (default: "Refreshing")
|
|
/// The message template displayed during the refresh.
|
|
/// Has effect only when the pullToRefresh option is set to true.
|
|
///
|
|
/// releaseTemplate — String (default: "Release to refresh")
|
|
/// The message template displayed when the user pulls the scroller below the pullOffset, indicating that pullToRefresh will occur.
|
|
/// Has effect only when the pullToRefresh option is set to true.
|
|
///
|
|
/// useNative — Boolean (default: false)
|
|
/// If set to true, the scroller will use the native scrolling available in the current platform. This should help with form issues on some platforms (namely Android and WP8).
|
|
/// Native scrolling is only enabled on platforms that support it: iOS > 4, Android > 2, WP8. BlackBerry devices do support it, but the native scroller is flaky.
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.mobile.ui.SplitView = function() { };
|
|
|
|
kendo.mobile.ui.SplitView.prototype = {
|
|
|
|
|
|
|
|
|
|
destroy: function() {
|
|
/// <summary>
|
|
/// Prepares the SplitView for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
expandPanes: function() {
|
|
/// <summary>
|
|
/// Displays the collapsible panes; has effect only when the device is in portrait orientation.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
collapsePanes: function() {
|
|
/// <summary>
|
|
/// Collapses back the collapsible panes (displayed previously with expandPanes); has effect only when the device is in portrait orientation.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoSplitView = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.mobile.ui.SplitView widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.mobile.ui.SplitView">The kendo.mobile.ui.SplitView instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoSplitView = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.mobile.ui.SplitView widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// style — String (default: "horizontal")
|
|
/// Defines the SplitView style - horizontal or vertical.
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.mobile.ui.Switch = function() { };
|
|
|
|
kendo.mobile.ui.Switch.prototype = {
|
|
|
|
|
|
|
|
|
|
check: function(check) {
|
|
/// <summary>
|
|
/// Get/Set the checked state of the widget.
|
|
/// </summary>
|
|
/// <param name="check" type="Boolean" >Whether to turn the widget on or off.</param>
|
|
/// <returns type="Boolean">The checked state of the widget.</returns>
|
|
|
|
},
|
|
|
|
|
|
destroy: function() {
|
|
/// <summary>
|
|
/// Prepares the Switch for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
enable: function(enable) {
|
|
/// <summary>
|
|
/// Changes the enabled state of the widget.
|
|
/// </summary>
|
|
/// <param name="enable" type="Boolean" >Whether to enable or disable the widget.</param>
|
|
|
|
},
|
|
|
|
|
|
toggle: function() {
|
|
/// <summary>
|
|
/// Toggle the checked state of the widget.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoSwitch = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.mobile.ui.Switch widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.mobile.ui.Switch">The kendo.mobile.ui.Switch instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoSwitch = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.mobile.ui.Switch widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// checked — Boolean (default: false)
|
|
/// The checked state of the widget.
|
|
///
|
|
/// enable — Boolean (default: true)
|
|
/// If set to false the widget will be disabled and will not allow the user to change its checked state. The widget is enabled by default.
|
|
///
|
|
/// offLabel — String (default: "OFF")
|
|
/// The OFF label.
|
|
///
|
|
/// onLabel — String (default: "ON")
|
|
/// The ON label.
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.mobile.ui.TabStrip = function() { };
|
|
|
|
kendo.mobile.ui.TabStrip.prototype = {
|
|
|
|
|
|
|
|
|
|
badge: function(tab,value) {
|
|
/// <summary>
|
|
/// Introduced in Q1 2013 SP Sets a badge on one of the tabs with the specified value. If invoked without second parameter, returns the tab's current badge value. Set the value to false to remove the badge.
|
|
/// </summary>
|
|
/// <param name="tab" type="Object" >The target tab specified either as a jQuery selector/object or as an item index.</param>
|
|
/// <param name="value" type="Object" >The target value to be set or false to be removed.</param>
|
|
/// <returns type="String|kendo.mobile.ui.TabStrip">Returns the badge value if invoked without parameters, otherwise returns the TabStrip object.</returns>
|
|
|
|
},
|
|
|
|
|
|
currentItem: function() {
|
|
/// <summary>
|
|
/// Get the currently selected tab DOM element.
|
|
/// </summary>
|
|
/// <returns type="jQuery">the currently selected tab DOM element.</returns>
|
|
|
|
},
|
|
|
|
|
|
destroy: function() {
|
|
/// <summary>
|
|
/// Prepares the TabStrip for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
switchTo: function(url) {
|
|
/// <summary>
|
|
/// Set the mobile TabStrip active tab to the tab with the specified URL. This method doesn't change the current View. To change the View, use Application's navigate method instead.
|
|
/// </summary>
|
|
/// <param name="url" type="Object" >The URL or zero based index of the tab.</param>
|
|
|
|
},
|
|
|
|
|
|
switchByFullUrl: function(url) {
|
|
/// <summary>
|
|
/// Set the mobile TabStrip active tab to the tab with the specified full URL. This method doesn't change the current View. To change the View, use Application's navigate method instead.
|
|
/// </summary>
|
|
/// <param name="url" type="String" >The URL of the tab.</param>
|
|
|
|
},
|
|
|
|
|
|
clear: function() {
|
|
/// <summary>
|
|
/// Clear the currently selected tab.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoTabStrip = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.mobile.ui.TabStrip widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.mobile.ui.TabStrip">The kendo.mobile.ui.TabStrip instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoTabStrip = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.mobile.ui.TabStrip widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// selectedIndex — Number (default: 0)
|
|
/// The index of the initially selected tab.
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.mobile.ui.View = function() { };
|
|
|
|
kendo.mobile.ui.View.prototype = {
|
|
|
|
|
|
|
|
|
|
contentElement: function() {
|
|
/// <summary>
|
|
/// Retrieves the current content holder of the View - this is the content element if the View is stretched or the scroll container otherwise.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
destroy: function() {
|
|
/// <summary>
|
|
/// Prepares the View for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
enable: function(enable) {
|
|
/// <summary>
|
|
/// Enables or disables the user interaction with the view and its contents.
|
|
/// </summary>
|
|
/// <param name="enable" type="Boolean" >Omitting the parameter or passing true enables the view. Passing false disables the view.</param>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoView = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.mobile.ui.View widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.mobile.ui.View">The kendo.mobile.ui.View instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoView = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.mobile.ui.View widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// model — String (default: null)
|
|
/// The MVVM model to bind to. If a string is passed, The view will try to resolve a reference to the view model variable in the global scope.
|
|
///
|
|
/// reload — Boolean (default: false)
|
|
/// Applicable to remote views only. If set to true, the remote view contents will be reloaded from the server (using Ajax) each time the view is navigated to.
|
|
///
|
|
/// stretch — Boolean (default: false)
|
|
/// If set to true, the view will stretch its child contents to occupy the entire view, while disabling kinetic scrolling.
|
|
/// Useful if the view contains an image or a map.
|
|
///
|
|
/// title — String
|
|
/// The text to display in the NavBar title (if present) and the browser title.
|
|
///
|
|
/// useNativeScrolling — Boolean (default: false)
|
|
/// If set to true, the view will use the native scrolling available in the current platform. This should help with form issues on some platforms (namely Android and WP8).
|
|
/// Native scrolling is only enabled on platforms that support it: iOS > 5+, Android > 3+, WP8. BlackBerry devices do support it, but the native scroller is flaky.
|
|
///
|
|
/// zoom — Boolean (default: false)
|
|
/// If set to true, the user can zoom in/out the contents of the view using the pinch/zoom gesture.
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.mobile.ui.Widget = function() { };
|
|
|
|
kendo.mobile.ui.Widget.prototype = {
|
|
|
|
|
|
|
|
|
|
view: function() {
|
|
/// <summary>
|
|
/// Returns the kendo.mobile.ui.View which contains the widget. If the widget is contained in a splitview, modalview, or drawer, the respective widget instance is returned.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoWidget = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.mobile.ui.Widget widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.mobile.ui.Widget">The kendo.mobile.ui.Widget instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoWidget = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.mobile.ui.Widget widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.ui.Draggable = function() { };
|
|
|
|
kendo.ui.Draggable.prototype = {
|
|
|
|
|
|
|
|
|
|
cancelHold: function() {
|
|
/// <summary>
|
|
/// Has effect only when holdToDrag is set to true. Cancels the activated state of the widget, caused by pressing and holding.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoDraggable = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.ui.Draggable widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.ui.Draggable">The kendo.ui.Draggable instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoDraggable = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.ui.Draggable widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// axis — String (default: null)
|
|
/// Constrains the hint movement to either the horizontal (x) or vertical (y) axis. Can be set to either "x" or "y".
|
|
///
|
|
/// cursorOffset — Object (default: null)
|
|
/// If set, specifies the offset of the hint relative to the mouse cursor/finger.
|
|
/// By default, the hint is initially positioned on top of the draggable source offset. The option accepts an object with two keys: top and left.
|
|
///
|
|
/// distance — Number (default: 5)
|
|
/// The required distance that the mouse should travel in order to initiate a drag.
|
|
///
|
|
/// group — String (default: "default")
|
|
/// Used to group sets of draggable and drop targets. A draggable with the same group value as a drop target will be accepted by the drop target.
|
|
///
|
|
/// hint — Function
|
|
/// Provides a way for customization of the drag indicator. If a function is supplied, it receives one argument - the draggable element's jQuery object.
|
|
///
|
|
/// holdToDrag — Boolean (default: false)
|
|
/// Suitable for touch oriented user interface, in order to avoid collision with the touch scrolling gesture. When set to true, the widget will be activated after the user taps and holds the finger on the element for a short amount of time.The draggable will also be activated by pressing, holding and lifting the finger without any movement. Dragging it afterwards will initiate the drag immediately. The activated mode can be canceled by calling cancelHold.
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.ui.DropTarget = function() { };
|
|
|
|
kendo.ui.DropTarget.prototype = {
|
|
|
|
|
|
|
|
|
|
destroyGroup: function() {
|
|
/// <summary>
|
|
/// Destroys all DropTarget instances from the group with the given name.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoDropTarget = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.ui.DropTarget widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.ui.DropTarget">The kendo.ui.DropTarget instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoDropTarget = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.ui.DropTarget widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// group — String (default: "default")
|
|
/// Used to group sets of draggable and drop targets. A draggable with the same group value as a drop target will be accepted by the drop target.
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.ui.DropTargetArea = function() { };
|
|
|
|
kendo.ui.DropTargetArea.prototype = {
|
|
|
|
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoDropTargetArea = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.ui.DropTargetArea widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.ui.DropTargetArea">The kendo.ui.DropTargetArea instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoDropTargetArea = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.ui.DropTargetArea widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// group — String (default: "default")
|
|
/// Used to group sets of draggable and drop targets. A draggable with the same group value as a drop target will be accepted by the drop target.
|
|
///
|
|
/// filter — String (default: null)
|
|
/// Selector to filter the drop targets in the area. Every matched element acts as a drop target and fires events on the DropTargetArea. Specifying the filter is mandatory.
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.ui.Touch = function() { };
|
|
|
|
kendo.ui.Touch.prototype = {
|
|
|
|
|
|
|
|
|
|
destroy: function() {
|
|
/// <summary>
|
|
/// Prepares the Touch for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoTouch = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.ui.Touch widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.ui.Touch">The kendo.ui.Touch instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoTouch = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.ui.Touch widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// multiTouch — Boolean (default: false)
|
|
/// If set to true, the widget will capture and trigger the gesturestart, gesturechange, and gestureend events when the user touches the element with two fingers.
|
|
///
|
|
/// enableSwipe — Boolean (default: false)
|
|
/// If set to true, the Touch widget will recognize horizontal swipes and trigger the swipe event.Notice: if the enableSwipe option is set to true, the dragstart, drag and dragend events will not be triggered.
|
|
///
|
|
/// minXDelta — Number (default: 30)
|
|
/// The minimum horizontal distance in pixels the user should swipe before the swipe event is triggered.
|
|
///
|
|
/// maxYDelta — Number (default: 20)
|
|
/// The maximum vertical deviation in pixels of the swipe event. Swipes with higher deviation are discarded.
|
|
///
|
|
/// maxDuration — Number (default: 1000)
|
|
/// The maximum amount of time in milliseconds the swipe event can last. Slower swipes are discarded.
|
|
///
|
|
/// minHold — Number (default: 800)
|
|
/// The timeout in milliseconds before the hold event is fired.Notice: the hold event will be triggered after the time passes, not after the user lifts his/hers finger.
|
|
///
|
|
/// doubleTapTimeout — Number (default: 400)
|
|
/// The maximum period (in milliseconds) between two consecutive taps which will trigger the doubletap event.
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.ui.Validator = function() { };
|
|
|
|
kendo.ui.Validator.prototype = {
|
|
|
|
|
|
|
|
|
|
errors: function() {
|
|
/// <summary>
|
|
/// Get the error messages if any.
|
|
/// </summary>
|
|
/// <returns type="Array">Messages for the failed validation rules.</returns>
|
|
|
|
},
|
|
|
|
|
|
hideMessages: function() {
|
|
/// <summary>
|
|
/// Hides the validation messages.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
validate: function() {
|
|
/// <summary>
|
|
/// Validates the input element(s) against the declared validation rules.
|
|
/// </summary>
|
|
/// <returns type="Boolean">true if all validation rules passed successfully.Note that if a HTML form element is set as validation container, the form submits will be automatically prevented if validation fails.</returns>
|
|
|
|
},
|
|
|
|
|
|
validateInput: function(input) {
|
|
/// <summary>
|
|
/// Validates the input element against the declared validation rules.
|
|
/// </summary>
|
|
/// <param name="input" type="Object" >Input element to be validated.</param>
|
|
/// <returns type="Boolean">true if all validation rules passed successfully.</returns>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoValidator = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.ui.Validator widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.ui.Validator">The kendo.ui.Validator instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoValidator = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.ui.Validator widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// messages — Object
|
|
/// Set of messages (either strings or functions) which will be shown when given validation rule fails.
|
|
/// By setting already existing key the appropriate built-in message will be overridden.
|
|
///
|
|
/// rules — Object
|
|
/// Set of custom validation rules. Those rules will extend the built-in ones.
|
|
///
|
|
/// validateOnBlur — Boolean
|
|
/// Determines if validation will be triggered when element loses focus. Default value is true.
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.ui.Widget = function() { };
|
|
|
|
kendo.ui.Widget.prototype = {
|
|
|
|
|
|
|
|
|
|
bind: function() {
|
|
/// <summary>
|
|
/// Attaches a handler to an event. Examples and more info can be found in the bind section of the kendo.Observable API reference.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
destroy: function() {
|
|
/// <summary>
|
|
/// Prepares the widget for safe removal from the DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
one: function() {
|
|
/// <summary>
|
|
/// Attaches a handler to an event. The handler is executed only once. Examples and more info can be found in the one section of the
|
|
/// kendo.Observable API reference.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
trigger: function() {
|
|
/// <summary>
|
|
/// Executes all handlers attached to the given event. More info can be found in the trigger section of the
|
|
/// kendo.Observable API reference.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
unbind: function() {
|
|
/// <summary>
|
|
/// Remove a previously attached event handler. More info can be found in the unbind section of the
|
|
/// kendo.Observable API reference.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
self: null
|
|
|
|
};
|
|
|
|
$.fn.getKendoWidget = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.ui.Widget widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.ui.Widget">The kendo.ui.Widget instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoWidget = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.ui.Widget widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|