InDesign插件-常规功能开发-添加参考线-js脚本开发-ID插件
发布时间：2023年12月28日
1.脚本执行概述
“脚本”面板和“脚本标签”面板概述，InDesign 包含两个用于脚本的面板：“脚本”面板和“脚本标签”面板。在“脚本”面板中可以运行脚本而不必离开 InDesign。“脚本”面板显示的是位于“InDesign 应用程序”文件夹和“偏好设置文件夹”下的”脚本“文件夹中的脚本。
选择“Windows”>“实用程序”>“脚本”打开脚本面板。如果创建或收到脚本，可将其放在“脚本面板”文件夹下，使其显示在“脚本”面板中。
macOS :Users/[用户名]/Library/Preferences/Adobe InDesign/[版本]/[语言]/Scripts/Scripts Panel
Windows XP : Documents and Settings[用户名]\Application Data\Adobe\InDesign[版本][语言]\Scripts\Scripts Panel
Windows Vista 和 Windows 7 : Users[用户名]\AppData\Roaming\Adobe\InDesign[版本][语言]\Scripts\Scripts Panel
例如作者机器上位于：C:\Users\ajz\AppData\Roaming\Adobe\InDesign\Version 15.0-J\zh_CN\Scripts\Scripts Panel
也可以放在系统脚本所在位置：C:\Program Files\Adobe\Adobe InDesign 2020\Scripts\Scripts Panel
本文开发一个功能，添加参考线。
2.InDesign 对象模型
当您考虑 InDesign 和 InDesign 文档时，您可能会在脑海中组织程序及其组件。您知道文本框架包含段落，而页面又包含文本框架。页面是跨页的一部分，一个或多个跨页组成一个文档。文档包含颜色、样式、图层和主跨页。当您考虑您创建的布局时，您会直观地理解它们是有顺序的。
InDesign 以相同的方式“思考”文档的内容。文档包含页面，页面包含页面项（文本框架、矩形、椭圆等）。文本框架包含字符、单词、段落和锚定框架；图形框架包含图像、EPS 文件或 PDF 文件；组包含其他页面项目。我们在这里提到的内容是构成 InDesign 出版物的对象，也是我们在编写 InDesign 脚本时使用的对象。
出版物中的对象按特定顺序排列：框架位于页面上，页面位于文档内，而文档位于 InDesign 应用程序对象内。当我们谈论对象模型或层次结构时，我们谈论的是这种结构。了解对象模型是找到要使用的对象的关键，而 InDesign 脚本的最佳指南是您对 InDesign 本身的了解。
对象具有属性。例如，文本对象的属性包括用于设置文本格式的字体、磅值和应用于文本的行距。
属性具有值；例如，文本的磅大小可以是数字（以磅为单位），也可以是用于自动引导的字符串“Auto”。文本的填充颜色属性可以设置为颜色、渐变、混合墨迹或色板。属性也可以是读/写或只读的。读/写属性可以设置为其他值；只读属性不能。
对象还具有方法，即脚本世界的动词，或者对象可以执行的操作。例如，document 对象具有 print、export 和 save 方法。方法具有定义方法效果的参数或值。例如，文档的 place 方法具有一个参数，用于定义要置入的文件。参数可以是必需的，也可以是可选的，具体取决于方法。
下图是 InDesign 对象模型的概述。该图不是 InDesign 脚本可用对象的完整列表；相反，它是用于理解对象类型之间关系的概念框架。
3.源码解析
显示一个脚本界面，与用户交互必要的参数选择，然后点击生成。
main();
function main(){
//Make certain that user interaction (display of dialogs, etc.) is turned on.
app.scriptPreferences.userInteractionLevel = UserInteractionLevels.interactWithAll;
var myObjectList = new Array;
if (app.documents.length != 0){
if (app.selection.length != 0){
for(var myCounter = 0;myCounter < app.selection.length; myCounter++){
switch (app.selection[myCounter].constructor.name){
case "Rectangle":
case "Oval":
case "Polygon":
case "TextFrame":
case "Group":
case "Button":
case "GraphicLine":
myObjectList.push(app.selection[myCounter]);
break;
}
}
if (myObjectList.length != 0){
var myOldXUnits = app.documents.item(0).viewPreferences.horizontalMeasurementUnits;
var myOldYUnits = app.documents.item(0).viewPreferences.verticalMeasurementUnits;
app.documents.item(0).viewPreferences.horizontalMeasurementUnits = MeasurementUnits.points;
app.documents.item(0).viewPreferences.verticalMeasurementUnits = MeasurementUnits.points;
myDisplayDialog(myObjectList);
//Comment out the previous line and uncomment the following line to use a ScriptUI dialog.
//myDisplayScriptUIDialog(myObjectList);
app.documents.item(0).viewPreferences.horizontalMeasurementUnits = myOldXUnits;
app.documents.item(0).viewPreferences.verticalMeasurementUnits = myOldYUnits;
}
else{
alert ("Please select a page item and try again.");
}
}
else{
alert ("Please select an object and try again.");
}
}
else{
alert ("Please open a document, select an object, and try again.");
}
}
function myDisplayDialog(myObjectList){
var myRangeButtons, myBasedOnButtons;
var myLabelWidth = 100;
var myDialog = app.dialogs.add({name:"AddGuides"});
with(myDialog){
with(dialogColumns.add()){
with(borderPanels.add()){
staticTexts.add({staticLabel:"Add Guides At:"});
with(dialogColumns.add()){
var myTopCheckbox = checkboxControls.add({staticLabel:"&Top", checkedState:true});
var myLeftCheckbox = checkboxControls.add({staticLabel:"&Left", checkedState:true});
var myBottomCheckbox = checkboxControls.add({staticLabel:"&Bottom", checkedState:true});
var myRightCheckbox = checkboxControls.add({staticLabel:"&Right", checkedState:true});
var myXCenterCheckbox = checkboxControls.add({staticLabel:"&Horizontal Center", checkedState:true});
var myYCenterCheckbox = checkboxControls.add({staticLabel:"&Vertical Center", checkedState:true});
var myXPointCheckbox = checkboxControls.add({staticLabel:"Path Point Hori&zontal Anchor", checkedState:false});
var myYPointCheckbox = checkboxControls.add({staticLabel:"Path Point Verti&cal Anchor", checkedState:false});
}
}
with(borderPanels.add()){
staticTexts.add({staticLabel:"Add Guides Around:"});
with(myRangeButtons = radiobuttonGroups.add()){
radiobuttonControls.add({staticLabel:"Each &Object", checkedState:true, minWidth:156});
radiobuttonControls.add({staticLabel:"Entire &Selection"});
}
}
with(borderPanels.add()){
with(dialogColumns.add()){
with(dialogRows.add()){
with(dialogColumns.add()){
staticTexts.add({staticLabel:"Guides Based On:"});
}
with(dialogColumns.add()){
with(myBasedOnButtons = radiobuttonGroups.add()){
radiobuttonControls.add({staticLabel:"&Geometric Bounds", checkedState:true, minWidth:160});
radiobuttonControls.add({staticLabel:"V&isible Bounds"});
}
}
}
with(dialogRows.add()){
with(dialogColumns.add()){
staticTexts.add({staticLabel:"Horizontal Offset:", minWidth:myLabelWidth});
}
with(dialogColumns.add()){
var myXOffsetField = measurementEditboxes.add({editValue:0, editUnits:MeasurementUnits.points});
}
}
with(dialogRows.add()){
with(dialogColumns.add()){
staticTexts.add({staticLabel:"Vertical Offset:", minWidth:myLabelWidth});
}
with(dialogColumns.add()){
var myYOffsetField = measurementEditboxes.add({editValue:0, editUnits:MeasurementUnits.points});
}
}
}
}
}
}
myReturn = myDialog.show();
if (myReturn == true){
//Get control values from the dialog box.
var myTop = myTopCheckbox.checkedState;
var myLeft = myLeftCheckbox.checkedState;
var myBottom = myBottomCheckbox.checkedState;
var myRight = myRightCheckbox.checkedState;
var myXCenter = myXCenterCheckbox.checkedState;
var myYCenter = myYCenterCheckbox.checkedState;
var myXPoint = myXPointCheckbox.checkedState;
var myYPoint = myYPointCheckbox.checkedState;
var myBasedOn = myBasedOnButtons.selectedButton;
var myRange = myRangeButtons.selectedButton;
var myXOffset = myXOffsetField.editValue;
var myYOffset = myYOffsetField.editValue;
//Remove the dialog box from memory.
myDialog.destroy();
if(myTop+myLeft+myBottom+myRight+myXCenter+myYCenter+myXPoint+myYPoint !=0){
myAddGuides(myTop, myLeft, myBottom, myRight, myXCenter, myYCenter, myRange, myBasedOn, myXOffset, myYOffset, myXPoint, myYPoint, myObjectList);
}
else{
alert("No guides were specified.");
}
}
else{
//Remove the dialog box from memory.
myDialog.destroy();
}
}
//ScriptUI version of the above dialog box.
function myDisplayScriptUIDialog(myObjectList){
var myBasedOn, myRange;
var myDialog = new Window('dialog', 'AddGuides');
with(myDialog){
alignChildren = 'fill';
var myGuideTypesPanel = add('panel', undefined, "Add Guides At:");
with(myGuideTypesPanel){
orientation = 'column';
alignChildren = 'left';
margins = [12, 16, 12, 6];
spacing = 4;
myDialog.myTopCheckbox = add('checkbox', undefined, "Top");
myDialog.myTopCheckbox.value = true;
myDialog.myLeftCheckbox = add('checkbox', undefined, "Left");
myDialog.myLeftCheckbox.value = true;
myDialog.myBottomCheckbox = add('checkbox', undefined, "Bottom");
myDialog.myBottomCheckbox.value = true;
myDialog.myRightCheckbox = add('checkbox', undefined, "Right");
myDialog.myRightCheckbox.value = true;
myDialog.myXCenterCheckbox = add('checkbox', undefined, "Horizontal Center");
myDialog.myXCenterCheckbox.value = true;
myDialog.myYCenterCheckbox = add('checkbox', undefined, "Vertical Center");
myDialog.myYCenterCheckbox.value = true;
myDialog.myXPointCheckbox = add('checkbox', undefined, "Path Point Horizontal Anchor");
myDialog.myXPointCheckbox.value = true;
myDialog.myYPointCheckbox = add('checkbox', undefined, "Path Point Vertical Anchor");
myDialog.myYPointCheckbox.value = true;
}
var myGuideLocationPanel = add('panel', undefined, "Add Guides Around:");
with(myGuideLocationPanel){
orientation = 'column';
alignChildren = 'left';
margins = [12, 14, 12, 6];
spacing = 4;
myDialog.myEachObjectRadioButton = add('radiobutton', undefined, "Each Object");
myDialog.myEachObjectRadioButton.value = true;
myDialog.myEntireSelectionRadioButton = add('radiobutton', undefined, "Entire Selection");
}
var myGuidesBasedOnPanel = add('panel', undefined, "Add Guides Based On:");
with(myGuidesBasedOnPanel){
orientation = 'column';
alignChildren = 'left';
margins = [12, 14, 12, 6];
spacing = 4;
myDialog.myGeometricBoundsRadioButton = add('radiobutton', undefined, "Geometric Bounds");
myDialog.myGeometricBoundsRadioButton.value = true;
myDialog.myVisibleBoundsRadioButton = add('radiobutton', undefined, "Visible Bounds");
with(add('group')){
orientation = 'row';
alignChildren = 'center';
spacing = 2;
with(add('group')){
orientation = 'column';
alignChildren = 'right';
var myXOffsetLabel = add('statictext', undefined, "Horizontal Offset:");
var myYOffsetLabel = add('statictext', undefined, "Vertical Offset:");
}
with(add('group')){
orientation = 'column';
alignChildren = 'right';
myDialog.myXOffsetField = add('edittext', undefined, "0", {enterKeySignalsOnChange:false});
myDialog.myXOffsetField.characters = 7;
myDialog.myXOffsetField.justify = "right";
myXOffsetField.onChange = function(){
if(myValidateNumber(myXOffsetField.text)==false){
alert("Invalid numeric entry!");
myDialog.myXOffsetField.text = "0";
}
}
myDialog.myYOffsetField = add('edittext', undefined, "0");
myDialog.myYOffsetField.justify = "right";
myDialog.myYOffsetField.characters = 7;
myYOffsetField.onChange = function(){
if(myValidateNumber(myYOffsetField.text)==false){
alert("Invalid numeric entry!");
myDialog.myYOffsetField.text = "0";
}
}
}
with(add('group')){
orientation = 'column';
alignChildren = 'left';
add('statictext', undefined, "points");
add('statictext', undefined, "points");
}
}
}
with(add('group')){
orientation = 'row';
alignment = 'right';
myDialog.myCloseButton = add('button', undefined, "Close", {name:'cancel'});
myDialog.myCloseButton.onClick = function(){myDialog.close()};
myDialog.myOKButton = add('button', undefined, "OK", {name:'ok'});
}
}
var myReturn = myDialog.show();
if (myReturn == true){
//Get control values from the dialog box.
with(myDialog){
var myTop = myTopCheckbox.value;
var myLeft = myLeftCheckbox.value;
var myBottom = myBottomCheckbox.value;
var myRight = myRightCheckbox.value;
var myXCenter = myXCenterCheckbox.value;
var myYCenter = myYCenterCheckbox.value;
var myXPoint = myXPointCheckbox.value;
var myYPoint = myYPointCheckbox.value;
var myXOffset = parseFloat(myXOffsetField.text);
var myYOffset = parseFloat(myYOffsetField.text);
if(myGeometricBoundsRadioButton.value == true){
myBasedOn = 0;
}
else{
myBasedOn = 1;
}
if(myEachObjectRadioButton.value == true){
myRange = 0;
}
else{
myRange = 1;
}
}
myDialog.close();
if(myTop+myLeft+myBottom+myRight+myXCenter+myYCenter+myXPoint+myYPoint !=0){
myAddGuides(myTop, myLeft, myBottom, myRight, myXCenter, myYCenter, myRange, myBasedOn, myXOffset, myYOffset, myXPoint, myYPoint, myObjectList);
}
else{
alert("No guides were specified.");
}
}
else{
myDialog.close();
}
}
function myAddGuides(myTop, myLeft, myBottom, myRight, myXCenter, myYCenter, myRange, myBasedOn, myXOffset, myYOffset, myXPoint, myYPoint, myObjectList){
var myLayer, myCounter;
var myOldRulerOrigin = app.activeDocument.viewPreferences.rulerOrigin;
app.activeDocument.viewPreferences.rulerOrigin = RulerOrigin.spineOrigin;
//Create a layer to hold the printers marks (if it does not already exist).
myLayer = app.activeDocument.layers.item("Guides");
try{
myLayerName = myLayer.name;
}
catch (myError){
myLayer = app.activeDocument.layers.add({name:"Guides"});
}
//Process the objects in the selection.
for(myCounter = 0; myCounter < myObjectList.length; myCounter ++){
var myObject = myObjectList[myCounter];
if (myBasedOn == 0){
myBounds = myObject.geometricBounds;
}
else{
myBounds = myObject.visibleBounds;
}
//Draw guides at path point locations, if necessary.
if ((myXPoint == true)||(myYPoint == true)){
myDrawGuidesAtPathPoints(myObject, myXPoint, myYPoint);
}
//Set up some initial bounding box values.
if ((myRange != 0)&&(myCounter==0)){
myX1 = myBounds[1];
myY1 = myBounds[0];
myX2 = myBounds[3];
myY2 = myBounds[2];
}
if(myRange == 0){
myDrawGuides (myBounds[1], myBounds[0], myBounds[3], myBounds[2], myTop, myLeft, myBottom, myRight, myXCenter, myYCenter, myLayer, myXOffset, myYOffset);
}
else{
//Compare the bounds values to the stored bounds.
//If a given bounds value is less than (for x1 and y1) or
//greater than (for x2 and y2) the stored value,
//then replace the stored value with the bounds value.
if (myBounds[0] < myY1){
myY1 = myBounds[0];
}
if (myBounds[1] < myX1){
myX1 = myBounds[1];
}
if (myBounds[2] > myY2){
myY2 = myBounds[2];
}
if (myBounds[3] > myX2){
myX2 = myBounds[3];
}
}
}
if(myRange != 0){
myDrawGuides (myX1, myY1, myX2, myY2, myTop, myLeft, myBottom, myRight, myXCenter, myYCenter, myLayer, myXOffset, myYOffset);
}
app.activeDocument.viewPreferences.rulerOrigin = myOldRulerOrigin;
}
function myDrawGuidesAtPathPoints(myObject, myXPoint, myYPoint){
for(var myPathCounter = 0; myPathCounter < myObject.paths.length; myPathCounter++){
for(var myPointCounter = 0; myPointCounter < myObject.paths.item(myPathCounter).pathPoints.length; myPointCounter ++){
if(myXPoint==true){
myDrawGuide(myObject.paths.item(myPathCounter).pathPoints.item(myPointCounter).anchor[0], 1);
}
if(myYPoint==true){
myDrawGuide(myObject.paths.item(myPathCounter).pathPoints.item(myPointCounter).anchor[1], 0);
}
}
}
}
function myDrawGuides(myX1, myY1, myX2, myY2, myTop, myLeft, myBottom, myRight, myXCenter, myYCenter, myLayer, myXOffset, myYOffset){
if (myTop == true){
myDrawGuide(myY1 - myYOffset, 0);
}
if (myLeft == true){
myDrawGuide(myX1 - myXOffset, 1);
}
if (myBottom == true){
myDrawGuide(myY2 + myYOffset, 0);
}
if (myRight == true){
myDrawGuide(myX2 + myXOffset, 1);
}
if (myXCenter == true){
myDrawGuide(myX1+((myX2-myX1)/2), 1);
}
if (myYCenter == true){
myDrawGuide(myY1+((myY2-myY1)/2), 0);
}
}
function myDrawGuide(myGuideLocation, myGuideOrientation){
var myLayer = app.activeDocument.layers.item("Guides");
with(app.activeWindow.activeSpread){
if(myGuideOrientation == 0){
with (guides.add(myLayer, undefined, undefined)){
orientation=HorizontalOrVertical.horizontal;
location=myGuideLocation;
}
}
else{
with (guides.add(myLayer, undefined, undefined)){
orientation=HorizontalOrVertical.vertical;
location=myGuideLocation;
}
}
}
}
function myValidateNumber(myString){
var myRegExp = /(^-?\d\d*\.\d*$)|(^-?\d\d*$)|(^-?\.\d\d*$)/;
return myRegExp.test(myString);
}
4.界面及结果
5.总结
该功能可以有效的帮助程序员掌握，参考线自动生成功能。读者可以参考使用。
文章来源:https://blog.csdn.net/m0_67316550/article/details/135263169
本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。 如若内容造成侵权/违法违规/事实不符，请联系我的编程经验分享网邮箱：chenni525@qq.com进行投诉反馈，一经查实，立即删除！
本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。 如若内容造成侵权/违法违规/事实不符，请联系我的编程经验分享网邮箱：chenni525@qq.com进行投诉反馈，一经查实，立即删除！