com.compdfkit.core.edit

Class CPDFEditTextArea

java.lang.Object

com.compdfkit.core.edit.CPDFEditArea

com.compdfkit.core.edit.CPDFEditTextArea

public class CPDFEditTextArea
extends CPDFEditArea

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CPDFEditTextArea.Action
static class	CPDFEditTextArea.PDFEditAlignType
static class	CPDFEditTextArea.PDFEditTextRenderingMode

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FontCourier
static java.lang.String	FontHelvtics
static java.lang.String	FontTimesRoman

Method Summary

Modifier and Type	Method and Description
boolean	addStrikethrough(CPDFEditCharPlace begin, CPDFEditCharPlace end)
boolean	addUnderline(CPDFEditCharPlace begin, CPDFEditCharPlace end)
boolean	clearCharsFontBold(CPDFEditCharPlace begin, CPDFEditCharPlace end)
boolean	clearCharsFontItalic(CPDFEditCharPlace begin, CPDFEditCharPlace end) Clear text font italic
CPDFEditCharItem	deleteText(CPDFEditCharPlace begin, CPDFEditCharPlace end) Delete text
CPDFEditTextArea.PDFEditAlignType	getAlign(CPDFEditCharPlace end) Get the alignment of the last character within a text range or of a single character.
CPDFEditTextArea.PDFEditAlignType	getAlignByRange(CPDFEditCharPlace begin, CPDFEditCharPlace end) Get the alignment within a text range where multiple alignments exist, return NULL.
java.lang.String	getAllText() Get all text in the text box
CPDFEditCharItem	getBeginCharPlace() Get begin char place of the text box
android.graphics.RectF[]	getCharsRangeAtPos(CPDFEditCharPlace begin, CPDFEditCharPlace end) Get char range of text
int	getColor(CPDFEditCharPlace end) Get the text color of the last character within a text range or of a single character, where the color is returned in the format of 0x00000000-0xFFFFFFFF.
int	getColorByRange(CPDFEditCharPlace begin, CPDFEditCharPlace end) Get the text color within a text range, where the color is returned in the format of 0x00000000-0xFFFFFFFF.
java.util.List<CPDFEditSelection>	getCurrentAreaSelections() Get the selected text range within the current text box。
java.util.List<CPDFEditSelection>	getCurrentAreaSelections(CPDFEditCharPlace begin, CPDFEditCharPlace end) Get the selected text range within the current text box by the starting position.
CPDFEditCharItem	getEditCharItemFromPlace(CPDFEditCharPlace place) Get current char item
CPDFEditCharItem	getEndCharPlace() Get end char place of the text box
java.lang.String	getFontName(CPDFEditCharPlace end) Get the font name of the last character within a text range or of a single character.
java.lang.String	getFontNameByRange(CPDFEditCharPlace begin, CPDFEditCharPlace end) Get the font name within the text range, return empty string if there are different fonts present in the text.
float	getFontSize(CPDFEditCharPlace end) Get the font size of the last character within a text range or of a single character.
float	getFontSizeByRange(CPDFEditCharPlace begin, CPDFEditCharPlace end) Get the font size of the text within a text range.
android.graphics.RectF	getFrame(boolean forceUpdate) Get the rect occupied by the text box
CPDFEditCharItem	getSectionBeginCharPlace(int section_index) Get the begin place of the section.
int	getSectionCount() Get section number of the text area.
CPDFEditCharItem	getSectionEndCharPlace(int section_index) Get the end place of the section.
CPDFEditSelection	getSelectionForWordPos(float x, float y) Get selection at positoin
java.lang.String	getText(CPDFEditCharPlace begin, CPDFEditCharPlace end) Get text in the range
float	getTransparancyByRange(CPDFEditCharPlace begin, CPDFEditCharPlace end) Get the text transparancy within a text range.
float	getTransparency(CPDFEditCharPlace end) Get the text transparancy of the last character within a text range or of a single character.
CPDFEditCharItem	insertText(CPDFEditCharPlace place, java.lang.String text) Insert text to text box
CPDFEditCharItem	insertTextRange(CPDFEditCharPlace begin, CPDFEditCharPlace end, java.lang.String text) Use other text to replace the text in range.
boolean	isBold(CPDFEditCharPlace end) Determine whether the last character within a specified text range or a single character has bold formatting.
boolean	isBoldByRange(CPDFEditCharPlace begin, CPDFEditCharPlace end) Determine whether all text within a specified text range has bold formatting.
boolean	isEmptyArea() Is the text box object empty?
boolean	isItalic(CPDFEditCharPlace end) Determine whether the last character within a specified text range or a single character has italic formatting.
boolean	isItalicByRange(CPDFEditCharPlace begin, CPDFEditCharPlace end) Determine whether all text within a specified text range has italic formatting.
boolean	isUnderlineByRange(CPDFEditCharPlace begin, CPDFEditCharPlace end)
boolean	moveBackward() move down one level
boolean	moveForward() move one level up
boolean	moveToTheBottom() bottom
boolean	moveToTheTop() pin to top
CPDFEditCharItem	onAction(CPDFEditCharPlace place, CPDFEditTextArea.Action action) Response action operation
CPDFEditCharRange	refreshRange(CPDFEditCharPlace begin, CPDFEditCharPlace end) refresh char range of text
void	release() Release text box
boolean	removeStrikethrough(CPDFEditCharPlace begin, CPDFEditCharPlace end)
boolean	removeUnderline(CPDFEditCharPlace begin, CPDFEditCharPlace end)
CPDFEditCharRange	replaceText(CPDFEditCharRange charRange, java.lang.String text) Replace the text within the range with other text.
CPDFEditCharItem	selectCharItemAtPos(float x, float y) Select char item at position
void	setAligningBlock(int type) Set align type
void	setAligningSection(CPDFEditCharPlace begin, CPDFEditCharPlace end, CPDFEditTextArea.PDFEditAlignType alignType) Set text align type
boolean	setCharsFontBold(CPDFEditCharPlace begin, CPDFEditCharPlace end)
void	setCharsFontColor(CPDFEditCharPlace begin, CPDFEditCharPlace end, int color) Set text color
boolean	setCharsFontItalic(CPDFEditCharPlace begin, CPDFEditCharPlace end) Set text font to italic
boolean	setCharsFontRederingMode(CPDFEditCharPlace begin, CPDFEditCharPlace end, CPDFEditTextArea.PDFEditTextRenderingMode mode) Sets text font render mode
android.graphics.RectF[]	setCharsFontSize(CPDFEditCharPlace begin, CPDFEditCharPlace end, float size) Set text font size
boolean	setCharsFontStrokeWidth(CPDFEditCharPlace begin, CPDFEditCharPlace end, int width) Sets text font stroke width.
void	setCharsTransparancy(CPDFEditCharPlace begin, CPDFEditCharPlace end, float tranrancy) Set text transparancy
boolean	setFontFromNativeTrueTypeFont(CPDFEditCharPlace begin, CPDFEditCharPlace end, java.lang.String font) Set text font
boolean	setFrame(android.graphics.RectF rectF, boolean isUpdate) Set the rect occupied by the text box
boolean	setFrame(android.graphics.RectF rectF, boolean isUpdate, boolean addToUndo)

