• 縦組み／横組み
• テキストサイズ単位や組版単位などの違い
• 段数、段間
• 字間、行間
• フレーム内マージン
• フレームの線の太さ

などの設定をすべて考慮して、テキストフレームの geometricBounds から文字数と行数を逆算する仕組み。

TextFrame.prototype の拡張になっているので、外部ファイル扱い (.jsxinc) にしておいて #import で適宜読み込むのがおすすめ。

使い方

Getter と setter を兼ねた gridDimensions() というメソッドになっている。そのまま呼び出せば get、引数を渡して呼び出せば set として動作する。

フレームの種類が「フレームグリッド」に設定されているテキストフレームにのみ有効。フレームグリッドでない場合はエラーを返す。

Get

1段のサイズが 15文字 × 20行 のテキストフレーム myTextFrame があるとすると、

myTextFrame.gridDimensions();

で [15, 20] という [文字数, 行数] 形式の array を返す。

Set

同じく [文字数, 行数] 形式の array を渡すことで、フレームグリッドのサイズを変更する。

myTextFrame.gridDimensions([16, 40]);

これで、段数・字間などはそのままに、各段のサイズが 16文字 × 40行 に変更される。どちらか片方だけ変更したい場合は、[0, 55] のようにゼロを使えばそこだけ無変更。

スクリプト

InDesign: フレームグリッドの文字数と行数をget/set — Gist

Please just let me Cancel

By default, it seems that the close event does not distinguish between an “OK” close and a “Cancel” close. This can be problematic in input validations, because if your validator is designed to prevent the dialog from closing upon detection of faulty input, it should absolutely not do so in the event of an explicit “Cancel” (or Esc) close.

The Workaround

Register event handlers for the Cancel button and Escape key, so that a justExit flag can be flipped when they occur. Then, the onClose handler can check the flag to determine whether it needs to validate and obstruct, or just get out of the way.

So first, define the boolean, and maybe a flagging function to flip it:

var justExitFlag = false;

function flipJustExit() {
	justExitFlag = true;
}

Now add event listeners. Specifically, there are three events you’ll want to monitor:

1. an Esc key press within the dialog window

myDialog.addEventListener("keydown", function (k) {
  if (k.keyIdentifier == "U+001B" /* Escape key */) {
    flipJustExit();
  }
});

2. a click on the Cancel button

myCancelBtn.addEventListener("click", flipJustExit);

3. a Spacebar key press on the Cancel button

myCancelBtn.addEventListener("keydown", function (k) {
  if (k.keyIdentifier == "U+0020" /* space key */) {
    flipJustExit();
  }
});

Finally, your onClose handler might be something like this:

function validateInput() {
  if (justExitFlag) {
    return true; /* doesn’t stop dialog from closing */
  } else if (inputIsInvalid()) {
    alertUserWithCrazyPopup();
    return false; /* stops dialog from closing */
  }
}

If you haven’t already, read why managing measurement units is important.

showCurrentSettings()

Use this to display a quick alert of what the current settings are.

I often find that some of these settings get messed up at one point or another in a scripting session full of stepping, incomplete functions, or exiting mid-script. When things get weird, I check these settings.

randomizeSettings()

Randomize the measurementUnit settings with this function to create the most implausible environment ever. (Horizontal agates and vertical picas, anyone?) Then, check to see if your script works correctly. Randomize and check again. Two or three cycles of this is probably enough to see if your script fails to work around measurementUnit diversity.

resetSettings()

After your tampering is done, call this function to hit the reset button. The default values assigned in this function are mine (i.e., standard settings for a Japanese language user), so be sure to substitute in your own defaults.

Try it:

#target indesign
 
var sp = app.scriptPreferences;
var vp = app.documents[0].isValid ?
          document.viewPreferences : app.viewPreferences;
 
