### Import :
```js
const Pane = brackets.getModule("view/Pane")
```

<a name="module_view/Pane"></a>

## view/Pane
Pane objects host views of files, editors, etc... Clients cannot access
Pane objects directly. Instead the implementation is protected by the
MainViewManager -- however View Factories are given a Pane object which
they can use to add views.  References to Pane objects should not be kept
as they may be destroyed and removed from the DOM.

To get a custom view, there are two components:

 1) A View Factory
 2) A View Object

View objects are anonymous object that have a particular interface.

Views can be added to a pane but do not have to exist in the Pane object's view list.
Such views are "temporary views".  Temporary views are not serialized with the Pane state
or reconstituted when the pane is serialized from disk.  They are destroyed at the earliest
opportunity.

Temporary views are added by calling `Pane.showView()` and passing it the view object. The view
will be destroyed when the next view is shown, the pane is mereged with another pane or the "Close All"
command is exectuted on the Pane.  Temporary Editor Views do not contain any modifications and are
added to the workingset (and are no longer tempoary views) once the document has been modified. They
will remain in the working set until closed from that point on.

Views that have a longer life span are added by calling addView to associate the view with a
filename in the _views object.  These views are not destroyed until they are removed from the pane
by calling one of the following: removeView, removeViews, or _reset

Pane Object Events:

 - viewListChange - Whenever there is a file change to a file in the working set.  These 2 events: `DocumentManager.pathRemove`
 and `DocumentManager.fileNameChange` will cause a `viewListChange` event so the WorkingSetView can update.

 - currentViewChange - Whenever the current view changes.
            (e, newView:View, oldView:View)

 - viewDestroy - Whenever a view has been destroyed
            (e, view:View)

View Interface:

The view is an anonymous object which has the following method signatures. see ImageViewer for an example or the sample
provided with Brackets `src/extensions/samples/BracketsConfigCentral`

```js
    {
        $el:jQuery
        getFile: function ():!File
        updateLayout: function(forceRefresh:boolean)
        destroy: function()
        getScrollPos: function():*=
        adjustScrollPos: function(state:Object=, heightDelta:number)=
        notifyContainerChange: function()=
        notifyVisibilityChange: function(boolean)=
        focus:function()=
    }
```
When views are created they can be added to the pane by calling `pane.addView()`.
Views can be created and parented by attaching directly  to `pane.$el`

    this._codeMirror = new CodeMirror(pane.$el, ...)

Factories can create a view that's initially hidden by calling `pane.addView(view)` and passing `false` for the show parameter.
Hidden views can be later shown by calling `pane.showView(view)`

`$el:jQuery!`

 property that stores the jQuery wrapped DOM element of the view. All views must have one so pane objects can manipulate the DOM
 element when necessary (e.g. `showView`, `_reparent`, etc...)

`getFile():File!`

 Called throughout the life of a View when the current file is queried by the system.

`updateLayout(forceRefresh:boolean)`

 Called to notify the view that it should be resized to fit its parent container.  This may be called several times
 or only once.  Views can ignore the `forceRefresh` flag. It is used for editor views to force a relayout of the editor
 which probably isn't necessary for most views.  Views should implement their html to be dynamic and not rely on this
 function to be called whenever possible.

`destroy()`

 Views must implement a destroy method to remove their DOM element at the very least.  There is no default
 implementation and views are hidden before this method is called. The Pane object doesn't make assumptions
 about when it is safe to remove a node. In some instances other cleanup  must take place before a the DOM
 node is destroyed so the implementation details are left to the view.

 Views can implement a simple destroy by calling

     this.$el.remove()

 These members are optional and need not be implemented by Views

     getScrollPos()
     adjustScrollPos()

 The system at various times will want to save and restore a view's scroll position.  The data returned by `getScrollPos()`
 is specific to the view and will be passed back to `adjustScrollPos()` when the scroll position needs to be restored.

 When Modal Bars are invoked, the system calls `getScrollPos()` so that the current scroll psotion of all visible Views can be cached.
 That cached scroll position is later passed to `adjustScrollPos()` along with a height delta.  The height delta is used to
 scroll the view so that it doesn't appear to have "jumped" when invoking the Modal Bar.

 Height delta will be a positive when the Modal Bar is being shown and negative number when the Modal Bar is being hidden.

 `getViewState()` is another optional member that is used to cache a view's state when hiding or destroying a view or closing the project.
 The data returned by this member is stored in `ViewStateManager` and is saved with the project.

 Views or View Factories are responsible for restoring the view state when the view of that file is created by recalling the cached state

     var view = createIconView(file, pane);
     view.restoreViewState(ViewStateManager.getViewState(file.fullPath));

 Notifications
 The following optional methods receive notifications from the Pane object when certain events take place which affect the view:

