Skip to content

Commit 1a73362

Browse files
committed
[lib] Wrote documentation of extra length properties
1 parent d870419 commit 1a73362

File tree

1 file changed

+20
-0
lines changed
  • tehreer-android/src/main/java/com/mta/tehreer/layout

1 file changed

+20
-0
lines changed

tehreer-android/src/main/java/com/mta/tehreer/layout/GlyphRun.java

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,10 +155,30 @@ public int getCharEnd() {
155155
return charEnd;
156156
}
157157

158+
/**
159+
* Returns the extra excluded length at the start of cluster map. If first cluster of this run
160+
* begins within the excluded range, then its rendering will be clipped from start. The amount
161+
* of clipping would be equal to the perceived trailing caret position of last excluded
162+
* character.
163+
*
164+
* @return The extra excluded length at the start of cluster map.
165+
*
166+
* @see #getClusterMap()
167+
*/
158168
public int getStartExtraLength() {
159169
return startExtraLength;
160170
}
161171

172+
/**
173+
* Returns the extra excluded length at the end of cluster map. If last cluster of this run
174+
* finishes within the excluded range, then its rendering will be clipped from end. The amount
175+
* of clipping would be equal to the perceived leading caret position of first excluded
176+
* character.
177+
*
178+
* @return The extra excluded length at the end of cluster map.
179+
*
180+
* @see #getClusterMap()
181+
*/
162182
public int getEndExtraLength() {
163183
return endExtraLength;
164184
}

0 commit comments

Comments
 (0)