function showCurrentSettings() {
 
    alert(
        "Current settings:n" +
        "Script: " + sp.measurementUnit.toString() + "nn" +
 
        "Horizontal: " + vp.horizontalMeasurementUnits.toString() + "n" +
        "Vertical: " + vp.verticalMeasurementUnits.toString() + "n" +
        "Stroke: " + vp.strokeMeasurementUnits.toString() + "nn" +
 
        "Text: " + vp.textSizeMeasurementUnits.toString() + "n" +
        "Typo: " + vp.typographicMeasurementUnits.toString() + "nn" +
 
        "Ruler: " + vp.rulerOrigin.toString()
    );
}
 
function randomizeSettings() {
    var unitArray = [
        MeasurementUnits.POINTS,
        MeasurementUnits.PICAS,
        MeasurementUnits.INCHES,
        MeasurementUnits.INCHES_DECIMAL,
        MeasurementUnits.MILLIMETERS,
        MeasurementUnits.CENTIMETERS,
        MeasurementUnits.CICEROS,
        MeasurementUnits.CUSTOM,
        MeasurementUnits.AGATES,
        MeasurementUnits.U,
        MeasurementUnits.BAI,
        MeasurementUnits.MILS,
        MeasurementUnits.PIXELS,
        MeasurementUnits.HA,
        MeasurementUnits.AMERICAN_POINTS,
    ];
    var scriptUnitArray = unitArray.concat(AutoEnum.AUTO_VALUE);
    var strokeUnitArray = [
        MeasurementUnits.POINTS,
        MeasurementUnits.MILLIMETERS,
        MeasurementUnits.PIXELS,
    ];
    var textUnitArray = [
        MeasurementUnits.POINTS,
        MeasurementUnits.PIXELS,
        MeasurementUnits.Q,
        MeasurementUnits.AMERICAN_POINTS,
    ];
    var typoUnitArray = [
        MeasurementUnits.POINTS,
        MeasurementUnits.PIXELS,
        MeasurementUnits.HA,
        MeasurementUnits.AMERICAN_POINTS,
        MeasurementUnits.U,
        MeasurementUnits.BAI,
        MeasurementUnits.MILS,
    ];
    var rulerOriginArray = [
        RulerOrigin.SPREAD_ORIGIN,
        RulerOrigin.PAGE_ORIGIN,
        RulerOrigin.SPINE_ORIGIN,
    ];
 
    function getRandomItem(myArray) {
        var myIndex = Math.floor(Math.random() * myArray.length);
 
        return myArray[myIndex];
    }
 
    // Set random values to the preferences
    sp.measurementUnit = getRandomItem(scriptUnitArray);
 
    vp.horizontalMeasurementUnits = getRandomItem(unitArray);
    vp.verticalMeasurementUnits = getRandomItem(unitArray);
 
    vp.strokeMeasurementUnits = getRandomItem(strokeUnitArray);
    vp.textSizeMeasurementUnits = getRandomItem(textUnitArray);
    vp.typographicMeasurementUnits = getRandomItem(typoUnitArray);
 
    vp.rulerOrigin = getRandomItem(rulerOriginArray);
 
    showCurrentSettings();
}
 
function resetSettings() {
    var defaultUnits = MeasurementUnits.MILLIMETERS;
 
    sp.measurementUnit = AutoEnum.AUTO_VALUE;
 
    vp.horizontalMeasurementUnits = defaultUnits;
    vp.strokeMeasurementUnits = defaultUnits;
    vp.verticalMeasurementUnits = defaultUnits;
 
    vp.rulerOrigin = RulerOrigin.SPINE_ORIGIN;
 
    vp.textSizeMeasurementUnits = MeasurementUnits.Q;
    vp.typographicMeasurementUnits = MeasurementUnits.HA;
 
    showCurrentSettings();
}

Where are these measurement units?

There are three major places where measurement units could vary depending on the user environment:

1. document.viewPreferences

Here you will find five important measurementUnit settings that may totally mess up your script if not accounted for.

The measurementUnit settings are:

