API Documentation Index
_global_
Array
Boolean
CoreTest
CoreTest is the unit testing library for SproutCore.
CoreTest.Plan
A test plan contains a set of functions that will be executed in order.
CoreTest.Suite
A test Suite defines a group of reusable unit tests that can be added to a test plan at any time by calling the generate() method.
Date
Function
Object
SC
All SproutCore methods and functions are defined inside of this namespace.
SC.AceTheme
SproutCore's Ace theme.
SC.AceTheme.Dark
SC.
SC.ActionSupport
Implements basic target + action support for views.
SC.AlertPane
Displays a preformatted modal alert pane.
SC.appCache
This is a very simple object that makes it easier to use the window.applicationCache in a SproutCore application.
SC.Application
The root object for a SproutCore application.
SC.Array
This module implements Observer-friendly Array-like behavior.
SC.ArrayController
An ArrayController provides a way for you to publish an array of objects for CollectionView or other controllers to work with.
SC.Async
Represents a call that is intended to be asynchronous.
SC.AudioView
Renders a audioView
using different technologies like HTML5 audio tag,
quicktime and flash.
SC.AutoMixin
Use this mixin to automatically mix in a list of mixins into all child views created by the view (that are created at view initialization).
SC.AutoResize
Use this mixin to make your view automatically resize based upon its value, title, or other string property.
SC.AutoResizingMenuItemView
Extends SC.MenuItemView to support auto resize.
SC.AutoResizingMenuPane
Extends SC.MenuPane to add support for automatic resizing.
SC.BaseTheme.canvasImageRenderDelegate
Renders and updates DOM representations of an image.
SC.BaseTheme.imageRenderDelegate
Renders and updates DOM representations of an image.
SC.BaseTheme.labelRenderDelegate
Renders and updates DOM representations of a label.
SC.BaseTheme.radioGroupRenderDelegate
Renders and updates the HTML representation of a group of radio buttons.
SC.BaseTheme.selectRenderDelegate
Renders and updates the DOM representation of a SelectView.
SC.Benchmark
This bit of meta-programming magic can install a benchmark handler on any object method.
SC.Binding
A binding simply connects the properties of two objects so that whenever the value of one property changes, the other property will be changed also.
SC.browser
This object contains information about the browser environment SproutCore is running in.
SC.Builder
The Builder class makes it easy to create new chained-builder API's such as
those provided by CoreQuery or jQuery
.
SC.Button
SC.ButtonView
Implements a push-button-style button.
SC.CalculatesEmptiness
A view is empty if all of its children are empty.
SC.CascadeDataSource
A cascading data source will actually forward requests onto an array of
additional data sources, stopping when one of the data sources returns YES
,
indicating that it handled the request.
SC.Checkbox
SC.CheckboxView
Represents a Checkbox Button.
SC.ChildArray
A `ChildArray` is used to map an array of `ChildRecord` objects.
SC.ChildAttribute
ChildAttribute is a subclass of RecordAttribute
and handles to-one
relationships for child records.
SC.ChildRecord
SC.ChildrenAttribute
ChildrenAttribute is a subclass of ChildAttribute and handles to-many relationships for child records.
SC.ChildViewLayoutProtocol
The SC.
SC.CollectionContent
This mixin provides standard methods used by a CollectionView to provide additional meta-data about content in a collection view such as selection or enabled state.
SC.CollectionGroup
Any view you want to use as a group view in a collection must include this mixin.
SC.CollectionRowDelegate
CollectionRowDelegate
s are consulted by collection views, such as SC.
SC.CollectionView
This class renders a collection of views based on the items array set as its content.
SC.CollectionViewDelegate
A Collection View Delegate is consulted by a SC.
SC.Color
Represents a color, and provides methods for manipulating it.
SC.Comparable
Implements some standard methods for comparing objects.
SC.ContainerView
A container view will display its "content" view as its only child.
SC.ContainerView.DISSOLVE
Provides dissolve transitions for SC.
SC.ContainerView.FADE_COLOR
Provides fade through color transitions to SC.
SC.ContainerView.MOVE_IN
Provides move in transitions to SC.
SC.ContainerView.PUSH
Provides push transitions to SC.
SC.ContainerView.REVEAL
Provides reveal transitions to SC.
SC.ContentDisplay
The SC.
SC.ContentValueSupport
This mixin allows a view to get its value from a content object based
on the value of its contentValueKey
.
SC.Control
A Control is a view that also implements some basic state functionality.
SC.Controller
The controller base class provides some common functions you will need for controllers in your applications, especially related to maintaining an editing context.
SC.ControlTestPane
Generates a pane that will display vertically stacked views for testing.
SC.Cookie
Allows for easier handling of the document.cookie object.
SC.Copyable
Implements some standard methods for copying an object.
SC.CoreSet
CoreSet is just like Set but not observable.
SC.CoreView
SC.CSSRule
SC.
SC.CSSStyle
SC.
SC.CSSStyleSheet
SC.
SC.Cursor
SC.
SC.DataSource
A DataSource connects an in-memory store to one or more server backends.
SC.DateFieldView
A Date field add behaviour to the Text Field to support date management, for example, disabling deletion, and special behaviour to tabs commands.
SC.DateTime
A class representation of a date and time.
SC.DelegateSupport
Support methods for the Delegate design pattern.
SC.DesignCoder
A DesignCoder encodes specifically the design for a set of views.
SC.DisclosureView
Disclosure triangle button.
SC.Drag
An instance of this object is created whenever a drag occurs.
SC.DragDataSourceProtocol
The SC.
SC.DraggablePaneSupport
Provides drag functionality to a pane.
SC.DragSourceProtocol
The SC.
SC.DropTargetProtocol
The SC.
SC.Editable
The Editable mixin is a standard protocol used to activate keyboard editing on views that are editable such as text fields, label views and item views.
SC.EmptyState
Represents an empty state that gets assigned as a state's initial substate if the state does not have an initial substate defined.
SC.EmptyTheme
SC.Enumerable
This mixin defines the common interface implemented by enumerable objects in SproutCore.
SC.Enumerator
An object that iterates over all of the values in an object.
SC.Error
An error, used to represent an error state.
SC.Event
SC.ExceptionHandler
If an exception is thrown during execution of your SproutCore app, this object will be given the opportunity to handle it.
SC.FetchedAttribute
Describes a single attribute that is fetched dynamically from the server when you request it.
SC.FieldView
Base view for managing a view backed by an input element.
SC.FixturesDataSource
TODO: Describe Class
SC.FlowedLayout
Normal SproutCore views are absolutely positioned--parent views have relatively little input on where their child views are placed.
SC.FormRowView
Represents a single row in a form.
SC.FormView
FormView lays out rows, manages their label widths, binds their
content properties, and sets up their contentValueKeys
as needed.
SC.Freezable
The SC.
SC.Function
SC.Gesturable
You can mix in SC.
SC.Gesture
An SC.
SC.GridView
A grid view renders a collection of items in a grid of rows and columns.
SC.HistoryState
Represents a history state that can be assigned to a SC.
SC.ImageButtonView
Provides a button that displays an image instead of the standard button user interface.
SC.imageQueue
The image queue can be used to control the order of loading images.
SC.ImageView
Displays an image in the browser.
SC.IndexSet
A collection of ranges.
SC.InlineEditable
This mixin is used for views that show a seperate editor view to edit.
SC.InlineEditor
This mixin is for a view that is editable but is acting as a proxy to edit another view.
SC.InlineEditorDelegate
This delegate is consulted by view implementing SC.
SC.InlineTextFieldDelegate
This is the default InlineEditorDelegate for SC.
SC.InlineTextFieldView
The inline text editor is used to display an editable area for controls that are not always editable such as label views and source list views.
SC.InnerFrame
InnerFrame provides the innerFrameForSize
function, which will return a frame for the given size adjusted
to fit within the given outer size, according to the align and scale properties.
SC.LabelView
Displays a static string of text.
SC.LegacyTheme.progressRenderDelegate
Renders and updates DOM representations of progress bars.
SC.LinkView
This view creates a link (i.e.
SC.ListItemView
Many times list items need to display a lot more than just a label of text.
SC.ListView
A list view renders vertical or horizontal lists of items.
SC.Logger
Object to allow for safe logging actions, such as using the browser console.
SC.MainPane
Most SproutCore applications have a main pane, which dominates the application page.
SC.ManyArray
A ManyArray
is used to map an array of record ids back to their
record objects which will be materialized from the owner store on demand.
SC.ManyAttribute
ManyAttribute is a subclass of RecordAttribute
and handles to-many
relationships.
SC.MasterDetailView
Master/Detail view is a simple view which manages a master view and a detail view.
SC.Math
Implements some enhancements to the built-in Number object that makes it easier to handle rounding and display of numbers.
SC.mediaCapabilities
An easy-to-reference list of media capabilities which the current running browser supports such as HTML5 and Plugin detection.
SC.MediaControlsView
(Document Your View Here)
SC.MediaSlider
The MediaSlider element takes the original SC.
SC.MenuItemView
An SC.MenuItemView is created for every item in a menu.
SC.MenuPane
SC.
SC.MenuScrollerView
Implements a complete scroller view for menus.
SC.MenuScrollView
Implements a scroll view for menus.
SC.MiniMediaControlsView
SC.ModalPane
A modal pane is used to capture mouse events inside a pane that is modal.
SC.Module
SC.
SC.NavigationBarView
NavigationBars do Great Things.
SC.NavigationBuilder
NavigationBuilder is an implementation of the Builder protocol.
SC.NavigationView
NavigationView is very loosely based on UINavigationController: that is, it implements a push/pop based API.
SC.NestedStore
A nested store can buffer changes to a parent store and then commit them all at once.
SC.Object
Root object for the SproutCore framework.
SC.ObjectController
An ObjectController gives you a simple way to manage the editing state of an object.
SC.ObjectDesigner
This is a basic designer used for all SC.
SC.ObjectMixinProtocol
The SC.
SC.Observable
Key-Value-Observing (KVO) simply allows one object to observe changes to a property on another object.
SC.ObservableProtocol
The SC.
SC.OverlayScrollerView
SC.Page
SC.
SC.PalettePane
Displays a non-modal, default positioned, drag&drop-able palette pane.
SC.Pane
A Pane is like a regular view except that it does not need to live within a parent view.
SC.PanelPane
Most SproutCore applications need modal panels.
SC.PickerPane
Display a non-modal pane that automatically repositions around a view so as to remain visible.
SC.PinchGesture
SC.platform
This platform object allows you to conditionally support certain HTML5 features.
SC.PopupButtonView
SC.
SC.PopupButtonView.InstantiateMenuTask
An SC.
SC.ProgressView
Displays a progress bar.
SC.Query
This class permits you to perform queries on your data store or a remote data store.
SC.RadioView
A RadioView is used to create a group of radio buttons.
SC.RangeObserver
A RangeObserver is used by Arrays to automatically observe all of the objects in a particular range on the array.
SC.Record
A Record is the core model class in SproutCore.
SC.RecordArray
A RecordArray
is a managed list of records (instances of your SC.
SC.RecordAttribute
A RecordAttribute describes a single attribute on a record.
SC.Reducers
SC.RelationshipSupport
Provides support for having relationships propagate by data provided by the data source.
SC.RenderContext
A RenderContext is a builder that can be used to generate HTML for views or to update an existing element.
SC.RenderDelegate
Base class for all render delegates.
SC.Request
Implements support for AJAX requests using XHR, XHR2 and other protocols.
SC.Request.manager
The request manager coordinates all of the active XHR requests.
SC.Responder
Provides common methods for sending events down a responder chain.
SC.ResponderContext
The root object for a responder chain.
SC.ResponderProtocol
The SC.
SC.Response
A response represents a single response from a server request and handles the communication to the server.
SC.RootResponder
The RootResponder captures events coming from a web browser and routes them to the correct view in the view hierarchy.
SC.routes
SC.
SC.RunLoop
The run loop provides a universal system for coordinating events within your application.
SC.Scanner
A Scanner reads a string and interprets the characters into numbers.
SC.SceneView
Displays several views as scenes that can slide on and off the screen.
SC.ScrollerView
Displays a horizontal or vertical scroller.
SC.ScrollView
Implements a complete scroll view.
SC.SegmentedView
SegmentedView is a special type of button that can display multiple segments.
SC.SegmentView
SegmentViews are the views used and arranged by SC.
SC.SelectionSet
A SelectionSet contains a set of objects that represent the current selection.
SC.SelectionSupport
Implements common selection management properties for controllers.
SC.SelectView
SelectView has a functionality similar to that of SelectField
Clicking the SelectView button displays a menu pane with a list of items.
SC.SeparatorView
Displays a horizontal or vertical separator line.
SC.Set
An unordered collection of objects.
SC.SheetPane
Displays a modal sheet pane that animates from the top of the viewport.
SC.SimpleMediaControlsView
SC.SingleAttribute
SingleAttribute
is a subclass of RecordAttribute
and handles to-one
relationships.
SC.SliderView
SliderView displays a horizontal slider control that you can use to choose from a spectrum (or a sequence) of values.
SC.SourceListGroupView
Displays a group view in a source list.
SC.SourceListView
Displays a source list like the source list in iTunes
.
SC.SparseArray
A dynamically filled array.
SC.SparseArrayDelegateProtocol
The SC.
SC.SplitChild
Child views of SplitViews should use this mixin to get their positioning logic and default settings.
SC.SplitDividerView
A SplitDividerView sits between any two other views in a SplitView.
SC.SplitThumb
A SplitThumb may be placed inside any view in a SplitView, and can even be a direct child of the SplitView.
SC.SplitView
SC.
SC.StackedView
A StackedView is a CollectionView that expects its content to use static layout to stack vertically.
SC.State
Represents a state within a statechart.
SC.StatechartDelegate
Apply to objects that are to represent a delegate for a SC.
SC.StatechartManager
The startchart manager mixin allows an object to be a statechart.
SC.StatePathMatcher
The SC.
SC.StateRouteHandlerContext
Represents contextual information for whenever a state handles a triggered route.
SC.StaticContentView
StaticContentView allows you to display arbitrary HTML content inside your view hierarchy.
SC.StaticLayout
SC.
SC.Store
The Store is where you can find all of your dataHashes
.
SC.String
Implements support methods useful when working with strings in SproutCore applications.
SC.SwapTransitionProtocol
The SC.
SC.SwipeGesture
SC.TableColumn
An abstract object that manages the state of the columns behind a
SC.
SC.TableView
Deprecated.
SC.TabView
Incorporates a segmented view and a container view to display the selected tab.
SC.TapGesture
SC.TemplateCollectionView
SC.TemplatePane
SC.
SC.TemplateView
SC.
SC.TextField
SC.TextFieldSupport
SC.TextFieldView
A text field is an input element with type "text".
SC.TextSelection
A simple object representing the selection inside a text field.
SC.Theme
Represents a theme, and is also the core theme in which SC looks for other themes.
SC.ThumbView
SC.Timer
A Timer executes a method after a defined period of time.
SC.ToolbarView
SC.
SC.Touch
SC.
SC.TreeController
A TreeController manages a tree of model objects that you might want to display in the UI using a collection view.
SC.TreeItemContent
A tree item is a model object that acts as a node in a tree-like data structure such as a hierarchy of folders or outline of items.
SC.UndoManager
This is a simple undo manager.
SC.UserDefaults
The UserDefaults object provides an easy way to store user preferences in your application on the local machine.
SC.Validatable
Views that include the Validatable mixin can be used with validators to ensure their values are valid.
SC.Validator
Validators provide a way for you to implement simple form field validation and transformation.
SC.Validator.CreditCard
Validate a field value as a credit card number.
SC.Validator.Date
SC.Validator.DateTime
SC.Validator.Email
SC.Validator.EmailOrEmpty
SC.Validator.NotEmpty
SC.Validator.Number
SC.Validator.Password
SC.Validator.PositiveInteger
SC.VideoView
Renders a videoView
using different technologies like HTML5 video tag,
quicktime and flash.
SC.View
Base class for managing a view.
SC.View.BOUNCE_ADJUST
To modify the bounce animation, you may set the following transition
options in transitionAdjustOptions
:
- bounces {Number} the number of bounce back iterations.
SC.View.BOUNCE_IN
SC.View.BOUNCE_OUT
SC.View.FADE_IN
SC.View.FADE_OUT
SC.View.POP_IN
SC.View.POP_OUT
SC.View.SCALE_IN
SC.View.SCALE_OUT
SC.View.SLIDE_IN
SC.View.SLIDE_OUT
SC.View.SMOOTH_ADJUST
To modify the smooth animation, you may set the following transition options in
transitionAdjustOptions
:- duration {Number} the number of seconds for the animation.
SC.View.SPRING_ADJUST
To modify the spring animation, you may set the following transition options in
transitionAdjustOptions
:- springs {Number} the number of spring back iterations.
SC.View.SPRING_IN
SC.View.SPRING_OUT
SC.ViewDesigner
A Designer class provides the core editing functionality you need to edit a view in the UI.
SC.ViewTransitionProtocol
The
SC.
SC.WebSocket
Implements SproutCore run loop aware event handling for WebSocket.
SC.WebSocketDelegate
A WebSocket Delegate is consulted by
SC.
SC.WebView
Used to display an iframe.
SC.WellView
A WellView is a ContainerView with a border.
SC.WorkspaceView
WorkspaceView manages a content view and two optional toolbars (top and bottom).
SC.XHRResponse
Concrete implementation of
SC.
String
Documentation generated by JsDoc Toolkit 2.4.0 on Wed Apr 08 2015 10:02:21 GMT-0600 (CST)
- springs {Number} the number of spring back iterations.
- duration {Number} the number of seconds for the animation.