API Documentation Index _global_ Array Boolean CoreTest CoreTest.Plan CoreTest.Suite Date Function Object SC SC.AceTheme SC.AceTheme.Dark SC.ActionSupport SC.AlertPane SC.appCache SC.Application SC.Array SC.ArrayController SC.Async SC.AudioView SC.AutoMixin SC.AutoResize SC.AutoResizingMenuItemView SC.AutoResizingMenuPane SC.BaseTheme.canvasImageRenderDelegate SC.BaseTheme.imageRenderDelegate SC.BaseTheme.labelRenderDelegate SC.BaseTheme.radioGroupRenderDelegate SC.BaseTheme.selectRenderDelegate SC.Benchmark SC.Binding SC.browser SC.Builder SC.Button SC.ButtonView SC.CalculatesEmptiness SC.CascadeDataSource SC.Checkbox SC.CheckboxView SC.ChildArray SC.ChildAttribute SC.ChildRecord SC.ChildrenAttribute SC.ChildViewLayoutProtocol SC.CollectionContent SC.CollectionGroup SC.CollectionRowDelegate SC.CollectionView SC.CollectionViewDelegate SC.Color SC.Comparable SC.ContainerView SC.ContainerView.DISSOLVE SC.ContainerView.FADE_COLOR SC.ContainerView.MOVE_IN SC.ContainerView.PUSH SC.ContainerView.REVEAL SC.ContentDisplay SC.ContentValueSupport SC.Control SC.Controller SC.ControlTestPane SC.Cookie SC.Copyable SC.CoreSet SC.CoreView SC.CSSRule SC.CSSStyle SC.CSSStyleSheet SC.Cursor SC.DataSource SC.DateFieldView SC.DateTime SC.DelegateSupport SC.DesignCoder SC.DisclosureView SC.Drag SC.DragDataSourceProtocol SC.DraggablePaneSupport SC.DragSourceProtocol SC.DropTargetProtocol SC.Editable SC.EmptyState SC.EmptyTheme SC.Enumerable SC.Enumerator SC.Error SC.Event SC.ExceptionHandler SC.FetchedAttribute SC.FieldView SC.FixturesDataSource SC.FlowedLayout SC.FormRowView SC.FormView SC.Freezable SC.Function SC.Gesturable SC.Gesture SC.GridView SC.HistoryState SC.ImageButtonView SC.imageQueue SC.ImageView SC.IndexSet SC.InlineEditable SC.InlineEditor SC.InlineEditorDelegate SC.InlineTextFieldDelegate SC.InlineTextFieldView SC.InnerFrame SC.LabelView SC.LegacyTheme.progressRenderDelegate SC.LinkView SC.ListItemView SC.ListView SC.Logger SC.MainPane SC.ManyArray SC.ManyAttribute SC.MasterDetailView SC.Math SC.mediaCapabilities SC.MediaControlsView SC.MediaSlider SC.MenuItemView SC.MenuPane SC.MenuScrollerView SC.MenuScrollView SC.MiniMediaControlsView SC.ModalPane SC.Module SC.NavigationBarView SC.NavigationBuilder SC.NavigationView SC.NestedStore SC.Object SC.ObjectController SC.ObjectDesigner SC.ObjectMixinProtocol SC.Observable SC.ObservableProtocol SC.OverlayScrollerView SC.Page SC.PalettePane SC.Pane SC.PanelPane SC.PickerPane SC.PinchGesture SC.platform SC.PopupButtonView SC.PopupButtonView.InstantiateMenuTask SC.ProgressView SC.Query SC.RadioView SC.RangeObserver SC.Record SC.RecordArray SC.RecordAttribute SC.Reducers SC.RelationshipSupport SC.RenderContext SC.RenderDelegate SC.Request SC.Request.manager SC.Responder SC.ResponderContext SC.ResponderProtocol SC.Response SC.RootResponder SC.routes SC.RunLoop SC.Scanner SC.SceneView SC.ScrollerView SC.ScrollView SC.SegmentedView SC.SegmentView SC.SelectionSet SC.SelectionSupport SC.SelectView SC.SeparatorView SC.Set SC.SheetPane SC.SimpleMediaControlsView SC.SingleAttribute SC.SliderView SC.SourceListGroupView SC.SourceListView SC.SparseArray SC.SparseArrayDelegateProtocol SC.SplitChild SC.SplitDividerView SC.SplitThumb SC.SplitView SC.StackedView SC.State SC.StatechartDelegate SC.StatechartManager SC.StatePathMatcher SC.StateRouteHandlerContext SC.StaticContentView SC.StaticLayout SC.Store SC.String SC.SwapTransitionProtocol SC.SwipeGesture SC.TableColumn SC.TableView SC.TabView SC.TapGesture SC.TemplateCollectionView SC.TemplatePane SC.TemplateView SC.TextField SC.TextFieldSupport SC.TextFieldView SC.TextSelection SC.Theme SC.ThumbView SC.Timer SC.ToolbarView SC.Touch SC.TreeController SC.TreeItemContent SC.UndoManager SC.UserDefaults SC.Validatable SC.Validator SC.Validator.CreditCard 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 SC.View SC.View.BOUNCE_ADJUST 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 SC.View.SPRING_ADJUST SC.View.SPRING_IN SC.View.SPRING_OUT SC.ViewDesigner SC.ViewTransitionProtocol SC.WebSocket SC.WebSocketDelegate SC.WebView SC.WellView SC.WorkspaceView SC.XHRResponse String

Class: SC.Error

Extends SC.Object.

An error, used to represent an error state.

Many API's within SproutCore will return an instance of this object whenever they have an error occur. An error includes an error code, description, and optional human readable label that indicates the item that failed.

Depending on the error, other properties may also be added to the object to help you recover from the failure.

You can pass error objects to various UI elements to display the error in the interface. You can easily determine if the value returned by some API is an error or not using the helper SC.ok(value).

Faking Error Objects

You can actually make any object you want to be treated like an Error object by simply implementing two properties: isError and errorValue. If you set isError to YES, then calling SC.ok(obj) on your object will return NO. If isError is YES, then SC.val(obj) will return your errorValue property instead of the receiver.

When using SC.typeOf(obj), SC.T_ERROR will only be returned if the obj is an instance of SC.Error

Defined in: error.js

Since:: SproutCore 1.0

Field Summary

Fields borrowed from SC.Object:: concatenatedProperties, isDestroyed, isObject, nextProperty, object, property, target, toInvalidate
Fields borrowed from SC.Observable:: isObservable

Instance Methods

Field Detail

code Number

error code. Used to designate the error type.

errorValue Object

The value the error represents. This is used when wrapping a value inside of an error to represent the validation failure.

SC.Error.HAS_MULTIPLE_VALUES Number

Standard error code for errors that do not support multiple values.

isError Boolean

Walk like a duck.

label String

Human readable name of the item with the error.

message String

Human readable description of the error. This can also be a non-localized key.

Instance Method Detail

errorObject()

The original error object. Normally this will return the receiver. However, sometimes another object will masquerade as an error; this gives you a way to get at the underlying error.

trace()

The error stacktrace.

Documentation generated by JsDoc Toolkit 2.4.0 on Wed Apr 08 2015 10:02:20 GMT-0600 (CST)