-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathCSInterface.js.html
1423 lines (1273 loc) · 48.4 KB
/
CSInterface.js.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width">
<title>Adobe CEP8 API Source: CSInterface.js</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.united.css">
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top navbar-inverse">
<div class="container">
<div class="navbar-header">
<a class="navbar-brand" href="index.html">Adobe CEP8 API</a>
<button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
</div>
<div class="navbar-collapse collapse" id="topNavigation">
<ul class="nav navbar-nav">
<li class="dropdown">
<a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li><a href="cep.html">cep</a></li><li><a href="cep.encoding.html">cep.encoding</a></li><li><a href="cep.encoding.convertion.html">cep.encoding.convertion</a></li><li><a href="cep.fs.html">cep.fs</a></li><li><a href="cep.process.html">cep.process</a></li><li><a href="cep.util.html">cep.util</a></li>
</ul>
</li>
<li class="dropdown">
<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li><a href="AgoraLib.html">AgoraLib</a></li><li><a href="ApiVersion.html">ApiVersion</a></li><li><a href="AppSkinInfo.html">AppSkinInfo</a></li><li><a href="ColorType.html">ColorType</a></li><li><a href="ContextMenuItemStatus.html">ContextMenuItemStatus</a></li><li><a href="CSEvent.html">CSEvent</a></li><li><a href="CSInterface.html">CSInterface</a></li><li><a href="Direction.html">Direction</a></li><li><a href="Extension.html">Extension</a></li><li><a href="GradientColor.html">GradientColor</a></li><li><a href="GradientStop.html">GradientStop</a></li><li><a href="HostCapabilities.html">HostCapabilities</a></li><li><a href="HostEnvironment.html">HostEnvironment</a></li><li><a href="MenuItemStatus.html">MenuItemStatus</a></li><li><a href="RGBColor.html">RGBColor</a></li><li><a href="Runtime.html">Runtime</a></li><li><a href="SystemPath.html">SystemPath</a></li><li><a href="UIColor.html">UIColor</a></li><li><a href="Version.html">Version</a></li><li><a href="VersionBound.html">VersionBound</a></li><li><a href="VersionRange.html">VersionRange</a></li><li><a href="Vulcan.html">Vulcan</a></li><li><a href="VulcanMessage.html">VulcanMessage</a></li>
</ul>
</li>
<li class="dropdown">
<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li><a href="global.html#AgoraLibResponse">AgoraLibResponse</a></li><li><a href="global.html#CSXSWindowType">CSXSWindowType</a></li><li><a href="global.html#EvalScript_ErrMessage">EvalScript_ErrMessage</a></li><li><a href="global.html#GetValueByKey">GetValueByKey</a></li><li><a href="global.html#requiredParamsValid">requiredParamsValid</a></li><li><a href="global.html#strStartsWith">strStartsWith</a></li><li><a href="global.html#VulcanInterface">VulcanInterface</a></li>
</ul>
</li>
</ul>
<div class="col-sm-3 col-md-3">
<form class="navbar-form" role="search">
<div class="input-group">
<input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
<div class="input-group-btn">
<button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
</div>
</div>
</form>
</div>
</div>
</div>
</div>
<div class="container" id="toc-content">
<div class="row">
<div class="col-md-12">
<div id="main">
<h1 class="page-title">Source: CSInterface.js</h1>
<section>
<article>
<pre
class="sunlight-highlight-javascript linenums">/**************************************************************************************************
*
* ADOBE SYSTEMS INCORPORATED
* Copyright 2013 Adobe Systems Incorporated
* All Rights Reserved.
*
* NOTICE: Adobe permits you to use, modify, and distribute this file in accordance with the
* terms of the Adobe license agreement accompanying it. If you have received this file from a
* source other than Adobe, then your use, modification, or distribution of it requires the prior
* written permission of Adobe.
*
**************************************************************************************************/
/** CSInterface - v8.0.0 */
/**
* Stores constants for the window types supported by the CSXS infrastructure.
*/
function CSXSWindowType()
{
}
/** Constant for the CSXS window type Panel. */
CSXSWindowType._PANEL = "Panel";
/** Constant for the CSXS window type Modeless. */
CSXSWindowType._MODELESS = "Modeless";
/** Constant for the CSXS window type ModalDialog. */
CSXSWindowType._MODAL_DIALOG = "ModalDialog";
/** EvalScript error message */
EvalScript_ErrMessage = "EvalScript error.";
/**
* @class Version
* Defines a version number with major, minor, micro, and special
* components. The major, minor and micro values are numeric; the special
* value can be any string.
*
* @param {number} major The major version component, a positive integer up to nine digits long.
* @param {number} minor The minor version component, a positive integer up to nine digits long.
* @param {number} micro The micro version component, a positive integer up to nine digits long.
* @param {string} special The special version component, an arbitrary string.
*
* @return A new Version object.
*/
function Version(major, minor, micro, special)
{
this.major = major;
this.minor = minor;
this.micro = micro;
this.special = special;
}
/**
* The maximum value allowed for a numeric version component.
* This reflects the maximum value allowed in PlugPlug and the manifest schema.
*/
Version.MAX_NUM = 999999999;
/**
* @class VersionBound
* Defines a boundary for a version range, which associates a Version object
* with a flag for whether it is an inclusive or exclusive boundary.
*
* @param {object} version The #Version object.
* @param {boolean} inclusive True if this boundary is inclusive, false if it is exclusive.
*
* @return A new VersionBound object.
*/
function VersionBound(version, inclusive)
{
this.version = version;
this.inclusive = inclusive;
}
/**
* @class VersionRange
* Defines a range of versions using a lower boundary and optional upper boundary.
*
* @param {object} lowerBound The #VersionBound object.
* @param {object} upperBound The #VersionBound object, or null for a range with no upper boundary.
*
* @return A new VersionRange object.
*/
function VersionRange(lowerBound, upperBound)
{
this.lowerBound = lowerBound;
this.upperBound = upperBound;
}
/**
* @class Runtime
* Represents a runtime related to the CEP infrastructure.
* Extensions can declare dependencies on particular
* CEP runtime versions in the extension manifest.
*
* @param {string} name The runtime name.
* @param version A {@link VersionRange} object that defines a range of valid versions.
*
* @return A new Runtime object.
*/
function Runtime(name, versionRange)
{
this.name = name;
this.versionRange = versionRange;
}
/**
* @class Extension
* Encapsulates a CEP-based extension to an Adobe application.
*
* @param {string} id The unique identifier of this extension.
* @param {string} name The localizable display name of this extension.
* @param {string} mainPath The path of the "index.html" file.
* @param {string} basePath The base path of this extension.
* @param {string} windowType The window type of the main window of this extension. Valid values are defined by {@link CSXSWindowType}.
* @param {number} width The default width in pixels of the main window of this extension.
* @param {number} height The default height in pixels of the main window of this extension.
* @param {number} minWidth The minimum width in pixels of the main window of this extension.
* @param {number} minHeight The minimum height in pixels of the main window of this extension.
* @param {number} maxWidth The maximum width in pixels of the main window of this extension.
* @param {number} maxHeight The maximum height in pixels of the main window of this extension.
* @param defaultExtensionDataXml The extension data contained in the default ExtensionDispatchInfo section of the extension manifest.
* @param specialExtensionDataXml The extension data contained in the application-specific ExtensionDispatchInfo section of the extension manifest.
* @param {object[]} requiredRuntimeList An array of Runtime objects for runtimes required by this extension.
* @param {boolean} isAutoVisible True if this extension is visible on loading.
* @param {boolean} isPluginExtension True if this extension has been deployed in the Plugins folder of the host application.
*
* @return A new Extension object.
*/
function Extension(id, name, mainPath, basePath, windowType, width, height, minWidth, minHeight, maxWidth, maxHeight,
defaultExtensionDataXml, specialExtensionDataXml, requiredRuntimeList, isAutoVisible, isPluginExtension)
{
this.id = id;
this.name = name;
this.mainPath = mainPath;
this.basePath = basePath;
this.windowType = windowType;
this.width = width;
this.height = height;
this.minWidth = minWidth;
this.minHeight = minHeight;
this.maxWidth = maxWidth;
this.maxHeight = maxHeight;
this.defaultExtensionDataXml = defaultExtensionDataXml;
this.specialExtensionDataXml = specialExtensionDataXml;
this.requiredRuntimeList = requiredRuntimeList;
this.isAutoVisible = isAutoVisible;
this.isPluginExtension = isPluginExtension;
}
/**
* @class CSEvent
* A standard JavaScript event, the base class for CEP events.
*
* @param {string} type The name of the event type.
* @param {string} scope The scope of event, can be "GLOBAL" or "APPLICATION".
* @param {string} appId The unique identifier of the application that generated the event.
* @param {string} extensionId The unique identifier of the extension that generated the event.
*
* @return A new CSEvent object
*/
function CSEvent(type, scope, appId, extensionId)
{
this.type = type;
this.scope = scope;
this.appId = appId;
this.extensionId = extensionId;
}
/** Event-specific data. */
CSEvent.prototype.data = "";
/**
* @class SystemPath
* Stores operating-system-specific location constants for use in the
* #CSInterface.getSystemPath() method.
* @return A new SystemPath object.
*/
function SystemPath()
{
}
/** The path to user data. */
SystemPath.USER_DATA = "userData";
/** The path to common files for Adobe applications. */
SystemPath.COMMON_FILES = "commonFiles";
/** The path to the user's default document folder. */
SystemPath.MY_DOCUMENTS = "myDocuments";
/** @deprecated. Use #SystemPath.Extension. */
SystemPath.APPLICATION = "application";
/** The path to current extension. */
SystemPath.EXTENSION = "extension";
/** The path to hosting application's executable. */
SystemPath.HOST_APPLICATION = "hostApplication";
/**
* @class ColorType
* Stores color-type constants.
*/
function ColorType()
{
}
/** RGB color type. */
ColorType.RGB = "rgb";
/** Gradient color type. */
ColorType.GRADIENT = "gradient";
/** Null color type. */
ColorType.NONE = "none";
/**
* @class RGBColor
* Stores an RGB color with red, green, blue, and alpha values.
* All values are in the range [0.0 to 255.0]. Invalid numeric values are
* converted to numbers within this range.
*
* @param {number} red The red value, in the range [0.0 to 255.0].
* @param {number} green The green value, in the range [0.0 to 255.0].
* @param {number} blue The blue value, in the range [0.0 to 255.0].
* @param {number} alpha The alpha (transparency) value, in the range [0.0 to 255.0].
* The default, 255.0, means that the color is fully opaque.
*
* @return A new RGBColor object.
*/
function RGBColor(red, green, blue, alpha)
{
this.red = red;
this.green = green;
this.blue = blue;
this.alpha = alpha;
}
/**
* @class Direction
* A point value in which the y component is 0 and the x component
* is positive or negative for a right or left direction,
* or the x component is 0 and the y component is positive or negative for
* an up or down direction.
*
* @param x The horizontal component of the point.
* @param y The vertical component of the point.
*
* @return A new Direction object.
*/
function Direction(x, y)
{
this.x = x;
this.y = y;
}
/**
* @class GradientStop
* Stores gradient stop information.
*
* @param offset The offset of the gradient stop, in the range [0.0 to 1.0].
* @param rgbColor The color of the gradient at this point, an #RGBColor object.
*
* @return GradientStop object.
*/
function GradientStop(offset, rgbColor)
{
this.offset = offset;
this.rgbColor = rgbColor;
}
/**
* @class GradientColor
* Stores gradient color information.
*
* @param type The gradient type, must be "linear".
* @param direction A #Direction object for the direction of the gradient
(up, down, right, or left).
* @param numStops The number of stops in the gradient.
* @param gradientStopList An array of #GradientStop objects.
*
* @return A new GradientColor object.
*/
function GradientColor(type, direction, numStops, arrGradientStop)
{
this.type = type;
this.direction = direction;
this.numStops = numStops;
this.arrGradientStop = arrGradientStop;
}
/**
* @class UIColor
* Stores color information, including the type, anti-alias level, and specific color
* values in a color object of an appropriate type.
*
* @param type The color type, 1 for "rgb" and 2 for "gradient".
The supplied color object must correspond to this type.
* @param antialiasLevel The anti-alias level constant.
* @param color A #RGBColor or #GradientColor object containing specific color information.
*
* @return A new UIColor object.
*/
function UIColor(type, antialiasLevel, color)
{
this.type = type;
this.antialiasLevel = antialiasLevel;
this.color = color;
}
/**
* @class AppSkinInfo
* Stores window-skin properties, such as color and font. All color parameter values are #UIColor objects except that systemHighlightColor is #RGBColor object.
*
* @param baseFontFamily The base font family of the application.
* @param baseFontSize The base font size of the application.
* @param appBarBackgroundColor The application bar background color.
* @param panelBackgroundColor The background color of the extension panel.
* @param appBarBackgroundColorSRGB The application bar background color, as sRGB.
* @param panelBackgroundColorSRGB The background color of the extension panel, as sRGB.
* @param systemHighlightColor The highlight color of the extension panel, if provided by the host application. Otherwise, the operating-system highlight color.
*
* @return AppSkinInfo object.
*/
function AppSkinInfo(baseFontFamily, baseFontSize, appBarBackgroundColor, panelBackgroundColor, appBarBackgroundColorSRGB, panelBackgroundColorSRGB, systemHighlightColor)
{
this.baseFontFamily = baseFontFamily;
this.baseFontSize = baseFontSize;
this.appBarBackgroundColor = appBarBackgroundColor;
this.panelBackgroundColor = panelBackgroundColor;
this.appBarBackgroundColorSRGB = appBarBackgroundColorSRGB;
this.panelBackgroundColorSRGB = panelBackgroundColorSRGB;
this.systemHighlightColor = systemHighlightColor;
}
/**
* @class HostEnvironment
* Stores information about the environment in which the extension is loaded.
*
* @param appName The application's name.
* @param appVersion The application's version.
* @param appLocale The application's current license locale.
* @param appUILocale The application's current UI locale.
* @param appId The application's unique identifier.
* @param isAppOnline True if the application is currently online.
* @param appSkinInfo An #AppSkinInfo object containing the application's default color and font styles.
*
* @return A new HostEnvironment object.
*/
function HostEnvironment(appName, appVersion, appLocale, appUILocale, appId, isAppOnline, appSkinInfo)
{
this.appName = appName;
this.appVersion = appVersion;
this.appLocale = appLocale;
this.appUILocale = appUILocale;
this.appId = appId;
this.isAppOnline = isAppOnline;
this.appSkinInfo = appSkinInfo;
}
/**
* @class HostCapabilities
* Stores information about the host capabilities.
*
* @param EXTENDED_PANEL_MENU True if the application supports panel menu.
* @param EXTENDED_PANEL_ICONS True if the application supports panel icon.
* @param DELEGATE_APE_ENGINE True if the application supports delegated APE engine.
* @param SUPPORT_HTML_EXTENSIONS True if the application supports HTML extensions.
* @param DISABLE_FLASH_EXTENSIONS True if the application disables FLASH extensions.
*
* @return A new HostCapabilities object.
*/
function HostCapabilities(EXTENDED_PANEL_MENU, EXTENDED_PANEL_ICONS, DELEGATE_APE_ENGINE, SUPPORT_HTML_EXTENSIONS, DISABLE_FLASH_EXTENSIONS)
{
this.EXTENDED_PANEL_MENU = EXTENDED_PANEL_MENU;
this.EXTENDED_PANEL_ICONS = EXTENDED_PANEL_ICONS;
this.DELEGATE_APE_ENGINE = DELEGATE_APE_ENGINE;
this.SUPPORT_HTML_EXTENSIONS = SUPPORT_HTML_EXTENSIONS;
this.DISABLE_FLASH_EXTENSIONS = DISABLE_FLASH_EXTENSIONS; // @since 5.0.0
}
/**
* @class ApiVersion
* Stores current api version.
*
* @since 4.2.0
*
* @param major The major version
* @param minor The minor version.
* @param micro The micro version.
*
* @return ApiVersion object.
*/
function ApiVersion(major, minor, micro)
{
this.major = major;
this.minor = minor;
this.micro = micro;
}
/**
* @class MenuItemStatus
* Stores flyout menu item status
*
* @since 5.2.0
*
* @param menuItemLabel The menu item label.
* @param enabled True if user wants to enable the menu item.
* @param checked True if user wants to check the menu item.
*
* @return MenuItemStatus object.
*/
function MenuItemStatus(menuItemLabel, enabled, checked)
{
this.menuItemLabel = menuItemLabel;
this.enabled = enabled;
this.checked = checked;
}
/**
* @class ContextMenuItemStatus
* Stores the status of the context menu item.
*
* @since 5.2.0
*
* @param menuItemID The menu item id.
* @param enabled True if user wants to enable the menu item.
* @param checked True if user wants to check the menu item.
*
* @return MenuItemStatus object.
*/
function ContextMenuItemStatus(menuItemID, enabled, checked)
{
this.menuItemID = menuItemID;
this.enabled = enabled;
this.checked = checked;
}
//------------------------------ CSInterface ----------------------------------
/**
* @class CSInterface
* This is the entry point to the CEP extensibility infrastructure.
* Instantiate this object and use it to:
* <ul>
* <li>Access information about the host application in which an extension is running</li>
* <li>Launch an extension</li>
* <li>Register interest in event notifications, and dispatch events</li>
* </ul>
*
* @return A new CSInterface object
*/
function CSInterface()
{
}
/**
* Users can add this event listener to handle native application theme color changes.
* Callback function gives extensions ability to fine-tune their theme color after the
* global theme color has been changed.
* The callback function should be like below:
*
* @example
* // event is a CSEvent object, but user can ignore it.
* function OnAppThemeColorChanged(event)
* {
* // Should get a latest HostEnvironment object from application.
* var skinInfo = JSON.parse(window.__adobe_cep__.getHostEnvironment()).appSkinInfo;
* // Gets the style information such as color info from the skinInfo,
* // and redraw all UI controls of your extension according to the style info.
* }
*/
CSInterface.THEME_COLOR_CHANGED_EVENT = "com.adobe.csxs.events.ThemeColorChanged";
/** The host environment data object. */
CSInterface.prototype.hostEnvironment = window.__adobe_cep__ ? JSON.parse(window.__adobe_cep__.getHostEnvironment()) : null;
/** Retrieves information about the host environment in which the
* extension is currently running.
*
* @return A #HostEnvironment object.
*/
CSInterface.prototype.getHostEnvironment = function()
{
this.hostEnvironment = JSON.parse(window.__adobe_cep__.getHostEnvironment());
return this.hostEnvironment;
};
/** Closes this extension. */
CSInterface.prototype.closeExtension = function()
{
window.__adobe_cep__.closeExtension();
};
/**
* Retrieves a path for which a constant is defined in the system.
*
* @param pathType The path-type constant defined in #SystemPath ,
*
* @return The platform-specific system path string.
*/
CSInterface.prototype.getSystemPath = function(pathType)
{
var path = decodeURI(window.__adobe_cep__.getSystemPath(pathType));
var OSVersion = this.getOSInformation();
if (OSVersion.indexOf("Windows") >= 0)
{
path = path.replace("file:///", "");
}
else if (OSVersion.indexOf("Mac") >= 0)
{
path = path.replace("file://", "");
}
return path;
};
/**
* Evaluates a JavaScript script, which can use the JavaScript DOM
* of the host application.
*
* @param script The JavaScript script.
* @param callback Optional. A callback function that receives the result of execution.
* If execution fails, the callback function receives the error message EvalScript_ErrMessage.
*/
CSInterface.prototype.evalScript = function(script, callback)
{
if(callback === null || callback === undefined)
{
callback = function(result){};
}
window.__adobe_cep__.evalScript(script, callback);
};
/**
* Retrieves the unique identifier of the application.
* in which the extension is currently running.
*
* @return The unique ID string.
*/
CSInterface.prototype.getApplicationID = function()
{
var appId = this.hostEnvironment.appId;
return appId;
};
/**
* Retrieves host capability information for the application
* in which the extension is currently running.
*
* @return A #HostCapabilities object.
*/
CSInterface.prototype.getHostCapabilities = function()
{
var hostCapabilities = JSON.parse(window.__adobe_cep__.getHostCapabilities() );
return hostCapabilities;
};
/**
* Triggers a CEP event programmatically. Yoy can use it to dispatch
* an event of a predefined type, or of a type you have defined.
*
* @param event A CSEvent object.
*/
CSInterface.prototype.dispatchEvent = function(event)
{
if (typeof event.data == "object")
{
event.data = JSON.stringify(event.data);
}
window.__adobe_cep__.dispatchEvent(event);
};
/**
* Registers an interest in a CEP event of a particular type, and
* assigns an event handler.
* The event infrastructure notifies your extension when events of this type occur,
* passing the event object to the registered handler function.
*
* @param type The name of the event type of interest.
* @param listener The JavaScript handler function or method.
* @param obj Optional, the object containing the handler method, if any.
* Default is null.
*/
CSInterface.prototype.addEventListener = function(type, listener, obj)
{
window.__adobe_cep__.addEventListener(type, listener, obj);
};
/**
* Removes a registered event listener.
*
* @param type The name of the event type of interest.
* @param listener The JavaScript handler function or method that was registered.
* @param obj Optional, the object containing the handler method, if any.
* Default is null.
*/
CSInterface.prototype.removeEventListener = function(type, listener, obj)
{
window.__adobe_cep__.removeEventListener(type, listener, obj);
};
/**
* Loads and launches another extension, or activates the extension if it is already loaded.
*
* @param extensionId The extension's unique identifier.
* @param startupParams Not currently used, pass "".
*
* @example
* To launch the extension "help" with ID "HLP" from this extension, call:
* <code>requestOpenExtension("HLP", ""); </code>
*
*/
CSInterface.prototype.requestOpenExtension = function(extensionId, params)
{
window.__adobe_cep__.requestOpenExtension(extensionId, params);
};
/**
* Retrieves the list of extensions currently loaded in the current host application.
* The extension list is initialized once, and remains the same during the lifetime
* of the CEP session.
*
* @param extensionIds Optional, an array of unique identifiers for extensions of interest.
* If omitted, retrieves data for all extensions.
*
* @return Zero or more #Extension objects.
*/
CSInterface.prototype.getExtensions = function(extensionIds)
{
var extensionIdsStr = JSON.stringify(extensionIds);
var extensionsStr = window.__adobe_cep__.getExtensions(extensionIdsStr);
var extensions = JSON.parse(extensionsStr);
return extensions;
};
/**
* Retrieves network-related preferences.
*
* @return A JavaScript object containing network preferences.
*/
CSInterface.prototype.getNetworkPreferences = function()
{
var result = window.__adobe_cep__.getNetworkPreferences();
var networkPre = JSON.parse(result);
return networkPre;
};
/**
* Initializes the resource bundle for this extension with property values
* for the current application and locale.
* To support multiple locales, you must define a property file for each locale,
* containing keyed display-string values for that locale.
* See localization documentation for Extension Builder and related products.
*
* Keys can be in the
* form <code>key.value="localized string"</code>, for use in HTML text elements.
* For example, in this input element, the localized key.value string is displayed
* instead of the empty value string:
*
* <code><input type="submit" value="" data-locale="key"/></code>
*
* @return An object containing the resource bundle information.
*/
CSInterface.prototype.initResourceBundle = function()
{
var resourceBundle = JSON.parse(window.__adobe_cep__.initResourceBundle());
var resElms = document.querySelectorAll('[data-locale]');
for (var n = 0; n < resElms.length; n++)
{
var resEl = resElms[n];
// Get the resource key from the element.
var resKey = resEl.getAttribute('data-locale');
if (resKey)
{
// Get all the resources that start with the key.
for (var key in resourceBundle)
{
if (key.indexOf(resKey) === 0)
{
var resValue = resourceBundle[key];
if (key.length == resKey.length)
{
resEl.innerHTML = resValue;
}
else if ('.' == key.charAt(resKey.length))
{
var attrKey = key.substring(resKey.length + 1);
resEl[attrKey] = resValue;
}
}
}
}
}
return resourceBundle;
};
/**
* Writes installation information to a file.
*
* @return The file path.
*/
CSInterface.prototype.dumpInstallationInfo = function()
{
return window.__adobe_cep__.dumpInstallationInfo();
};
/**
* Retrieves version information for the current Operating System,
* See http://www.useragentstring.com/pages/Chrome/ for Chrome navigator.userAgent values.
*
* @return A string containing the OS version, or "unknown Operation System".
* If user customizes the User Agent by setting CEF command parameter "--user-agent", only
* "Mac OS X" or "Windows" will be returned.
*/
CSInterface.prototype.getOSInformation = function()
{
var userAgent = navigator.userAgent;
if ((navigator.platform == "Win32") || (navigator.platform == "Windows"))
{
var winVersion = "Windows";
var winBit = "";
if (userAgent.indexOf("Windows") > -1)
{
if (userAgent.indexOf("Windows NT 5.0") > -1)
{
winVersion = "Windows 2000";
}
else if (userAgent.indexOf("Windows NT 5.1") > -1)
{
winVersion = "Windows XP";
}
else if (userAgent.indexOf("Windows NT 5.2") > -1)
{
winVersion = "Windows Server 2003";
}
else if (userAgent.indexOf("Windows NT 6.0") > -1)
{
winVersion = "Windows Vista";
}
else if (userAgent.indexOf("Windows NT 6.1") > -1)
{
winVersion = "Windows 7";
}
else if (userAgent.indexOf("Windows NT 6.2") > -1)
{
winVersion = "Windows 8";
}
else if (userAgent.indexOf("Windows NT 6.3") > -1)
{
winVersion = "Windows 8.1";
}
else if (userAgent.indexOf("Windows NT 10") > -1)
{
winVersion = "Windows 10";
}
if (userAgent.indexOf("WOW64") > -1 || userAgent.indexOf("Win64") > -1)
{
winBit = " 64-bit";
}
else
{
winBit = " 32-bit";
}
}
return winVersion + winBit;
}
else if ((navigator.platform == "MacIntel") || (navigator.platform == "Macintosh"))
{
var result = "Mac OS X";
if (userAgent.indexOf("Mac OS X") > -1)
{
result = userAgent.substring(userAgent.indexOf("Mac OS X"), userAgent.indexOf(")"));
result = result.replace(/_/g, ".");
}
return result;
}
return "Unknown Operation System";
};
/**
* Opens a page in the default system browser.
*
* @since 4.2.0
*
* @param url The URL of the page/file to open, or the email address.
* Must use HTTP/HTTPS/file/mailto protocol. For example:
* "http://www.adobe.com"
* "https://github.com"
* "file:///C:/log.txt"
* "mailto:[email protected]"
*
* @return One of these error codes:
* <ul>
* <li>NO_ERROR - 0</li>
* <li>ERR_UNKNOWN - 1</li>
* <li>ERR_INVALID_PARAMS - 2</li>
* <li>ERR_INVALID_URL - 201</li>
* </ul>
*/
CSInterface.prototype.openURLInDefaultBrowser = function(url)
{
return cep.util.openURLInDefaultBrowser(url);
};
/**
* Retrieves extension ID.
*
* @since 4.2.0
*
* @return extension ID.
*/
CSInterface.prototype.getExtensionID = function()
{
return window.__adobe_cep__.getExtensionId();
};
/**
* Retrieves the scale factor of screen.
* On Windows platform, the value of scale factor might be different from operating system's scale factor,
* @since host application may use its self-defined scale factor.
*
* @since 4.2.0
*
* @return One of the following float number.
* <ul>
* <li> -1.0 when error occurs </li>
* <li> 1.0 means normal screen </li>
* <li> >1.0 means HiDPI screen </li>
* </ul>
*/
CSInterface.prototype.getScaleFactor = function()
{
return window.__adobe_cep__.getScaleFactor();
};
/**
* Set a handler to detect any changes of scale factor. This only works on Mac.
*
* @since 4.2.0
*
* @param handler The function to be called when scale factor is changed.
*
*/
CSInterface.prototype.setScaleFactorChangedHandler = function(handler)
{
window.__adobe_cep__.setScaleFactorChangedHandler(handler);
};
/**
* Retrieves current API version.
*
* @since 4.2.0
*
* @return ApiVersion object.
*
*/
CSInterface.prototype.getCurrentApiVersion = function()
{
var apiVersion = JSON.parse(window.__adobe_cep__.getCurrentApiVersion());
return apiVersion;
};
/**
* Set panel flyout menu by an XML.
*
* @since 5.2.0<br/>
*
* Register a callback function for <code>"com.adobe.csxs.events.flyoutMenuClicked"</code> to get notified when a
* menu item is clicked.
* The <code>"data"</code> attribute of event is an object which contains <code>"menuId"</code> and <code>"menuName"</code> attributes.
*
* Register callback functions for <code>"com.adobe.csxs.events.flyoutMenuOpened"</code> and <code>"com.adobe.csxs.events.flyoutMenuClosed"</code>
* respectively to get notified when flyout menu is opened or closed.
*
* @param {string} menu An XML string which describes menu structure.
* @example
* An example menu XML:
* '<Menu>
* <MenuItem Id="menuItemId1" Label="TestExample1" Enabled="true" Checked="false"/>
* <MenuItem Label="TestExample2">
* <MenuItem Label="TestExample2-1" >
* <MenuItem Label="TestExample2-1-1" Enabled="false" Checked="true"/>
* </MenuItem>
* <MenuItem Label="TestExample2-2" Enabled="true" Checked="true"/>
* </MenuItem>
* <MenuItem Label="---" />
* <MenuItem Label="TestExample3" Enabled="false" Checked="false"/>
* </Menu>'
*
*/
CSInterface.prototype.setPanelFlyoutMenu = function(menu)
{
if ("string" != typeof menu)
{
return;
}
window.__adobe_cep__.invokeSync("setPanelFlyoutMenu", menu);
};
/**
* Updates a menu item in the extension window's flyout menu, by setting the enabled