Salesforce Console Developer Guide
jNote: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.
isCustomConsoleComponentPoppedOut()
Determines if a custom console component
is popped out from a browser. To use this method,
multi-monitor components must be turned on. 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
1<apex:page>
2
3 <A HREF="#" onClick="checkPoppedOut(); return false;">
4 Is this component popped out?</A> <BR/>
5
6 <apex:includeScript value="/support/console/68.0/integration.js"/>
7 <script type="text/javascript">
8 function checkResult(result) {
9 if (result.success) {
10 alert('Is this component popped out: ' + result.poppedOut);
11 } else {
12 alert('Error invoking this method. Check the browser developer console for more information.');
13 }
14 }
15 function checkPoppedOut() {
16 sforce.console.isCustomConsoleComponentPoppedOut(checkResult);
17 }
18 </script>
19</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. |