Class: SC.PanelPane


Extends SC.Pane.

Most SproutCore applications need modal panels. The default way to use the panel pane is to simply add it to your page like this:

SC.PanelPane.create({
  layout: { width: 400, height: 200, centerX: 0, centerY: 0 },
  contentView: SC.View.extend({
  })
}).append();

This will cause your panel to display. The default layout for a Panel is to cover the entire document window with a semi-opaque background, and to resize with the window.

Defined in: panel.js

Since:
SproutCore 1.0

Field Summary

Instance Methods

Field Detail

acceptsKeyPane Boolean
Default value:
YES
See:
SC.Pane#acceptsKeyPane
ariaDescribedBy String

The WAI-ARIA describedby text. Screen readers will use this to speak the description of the panel. This should be an id to an element inside the panel.

ariaLabel String

The WAI-ARIA label for the panel. Screen readers will use this to tell the user a name for the panel.

ariaLabelledBy String

The WAI-ARIA labelledby for the panel. Screen readers will use this to tell the header or name of your panel if there is no label. This should be an id to an element inside the panel.

ariaRole String
The WAI-ARIA role for panel pane.
Default value:
'dialog'
classNames Array
Default value:
['sc-panel']
See:
SC.View#classNames
contentView SC.View
Set this to the view you want to act as the content within the panel.
Default value:
null
isModal Boolean

Indicates that a pane is modal and should not allow clicks to pass though to panes underneath it. This will usually cause the pane to show the modalPane underneath it.

Default value:
YES
isPanelPane
Walk like a duck.
modalPane

The modal pane to place behind this pane if this pane is modal. This must be a subclass or an instance of SC.ModalPane.

renderDelegateName String
The name of the theme's `SC.PanelPane` render delegate.
Default value:
'panelRenderDelegate'

Instance Method Detail

contentViewDidChange()

Invoked whenever the content property changes. This method will simply call replaceContent. Override replaceContent to change how the view is swapped out.

destroy()
didAppendToDocument()
Called when the pane is attached. Takes on key pane status.
didShowInDocument()
Called when the pane is shown. Takes on key pane status.
replaceContent(newContent)
Parameters:
newContent SC.View
willHideInDocument()
Called when the pane is about to be hidden. Resigns key pane status.
willRemoveFromDocument()
Called when the pane is detached. Resigns key pane status.
Documentation generated by JsDoc Toolkit 2.4.0 on Wed Apr 08 2015 10:02:21 GMT-0600 (CST)