Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 | 1x 1x 1x 1x 1x 571x 571x 639x 639x 594x 7x 7x 7x 587x 578x 151x 578x 642x 640x 45x 3x 571x 1x 72x 98x 1x 60x 60x 60x 60x 47x 44x 60x 1x 273x 273x 273x 273x 334x 352x 352x 352x 122x 106x 230x 210x 273x 1x 47x 47x 47x 110x 110x 42x 4x 4x 38x 37x 37x 43x 37x 37x 47x 1x 33x 30x 24x 33x 951x 951x 1137x 951x 380x 4x 380x 3x 143x 143x 96x 96x 96x 47x | import { getClosestAncestorBlockGroupIndex } from '../editing/getClosestAncestorBlockGroupIndex';
import { isBlockGroupOfType } from '../typeCheck/isBlockGroupOfType';
import { iterateSelections } from './iterateSelections';
import { mutateBlock } from '../common/mutate';
import type {
ContentModelBlock,
ContentModelBlockGroup,
ContentModelBlockGroupType,
ContentModelDocument,
ContentModelListItem,
ContentModelParagraph,
ContentModelSegment,
ContentModelTable,
IterateSelectionsOption,
OperationalBlocks,
ReadonlyContentModelBlock,
ReadonlyContentModelBlockGroup,
ReadonlyContentModelDocument,
ReadonlyContentModelListItem,
ReadonlyContentModelParagraph,
ReadonlyContentModelSegment,
ReadonlyContentModelTable,
ReadonlyOperationalBlocks,
ReadonlyTableSelectionContext,
ShallowMutableContentModelParagraph,
ShallowMutableContentModelSegment,
TableSelectionContext,
TypeOfBlockGroup,
} from 'roosterjs-content-model-types';
//#region getSelectedSegmentsAndParagraphs
/**
* Get an array of selected parent paragraph and child segment pair
* @param model The Content Model to get selection from
* @param includingFormatHolder True means also include format holder as segment from list item, in that case paragraph will be null
* @param includingEntity True to include entity in result as well
*/
export function getSelectedSegmentsAndParagraphs(
model: ContentModelDocument,
includingFormatHolder: boolean,
includingEntity?: boolean
): [ContentModelSegment, ContentModelParagraph | null, ContentModelBlockGroup[]][];
/**
* Get an array of selected parent paragraph and child segment pair, return mutable paragraph and segments
* @param model The Content Model to get selection from
* @param includingFormatHolder True means also include format holder as segment from list item, in that case paragraph will be null
* @param includingEntity True to include entity in result as well
* @param mutate Set to true to indicate we will mutate the selected paragraphs
*/
export function getSelectedSegmentsAndParagraphs(
model: ReadonlyContentModelDocument,
includingFormatHolder: boolean,
includingEntity: boolean,
mutate: true
): [
ShallowMutableContentModelSegment,
ContentModelParagraph | null,
ReadonlyContentModelBlockGroup[]
][];
/**
* Get an array of selected parent paragraph and child segment pair (Readonly)
* @param model The Content Model to get selection from
* @param includingFormatHolder True means also include format holder as segment from list item, in that case paragraph will be null
* @param includingEntity True to include entity in result as well
*/
export function getSelectedSegmentsAndParagraphs(
model: ReadonlyContentModelDocument,
includingFormatHolder: boolean,
includingEntity?: boolean
): [
ReadonlyContentModelSegment,
ReadonlyContentModelParagraph | null,
ReadonlyContentModelBlockGroup[]
][];
export function getSelectedSegmentsAndParagraphs(
model: ReadonlyContentModelDocument,
includingFormatHolder: boolean,
includingEntity?: boolean,
mutate?: boolean
): [
ReadonlyContentModelSegment,
ReadonlyContentModelParagraph | null,
ReadonlyContentModelBlockGroup[]
][] {
const selections = collectSelections(model, {
includeListFormatHolder: includingFormatHolder ? 'allSegments' : 'never',
});
const result: [
ReadonlyContentModelSegment,
ReadonlyContentModelParagraph | null,
ReadonlyContentModelBlockGroup[]
][] = [];
selections.forEach(({ segments, block, path }) => {
if (segments) {
if (
includingFormatHolder &&
!block &&
segments.length == 1 &&
path[0].blockGroupType == 'ListItem' &&
segments[0] == path[0].formatHolder
) {
const list = path[0];
Iif (mutate) {
mutateBlock(list);
}
result.push([list.formatHolder, null, path]);
} else if (block?.blockType == 'Paragraph') {
if (mutate) {
mutateBlock(block);
}
segments.forEach(segment => {
if (
includingEntity ||
segment.segmentType != 'Entity' ||
!segment.entityFormat.isReadonly
) {
result.push([segment, block, path]);
}
});
}
} else if (block?.blockType == 'Entity' && includingEntity) {
// Here we treat the entity as segment since they are compatible, then it has no parent paragraph
result.push([block, null /*paragraph*/, path]);
}
});
return result;
}
//#endregion
//#region getSelectedSegments
/**
* Get an array of selected segments from a content model
* @param model The Content Model to get selection from
* @param includingFormatHolder True means also include format holder as segment from list item
*/
export function getSelectedSegments(
model: ContentModelDocument,
includingFormatHolder: boolean
): ContentModelSegment[];
/**
* Get an array of selected segments from a content model, return mutable segments
* @param model The Content Model to get selection from
* @param includingFormatHolder True means also include format holder as segment from list item
* @param mutate Set to true to indicate we will mutate the selected paragraphs
*/
export function getSelectedSegments(
model: ReadonlyContentModelDocument,
includingFormatHolder: boolean,
mutate: true
): ShallowMutableContentModelSegment[];
/**
* Get an array of selected segments from a content model (Readonly)
* @param model The Content Model to get selection from
* @param includingFormatHolder True means also include format holder as segment from list item
*/
export function getSelectedSegments(
model: ReadonlyContentModelDocument,
includingFormatHolder: boolean
): ReadonlyContentModelSegment[];
export function getSelectedSegments(
model: ReadonlyContentModelDocument,
includingFormatHolder: boolean,
mutate?: boolean
): ReadonlyContentModelSegment[] {
const segments = mutate
? getSelectedSegmentsAndParagraphs(
model,
includingFormatHolder,
false /*includeEntity*/,
true /*mutate*/
)
: getSelectedSegmentsAndParagraphs(model, includingFormatHolder);
return segments.map(x => x[0]);
}
//#endregion
//#region getSelectedParagraphs
/**
* Get any array of selected paragraphs from a content model
* @param model The Content Model to get selection from
*/
export function getSelectedParagraphs(model: ContentModelDocument): ContentModelParagraph[];
/**
* Get any array of selected paragraphs from a content model, return mutable paragraphs
* @param model The Content Model to get selection from
* @param mutate Set to true to indicate we will mutate the selected paragraphs
*/
export function getSelectedParagraphs(
model: ReadonlyContentModelDocument,
mutate: true
): ShallowMutableContentModelParagraph[];
/**
* Get any array of selected paragraphs from a content model (Readonly)
* @param model The Content Model to get selection from
*/
export function getSelectedParagraphs(
model: ReadonlyContentModelDocument
): ReadonlyContentModelParagraph[];
export function getSelectedParagraphs(
model: ReadonlyContentModelDocument,
mutate?: boolean
): ReadonlyContentModelParagraph[] {
const selections = collectSelections(model, { includeListFormatHolder: 'never' });
const result: ReadonlyContentModelParagraph[] = [];
removeUnmeaningfulSelections(selections);
selections.forEach(({ block }) => {
if (block?.blockType == 'Paragraph') {
result.push(mutate ? mutateBlock(block) : block);
}
});
return result;
}
//#endregion
//#region getOperationalBlocks
/**
* Get an array of block group - block pair that is of the expected block group type from selection
* @param group The root block group to search
* @param blockGroupTypes The expected block group types
* @param stopTypes Block group types that will stop searching when hit
* @param deepFirst True means search in deep first, otherwise wide first
* @param isValidTarget @optional An additional callback to validate whether a matching block group is a valid target
*/
export function getOperationalBlocks<T extends ContentModelBlockGroup>(
group: ContentModelBlockGroup,
blockGroupTypes: TypeOfBlockGroup<T>[],
stopTypes: ContentModelBlockGroupType[],
deepFirst?: boolean,
isValidTarget?: (block: ReadonlyContentModelBlockGroup) => boolean
): OperationalBlocks<T>[];
/**
* Get an array of block group - block pair that is of the expected block group type from selection (Readonly)
* @param group The root block group to search
* @param blockGroupTypes The expected block group types
* @param stopTypes Block group types that will stop searching when hit
* @param deepFirst True means search in deep first, otherwise wide first
* @param isValidTarget @optional An additional callback to validate whether a matching block group is a valid target
*/
export function getOperationalBlocks<T extends ReadonlyContentModelBlockGroup>(
group: ReadonlyContentModelBlockGroup,
blockGroupTypes: TypeOfBlockGroup<T>[],
stopTypes: ContentModelBlockGroupType[],
deepFirst?: boolean,
isValidTarget?: (block: ReadonlyContentModelBlockGroup) => boolean
): ReadonlyOperationalBlocks<T>[];
export function getOperationalBlocks<T extends ContentModelBlockGroup>(
group: ReadonlyContentModelBlockGroup,
blockGroupTypes: TypeOfBlockGroup<T>[],
stopTypes: ContentModelBlockGroupType[],
deepFirst?: boolean,
isValidTarget?: (block: ReadonlyContentModelBlockGroup) => boolean
): ReadonlyOperationalBlocks<T>[] {
const result: ReadonlyOperationalBlocks<T>[] = [];
const findSequence = deepFirst ? blockGroupTypes.map(type => [type]) : [blockGroupTypes];
const selections = collectSelections(group, {
includeListFormatHolder: 'never',
contentUnderSelectedTableCell: 'ignoreForTable', // When whole table is selected, we treat the table as a single block
});
removeUnmeaningfulSelections(selections);
selections.forEach(({ path, block }) => {
for (let i = 0; i < findSequence.length; i++) {
const groupIndex = getClosestAncestorBlockGroupIndex(
path,
findSequence[i],
stopTypes,
isValidTarget
);
if (groupIndex >= 0) {
if (result.filter(x => x.block == path[groupIndex]).length <= 0) {
result.push({
parent: path[groupIndex + 1],
block: path[groupIndex] as T,
path: path.slice(groupIndex + 1),
});
}
break;
} else if (i == findSequence.length - 1 && block) {
result.push({
parent: path[0],
block: block,
path,
});
break;
}
}
});
return result;
}
//#endregion
//#region getFirstSelectedTable
/**
* Get the first selected table from content model
* @param model The Content Model to get selection from
*/
export function getFirstSelectedTable(
model: ContentModelDocument
): [ContentModelTable | undefined, ContentModelBlockGroup[]];
/**
* Get the first selected table from content model (Readonly)
* @param model The Content Model to get selection from
*/
export function getFirstSelectedTable(
model: ReadonlyContentModelDocument
): [ReadonlyContentModelTable | undefined, ReadonlyContentModelBlockGroup[]];
export function getFirstSelectedTable(
model: ReadonlyContentModelDocument
): [ReadonlyContentModelTable | undefined, ReadonlyContentModelBlockGroup[]] {
const selections = collectSelections(model, { includeListFormatHolder: 'never' });
let table: ReadonlyContentModelTable | undefined;
let resultPath: ReadonlyContentModelBlockGroup[] = [];
removeUnmeaningfulSelections(selections);
selections.forEach(({ block, tableContext, path }) => {
if (!table) {
if (block?.blockType == 'Table') {
table = block;
resultPath = [...path];
} else if (tableContext?.table) {
table = tableContext.table;
const parent = path.filter(
group => group.blocks.indexOf(tableContext.table) >= 0
)[0];
const index = path.indexOf(parent);
resultPath = index >= 0 ? path.slice(index) : [];
}
}
});
return [table, resultPath];
}
//#endregion
//#region getFirstSelectedListItem
/**
* Get the first selected list item from content model
* @param model The Content Model to get selection from
*/
export function getFirstSelectedListItem(
model: ContentModelDocument
): ContentModelListItem | undefined;
/**
* Get the first selected list item from content model (Readonly)
* @param model The Content Model to get selection from
*/
export function getFirstSelectedListItem(
model: ReadonlyContentModelDocument
): ReadonlyContentModelListItem | undefined;
export function getFirstSelectedListItem(
model: ReadonlyContentModelDocument
): ReadonlyContentModelListItem | undefined {
let listItem: ContentModelListItem | undefined;
getOperationalBlocks(model, ['ListItem'], ['TableCell']).forEach(r => {
if (!listItem && isBlockGroupOfType<ContentModelListItem>(r.block, 'ListItem')) {
listItem = r.block;
}
});
return listItem;
}
//#endregion
//#region collectSelections
interface SelectionInfo {
path: ContentModelBlockGroup[];
segments?: ContentModelSegment[];
block?: ContentModelBlock;
tableContext?: TableSelectionContext;
}
interface ReadonlySelectionInfo {
path: ReadonlyContentModelBlockGroup[];
segments?: ReadonlyContentModelSegment[];
block?: ReadonlyContentModelBlock;
tableContext?: ReadonlyTableSelectionContext;
}
function collectSelections(
group: ContentModelBlockGroup,
option?: IterateSelectionsOption
): SelectionInfo[];
function collectSelections(
group: ReadonlyContentModelBlockGroup,
option?: IterateSelectionsOption
): ReadonlySelectionInfo[];
function collectSelections(
group: ReadonlyContentModelBlockGroup,
option?: IterateSelectionsOption
): ReadonlySelectionInfo[] {
const selections: ReadonlySelectionInfo[] = [];
iterateSelections(
group,
(path, tableContext, block, segments) => {
selections.push({
path,
tableContext,
block,
segments,
});
},
option
);
return selections;
}
//#endregion
//#region utils
function removeUnmeaningfulSelections(selections: ReadonlySelectionInfo[]) {
if (
selections.length > 1 &&
isOnlySelectionMarkerSelected(selections, false /*checkFirstParagraph*/)
) {
selections.pop();
}
// Remove head paragraph if first selection marker is the only selection
if (
selections.length > 1 &&
isOnlySelectionMarkerSelected(selections, true /*checkFirstParagraph*/)
) {
selections.shift();
}
}
function isOnlySelectionMarkerSelected(
selections: ReadonlySelectionInfo[],
checkFirstParagraph: boolean
): boolean {
const selection = selections[checkFirstParagraph ? 0 : selections.length - 1];
if (
selection.block?.blockType == 'Paragraph' &&
selection.segments &&
selection.segments.length > 0
) {
const allSegments = selection.block.segments;
const segment = selection.segments[0];
return (
selection.segments.length == 1 &&
segment.segmentType == 'SelectionMarker' &&
segment == allSegments[checkFirstParagraph ? allSegments.length - 1 : 0]
);
} else {
return false;
}
}
//#endregion
|