Methods inherited from class com.compdfkit.core.edit.CPDFEditArea

attachDocument, getPageNum, getPtr, isValid

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FontCourier

public static final java.lang.String FontCourier

See Also:

Constant Field Values

FontHelvtics

public static final java.lang.String FontHelvtics

See Also:

Constant Field Values

FontTimesRoman

public static final java.lang.String FontTimesRoman

See Also:

Constant Field Values

Method Detail

getFrame

public android.graphics.RectF getFrame(boolean forceUpdate)

Get the rect occupied by the text box

Parameters:

forceUpdate - whether to force update

Returns:

Returns the rect occupied by the text box

setFrame

public boolean setFrame(android.graphics.RectF rectF,
                        boolean isUpdate)

Set the rect occupied by the text box

Parameters:

rectF - the rect occupied by the text box

isUpdate - whether to force update

Returns:

Returns whether to successfully set rect

setFrame

public boolean setFrame(android.graphics.RectF rectF,
                        boolean isUpdate,
                        boolean addToUndo)

selectCharItemAtPos

public CPDFEditCharItem selectCharItemAtPos(float x,
                                            float y)

Select char item at position

Parameters:

x - x coordinate in the page(Page coordinate)

y - y coordinate in the page(Page coordinate)

Returns:

Returns char item

