layoutbridge-light 0.0.0-stage → 1.0.1

package/indesign/commands/45-frame-options.js

@@ -0,0 +1,247 @@
+/* Wunschliste J (Sitzung 7) – Rahmenoptionen lesen: get_frame_options. */
+
+/* first_baseline_offset: Name <-> FirstBaseline-Enumerator. */
+function idcFirstBaselineFor(name) {
+  if (typeof FirstBaseline === 'undefined') { return null; }
+  if (name === 'ascent') { return FirstBaseline.ASCENT_OFFSET; }
+  if (name === 'cap_height') { return FirstBaseline.CAP_HEIGHT; }
+  if (name === 'leading') { return FirstBaseline.LEADING_OFFSET; }
+  if (name === 'x_height') { return FirstBaseline.X_HEIGHT; }
+  if (name === 'fixed') { return FirstBaseline.FIXED_HEIGHT; }
+  if (name === 'embox_top') { return FirstBaseline.EMBOX_TOP; }
+  return null;
+}
+
+function idcFirstBaselineName(value) {
+  if (value === undefined || value === null) { return null; }
+  if (typeof FirstBaseline === 'undefined') { return String(value); }
+  if (IDC.enumIs(value, FirstBaseline.ASCENT_OFFSET)) { return 'ascent'; }
+  if (IDC.enumIs(value, FirstBaseline.CAP_HEIGHT)) { return 'cap_height'; }
+  if (IDC.enumIs(value, FirstBaseline.LEADING_OFFSET)) { return 'leading'; }
+  if (IDC.enumIs(value, FirstBaseline.X_HEIGHT)) { return 'x_height'; }
+  if (IDC.enumIs(value, FirstBaseline.FIXED_HEIGHT)) { return 'fixed'; }
+  if (IDC.enumIs(value, FirstBaseline.EMBOX_TOP)) { return 'embox_top'; }
+  return String(value);
+}
+
+function idcVerticalJustificationName(value) {
+  if (value === undefined || value === null) { return null; }
+  if (typeof VerticalJustification === 'undefined') { return String(value); }
+  if (IDC.enumIs(value, VerticalJustification.TOP_ALIGN)) { return 'top'; }
+  if (IDC.enumIs(value, VerticalJustification.CENTER_ALIGN)) { return 'center'; }
+  if (IDC.enumIs(value, VerticalJustification.BOTTOM_ALIGN)) { return 'bottom'; }
+  if (IDC.enumIs(value, VerticalJustification.JUSTIFY_ALIGN)) { return 'justify'; }
+  return String(value);
+}
+
+/*
+ * Name -> VerticalJustification, null bei unbekanntem Namen. Kein
+ * verschachtelter ?:-Ausdruck: ExtendScript klammert ihn links (Fund 3,
+ * Sitzung 6, live nachgewiesen am 05.09.2026).
+ */
+function idcVerticalJustificationFor(name) {
+  if (typeof VerticalJustification === 'undefined') { return null; }
+  if (name === 'top') { return VerticalJustification.TOP_ALIGN; }
+  if (name === 'center') { return VerticalJustification.CENTER_ALIGN; }
+  if (name === 'bottom') { return VerticalJustification.BOTTOM_ALIGN; }
+  if (name === 'justify') { return VerticalJustification.JUSTIFY_ALIGN; }
+  return null;
+}
+
+function idcColumnTypeName(value) {
+  if (value === undefined || value === null) { return null; }
+  if (typeof TextColumnType === 'undefined') { return String(value); }
+  if (IDC.enumIs(value, TextColumnType.FIXED_NUMBER)) { return 'fixed_number'; }
+  if (IDC.enumIs(value, TextColumnType.FIXED_WIDTH)) { return 'fixed_width'; }
+  if (IDC.enumIs(value, TextColumnType.FLEXIBLE_WIDTH)) { return 'flexible_width'; }
+  return String(value);
+}
+
+/*
+ * Spaltenart. Adobes DOM (TextFramePreference) fuehrt sie als zwei Schalter
+ * useFixedColumnWidth / useFlexibleColumnWidth; ein textColumnType gibt es
+ * dort nicht (in 21.5 wirft der Zugriff – Sitzung 7). Erst die Schalter,
+ * dann der Rueckfall auf textColumnType fuer Laufzeiten, die ihn kennen.
+ */
+function idcColumnType(prefs) {
+  var flexible = null, fixed = null;
+  try { flexible = prefs.useFlexibleColumnWidth === true; } catch (e0) { flexible = null; }
+  try { fixed = prefs.useFixedColumnWidth === true; } catch (e1) { fixed = null; }
+  if (flexible === true) { return 'flexible_width'; }
+  if (fixed === true) { return 'fixed_width'; }
+  if (flexible === false || fixed === false) { return 'fixed_number'; }
+  try { return idcColumnTypeName(prefs.textColumnType); } catch (e2) { return null; }
+}
+
+/*
+ * inset_mm beim Anlegen: eine Zahl (alle Kanten) oder { top, left, bottom,
+ * right }; fehlende Kanten eines Objekts gelten als 0.
+ */
+function idcInsetArg(spec, field) {
+  var keys = ['top', 'left', 'bottom', 'right'];
+  var out = {};
+  var i, v;
+  if (typeof spec === 'number') {
+    if (!isFinite(spec) || spec < 0) {
+      IDC.fail('invalid_argument', field + ' must be a number of 0 or more (mm).', { value: spec });
+    }
+    return { top: spec, left: spec, bottom: spec, right: spec };
+  }
+  if (!spec || typeof spec !== 'object') {
+    IDC.fail('invalid_argument', field + ' must be a number or an object { top, left, bottom, right } in mm.', null);
+  }
+  for (i = 0; i < keys.length; i++) {
+    v = spec[keys[i]];
+    if (v === undefined || v === null) { out[keys[i]] = 0; continue; }
+    if (typeof v !== 'number' || !isFinite(v) || v < 0) {
+      IDC.fail('invalid_argument', field + '.' + keys[i] + ' must be a number of 0 or more.', spec);
+    }
+    out[keys[i]] = v;
+  }
+  return out;
+}
+
+/*
+ * Rahmenoptionen eines Textrahmens (Objekt > Textrahmenoptionen), gelesen
+ * unter Millimeter; Grundlinien-Mindestabstand in Punkt.
+ */
+function idcTextFrameOptions(doc, frame) {
+  var prefs = null;
+  var out = {
+    columns: { count: null, gutter_mm: null, type: null, fixed_width_mm: null },
+    inset_mm: null,
+    vertical_justification: null,
+    vertical_threshold_mm: null,
+    first_baseline_offset: null,
+    min_first_baseline_pt: null,
+    ignore_text_wrap: null,
+    optical_margin_alignment: null,
+    optical_margin_size_pt: null
+  };
+  /* A-7.4: storyweite Werte (StoryPreference) unter text, damit get_frame_options sie zeigt. */
+  try {
+    var storyOptions = idcReadStoryOptions(frame.parentStory);
+    out.optical_margin_alignment = storyOptions.optical_margin_alignment;
+    out.optical_margin_size_pt = storyOptions.optical_margin_size_pt;
+  } catch (eS) { /* bleibt null */ }
+  try { prefs = frame.textFramePreferences; } catch (e0) { prefs = null; }
+  if (prefs === null || prefs === undefined) { return out; }
+  try { out.columns.count = Number(prefs.textColumnCount); } catch (e1) { /* bleibt null */ }
+  try { out.columns.gutter_mm = IDC.round(Number(prefs.textColumnGutter)); } catch (e2) { /* bleibt null */ }
+  out.columns.type = idcColumnType(prefs);
+  try { out.columns.fixed_width_mm = IDC.round(Number(prefs.textColumnFixedWidth)); } catch (e4) { /* bleibt null */ }
+  try { out.inset_mm = idcEdgesFromArray(prefs.insetSpacing); } catch (e5) { /* bleibt null */ }
+  try { out.vertical_justification = idcVerticalJustificationName(prefs.verticalJustification); } catch (e6) { /* bleibt null */ }
+  try { out.vertical_threshold_mm = IDC.round(Number(prefs.verticalThreshold)); } catch (e7) { /* bleibt null */ }
+  try { out.first_baseline_offset = idcFirstBaselineName(prefs.firstBaselineOffset); } catch (e8) { /* bleibt null */ }
+  try {
+    out.min_first_baseline_pt = IDC.inPoints(function () { return IDC.round(Number(prefs.minimumFirstBaselineOffset), 3); });
+  } catch (e9) { /* bleibt null */ }
+  try { out.ignore_text_wrap = prefs.ignoreWrap === true; } catch (e10) { /* bleibt null */ }
+  return out;
+}
+
+/* Verkettung: Story, Stellung des Rahmens in ihr, Nachbarn, Uebersatz. */
+function idcThreading(frame) {
+  var out = {
+    story_id: null,
+    story_length: null,
+    frame_index: null,
+    frame_count: null,
+    previous_frame_id: null,
+    next_frame_id: null,
+    overset: null,
+    story_overset: null
+  };
+  var story = null, frames, i, prev = null, next = null;
+  try { story = frame.parentStory; } catch (e0) { story = null; }
+  if (story !== null && story !== undefined) {
+    try { out.story_id = Number(story.id); } catch (e1) { /* null */ }
+    try { out.story_length = Number(story.characters.length); } catch (e2) { /* null */ }
+    try {
+      frames = story.textContainers;
+      out.frame_count = frames.length;
+      for (i = 0; i < frames.length; i++) {
+        if (Number(frames[i].id) === Number(frame.id)) { out.frame_index = i; break; }
+      }
+    } catch (e3) { /* null */ }
+    try { out.story_overset = story.overflows === true; } catch (e4) { /* null */ }
+  }
+  try { prev = frame.previousTextFrame; } catch (e5) { prev = null; }
+  try { next = frame.nextTextFrame; } catch (e6) { next = null; }
+  try { if (prev !== null && prev !== undefined && prev.isValid === true) { out.previous_frame_id = Number(prev.id); } } catch (e7) { /* null */ }
+  try { if (next !== null && next !== undefined && next.isValid === true) { out.next_frame_id = Number(next.id); } } catch (e8) { /* null */ }
+  try { out.overset = frame.overflows === true; } catch (e9) { /* null */ }
+  return out;
+}
+
+/*
+ * Grundlinie der ersten Zeile in mm ab Seitenoberkante (Lineal steht fuer
+ * den Aufruf auf Seiten-Nullpunkt), null ohne Text. Der direkte Weg, den
+ * Sitz einer Bildunterschrift im Grundlinienraster zu pruefen (Fund 3).
+ */
+function idcFirstBaselineMm(frame) {
+  try {
+    if (frame.lines.length === 0) { return null; }
+    return IDC.round(Number(frame.lines.item(0).baseline), 3);
+  } catch (e0) { return null; }
+}
+
+/* Textumfluss eines Objekts mit Abstand. */
+function idcTextWrapOptions(item) {
+  var out = { mode: null, offset_mm: null };
+  var prefs = null, mode;
+  try { prefs = item.textWrapPreferences; } catch (e0) { prefs = null; }
+  if (prefs === null || prefs === undefined) { return out; }
+  mode = idcTextWrapName(item);
+  if (mode === 'contour') { mode = 'object_shape'; }
+  out.mode = mode;
+  try { out.offset_mm = idcEdgesFromArray(prefs.textWrapOffset); } catch (e1) { out.offset_mm = null; }
+  return out;
+}
+
+IDC.register('get_frame_options', { needs_document: true, read_only: true, ruler: 'page' },
+  function (ctx) {
+    var args = ctx.args;
+    var doc = ctx.doc;
+    var found = idcFrameArg(doc, args, 'frame_id');
+    var item = found.item;
+    var type = IDC.itemType(item);
+    var landing = IDC.landing(item);
+    var look = idcAppearanceFull(item);
+    var corners = type === 'line' || type === 'group' ? null : idcReadCorners(item);
+    var out = {
+      frame_id: Number(item.id),
+      type: type,
+      page_id: landing.page_id,
+      page_name: landing.page_name,
+      on_parent_page: found.on_parent === true,
+      coordinate_space: idcBoundsSpace(item),
+      bounds_mm: idcItemBounds(doc, item),
+      rotation_deg: idcRotationOf(item),
+      text_wrap: idcTextWrapOptions(item),
+      appearance: look,
+      corners: corners === null ? null : { top_left: corners.top_left, top_right: corners.top_right, bottom_left: corners.bottom_left, bottom_right: corners.bottom_right, uniform: corners.uniform },
+      layer: idcLayerSummary(doc, item),
+      locked: idcReadBool(item, 'locked') === true,
+      anchored: idcAnchorInfo(item),
+      effects: null,
+      has_effects: null,
+      text: null
+    };
+    /* A-8.6: Effekte des Objekts und ob Flaeche, Kontur, Text abweichen. */
+    var effects = idcEffectsSummary(item);
+    out.effects = effects.effects;
+    out.has_effects = effects.has_effects;
+    var parentGroup = null;
+    try { if (IDC.className(item.parent) === 'Group') { parentGroup = Number(item.parent.id); } } catch (e0) { parentGroup = null; }
+    out.parent_group_id = parentGroup;
+
+    if (IDC.isTextFrame(item)) {
+      out.text = idcTextFrameOptions(doc, item);
+      out.text.threading = idcThreading(item);
+      out.text.first_baseline_mm = idcFirstBaselineMm(item);
+      try { out.text.character_count = Number(item.characters.length); } catch (e1) { out.text.character_count = null; }
+    }
+    return out;
+  });