Skip to content

docs(InteractionDialog): clarify animation, formMode, and no-op transitions (#5071)#5096

Merged
shai-almog merged 1 commit into
masterfrom
docs/interaction-dialog-5071
May 29, 2026
Merged

docs(InteractionDialog): clarify animation, formMode, and no-op transitions (#5071)#5096
shai-almog merged 1 commit into
masterfrom
docs/interaction-dialog-5071

Conversation

@shai-almog
Copy link
Copy Markdown
Collaborator

@shai-almog shai-almog commented May 29, 2026

Summary

  • Expand the documentation on InteractionDialog to address the four areas flagged in InteractionDialog documentation improvements #5071.
  • setAnimateShow / setRepositionAnimation now cross-reference each other and explicitly state that repositionAnimation only has an effect when animateShow is true.
  • setRepositionAnimation describes the "grow from / shrink to a 1x1 point at the center" animation effect and what false actually does.
  • setFormMode explains the two layered panes (Form.getLayeredPane vs Form.getFormLayeredPane), the practical difference, the auto-enable in showPopupDialog(Component) when the target lives outside the content pane, and gives a "leave it at the default unless..." recommendation.
  • setTransitions is now documented as a no-op, pointing readers at setAnimateShow / setRepositionAnimation for actual animation control.

Closes #5071.

Test plan

  • mvn -pl core compile -Plocal-dev-javase succeeds
  • File remains ASCII-only (no em-dash/arrow/ellipsis in /// doc comments)
  • Review rendered Javadoc

🤖 Generated with Claude Code

@shai-almog @claude
docs(InteractionDialog): clarify animation, formMode, and no-op trans…
d0667a3 
…itions (#5071)

Expand the documentation on InteractionDialog to address the four areas
flagged in #5071:

- setAnimateShow / setRepositionAnimation cross-reference each other and
  explicitly state that repositionAnimation is gated on animateShow.
- setRepositionAnimation now describes the "grow from / shrink to a 1x1
  point at the center" effect and what false actually means.
- setFormMode explains the two layered panes, what each is appropriate
  for, that showPopupDialog(Component) auto-enables it when the target
  lives outside the content pane, and gives a default recommendation.
- setTransitions is now documented as a no-op, pointing readers at
  setAnimateShow / setRepositionAnimation for actual animation control.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@shai-almog shai-almog merged commit 8dcd4a0 into master May 29, 2026
19 checks passed
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 29, 2026

✅ Continuous Quality Report

Test & Coverage

Static Analysis

  • SpotBugs [Report archive]
    • ✅ ByteCodeTranslator: 0 findings (no issues)
    • ✅ android: 0 findings (no issues)
    • ✅ codenameone-maven-plugin: 0 findings (no issues)
    • ✅ core-unittests: 0 findings (no issues)
    • ✅ ios: 0 findings (no issues)
  • ✅ PMD: 0 findings (no issues) [Report archive]
  • ✅ Checkstyle: 0 findings (no issues) [Report archive]

Generated automatically by the PR CI workflow.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 29, 2026

Cloudflare Preview

@shai-almog
Copy link
Copy Markdown
Collaborator Author

shai-almog commented May 29, 2026 •
edited
Loading

Compared 122 screenshots: 122 matched.

Native Android coverage

  • 📊 Line coverage: 12.80% (7452/58229 lines covered) [HTML preview] (artifact android-coverage-report, jacocoAndroidReport/html/index.html)
    • Other counters: instruction 10.41% (37337/358503), branch 4.31% (1460/33874), complexity 5.40% (1759/32544), method 9.45% (1441/15249), class 15.52% (330/2126)
    • Lowest covered classes
      • kotlin.collections.kotlin.collections.ArraysKt___ArraysKt – 0.00% (0/6327 lines covered)
      • kotlin.collections.unsigned.kotlin.collections.unsigned.UArraysKt___UArraysKt – 0.00% (0/2384 lines covered)
      • org.jacoco.agent.rt.internal_b6258fc.asm.org.jacoco.agent.rt.internal_b6258fc.asm.ClassReader – 0.00% (0/1519 lines covered)
      • kotlin.collections.kotlin.collections.CollectionsKt___CollectionsKt – 0.00% (0/1148 lines covered)
      • org.jacoco.agent.rt.internal_b6258fc.asm.org.jacoco.agent.rt.internal_b6258fc.asm.MethodWriter – 0.00% (0/923 lines covered)
      • kotlin.sequences.kotlin.sequences.SequencesKt___SequencesKt – 0.00% (0/730 lines covered)
      • kotlin.text.kotlin.text.StringsKt___StringsKt – 0.00% (0/623 lines covered)
      • org.jacoco.agent.rt.internal_b6258fc.asm.org.jacoco.agent.rt.internal_b6258fc.asm.Frame – 0.00% (0/564 lines covered)
      • kotlin.collections.kotlin.collections.ArraysKt___ArraysJvmKt – 0.00% (0/495 lines covered)
      • kotlinx.coroutines.kotlinx.coroutines.JobSupport – 0.00% (0/423 lines covered)

✅ Native Android screenshot tests passed.

Native Android coverage

  • 📊 Line coverage: 12.80% (7452/58229 lines covered) [HTML preview] (artifact android-coverage-report, jacocoAndroidReport/html/index.html)
    • Other counters: instruction 10.41% (37337/358503), branch 4.31% (1460/33874), complexity 5.40% (1759/32544), method 9.45% (1441/15249), class 15.52% (330/2126)
    • Lowest covered classes
      • kotlin.collections.kotlin.collections.ArraysKt___ArraysKt – 0.00% (0/6327 lines covered)
      • kotlin.collections.unsigned.kotlin.collections.unsigned.UArraysKt___UArraysKt – 0.00% (0/2384 lines covered)
      • org.jacoco.agent.rt.internal_b6258fc.asm.org.jacoco.agent.rt.internal_b6258fc.asm.ClassReader – 0.00% (0/1519 lines covered)
      • kotlin.collections.kotlin.collections.CollectionsKt___CollectionsKt – 0.00% (0/1148 lines covered)
      • org.jacoco.agent.rt.internal_b6258fc.asm.org.jacoco.agent.rt.internal_b6258fc.asm.MethodWriter – 0.00% (0/923 lines covered)
      • kotlin.sequences.kotlin.sequences.SequencesKt___SequencesKt – 0.00% (0/730 lines covered)
      • kotlin.text.kotlin.text.StringsKt___StringsKt – 0.00% (0/623 lines covered)
      • org.jacoco.agent.rt.internal_b6258fc.asm.org.jacoco.agent.rt.internal_b6258fc.asm.Frame – 0.00% (0/564 lines covered)
      • kotlin.collections.kotlin.collections.ArraysKt___ArraysJvmKt – 0.00% (0/495 lines covered)
      • kotlinx.coroutines.kotlinx.coroutines.JobSupport – 0.00% (0/423 lines covered)

Benchmark Results

Detailed Performance Metrics

Metric Duration
Base64 payload size 8192 bytes
Base64 benchmark iterations 6000
Base64 native encode 831.000 ms
Base64 CN1 encode 330.000 ms
Base64 encode ratio (CN1/native) 0.397x (60.3% faster)
Base64 native decode 985.000 ms
Base64 CN1 decode 324.000 ms
Base64 decode ratio (CN1/native) 0.329x (67.1% faster)
Image encode benchmark status skipped (SIMD unsupported)

@shai-almog
Copy link
Copy Markdown
Collaborator Author

shai-almog commented May 29, 2026 •
edited
Loading

Compared 122 screenshots: 122 matched.
✅ Native iOS Metal screenshot tests passed.

Benchmark Results

  • VM Translation Time: 0 seconds
  • Compilation Time: 171 seconds

Build and Run Timing

Metric Duration
Simulator Boot 61000 ms
Simulator Boot (Run) 1000 ms
App Install 12000 ms
App Launch 12000 ms
Test Execution 287000 ms

Detailed Performance Metrics

Metric Duration
Base64 payload size 8192 bytes
Base64 benchmark iterations 6000
Base64 native encode 419.000 ms
Base64 CN1 encode 1217.000 ms
Base64 encode ratio (CN1/native) 2.905x (190.5% slower)
Base64 native decode 274.000 ms
Base64 CN1 decode 864.000 ms
Base64 decode ratio (CN1/native) 3.153x (215.3% slower)
Base64 SIMD encode 395.000 ms
Base64 encode ratio (SIMD/native) 0.943x (5.7% faster)
Base64 encode ratio (SIMD/CN1) 0.325x (67.5% faster)
Base64 SIMD decode 369.000 ms
Base64 decode ratio (SIMD/native) 1.347x (34.7% slower)
Base64 decode ratio (SIMD/CN1) 0.427x (57.3% faster)
Image encode benchmark iterations 100
Image createMask (SIMD off) 59.000 ms
Image createMask (SIMD on) 11.000 ms
Image createMask ratio (SIMD on/off) 0.186x (81.4% faster)
Image applyMask (SIMD off) 118.000 ms
Image applyMask (SIMD on) 55.000 ms
Image applyMask ratio (SIMD on/off) 0.466x (53.4% faster)
Image modifyAlpha (SIMD off) 136.000 ms
Image modifyAlpha (SIMD on) 57.000 ms
Image modifyAlpha ratio (SIMD on/off) 0.419x (58.1% faster)
Image modifyAlpha removeColor (SIMD off) 143.000 ms
Image modifyAlpha removeColor (SIMD on) 59.000 ms
Image modifyAlpha removeColor ratio (SIMD on/off) 0.413x (58.7% faster)
Image PNG encode (SIMD off) 975.000 ms
Image PNG encode (SIMD on) 1035.000 ms
Image PNG encode ratio (SIMD on/off) 1.062x (6.2% slower)
Image JPEG encode 421.000 ms

@shai-almog
Copy link
Copy Markdown
Collaborator Author

shai-almog commented May 29, 2026 •
edited
Loading

Compared 122 screenshots: 122 matched.
✅ Native iOS screenshot tests passed.

Benchmark Results

  • VM Translation Time: 0 seconds
  • Compilation Time: 344 seconds

Build and Run Timing

Metric Duration
Simulator Boot 102000 ms
Simulator Boot (Run) 1000 ms
App Install 18000 ms
App Launch 11000 ms
Test Execution 372000 ms

Detailed Performance Metrics

Metric Duration
Base64 payload size 8192 bytes
Base64 benchmark iterations 6000
Base64 native encode 604.000 ms
Base64 CN1 encode 1429.000 ms
Base64 encode ratio (CN1/native) 2.366x (136.6% slower)
Base64 native decode 323.000 ms
Base64 CN1 decode 992.000 ms
Base64 decode ratio (CN1/native) 3.071x (207.1% slower)
Base64 SIMD encode 393.000 ms
Base64 encode ratio (SIMD/native) 0.651x (34.9% faster)
Base64 encode ratio (SIMD/CN1) 0.275x (72.5% faster)
Base64 SIMD decode 372.000 ms
Base64 decode ratio (SIMD/native) 1.152x (15.2% slower)
Base64 decode ratio (SIMD/CN1) 0.375x (62.5% faster)
Image encode benchmark iterations 100
Image createMask (SIMD off) 58.000 ms
Image createMask (SIMD on) 9.000 ms
Image createMask ratio (SIMD on/off) 0.155x (84.5% faster)
Image applyMask (SIMD off) 133.000 ms
Image applyMask (SIMD on) 61.000 ms
Image applyMask ratio (SIMD on/off) 0.459x (54.1% faster)
Image modifyAlpha (SIMD off) 151.000 ms
Image modifyAlpha (SIMD on) 72.000 ms
Image modifyAlpha ratio (SIMD on/off) 0.477x (52.3% faster)
Image modifyAlpha removeColor (SIMD off) 138.000 ms
Image modifyAlpha removeColor (SIMD on) 59.000 ms
Image modifyAlpha removeColor ratio (SIMD on/off) 0.428x (57.2% faster)
Image PNG encode (SIMD off) 1105.000 ms
Image PNG encode (SIMD on) 837.000 ms
Image PNG encode ratio (SIMD on/off) 0.757x (24.3% faster)
Image JPEG encode 561.000 ms

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

InteractionDialog documentation improvements

1 participant

@shai-almog