insertText

public CPDFEditCharItem insertText(CPDFEditCharPlace place,
                                   java.lang.String text)

Insert text to text box

Parameters:

place - Place to insert text

text - Text to intert

Returns:

Returns char item

insertTextRange

public CPDFEditCharItem insertTextRange(CPDFEditCharPlace begin,
                                        CPDFEditCharPlace end,
                                        java.lang.String text)

Use other text to replace the text in range.

Parameters:

begin - Start place of the text range

end - End place of the text range

text - Text used to replace

Returns:

Returns char item

onAction

public CPDFEditCharItem onAction(CPDFEditCharPlace place,
                                 CPDFEditTextArea.Action action)

Response action operation

Parameters:

place - Current edit place

action - Action type

Returns:

Returns char item

getSelectionForWordPos

public CPDFEditSelection getSelectionForWordPos(float x,
                                                float y)

Get selection at positoin

Parameters:

x - X coordinate in the page(Page coordinate)

y - Y coordinate in the page(Page coordinate)

Returns:

Returns selection

refreshRange

public CPDFEditCharRange refreshRange(CPDFEditCharPlace begin,
                                      CPDFEditCharPlace end)

refresh char range of text

Parameters:

begin - Begin place of text

end - End place of text

Returns:

char range of text

getCharsRangeAtPos

public android.graphics.RectF[] getCharsRangeAtPos(CPDFEditCharPlace begin,
                                                   CPDFEditCharPlace end)

Get char range of text

Parameters:

begin - Begin place of text

end - End place of text

Returns:

char range of text

getBeginCharPlace

public CPDFEditCharItem getBeginCharPlace()

Get begin char place of the text box

Returns:

Returns begin char place of the text box

getEndCharPlace

public CPDFEditCharItem getEndCharPlace()

Get end char place of the text box

Returns:

Returns end char place of the text box

deleteText

public CPDFEditCharItem deleteText(CPDFEditCharPlace begin,
                                   CPDFEditCharPlace end)

Delete text

Parameters:

begin - Begin place of text

end - End place of text

Returns:

Returns current char item in the text box

getEditCharItemFromPlace

public CPDFEditCharItem getEditCharItemFromPlace(CPDFEditCharPlace place)

Get current char item

Parameters:

place - place of text

Returns:

Returns current char item in the text box

setCharsFontSize

public android.graphics.RectF[] setCharsFontSize(CPDFEditCharPlace begin,
                                                 CPDFEditCharPlace end,
                                                 float size)

Set text font size

Parameters:

begin - Begin place of text

end - End place of text

size - font size

Returns:

Returns text range array

setCharsFontColor

public void setCharsFontColor(CPDFEditCharPlace begin,
                              CPDFEditCharPlace end,
                              int color)

Set text color

Parameters:

begin - Begin place of text

end - End place of text

color - Text color

setCharsTransparancy

public void setCharsTransparancy(CPDFEditCharPlace begin,
                                 CPDFEditCharPlace end,
                                 float tranrancy)

Set text transparancy

Parameters:

begin - Begin place of text

end - End place of text

tranrancy - text transparancy(0-255)

setAligningBlock

public void setAligningBlock(int type)

Set align type

Parameters:

type - align type

setAligningSection

public void setAligningSection(CPDFEditCharPlace begin,
                               CPDFEditCharPlace end,
                               CPDFEditTextArea.PDFEditAlignType alignType)

Set text align type

Parameters:

begin - Begin place of text

end - End place of text

alignType - Align type

getText

