SproutCore Reference Index

WARNING: This is draft reference documentation generated automatically from the SproutCore source. It has not been fully vetted for accuracy or completeness. Expect to find bugs here and there. If you want to help make the docs better, please grab the source and make the docs better!

_global_


Function


SC

The SproutCore namespace.

SC.AlertPane

Displays a preformatted modal alert pane.

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.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.Border

The Border mixin can be applied to any view to give it a visual border.

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

This mixin implements many of the basic state-handling attributes for button-like views, including an auto-updated title, and mapping the current value to an isSelected state.

SC.ButtonView

Implements a push-button-style button.

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.CheckboxView

Renders a checkbox button view specifically.

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

TODO: Add full description of SC.CollectionGroup Any view you want to use as a group view in a collection must include this mixin.

SC.CollectionRowDelegate

CollectionRowDelegates are consulted by SC.ListView and SC.TableView to control the height of rows, including specifying custom heights for specific rows.

SC.CollectionView

TODO: Document SC.CollectionView Renders a collection of views from a source array of model objects.

SC.CollectionViewDelegate

A Collection View Delegate is consulted by a SC.CollectionView's to make policy decisions about certain behaviors such as selection control and drag and drop.

SC.Comparable

Implements some standard methods for comparing objects.

SC.ContainerView

A container view will display its "content" view as its only child.

SC.ContentDisplay

The SC.ContentDisplay mixin makes it easy to automatically update your view display whenever relevant properties on a content object change.

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.Cookie

Allows for easier handling of the document.cookie object.

SC.Copyable

Impelements some standard methods for copying an object.

SC.CoreQuery


SC.CoreSet

CoreSet is just like set but not observable.

SC.Cursor

SC.Cursor A Cursor object is used to sychronize the cursor used by multiple views at the same time.

SC.DataSource

TODO: Describe

SC.DateTime

A class representation of a date and time.

SC.DelegateSupport

Support methods for the Delegate design pattern.

SC.DisclosureView

Disclosure triangle button.

SC.Drag

An instance of this object is created whenever a drag occurs.

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.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.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.Freezable

The SC.Freezable mixin implements some basic methods for marking an object as frozen.

SC.GridView

A grid view renders a collection of items in a grid of rows and columns.

SC.imageCache

The image cache can be used to control the order of loading images into the browser cache.

SC.ImageView

Displays an image in the browser.

SC.IndexSet

A collection of ranges.

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.LabelView

Displays a static string of text.

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 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.MenuItemView

SC.MenuItemView

SC.MenuPane

SC.MenuPane

SC.MenuScrollerView

Implements a complete scroller view for menus.

SC.MenuScrollView

Implements a scroll view for menus.

SC.ModalPane

A modal pane is used to capture mouse events inside a pane that is modal.

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.Observable

Key-Value-Observing (KVO) simply allows one object to observe changes to a property on another object.

SC.Observers

The private ObserverQueue is used to maintain a set of pending observers.

SC.ObserverSet

This private class is used to store information about obversers on a particular key.

SC.Page

SC.Page A Page object is used to store a set of views that can be lazily configured as needed.

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.ProgressView

Displays a progress bar.

SC.Query

This permits you to perform queries on your data store, written in a SQL-like language.

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 wraps an array of storeKeys and, optionally, a Query object.

SC.RecordAttribute

A RecordAttribute describes a single attribute on a record.

SC.RenderContext

A RenderContext is a builder that can be used to generate HTML for views or to update an existing element.

SC.Request

Implements support for Ajax requests using XHR, JSON-P and other prototcols.

SC.Responder

Provides common methods for sending events down a responder chain.

SC.ResponderContext

The root object for a responder chain.

SC.RootResponder

The RootResponder captures events coming from a web browser and routes them to the correct view in the view hierarchy.

SC.routes

Routes makes it possible to load a location in the browser.

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.Scrollable

Any views you implement that are scrollable should include this mixin to provide basic support for scrolling actions.

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.SelectFieldView

SelectFieldView displays browser-native popup menu.

SC.SelectionSet

A SelectionSet contains a set of objects that represent the current selection.

SC.SelectionSupport

Implements common selection management properties for controllers.

SC.SeparatorView

Displays a horizontal or vertical separator line.

SC.Set

An unordered collection of objects.

SC.SingleAttribute

SingleAttribute is a subclass of RecordAttribute and handles to-one relationships.

SC.SliderView

A SliderView shows a horizontal slider control that you can use to set variable 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.SplitDividerView

A SplitDividerView displays a divider between two views within a SplitView.

SC.StackedView

A StackedView is a CollectionView that expects its content to use static layout to stack vertically.

SC.StaticLayout

Normally, SproutCore views use absolute positioning to display themselves on the screen.

SC.Store

The Store is where you can find all of your dataHashes.

SC.String

SproutCore implements a variety of enhancements to the built-in String object that make it easy to perform common substitutions and conversions.

SC.TabView

Incorporates a segmented view and a container view to display the selected tab.

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.ThumbView

A ThumbView works in concert with SC.SplitView to adjust the divider position from an arbitrary subview of the SplitView.

SC.Timer

A Timer executes a method after a defined period of time.

SC.ToolbarView

A toolbar view can be anchored at the top or bottom of the window to contain your main toolbar buttons.

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.Email


SC.Validator.EmailOrEmpty


SC.Validator.NotEmpty


SC.Validator.Number


SC.Validator.Password


SC.View

Base class for managing a view.

SC.WebView

Used to display an iframe.

SC.WellView

A WellView is a ContainerView with a border.

String


Documentation generated by JsDoc Toolkit 2.0.2 on Sat Jan 02 2010 13:50:00 GMT-0800 (PST)