`notifyContainerChange()`

 Optional Notification callback called when the container changes. The view can perform any synchronization or state update
 it needs to do when its parent container changes.

`notifyVisiblityChange()`

 Optional Notification callback called when the view's vsibility changes.  The view can perform any synchronization or
 state update it needs to do when its visiblity state changes.


* [view/Pane](#module_view/Pane)
    * [.Pane](#module_view/Pane..Pane)
        * [new Pane(id, $container)](#new_module_view/Pane..Pane_new)
        * [.id](#module_view/Pane..Pane+id) : <code>string</code>
        * [.$container](#module_view/Pane..Pane+$container) : <code>JQuery</code>
        * [.$el](#module_view/Pane..Pane+$el) : <code>JQuery</code>
        * [.$header](#module_view/Pane..Pane+$header) : <code>JQuery</code>
        * [.$headerText](#module_view/Pane..Pane+$headerText) : <code>JQuery</code>
        * [.$headerFlipViewBtn](#module_view/Pane..Pane+$headerFlipViewBtn) : <code>JQuery</code>
        * [.$headerCloseBtn](#module_view/Pane..Pane+$headerCloseBtn) : <code>JQuery</code>
        * [.$content](#module_view/Pane..Pane+$content) : <code>JQuery</code>
        * [.ITEM_NOT_FOUND](#module_view/Pane..Pane+ITEM_NOT_FOUND)
        * [.ITEM_FOUND_NO_SORT](#module_view/Pane..Pane+ITEM_FOUND_NO_SORT)
        * [.ITEM_FOUND_NEEDS_SORT](#module_view/Pane..Pane+ITEM_FOUND_NEEDS_SORT)
        * [.mergeFrom(other)](#module_view/Pane..Pane+mergeFrom)
        * [.destroy()](#module_view/Pane..Pane+destroy)
        * [.getViewList()](#module_view/Pane..Pane+getViewList) ⇒ <code>Array.&lt;File&gt;</code>
        * [.getViewListSize()](#module_view/Pane..Pane+getViewListSize) ⇒ <code>number</code>
        * [.findInViewList(fullPath)](#module_view/Pane..Pane+findInViewList) ⇒ <code>number</code>
        * [.findInViewListAddedOrder(fullPath)](#module_view/Pane..Pane+findInViewListAddedOrder) ⇒ <code>number</code>
        * [.findInViewListMRUOrder(fullPath)](#module_view/Pane..Pane+findInViewListMRUOrder) ⇒ <code>number</code>
        * [.reorderItem(file, [index], [force])](#module_view/Pane..Pane+reorderItem) ⇒ <code>number</code>
        * [.addToViewList(file, [index])](#module_view/Pane..Pane+addToViewList) ⇒ <code>number</code>
        * [.addListToViewList(fileList)](#module_view/Pane..Pane+addListToViewList) ⇒ <code>Array.&lt;File&gt;</code>
        * [.makeViewMostRecent(file)](#module_view/Pane..Pane+makeViewMostRecent)
        * [.sortViewList(compareFn)](#module_view/Pane..Pane+sortViewList)
        * [.swapViewListIndexes(index1, index2)](#module_view/Pane..Pane+swapViewListIndexes) ⇒ <code>boolean</code>
        * [.traverseViewListByMRU(direction, [current])](#module_view/Pane..Pane+traverseViewListByMRU) ⇒ <code>File</code>
        * [.showInterstitial(show)](#module_view/Pane..Pane+showInterstitial)
        * [.getViewForPath(path)](#module_view/Pane..Pane+getViewForPath) ⇒ <code>boolean</code>
        * [.addView(view, show)](#module_view/Pane..Pane+addView)
        * [.showView(view)](#module_view/Pane..Pane+showView)
        * [.updateLayout(forceRefresh)](#module_view/Pane..Pane+updateLayout)
        * [.getCurrentlyViewedFile()](#module_view/Pane..Pane+getCurrentlyViewedFile) ⇒ <code>File</code>
        * [.getCurrentlyViewedEditor()](#module_view/Pane..Pane+getCurrentlyViewedEditor) ⇒ <code>File</code>
        * [.getCurrentlyViewedPath()](#module_view/Pane..Pane+getCurrentlyViewedPath) ⇒ <code>string</code>
        * [.destroyViewIfNotNeeded(view)](#module_view/Pane..Pane+destroyViewIfNotNeeded)
        * [.removeView(file, suppressOpenNextFile, preventViewChange)](#module_view/Pane..Pane+removeView) ⇒ <code>boolean</code>
        * [.removeViews(list)](#module_view/Pane..Pane+removeViews) ⇒ <code>Array.&lt;File&gt;</code>
        * [.focus()](#module_view/Pane..Pane+focus)
        * [.loadState(state)](#module_view/Pane..Pane+loadState) ⇒ <code>jQuery.Promise</code>
        * [.saveState()](#module_view/Pane..Pane+saveState) ⇒ <code>Object</code>
        * [.getScrollState()](#module_view/Pane..Pane+getScrollState) ⇒ <code>Object</code>
        * [.restoreAndAdjustScrollState([state], [heightDelta])](#module_view/Pane..Pane+restoreAndAdjustScrollState)

<a name="module_view/Pane..Pane"></a>

### view/Pane.Pane
**Kind**: inner class of [<code>view/Pane</code>](#module_view/Pane)  
**See**: [MainViewManager](MainViewManager) for more information  

* [.Pane](#module_view/Pane..Pane)
    * [new Pane(id, $container)](#new_module_view/Pane..Pane_new)
    * [.id](#module_view/Pane..Pane+id) : <code>string</code>
    * [.$container](#module_view/Pane..Pane+$container) : <code>JQuery</code>
    * [.$el](#module_view/Pane..Pane+$el) : <code>JQuery</code>
    * [.$header](#module_view/Pane..Pane+$header) : <code>JQuery</code>
    * [.$headerText](#module_view/Pane..Pane+$headerText) : <code>JQuery</code>
    * [.$headerFlipViewBtn](#module_view/Pane..Pane+$headerFlipViewBtn) : <code>JQuery</code>
    * [.$headerCloseBtn](#module_view/Pane..Pane+$headerCloseBtn) : <code>JQuery</code>
    * [.$content](#module_view/Pane..Pane+$content) : <code>JQuery</code>
    * [.ITEM_NOT_FOUND](#module_view/Pane..Pane+ITEM_NOT_FOUND)
    * [.ITEM_FOUND_NO_SORT](#module_view/Pane..Pane+ITEM_FOUND_NO_SORT)
    * [.ITEM_FOUND_NEEDS_SORT](#module_view/Pane..Pane+ITEM_FOUND_NEEDS_SORT)
    * [.mergeFrom(other)](#module_view/Pane..Pane+mergeFrom)
    * [.destroy()](#module_view/Pane..Pane+destroy)
    * [.getViewList()](#module_view/Pane..Pane+getViewList) ⇒ <code>Array.&lt;File&gt;</code>
    * [.getViewListSize()](#module_view/Pane..Pane+getViewListSize) ⇒ <code>number</code>
    * [.findInViewList(fullPath)](#module_view/Pane..Pane+findInViewList) ⇒ <code>number</code>
    * [.findInViewListAddedOrder(fullPath)](#module_view/Pane..Pane+findInViewListAddedOrder) ⇒ <code>number</code>
    * [.findInViewListMRUOrder(fullPath)](#module_view/Pane..Pane+findInViewListMRUOrder) ⇒ <code>number</code>
    * [.reorderItem(file, [index], [force])](#module_view/Pane..Pane+reorderItem) ⇒ <code>number</code>
    * [.addToViewList(file, [index])](#module_view/Pane..Pane+addToViewList) ⇒ <code>number</code>
    * [.addListToViewList(fileList)](#module_view/Pane..Pane+addListToViewList) ⇒ <code>Array.&lt;File&gt;</code>
    * [.makeViewMostRecent(file)](#module_view/Pane..Pane+makeViewMostRecent)
    * [.sortViewList(compareFn)](#module_view/Pane..Pane+sortViewList)
    * [.swapViewListIndexes(index1, index2)](#module_view/Pane..Pane+swapViewListIndexes) ⇒ <code>boolean</code>
    * [.traverseViewListByMRU(direction, [current])](#module_view/Pane..Pane+traverseViewListByMRU) ⇒ <code>File</code>
    * [.showInterstitial(show)](#module_view/Pane..Pane+showInterstitial)
    * [.getViewForPath(path)](#module_view/Pane..Pane+getViewForPath) ⇒ <code>boolean</code>
    * [.addView(view, show)](#module_view/Pane..Pane+addView)
    * [.showView(view)](#module_view/Pane..Pane+showView)
    * [.updateLayout(forceRefresh)](#module_view/Pane..Pane+updateLayout)
    * [.getCurrentlyViewedFile()](#module_view/Pane..Pane+getCurrentlyViewedFile) ⇒ <code>File</code>
    * [.getCurrentlyViewedEditor()](#module_view/Pane..Pane+getCurrentlyViewedEditor) ⇒ <code>File</code>
    * [.getCurrentlyViewedPath()](#module_view/Pane..Pane+getCurrentlyViewedPath) ⇒ <code>string</code>
    * [.destroyViewIfNotNeeded(view)](#module_view/Pane..Pane+destroyViewIfNotNeeded)
    * [.removeView(file, suppressOpenNextFile, preventViewChange)](#module_view/Pane..Pane+removeView) ⇒ <code>boolean</code>
    * [.removeViews(list)](#module_view/Pane..Pane+removeViews) ⇒ <code>Array.&lt;File&gt;</code>
    * [.focus()](#module_view/Pane..Pane+focus)
    * [.loadState(state)](#module_view/Pane..Pane+loadState) ⇒ <code>jQuery.Promise</code>
    * [.saveState()](#module_view/Pane..Pane+saveState) ⇒ <code>Object</code>
    * [.getScrollState()](#module_view/Pane..Pane+getScrollState) ⇒ <code>Object</code>
    * [.restoreAndAdjustScrollState([state], [heightDelta])](#module_view/Pane..Pane+restoreAndAdjustScrollState)

<a name="new_module_view/Pane..Pane_new"></a>

#### new Pane(id, $container)
Pane Objects are constructed by the MainViewManager object when a Pane view is needed.


| Param | Type | Description |
| --- | --- | --- |
| id | <code>string</code> | The id to use to identify this pane. |
| $container | <code>jQuery</code> | The parent jQuery container to place the pane view. |

<a name="module_view/Pane..Pane+id"></a>

#### pane.id : <code>string</code>
id of the pane

**Kind**: instance property of [<code>Pane</code>](#module_view/Pane..Pane)  
**Read only**: true  
<a name="module_view/Pane..Pane+$container"></a>

#### pane.$container : <code>JQuery</code>
container where the pane lives

**Kind**: instance property of [<code>Pane</code>](#module_view/Pane..Pane)  
**Read only**: true  
<a name="module_view/Pane..Pane+$el"></a>

#### pane.$el : <code>JQuery</code>
the wrapped DOM node of this pane

**Kind**: instance property of [<code>Pane</code>](#module_view/Pane..Pane)  
**Read only**: true  
<a name="module_view/Pane..Pane+$header"></a>

#### pane.$header : <code>JQuery</code>
the wrapped DOM node container that contains name of current view and the switch view button, or informational string if there is no view

**Kind**: instance property of [<code>Pane</code>](#module_view/Pane..Pane)  
**Read only**: true  
<a name="module_view/Pane..Pane+$headerText"></a>

#### pane.$headerText : <code>JQuery</code>
the wrapped DOM node that contains name of current view, or informational string if there is no view

**Kind**: instance property of [<code>Pane</code>](#module_view/Pane..Pane)  
**Read only**: true  
<a name="module_view/Pane..Pane+$headerFlipViewBtn"></a>

#### pane.$headerFlipViewBtn : <code>JQuery</code>
the wrapped DOM node that is used to flip the view to another pane

**Kind**: instance property of [<code>Pane</code>](#module_view/Pane..Pane)  
**Read only**: true  
<a name="module_view/Pane..Pane+$headerCloseBtn"></a>

#### pane.$headerCloseBtn : <code>JQuery</code>
close button of the pane

**Kind**: instance property of [<code>Pane</code>](#module_view/Pane..Pane)  
**Read only**: true  
<a name="module_view/Pane..Pane+$content"></a>

#### pane.$content : <code>JQuery</code>
the wrapped DOM node that contains views

**Kind**: instance property of [<code>Pane</code>](#module_view/Pane..Pane)  
**Read only**: true  
<a name="module_view/Pane..Pane+ITEM_NOT_FOUND"></a>

#### pane.ITEM\_NOT\_FOUND
Return value from reorderItem when the Item was not found

**Kind**: instance constant of [<code>Pane</code>](#module_view/Pane..Pane)  
**See**: [Pane#reorderItem](Pane#reorderItem)  
<a name="module_view/Pane..Pane+ITEM_FOUND_NO_SORT"></a>

#### pane.ITEM\_FOUND\_NO\_SORT
Return value from reorderItem when the Item was found at its natural index
and the workingset does not need to be resorted

**Kind**: instance constant of [<code>Pane</code>](#module_view/Pane..Pane)  
**See**: [Pane#reorderItem](Pane#reorderItem)  
<a name="module_view/Pane..Pane+ITEM_FOUND_NEEDS_SORT"></a>

#### pane.ITEM\_FOUND\_NEEDS\_SORT
Return value from reorderItem when the Item was found and reindexed
and the workingset needs to be resorted

**Kind**: instance constant of [<code>Pane</code>](#module_view/Pane..Pane)  
**See**: [Pane#reorderItem](Pane#reorderItem)  
<a name="module_view/Pane..Pane+mergeFrom"></a>

#### pane.mergeFrom(other)
Merges the another Pane object's contents into this Pane

**Kind**: instance method of [<code>Pane</code>](#module_view/Pane..Pane)  

| Param | Type | Description |
| --- | --- | --- |
| other | <code>Pane</code> | Pane from which to copy |

<a name="module_view/Pane..Pane+destroy"></a>

#### pane.destroy()
Removes the DOM node for the Pane, removes all
 event handlers and _resets all internal data structures

**Kind**: instance method of [<code>Pane</code>](#module_view/Pane..Pane)  
<a name="module_view/Pane..Pane+getViewList"></a>

#### pane.getViewList() ⇒ <code>Array.&lt;File&gt;</code>
Returns a copy of the view file list

**Kind**: instance method of [<code>Pane</code>](#module_view/Pane..Pane)  
<a name="module_view/Pane..Pane+getViewListSize"></a>

#### pane.getViewListSize() ⇒ <code>number</code>
Returns the number of entries in the view file list

**Kind**: instance method of [<code>Pane</code>](#module_view/Pane..Pane)  
<a name="module_view/Pane..Pane+findInViewList"></a>

#### pane.findInViewList(fullPath) ⇒ <code>number</code>
Returns the index of the item in the view file list

**Kind**: instance method of [<code>Pane</code>](#module_view/Pane..Pane)  
**Returns**: <code>number</code> - index of the item or -1 if not found  

| Param | Type | Description |
| --- | --- | --- |
| fullPath | <code>string</code> | the full path of the item to look for |

<a name="module_view/Pane..Pane+findInViewListAddedOrder"></a>

#### pane.findInViewListAddedOrder(fullPath) ⇒ <code>number</code>
Returns the order in which the item was added

**Kind**: instance method of [<code>Pane</code>](#module_view/Pane..Pane)  
**Returns**: <code>number</code> - order of the item or -1 if not found  

| Param | Type | Description |
| --- | --- | --- |
| fullPath | <code>string</code> | the full path of the item to look for |

<a name="module_view/Pane..Pane+findInViewListMRUOrder"></a>

#### pane.findInViewListMRUOrder(fullPath) ⇒ <code>number</code>
Returns the order in which the item was last used

**Kind**: instance method of [<code>Pane</code>](#module_view/Pane..Pane)  
**Returns**: <code>number</code> - order of the item or -1 if not found.
     0 indicates most recently used, followed by 1 and so on...  

| Param | Type | Description |
| --- | --- | --- |
| fullPath | <code>string</code> | the full path of the item to look for |

<a name="module_view/Pane..Pane+reorderItem"></a>

#### pane.reorderItem(file, [index], [force]) ⇒ <code>number</code>
reorders the specified file in the view list to the desired position

**Kind**: instance method of [<code>Pane</code>](#module_view/Pane..Pane)  
**Returns**: <code>number</code> - this function returns one of the following manifest constants:
           ITEM_NOT_FOUND        : The request file object was not found
           ITEM_FOUND_NO_SORT    : The request file object was found but it was already at the requested index
           ITEM_FOUND_NEEDS_SORT : The request file object was found and moved to a new index and the list should be resorted  

| Param | Type | Description |
| --- | --- | --- |
| file | <code>File</code> | the file object of the item to reorder |
| [index] | <code>number</code> | the new position of the item |
| [force] | <code>boolean</code> | true to force the item into that position, false otherwise.  (Requires an index be requested) |

<a name="module_view/Pane..Pane+addToViewList"></a>

#### pane.addToViewList(file, [index]) ⇒ <code>number</code>
Adds the given file to the end of the workingset, if it is not already in the list
Does not change which document is currently open in the editor. Completes synchronously.

**Kind**: instance method of [<code>Pane</code>](#module_view/Pane..Pane)  
**Returns**: <code>number</code> - index of where the item was added  

| Param | Type | Description |
| --- | --- | --- |
| file | <code>File</code> | file to add |
| [index] | <code>number</code> | position where to add the item |

<a name="module_view/Pane..Pane+addListToViewList"></a>

#### pane.addListToViewList(fileList) ⇒ <code>Array.&lt;File&gt;</code>
Adds the given file list to the end of the workingset.

**Kind**: instance method of [<code>Pane</code>](#module_view/Pane..Pane)  
**Returns**: <code>Array.&lt;File&gt;</code> - list of files added to the list  

| Param | Type |
| --- | --- |
| fileList | <code>Array.&lt;File&gt;</code> | 

<a name="module_view/Pane..Pane+makeViewMostRecent"></a>

#### pane.makeViewMostRecent(file)
Moves the specified file to the front of the MRU (Most Recently Used) list.

**Kind**: instance method of [<code>Pane</code>](#module_view/Pane..Pane)  

| Param | Type | Description |
| --- | --- | --- |
| file | <code>File</code> | The file to move to the front of the MRU list. |

<a name="module_view/Pane..Pane+sortViewList"></a>

#### pane.sortViewList(compareFn)
Sorts items in the pane's view list.

**Kind**: instance method of [<code>Pane</code>](#module_view/Pane..Pane)  

| Param | Type | Description |
| --- | --- | --- |
| compareFn | <code>function</code> | The function used to compare items in the view list. |

<a name="module_view/Pane..Pane+swapViewListIndexes"></a>

#### pane.swapViewListIndexes(index1, index2) ⇒ <code>boolean</code>
Swaps two items in the file view list (used while dragging items in the working set view)

**Kind**: instance method of [<code>Pane</code>](#module_view/Pane..Pane)  
**Returns**: <code>boolean</code> - } true  

| Param | Type | Description |
| --- | --- | --- |
| index1 | <code>number</code> | the index of the first item to swap |
| index2 | <code>number</code> | the index of the second item to swap |

<a name="module_view/Pane..Pane+traverseViewListByMRU"></a>

#### pane.traverseViewListByMRU(direction, [current]) ⇒ <code>File</code>
Traverses the list and returns the File object of the next item in the MRU order

**Kind**: instance method of [<code>Pane</code>](#module_view/Pane..Pane)  
**Returns**: <code>File</code> - The File object of the next item in the travesal order or null if there isn't one.  

| Param | Type | Description |
| --- | --- | --- |
| direction | <code>number</code> | Must be 1 or -1 to traverse forward or backward |
| [current] | <code>string</code> | the fullPath of the item where traversal is to start.                              If this parameter is omitted then the path of the current view is used.                              If the current view is a temporary view then the first item in the MRU list is returned |

<a name="module_view/Pane..Pane+showInterstitial"></a>

#### pane.showInterstitial(show)
Shows the pane's interstitial page

**Kind**: instance method of [<code>Pane</code>](#module_view/Pane..Pane)  

| Param | Type | Description |
| --- | --- | --- |
| show | <code>boolean</code> | show or hide the interstitial page |

<a name="module_view/Pane..Pane+getViewForPath"></a>

#### pane.getViewForPath(path) ⇒ <code>boolean</code>
retrieves the view object for the given path

**Kind**: instance method of [<code>Pane</code>](#module_view/Pane..Pane)  
**Returns**: <code>boolean</code> - show - show or hide the interstitial page  

| Param | Type | Description |
| --- | --- | --- |
| path | <code>string</code> | the fullPath of the view to retrieve |

<a name="module_view/Pane..Pane+addView"></a>

#### pane.addView(view, show)
Adds a view to the pane

**Kind**: instance method of [<code>Pane</code>](#module_view/Pane..Pane)  

| Param | Type | Description |
| --- | --- | --- |
| view | <code>View</code> | the View object to add |
| show | <code>boolean</code> | true to show the view right away, false otherwise |

<a name="module_view/Pane..Pane+showView"></a>

#### pane.showView(view)
Swaps the current view with the requested view.
If the interstitial page is shown, it is hidden.
If the currentView is a temporary view, it is destroyed.

**Kind**: instance method of [<code>Pane</code>](#module_view/Pane..Pane)  

| Param | Type | Description |
| --- | --- | --- |
| view | <code>View</code> | the to show |

<a name="module_view/Pane..Pane+updateLayout"></a>

#### pane.updateLayout(forceRefresh)
Sets pane content height. Updates the layout causing the current view to redraw itself

**Kind**: instance method of [<code>Pane</code>](#module_view/Pane..Pane)  

| Param | Type | Description |
| --- | --- | --- |
| forceRefresh | <code>boolean</code> | true to force a resize and refresh of the current view, false if just to resize forceRefresh is only used by Editor views to force a relayout of all editor DOM elements. Custom View implementations should just ignore this flag. |

<a name="module_view/Pane..Pane+getCurrentlyViewedFile"></a>

#### pane.getCurrentlyViewedFile() ⇒ <code>File</code>
Retrieves the File object of the current view

**Kind**: instance method of [<code>Pane</code>](#module_view/Pane..Pane)  
**Returns**: <code>File</code> - the File object of the current view or null if there isn't one  
<a name="module_view/Pane..Pane+getCurrentlyViewedEditor"></a>

#### pane.getCurrentlyViewedEditor() ⇒ <code>File</code>
Retrieves the File object of the current view

**Kind**: instance method of [<code>Pane</code>](#module_view/Pane..Pane)  
**Returns**: <code>File</code> - the File object of the current view or null if there isn't one  
<a name="module_view/Pane..Pane+getCurrentlyViewedPath"></a>

#### pane.getCurrentlyViewedPath() ⇒ <code>string</code>
Retrieves the path of the current view

**Kind**: instance method of [<code>Pane</code>](#module_view/Pane..Pane)  
**Returns**: <code>string</code> - the path of the current view or null if there isn't one  
<a name="module_view/Pane..Pane+destroyViewIfNotNeeded"></a>

#### pane.destroyViewIfNotNeeded(view)
destroys the view if it isn't needed

**Kind**: instance method of [<code>Pane</code>](#module_view/Pane..Pane)  

| Param | Type | Description |
| --- | --- | --- |
| view | <code>View</code> | the view to destroy |

<a name="module_view/Pane..Pane+removeView"></a>

#### pane.removeView(file, suppressOpenNextFile, preventViewChange) ⇒ <code>boolean</code>
Removes the view and opens the next view

**Kind**: instance method of [<code>Pane</code>](#module_view/Pane..Pane)  
**Returns**: <code>boolean</code> - true if the file was removed from the working set
 This function will remove a temporary view of a file but will return false in that case  

| Param | Type | Description |
| --- | --- | --- |
| file | <code>File</code> | the file to close |
| suppressOpenNextFile | <code>boolean</code> | suppresses opening the next file in MRU order |
| preventViewChange | <code>boolean</code> | if suppressOpenNextFile is truthy, this flag can be used to                                      prevent the current view from being destroyed.                                      Ignored if suppressOpenNextFile is falsy |

<a name="module_view/Pane..Pane+removeViews"></a>

#### pane.removeViews(list) ⇒ <code>Array.&lt;File&gt;</code>
Removes the specifed file from all internal lists, destroys the view of the file (if there is one)
 and shows the interstitial page if the current view is destroyed.

**Kind**: instance method of [<code>Pane</code>](#module_view/Pane..Pane)  
**Returns**: <code>Array.&lt;File&gt;</code> - Array of File objects removed from the working set.
 This function will remove temporary views but the file objects for those views will not be found
 in the result set.  Only the file objects removed from the working set are returned.  

| Param | Type | Description |
| --- | --- | --- |
| list | <code>Array.&lt;File&gt;</code> | Array of files to remove |

<a name="module_view/Pane..Pane+focus"></a>

#### pane.focus()
Gives focus to the last thing that had focus, the current view or the pane in that order

**Kind**: instance method of [<code>Pane</code>](#module_view/Pane..Pane)  
<a name="module_view/Pane..Pane+loadState"></a>

#### pane.loadState(state) ⇒ <code>jQuery.Promise</code>
serializes the pane state from JSON

**Kind**: instance method of [<code>Pane</code>](#module_view/Pane..Pane)  
**Returns**: <code>jQuery.Promise</code> - A promise which resolves to \{fullPath:string, paneId:string} which can be passed as command data to FILE_OPEN  

| Param | Type | Description |
| --- | --- | --- |
| state | <code>Object</code> | the state to load |

<a name="module_view/Pane..Pane+saveState"></a>

#### pane.saveState() ⇒ <code>Object</code>
Returns the JSON-ified state of the object so it can be serialize

**Kind**: instance method of [<code>Pane</code>](#module_view/Pane..Pane)  
**Returns**: <code>Object</code> - state - the state to save  
<a name="module_view/Pane..Pane+getScrollState"></a>

#### pane.getScrollState() ⇒ <code>Object</code>
gets the current view's scroll state data

**Kind**: instance method of [<code>Pane</code>](#module_view/Pane..Pane)  
**Returns**: <code>Object</code> - scroll state - the current scroll state  
<a name="module_view/Pane..Pane+restoreAndAdjustScrollState"></a>

#### pane.restoreAndAdjustScrollState([state], [heightDelta])
tells the current view to restore its scroll state from cached data and apply a height delta

**Kind**: instance method of [<code>Pane</code>](#module_view/Pane..Pane)  

| Param | Type | Description |
| --- | --- | --- |
| [state] | <code>Object</code> | the current scroll state |
| [heightDelta] | <code>number</code> | the amount to add or subtract from the state |