public java.lang.String getText(CPDFEditCharPlace begin,
                                CPDFEditCharPlace end)

Get text in the range

Parameters:

begin - Begin place of text

end - End place of text

Returns:

Returns text in the range

getAllText

public java.lang.String getAllText()

Get all text in the text box

Returns:

all text in the text box

release

public void release()

Release text box

setCharsFontItalic

public boolean setCharsFontItalic(CPDFEditCharPlace begin,
                                  CPDFEditCharPlace end)

Set text font to italic

Parameters:

begin - Begin place of text

end - End place of text

Returns:

Returns whether to successfully set font to italic

clearCharsFontItalic

public boolean clearCharsFontItalic(CPDFEditCharPlace begin,
                                    CPDFEditCharPlace end)

Clear text font italic

Parameters:

begin - Begin place of text

end - End place of text

Returns:

Returns whether to successfully clear text font italic

isItalicByRange

public boolean isItalicByRange(CPDFEditCharPlace begin,
                               CPDFEditCharPlace end)

Determine whether all text within a specified text range has italic formatting.

Parameters:

begin - Begin place of text

end - End place of text

Returns:

Returns a boolean value.

isItalic

public boolean isItalic(CPDFEditCharPlace end)

Determine whether the last character within a specified text range or a single character has italic formatting.

Parameters:

end - End place of text

Returns:

Returns a boolean value.

isBoldByRange

public boolean isBoldByRange(CPDFEditCharPlace begin,
                             CPDFEditCharPlace end)

Determine whether all text within a specified text range has bold formatting.

Parameters:

begin - Begin place of text

end - End place of text

Returns:

Returns a boolean value.

setCharsFontBold

public boolean setCharsFontBold(CPDFEditCharPlace begin,
                                CPDFEditCharPlace end)

clearCharsFontBold

public boolean clearCharsFontBold(CPDFEditCharPlace begin,
                                  CPDFEditCharPlace end)

isUnderlineByRange

public boolean isUnderlineByRange(CPDFEditCharPlace begin,
                                  CPDFEditCharPlace end)

isBold

public boolean isBold(CPDFEditCharPlace end)

Determine whether the last character within a specified text range or a single character has bold formatting.

Parameters:

end - End place of text

Returns:

Returns a boolean value.

setCharsFontRederingMode

public boolean setCharsFontRederingMode(CPDFEditCharPlace begin,
                                        CPDFEditCharPlace end,
                                        CPDFEditTextArea.PDFEditTextRenderingMode mode)

Sets text font render mode

Parameters:

begin - Begin place of text

end - End place of text

mode - Render mode

Returns:

Returns whether to successfully set render mode

setCharsFontStrokeWidth

public boolean setCharsFontStrokeWidth(CPDFEditCharPlace begin,
                                       CPDFEditCharPlace end,
                                       int width)

Sets text font stroke width.

Parameters:

begin - Begin place of text

end - End place of text

width - stroke width

Returns:

Returns whether to successfully set stroke width

setFontFromNativeTrueTypeFont

public boolean setFontFromNativeTrueTypeFont(CPDFEditCharPlace begin,
                                             CPDFEditCharPlace end,
                                             java.lang.String font)

Set text font

Parameters:

begin - Begin place of text

end - End place of text

font - Text font

Returns:

Returns whether to successfully set font

getCurrentAreaSelections

public java.util.List<CPDFEditSelection> getCurrentAreaSelections(CPDFEditCharPlace begin,
                                                                  CPDFEditCharPlace end)

Get the selected text range within the current text box by the starting position.

Parameters:

begin - Begin place of text

end - End place of text

Returns:

Returns list of edit text selection

getCurrentAreaSelections

public java.util.List<CPDFEditSelection> getCurrentAreaSelections()

Get the selected text range within the current text box。

Returns:

Returns list of edit text selection

isEmptyArea

public boolean isEmptyArea()

Is the text box object empty?

Returns:

Returns a boolean value.

getFontSize

public float getFontSize(CPDFEditCharPlace end)

Get the font size of the last character within a text range or of a single character.

Parameters:

end - End place of text

