Class Index | File Index

Classes


Class Vizit.Essential.Controller


Extends Vizit.Core.UI.ChromelessWindow.

Defined in: <pkg\Release\Vizit\Layouts\Vizit\vizit-all.js>.

Class Summary
Constructor Attributes Constructor Name and Description
 
This controller creates and manages a Vizit Essential window or embedded viewer that integrates with any licensed features.
Method Summary
Method Attributes Method Name and Description
 
Gets the DocumentPanel object managed by this controller
 
Returns the a Document Reference that can be used as a reference to the document in other methods such as Vizit.Essential.Manager.Open
 
Open(docRef, page, target)
Opens the document corresponding to the provided Document Reference in Essential and SX at the given page
Methods borrowed from class Vizit.Core.UI.ChromelessWindow:
Hide, IsMaximized, Maximize, Restore, Show
Class Detail
Vizit.Essential.Controller(config)
This controller creates and manages a Vizit Essential window or embedded viewer that integrates with any licensed features.
Parameters:
{Object} config
A configuration object to initialize this controller and configure its contained DocumentPanel and DocumentCommentPanel
{String[]} config.mainbarActions Optional
An array of action names to display in the main toolbar of the DocumentPanel. See Vizit.Essential.Actions.
{Object} config.bottomBar Optional
An object specifying the actions to be displayed in the bottom toolbar of the DocumentPanel.
{String[]} config.bottomBar.leftActions Optional
An array of action names to display on the left side of the bottom toolbar of the DocumentPanel. See Vizit.Essential.Actions.
{String[]} config.bottomBar.rightActions Optional
An array of action names to display on the right side of the bottom toolbar of the DocumentPanel. See Vizit.Essential.Actions.
{String[]} config.sidebarActions Optional
An array of action names to display in the Sidebar. The AboutVizit action cannot be removed from this toolbar. See Vizit.Essential.Actions.
{String[]} config.socialActions Optional
An array of action names to display in the toolbar of the SX area in the SidePanel. See Vizit.Essential.Actions.
{Object[]} config.keyboardActions Optional
An array of keyboard shortcut configurations.
{String} config.keyboardActions[].action Optional
For action names, refer to Vizit.Essential.Actions.
{Function} config.keyboardActions[].handler Optional
A delegate that is called immediately before the specified action. If false is returned from handler, the action will be canceled.
{Boolean} config.keyboardActions[].ctrl Optional
Whether or not the CTRL key must be pressed for the action to execute. Defaults to false.
{Boolean} config.keyboardActions[].shift Optional
Whether or not the SHIFT key must be pressed for the action to execute. Defaults to false.
{Boolean} config.keyboardActions[].stopEvent Optional
Whether or not the browsers default be havior will be silenced. Defaults to false.
{String|String[]} config.keyboardActions[].key
A key or array of keys that would trigger the action. Any letter can be placed in quotes. Specialty keys can be found at ExtJs's documentation for Ext.EventManager. The string value of an Ext.EventManager property should be used. For example, mapping Vizit.Essential.Actions.FullScreen to a keyboard shortcut for Ext.EventManager.ESC should use the following config { action: 'FullScreen', key: 'esc' }.
{Object} config.disabledActions Optional
A hashtable of action name / boolean pairs that specify actions not be displayed in the toolbar or applied as keybaord shortcuts. See Vizit.Essential.Actions
{Object} config.initWithDocRef Optional
A document reference of the document to open when the controller loads and is rendered. See Vizit.Essential.Viewer.DocumentPanel#Open
{Number} config.initAtPage Optional
The page to open the provided document to. It is zero based (ie: The first page is 0). The default is 0.
{HTMLElement|Vizit.Core.UI.Element|String} config.renderTo Optional
The element or id of the element to render the DocumentPanel to.
{Object} config.initAtPoint Optional
The point at which a floating DocumentPanel is displayed. This only is applied when the window is first opened.
{Number} config.initAtPoint.X
The X coordinate.
{Number} config.initAtPoint.Y
The Y coordinate.
{Number} config.width Optional
The width of the floating DocumentPanel. This is ignored if renderTo is used. Defaults to 475.
{Number} config.height Optional
The height of the floating DocumentPanel. This is ignored if renderTo is used. Defaults to 400.
{Vizit.Essential.Viewer.DisplayMode} config.displayMode Optional
The display mode of the DocumentPanel.
{Number} config.thumbSize Optional
The default size of thumbnails in the DocumentPanel.
{Number} config.maximized Optional
Whether or not to automatically maximize Vizit Essential. Defaults to false. Ignores autoShow configuration.
{Boolean} config.autoShow Optional
Whether or not to automatically show the floating DocumentPanel when it is rendered. Defaults to false.
{String} config.fullScreenHUDMessage Optional
DEPRECATED A string shown to the user when Essential transitions to full screen. Defaults to "Press ESC to exit full screen mode."
{Boolean} config.socialIsEnabled Optional
Whether or not SX is enabled in this Essential window.
Method Detail
{Vizit.Essential.Viewer.DocumentPanel} GetDocumentPanel()
Gets the DocumentPanel object managed by this controller
Returns:
{Vizit.Essential.Viewer.DocumentPanel} The DocumentPanel managed by this controller.

{Object} GetDocumentRef()
Returns the a Document Reference that can be used as a reference to the document in other methods such as Vizit.Essential.Manager.Open
Returns:
{Object} A Document Reference representing the currently open document.

Open(docRef, page, target)
Opens the document corresponding to the provided Document Reference in Essential and SX at the given page
Parameters:
{Object} docRef
A document reference object in either of the following forms:
{ "url": http://urlOfTheDocument.ext } or
{ "list": listId, "item": itemId } where listId is a GUID and itemId is a number.
{Number} page Optional
The page to open the provided document to. It is zero based (ie: The first page is 0). The default is 0.
{Vizit.Core.UI.Element} target Optional
The target to render the floating window next to. Does not apply if renderTo is used during construction.

Documentation generated by JsDoc Toolkit 2.4.0 on Mon Oct 28 2013 13:52:27 GMT-0000 (GMT)