isCustomConsoleComponentPoppedOut()

Determines if a custom console component is popped out from a browser. To use this method, multi-monitor components must be turned on. For more information, see “Turn on Multi-Monitor Components for a Salesforce Console” in the online help. This method is only available in API version 30.0 or later.

Syntax

1sforce.console.isCustomConsoleComponentPoppedOut (callback:Function)

Arguments

Name	Type	Description
callback	function	JavaScript method that’s called upon completion of the method.

Sample Code–Visualforce

1swfobject.registerObject("clippy.codeblock-1", "9");
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17<apex:page>
18
19    <A HREF="#" onClick="checkPoppedOut(); return false;">
20         Is this component popped out?</A> <BR/>
21
22    <apex:includeScript value="/support/console/30.0/integration.js"/>
23    <script type="text/javascript">
24        function checkResult(result) {
25          if (result.success) {
26            alert('Is this component popped out: ' + result.poppedOut);
27          } else {
28            alert('Error invoking this method. Check the browser developer console for more information.');
29          }
30        }
31        function checkPoppedOut() {
32          sforce.console.isCustomConsoleComponentPoppedOut(checkResult);
33        }
34    </script>
35</apex:page>

Response

This method is asynchronous, so it returns its response in an object in a callback method. The response object contains the following field:

Name	Type	Description
success	boolean	`true` if returning the component’s pop out status was successful; `false` otherwise.
poppedOut	boolean	`true` if the component is popped out; `false` otherwise.

Salesforce Console Integration Toolkit Developer's Guide

isCustomConsoleComponentPoppedOut()

Syntax

Arguments

Sample Code–Visualforce

Response