Returns:

Returns the font size.

getFontSizeByRange

public float getFontSizeByRange(CPDFEditCharPlace begin,
                                CPDFEditCharPlace end)

Get the font size of the text within a text range. If there are multiple font sizes present in the text range, return -1.

Parameters:

begin - Begin place of text

end - End place of text

Returns:

Returns the font size.

getTransparency

public float getTransparency(CPDFEditCharPlace end)

Get the text transparancy of the last character within a text range or of a single character.

Parameters:

end - End place of text

Returns:

Returns the text transparancy(0-255).

getTransparancyByRange

public float getTransparancyByRange(CPDFEditCharPlace begin,
                                    CPDFEditCharPlace end)

Get the text transparancy within a text range. If there are multiple transparancy values present in the text range, return -1.

Parameters:

begin - Begin place of text

end - End place of text

Returns:

Returns the text transparancy(0-255).

getColor

public int getColor(CPDFEditCharPlace end)

Get the text color of the last character within a text range or of a single character, where the color is returned in the format of 0x00000000-0xFFFFFFFF.

Parameters:

end - End place of text

Returns:

Returns the text color.

getColorByRange

public int getColorByRange(CPDFEditCharPlace begin,
                           CPDFEditCharPlace end)

Get the text color within a text range, where the color is returned in the format of 0x00000000-0xFFFFFFFF. If there are multiple colors present in the text range, return -1.

Parameters:

begin - Begin place of text

end - End place of text

Returns:

Returns the text color.

getAlign

public CPDFEditTextArea.PDFEditAlignType getAlign(CPDFEditCharPlace end)

Get the alignment of the last character within a text range or of a single character.

Parameters:

end - End place of text

Returns:

Returns the alignment.

getAlignByRange

public CPDFEditTextArea.PDFEditAlignType getAlignByRange(CPDFEditCharPlace begin,
                                                         CPDFEditCharPlace end)

Get the alignment within a text range where multiple alignments exist, return NULL.

Parameters:

begin - Begin place of text

end - End place of text

Returns:

Returns the alignment.

getFontName

public java.lang.String getFontName(CPDFEditCharPlace end)

Get the font name of the last character within a text range or of a single character.

Parameters:

end - End place of text

Returns:

Returns font name.

getFontNameByRange

public java.lang.String getFontNameByRange(CPDFEditCharPlace begin,
                                           CPDFEditCharPlace end)

Get the font name within the text range, return empty string if there are different fonts present in the text.

Parameters:

begin - Begin place of text

end - End place of text

Returns:

Returns font name.

replaceText

public CPDFEditCharRange replaceText(CPDFEditCharRange charRange,
                                     java.lang.String text)

Replace the text within the range with other text.

Parameters:

charRange - The text range to be replaced.

text - The text that is used to replace.

Returns:

Returns whether succeed to replace.

getSectionCount

public int getSectionCount()

Get section number of the text area.

Returns:

Returns the section number.

getSectionBeginCharPlace

public CPDFEditCharItem getSectionBeginCharPlace(int section_index)

Get the begin place of the section.

Parameters:

section_index - Section index.

Returns:

Returns begin place.

getSectionEndCharPlace

public CPDFEditCharItem getSectionEndCharPlace(int section_index)

Get the end place of the section.

Parameters:

section_index -

Returns:

addUnderline

public boolean addUnderline(CPDFEditCharPlace begin,
                            CPDFEditCharPlace end)

removeUnderline

public boolean removeUnderline(CPDFEditCharPlace begin,
                               CPDFEditCharPlace end)

addStrikethrough

public boolean addStrikethrough(CPDFEditCharPlace begin,
                                CPDFEditCharPlace end)

removeStrikethrough

public boolean removeStrikethrough(CPDFEditCharPlace begin,
                                   CPDFEditCharPlace end)

moveToTheTop

public boolean moveToTheTop()

pin to top

moveToTheBottom

public boolean moveToTheBottom()

bottom

moveForward

public boolean moveForward()

move one level up

moveBackward

public boolean moveBackward()

move down one level