• horizontalMeasurementUnits
• verticalMeasurementUnits
• strokeMeasurementUnits
• textSizeMeasurementUnits
• typographicMeasurementUnits

Although some documentation lists all 15 MeasurementUnit enums as possible values for these properties, the truth is that the stroke, textSize, and typographic properties only accept values from a specific subset of these enums. They are:

Stroke measurement units

• MeasurementUnits.POINTS
• MeasurementUnits.MILLIMETERS
• MeasurementUnits.PIXELS

Text size measurement units

• MeasurementUnits.POINTS
• MeasurementUnits.PIXELS
• MeasurementUnits.Q
• MeasurementUnits.AMERICAN_POINTS

Typographic measurement units

• MeasurementUnits.POINTS
• MeasurementUnits.PIXELS
• MeasurementUnits.HA
• MeasurementUnits.AMERICAN_POINTS
• MeasurementUnits.U
• MeasurementUnits.BAI
• MeasurementUnits.MILS

2. application.viewPreferences

Same as document.viewPreferences, but like a default setting for new documents. The document.viewPreferences for each individual document will take precedence over these.

3. application.scriptPreferences.measurementUnit

This single property here affects some — but confusingly, not all — ways in which scripts handle units. In addition to all 15 MeasurementUnit enums, there is also a special context-dependent AutoEnum.AUTO_VALUE that uses whatever MeasurementUnit enum is assigned to a relevant property in the viewPreferences. AutoEnum.AUTO_VALUE is the default setting.

I consider this, the scriptPreferences.measurementUnit, to be the most dangerous measurementUnit pitfall. Why? Unlike the viewPreferences, there is no way a casual user of your script will be able to find or change this setting through the standard InDesign GUI. Thus, a reckless script that changes this setting and fails to revert it may alter the behavior of all other scripts in that user’s environment.

There are two things you should do to prevent this disaster. One is to be extremely serious about reverting any changes you make to this property. It’s a good idea to call the reverting routine in the finally of a try clause, so that an unexpected error will not abort the script without reverting.

The second is to script defensively, and make sure your script works regardless of the user’s scriptPreferences.measurementUnit. Do not assume it will always be set to AutoEnum.AUTO_VALUE. If the setting is going to affect any functionality in your script, alter it temporarily to something that is guaranteed to work as intended, and then revert to the original setting.

Test your script

Check to see how your script will work in random measurement unit environments.

特によくあるのが app.scriptPreferences の設定。 enableRedraw はほとんどの場合で disable したいだろうし、 measurementUnit は意図しない設定になっていると絶対値の組み込まれたアルゴリズムが不具合を起こす。

この辺の〈保持→変更→復元〉という処理を main() などに直接入れちゃうと煩雑なので、 scriptSettings.alter() と scriptSettings.revert() で本体ルーチンを挟むだけでいいようにメソッド化してみた。

// Make alter and revert methods
var scriptSettings = {
  alter: function() {
    var prefs = app.scriptPreferences;
    var propStrs = ["enableRedraw", "measurementUnit", "userInteractionLevel"];
    var tempVals = [false, AutoEnum.AUTO_VALUE, UserInteractionLevels.INTERACT_WITH_ALL]
    var originalVals = [];

    for (var i = 0; i < propStrs.length; i++) {
      originalVals.push(prefs[propStrs[i]]); // Retain original values
      prefs[propStrs[i]] = tempVals[i]; // Change to temporary values
    }

    // Make a function to revert to original values
    this.revert = function() {
      for (var i = 0; i < propStrs.length; i++) {
        prefs[propStrs[i]] = originalVals[i];
      }
    };
  }
};

以上を本体処理より前に declare しておくだけ。

メリット

1. 変更不要のプロパティがあれば、 propStrs と tempVals の array から削るだけ
2. エラーなどで途中 exit() する場面でも、その手前で scriptSettings.revert() を call するだけ

scriptSettings の declare 時ではなく、 alter() を call した時点での設定値が保存される、という点にだけ注意。