devexpress-richedit 26.1.2-beta → 26.1.3

package/lib/common/screen-reader-manager.js

@@ -8,9 +8,8 @@ import { NumberingType } from "./model/numbering-lists/numbering-list";
 import { TablePositionIndexes } from "./model/tables/main-structures/table";
 import { InlinePictureRun } from "./model/runs/inline-picture-run";
 import { RichUtils } from "./model/rich-utils";
-import { formatMessage } from "devextreme/localization";
 import { RunType } from "./model/runs/run-type";
-import { SubDocumentPosition } from "./model/sub-document";
+import { SubDocumentPosition, TransformAction } from "./model/sub-document";
 class TableInfo {
     constructor(index, columnIndex, rowIndex) {
         this.index = index;
@@ -21,16 +20,7 @@ class TableInfo {
 export class ScreenReaderManager {
     static { this._maxAnnouncedTextLength = 500; }
     static { this._spaceSeparatorRegex = /^\p{Zs}$/u; }
-    static { this._specialCharSubstitutionTable = {
-        [RichUtils.specialCharacters.SectionMark]: RichUtils.specialCharacters.PageBreak + "\u200C",
-        [RichUtils.specialCharacters.PageBreak]: RichUtils.specialCharacters.PageBreak + "\u200C",
-    }; }
-    constructor(control, liveRegion) {
-        this._charNames = Object.assign({
-            [RichUtils.specialCharacters.TabMark]: getString("TabAnnouncement"),
-            [RichUtils.specialCharacters.ParagraphMark]: getString("CarriageReturnAnnouncement"),
-            [RichUtils.specialCharacters.LineBreak]: getString("LineBreakAnnouncement"),
-        }, ScreenReaderManager._specialCharSubstitutionTable);
+    constructor(control, liveRegion, resources) {
         this._handlers = new Map([
             [RichEditClientCommand.NextCharacter, (selection, lp) => this._getCurrentCharacterAnnouncement(selection, lp)],
             [RichEditClientCommand.PreviousCharacter, (selection, lp) => this._getCurrentCharacterAnnouncement(selection, lp)],
@@ -53,6 +43,14 @@ export class ScreenReaderManager {
         this._prevNavInHyperlink = false;
         this._control = control;
         this._liveRegion = liveRegion;
+        this._announcements = resources.announcements;
+        this._charNames = {
+            [RichUtils.specialCharacters.TabMark]: this._announcements.tab,
+            [RichUtils.specialCharacters.ParagraphMark]: this._announcements.carriageReturn,
+            [RichUtils.specialCharacters.LineBreak]: this._announcements.lineBreak,
+            [RichUtils.specialCharacters.PageBreak]: this._announcements.pageBreak,
+            [RichUtils.specialCharacters.SectionMark]: this._announcements.pageBreak,
+        };
     }
     _announce(...announcment) {
         this._clearAnnouncement();
@@ -106,7 +104,7 @@ export class ScreenReaderManager {
         const result = [];
         if (!tableInfo.table) {
             if (this._tableInfo) {
-                result.push(getString("OutOfTableAnnouncement"));
+                result.push(this._announcements.outOfTable);
                 this._tableInfo = null;
             }
             return result;
@@ -117,35 +115,40 @@ export class ScreenReaderManager {
         const colIndex = cellGridInfo.getGridCellIndex();
         const rowIndex = cellGridInfo.getStartRowIndex();
         const currentTableInfo = new TableInfo(tableInfo.table.index, colIndex, rowIndex);
-        if (!this._tableInfo || this._tableInfo.index !== currentTableInfo.index)
-            result.push(getString("InTableAnnouncement", tableCellGridInfos.length, tableCellGridInfos[0].length));
+        if (!this._tableInfo || this._tableInfo.index !== currentTableInfo.index) {
+            if (this._tableInfo) {
+                result.push(this._announcements.outOfTable);
+                this._tableInfo = null;
+            }
+            result.push(formatString(this._announcements.inTable, tableCellGridInfos.length, tableCellGridInfos[0].length));
+        }
         if (!this._tableInfo || this._tableInfo.rowIndex !== currentTableInfo.rowIndex)
-            result.push(getString("TableRowAnnouncement", rowIndex + 1));
+            result.push(formatString(this._announcements.tableRow, rowIndex + 1));
         if (!this._tableInfo || this._tableInfo.columnIndex !== currentTableInfo.columnIndex)
-            result.push(getString("TableColumnAnnouncement", colIndex + 1));
+            result.push(formatString(this._announcements.tableColumn, colIndex + 1));
         this._tableInfo = currentTableInfo;
         return result;
     }
     _processExtendSelectionCommand(intervals) {
         let announcments = [];
         if (this._commandId === RichEditClientCommand.SelectAll)
-            announcments.push(getString("SelectAllAnnouncement"), "\n");
+            announcments.push(this._announcements.selectAll, "\n");
+        const subDocument = this._control.selection.activeSubDocument;
         const selectedIntervals = IntervalUtils.subtractIntervals(intervals, this._selectionIntervals);
         if (selectedIntervals.length > 0)
-            announcments.push(getString("TextSelectedAnnouncement", this._getTextByIntervals(selectedIntervals)));
+            announcments.push(formatString(this._announcements.textSelected, this._getTextByIntervals(subDocument, selectedIntervals)));
         const unselectedIntervals = IntervalUtils.subtractIntervals(this._selectionIntervals, intervals);
         if (unselectedIntervals.length > 0)
-            announcments.push(getString("TextUnselectedAnnouncement", this._getTextByIntervals(unselectedIntervals)));
+            announcments.push(formatString(this._announcements.textUnselected, this._getTextByIntervals(subDocument, unselectedIntervals)));
         return announcments;
     }
-    _getTextByIntervals(intervals) {
+    _getTextByIntervals(subDocument, intervals) {
         const length = intervals.reduce((total, interval) => total + interval.length, 0);
         if (length > ScreenReaderManager._maxAnnouncedTextLength)
             return `${length} characters`;
-        const subDocument = this._control.selection.activeSubDocument;
         return intervals.map(i => subDocument.getVisibleText(i, {
             includeNumberedListMarks: true,
-            charMap: ScreenReaderManager._specialCharSubstitutionTable
+            transform: this._tryResolveDocumentElements.bind(this)
         })).join('');
     }
     _updateHyperlinkState(lp) {
@@ -155,9 +158,9 @@ export class ScreenReaderManager {
         const inHyperlink = lp.box?.hyperlinkTip != null;
         const prevInHyperlink = this._prevNavInHyperlink;
         if (inHyperlink && !prevInHyperlink)
-            return getString("LinkAnnouncement");
+            return this._announcements.link;
         if (!inHyperlink && prevInHyperlink)
-            return getString("OutOfLinkAnnouncement");
+            return this._announcements.outOfLink;
         return null;
     }
     _getCurrentCharacterAnnouncement(selection, lp) {
@@ -165,7 +168,7 @@ export class ScreenReaderManager {
         const subDocument = selection.activeSubDocument;
         const info = subDocument.getRunAndIndexesByPosition(pos);
         if (info.run instanceof InlinePictureRun)
-            return ScreenReaderManager._getInlinePictureText(info.run);
+            return this._getInlinePictureText(info.run);
         const isFieldCodeStartRun = info.run.getType() === RunType.FieldCodeStartRun;
         const charInfo = isFieldCodeStartRun
             ? subDocument.getRunAndIndexesByPosition(lp.getLogPosition(DocumentLayoutDetailsLevel.Box))
@@ -199,8 +202,7 @@ export class ScreenReaderManager {
         const subDocument = selection.activeSubDocument;
         const wordEnd = LayoutWordBounds.getLayoutWordEndBound(this._control.layout, subDocument, selection, pos, false);
         let text = subDocument.getVisibleText(FixedInterval.fromPositions(pos, wordEnd), {
-            inlinePictureAltText: ScreenReaderManager._getInlinePictureText,
-            charMap: ScreenReaderManager._specialCharSubstitutionTable
+            transform: this._tryResolveDocumentElements.bind(this)
         });
         return this._buildContextualAnnouncement(text, new SubDocumentPosition(subDocument, pos), lp);
     }
@@ -218,22 +220,40 @@ export class ScreenReaderManager {
     }
     _onHyperlinkFieldStart(fieldIndexes, subDocument, pos) {
         const field = this._getHyperlinkField(fieldIndexes, subDocument);
-        return field && pos === field.getResultStartPosition() ? ` ${getString("LinkAnnouncement")} ` : null;
+        return field && pos === field.getResultStartPosition() ? ` ${this._announcements.link} ` : null;
     }
     _getVisibleText(subDocument, interval, includeNumberedListMarks = false) {
         const result = subDocument.getVisibleText(interval, {
             includeNumberedListMarks,
-            inlinePictureAltText: ScreenReaderManager._getInlinePictureText,
-            charMap: ScreenReaderManager._specialCharSubstitutionTable,
-            resolveAdditionalText: (fieldIndexes, pos) => this._onHyperlinkFieldStart(fieldIndexes, subDocument, pos)
+            transform: (info, fieldIndexes) => {
+                const prefix = this._onHyperlinkFieldStart(fieldIndexes, subDocument, info.getAbsolutePosition());
+                const text = this._tryResolveDocumentElements(info);
+                if (prefix == null && text == null)
+                    return null;
+                return {
+                    text: (prefix ?? '') + (text ?? ''),
+                    action: text != null ? TransformAction.Replace : TransformAction.InsertBefore
+                };
+            }
         });
         return result === RichUtils.specialCharacters.ParagraphMark
-            ? getString("BlankAnnouncement")
+            ? this._announcements.blank
             : result;
     }
-    static _getInlinePictureText(run) {
+    _tryResolveDocumentElements(info) {
+        return info.run.getType() === RunType.InlinePictureRun
+            ? this._getInlinePictureText(info.run)
+            : this._tryResolveSpecialCharacters(info);
+    }
+    _tryResolveSpecialCharacters(info) {
+        const char = info.getCurrentChar();
+        if (char === RichUtils.specialCharacters.PageBreak || char === RichUtils.specialCharacters.SectionMark)
+            return ` ${this._announcements.pageBreak} `;
+        return null;
+    }
+    _getInlinePictureText(run) {
         const nonVisualProps = run.info.nonVisualDrawingProperties;
-        return getString("PictureAnnouncement", nonVisualProps.description ?? nonVisualProps.name ?? '');
+        return formatString(this._announcements.picture, nonVisualProps.description ?? nonVisualProps.name ?? '');
     }
     _getPageChangePrefix(pageIndex) {
         if (this._pageIndex === null) {
@@ -242,20 +262,20 @@ export class ScreenReaderManager {
         }
         if (pageIndex !== this._pageIndex) {
             this._pageIndex = pageIndex;
-            return getString("PageAnnouncement", pageIndex + 1);
+            return formatString(this._announcements.page, pageIndex + 1);
         }
         return '';
     }
     _getCharName(char) {
         if (char in this._charNames)
             return this._charNames[char];
-        return ScreenReaderManager._spaceSeparatorRegex.test(char) ? getString("SpaceAnnouncement") : char;
+        return ScreenReaderManager._spaceSeparatorRegex.test(char) ? this._announcements.space : char;
     }
     _resolveListMarker(paragraph) {
         const levelIndex = paragraph.getListLevelIndex();
         const levelType = paragraph.getNumberingList().getLevelType(levelIndex);
         if (levelType === NumberingType.Bullet)
-            return getString("BulletAnnouncement");
+            return this._announcements.bullet;
         return paragraph.getNumberingListText();
     }
     _getListItemAnnouncement(paragraph, pos, lp, content) {
@@ -263,14 +283,14 @@ export class ScreenReaderManager {
             return null;
         const level = paragraph.getListLevelIndex() + 1;
         const listMarker = this._resolveListMarker(paragraph);
-        return `${getString("ListItemAnnouncement", level, listMarker)} ${content}`;
+        return `${formatString(this._announcements.listItem, level, listMarker)} ${content}`;
     }
     dispose() {
         this._clearAnnouncement();
         this._liveRegion.remove();
     }
 }
-const stringCache = {};
+const stringFormatterCache = {};
 function createFormatter(template) {
     const tokens = [];
     let lastIndex = 0;
@@ -296,14 +316,11 @@ function createFormatter(template) {
         return result;
     };
 }
-function getString(key, ...args) {
-    let entry = stringCache[key];
-    if (!entry) {
-        const str = formatMessage(`AspNetCoreRichEditStringId.${key}`);
-        entry = args.length > 0 ? createFormatter(str) : str;
-        stringCache[key] = entry;
+function formatString(template, ...args) {
+    let formatter = stringFormatterCache[template];
+    if (!formatter) {
+        formatter = createFormatter(template);
+        stringFormatterCache[template] = formatter;
     }
-    if (typeof entry === "function")
-        return entry(args);
-    return entry;
+    return formatter(args);
 }

package/lib/common/string-resources.d.ts

@@ -3,6 +3,7 @@ export declare class StringResources {
     seqCaptionPrefixes: SeqCaptionPrefixes;
     commonLabels: CommonLabels;
     quickSearchPanel: QuickSearchPanelStringResources;
+    announcements: IAnnouncementStringResources;
     constructor();
 }
 export declare class HeaderFooterStringResources {
@@ -31,3 +32,25 @@ export declare class QuickSearchPanelStringResources {
     noMatches: string;
     of: string;
 }
+export interface IAnnouncementStringResources {
+    inTable?: string;
+    outOfTable?: string;
+    tableRow?: string;
+    tableColumn?: string;
+    selectAll?: string;
+    textSelected?: string;
+    textUnselected?: string;
+    tab?: string;
+    carriageReturn?: string;
+    lineBreak?: string;
+    picture?: string;
+    page?: string;
+    space?: string;
+    bullet?: string;
+    listItem?: string;
+    link?: string;
+    outOfLink?: string;
+    blank?: string;
+    pageBreak?: string;
+}
+export declare function getStringResources(): StringResources;

package/lib/common/string-resources.js

@@ -1,9 +1,11 @@
+import { formatMessage } from "devextreme/localization";
 export class StringResources {
     constructor() {
         this.headerFooter = new HeaderFooterStringResources();
         this.seqCaptionPrefixes = new SeqCaptionPrefixes();
         this.commonLabels = new CommonLabels();
         this.quickSearchPanel = new QuickSearchPanelStringResources();
+        this.announcements = {};
     }
 }
 export class HeaderFooterStringResources {
@@ -14,3 +16,44 @@ export class CommonLabels {
 }
 export class QuickSearchPanelStringResources {
 }
+export function getStringResources() {
+    const sr = new StringResources();
+    sr.headerFooter.evenPageFooter = formatMessage('XtraRichEditStringId.Caption_EvenPageFooter');
+    sr.headerFooter.evenPageHeader = formatMessage('XtraRichEditStringId.Caption_EvenPageHeader');
+    sr.headerFooter.firstPageFooter = formatMessage('XtraRichEditStringId.Caption_FirstPageFooter');
+    sr.headerFooter.firstPageHeader = formatMessage('XtraRichEditStringId.Caption_FirstPageHeader');
+    sr.headerFooter.footer = formatMessage('XtraRichEditStringId.Caption_PageFooter');
+    sr.headerFooter.header = formatMessage('XtraRichEditStringId.Caption_PageHeader');
+    sr.headerFooter.oddPageFooter = formatMessage('XtraRichEditStringId.Caption_OddPageFooter');
+    sr.headerFooter.oddPageHeader = formatMessage('XtraRichEditStringId.Caption_OddPageHeader');
+    sr.headerFooter.sameAsPrevious = formatMessage('XtraRichEditStringId.Caption_SameAsPrevious');
+    sr.seqCaptionPrefixes.figurePrefix = formatMessage('XtraRichEditStringId.Caption_CaptionPrefixFigure');
+    sr.seqCaptionPrefixes.tablePrefix = formatMessage('XtraRichEditStringId.Caption_CaptionPrefixTable');
+    sr.seqCaptionPrefixes.equationPrefix = formatMessage('XtraRichEditStringId.Caption_CaptionPrefixEquation');
+    sr.commonLabels.noTocEntriesFound = formatMessage('XtraRichEditStringId.Msg_NoTocEntriesFound');
+    sr.commonLabels.clickToFollowHyperlink = formatMessage('XtraRichEditStringId.Msg_ClickToFollowHyperlink');
+    sr.commonLabels.currentDocumentHyperlinkTooltip = formatMessage('XtraRichEditStringId.Caption_CurrentDocumentHyperlinkTooltip');
+    sr.quickSearchPanel.of = formatMessage('ASPxRichEditStringId.FindReplace_Of');
+    sr.quickSearchPanel.items = formatMessage('ASPxRichEditStringId.FindReplace_Items');
+    sr.quickSearchPanel.noMatches = formatMessage('ASPxRichEditStringId.FindReplace_NoMatches');
+    sr.announcements.inTable = formatMessage('AspNetCoreRichEditStringId.InTableAnnouncement');
+    sr.announcements.outOfTable = formatMessage('AspNetCoreRichEditStringId.OutOfTableAnnouncement');
+    sr.announcements.tableRow = formatMessage('AspNetCoreRichEditStringId.TableRowAnnouncement');
+    sr.announcements.tableColumn = formatMessage('AspNetCoreRichEditStringId.TableColumnAnnouncement');
+    sr.announcements.selectAll = formatMessage('AspNetCoreRichEditStringId.SelectAllAnnouncement');
+    sr.announcements.textSelected = formatMessage('AspNetCoreRichEditStringId.TextSelectedAnnouncement');
+    sr.announcements.textUnselected = formatMessage('AspNetCoreRichEditStringId.TextUnselectedAnnouncement');
+    sr.announcements.picture = formatMessage('AspNetCoreRichEditStringId.PictureAnnouncement');
+    sr.announcements.page = formatMessage('AspNetCoreRichEditStringId.PageAnnouncement');
+    sr.announcements.space = formatMessage('AspNetCoreRichEditStringId.SpaceAnnouncement');
+    sr.announcements.bullet = formatMessage('AspNetCoreRichEditStringId.BulletAnnouncement');
+    sr.announcements.listItem = formatMessage('AspNetCoreRichEditStringId.ListItemAnnouncement');
+    sr.announcements.tab = formatMessage('AspNetCoreRichEditStringId.TabAnnouncement');
+    sr.announcements.carriageReturn = formatMessage('AspNetCoreRichEditStringId.CarriageReturnAnnouncement');
+    sr.announcements.lineBreak = formatMessage('AspNetCoreRichEditStringId.LineBreakAnnouncement');
+    sr.announcements.link = formatMessage('AspNetCoreRichEditStringId.LinkAnnouncement');
+    sr.announcements.outOfLink = formatMessage('AspNetCoreRichEditStringId.OutOfLinkAnnouncement');
+    sr.announcements.blank = formatMessage('AspNetCoreRichEditStringId.BlankAnnouncement');
+    sr.announcements.pageBreak = formatMessage('AspNetCoreRichEditStringId.PageBreakAnnouncement');
+    return sr;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "devexpress-richedit",
-  "version": "26.1.2-beta",
+  "version": "26.1.3",
   "homepage": "https://www.devexpress.com/",
   "bugs": "https://www.devexpress.com/support/",
   "author": "Developer Express Inc.",
@@ -11,8 +11,8 @@
     "build-nspell": "webpack --mode production --config=bin/nspell.webpack.config.js"
   },
   "peerDependencies": {
-    "devextreme": "26.1.2-beta",
-    "devextreme-dist": "26.1.2-beta"
+    "devextreme": "26.1.3",
+    "devextreme-dist": "26.1.3"
   },
   "devDependencies": {
     "dictionary-en": "3.2.0",