com.foxit.sdk.addon.pageeditor.ParagraphEditing类 参考

类 com.foxit.sdk.addon.pageeditor.ParagraphEditing 继承关系图:

Public 成员函数
	ParagraphEditing (ParagraphEditing other)
	构造函数，使用另一个段落编辑对象。 更多...
boolean	activate () throws com.foxit.sdk.PDFException
	激活段落编辑。 更多...
boolean	canCopy () throws com.foxit.sdk.PDFException
	检查是否可以复制文本。 更多...
boolean	canCut () throws com.foxit.sdk.PDFException
	检查是否可以剪切文本。 更多...
boolean	canDelete () throws com.foxit.sdk.PDFException
	检查是否可以删除文本。 更多...
boolean	canDeselectAll () throws com.foxit.sdk.PDFException
	检查是否可以取消选择所有文本。 更多...
boolean	canPaste () throws com.foxit.sdk.PDFException
	检查是否可以粘贴文本。 更多...
boolean	canSelectAll () throws com.foxit.sdk.PDFException
	检查是否可以全选文本。 更多...
boolean	copySelected () throws com.foxit.sdk.PDFException
	复制选中的文本。 更多...
boolean	cutSelected () throws com.foxit.sdk.PDFException
	剪切选中的文本。 更多...
boolean	deactivate () throws com.foxit.sdk.PDFException
	停用段落编辑。 更多...
void	dedent () throws com.foxit.sdk.PDFException
	减少文本缩进。 更多...
synchronized void	delete ()
	直接清除C++相关资源。 更多...
boolean	deleteSelected () throws com.foxit.sdk.PDFException
	删除选中的文本。 更多...
boolean	deselectAll () throws com.foxit.sdk.PDFException
	取消选择所有文本。 更多...
void	exitEditing (boolean is_end_directly) throws com.foxit.sdk.PDFException
	退出段落编辑。 更多...
void	indent () throws com.foxit.sdk.PDFException
	增加文本缩进。 更多...
boolean	insertText (String text) throws com.foxit.sdk.PDFException
	在页面中插入文本时调用此函数。 更多...
boolean	isEmpty ()
	检查当前对象是否为空。 更多...
boolean	onChar (int char_code) throws com.foxit.sdk.PDFException
	输入字符代码时调用此函数。 更多...
boolean	onKeyDown (int key_code) throws com.foxit.sdk.PDFException
	键盘按键按下时调用此函数。 更多...
boolean	onKeyUp (int key_code) throws com.foxit.sdk.PDFException
	键盘按键抬起时调用此函数。 更多...
boolean	onLButtonDoubleClick (int page_index, PointF point) throws com.foxit.sdk.PDFException
	鼠标左键双击时调用此函数。 更多...
boolean	onLButtonDown (int page_index, PointF point) throws com.foxit.sdk.PDFException
	鼠标左键按下时调用此函数。 更多...
boolean	onLButtonUp (int page_index, PointF point) throws com.foxit.sdk.PDFException
	鼠标左键抬起时调用此函数。 更多...
boolean	onMouseMove (int page_index, PointF point) throws com.foxit.sdk.PDFException
	鼠标移动时调用此函数。 更多...
boolean	onMouseWheel (int page_index, PointF point, int delta) throws com.foxit.sdk.PDFException
	鼠标滚轮滚动时调用此函数。 更多...
boolean	pasteSelected () throws com.foxit.sdk.PDFException
	粘贴复制的文本。 更多...
boolean	render (Int32Array page_index_array, Renderer renderer) throws com.foxit.sdk.PDFException
	在渲染器上绘制当前段落编辑操作状态。 更多...
boolean	selectAll () throws com.foxit.sdk.PDFException
	全选文本。 更多...
void	setAlignment (int alignment) throws com.foxit.sdk.PDFException
	为文本设置文本对齐方式。 更多...
void	setBold (boolean is_bold) throws com.foxit.sdk.PDFException
	为文本设置粗体状态。 更多...
void	setBulletedList (int bullet_type) throws com.foxit.sdk.PDFException
	为文本设置项目符号列表。 更多...
void	setCharHorizontalScale (int scale) throws com.foxit.sdk.PDFException
	为文本设置字符水平缩放。 更多...
void	setCharSpace (float char_space) throws com.foxit.sdk.PDFException
	为文本设置字符间距。 更多...
void	setFontName (String font_name) throws com.foxit.sdk.PDFException
	为文本设置字体名称。 更多...
void	setFontSize (float font_size) throws com.foxit.sdk.PDFException
	为文本设置字体大小。 更多...
void	setItalic (boolean is_italic) throws com.foxit.sdk.PDFException
	为文本设置斜体状态。 更多...
void	setLineSpace (float line_space) throws com.foxit.sdk.PDFException
	为文本设置行间距。 更多...
void	setNumberedList (int numbering_type) throws com.foxit.sdk.PDFException
	为文本设置编号列表的外观。 更多...
void	setParagraphSpacing (float paragraph_space) throws com.foxit.sdk.PDFException
	为文本设置段落间距。 更多...
void	setStrikethrough (boolean is_striketrough) throws com.foxit.sdk.PDFException
	为文本设置删除线样式。 更多...
void	setSubscript (boolean is_subscript) throws com.foxit.sdk.PDFException
	为文本设置下标属性。 更多...
void	setSuperscript (boolean is_superscript) throws com.foxit.sdk.PDFException
	为文本设置上标属性。 更多...
void	setTextColor (long text_color) throws com.foxit.sdk.PDFException
	为文本设置文本颜色。 更多...
void	setUnderline (boolean is_underline) throws com.foxit.sdk.PDFException
	为文本设置下划线。 更多...
void	startEditing (int page_index, PointF start_point, PointF end_point) throws com.foxit.sdk.PDFException
	开始段落编辑。 更多...
Public 成员函数 继承自 com.foxit.sdk.common.Base
synchronized void	delete ()
	直接清除C++相关资源。 更多...

静态 Public 属性
static final int	e_BulletTypeBlackDiamondMinusWhite = 8
	项目符号类型：黑菱形减去白色。
static final int	e_BulletTypeCheck = 4
	项目符号类型：对勾。
static final int	e_BulletTypeDiagonalUpRightArrow = 7
	项目符号类型：右上对角箭头。
static final int	e_BulletTypeInverseTangentCircle = 6
	项目符号类型：反切圆。
static final int	e_BulletTypeNone = 0
	项目符号类型：无。
static final int	e_BulletTypeRightArrow = 5
	项目符号类型：右箭头（上白下黑）。
static final int	e_BulletTypeSolidCircle = 1
	项目符号类型：实心圆。
static final int	e_BulletTypeSolidDiamond = 3
	项目符号类型：实心菱形。
static final int	e_BulletTypeSolidRectangle = 2
	项目符号类型：实心矩形。
static final int	e_NumberingTypeDecimalDot = 1
	编号类型：1. 2. 3.
static final int	e_NumberingTypeDecimalRParen = 2
	编号类型：1) 2) 3)
static final int	e_NumberingTypeLowerLatinDot = 5
	编号类型：a. b. c.
static final int	e_NumberingTypeLowerLatinRParen = 4
	编号类型：a) b) c)
static final int	e_NumberingTypeNone = 0
	编号类型：无。
static final int	e_NumberingTypeUpperLatinDot = 3
	编号类型：A. B. C.

详细描述

此类表示段落编辑操作。 在使用段落编辑功能的任何方法之前，请确保已调用函数 ParagraphEditing.activate 。 不需要使用任何段落编辑功能时，请调用函数 ParagraphEditing.deactivate 来停用。

构造及析构函数说明

ParagraphEditing()

com.foxit.sdk.addon.pageeditor.ParagraphEditing.ParagraphEditing

(

ParagraphEditing

other

)

构造函数，使用另一个段落编辑对象。

参数

[in]

other

另一个段落编辑对象。

成员函数说明

activate()

boolean com.foxit.sdk.addon.pageeditor.ParagraphEditing.activate

(

)

throws com.foxit.sdk.PDFException

激活段落编辑。

返回

true 表示成功，false 表示失败。

canCopy()

boolean com.foxit.sdk.addon.pageeditor.ParagraphEditing.canCopy

(

)

throws com.foxit.sdk.PDFException

检查是否可以复制文本。

返回

true 表示当前选中的文本对象可以被复制，false 表示不可以。

canCut()

boolean com.foxit.sdk.addon.pageeditor.ParagraphEditing.canCut

(

)

throws com.foxit.sdk.PDFException

检查是否可以剪切文本。

返回

true 表示当前选中的文本可以被剪切，false 表示不可以。

canDelete()

boolean com.foxit.sdk.addon.pageeditor.ParagraphEditing.canDelete

(

)

throws com.foxit.sdk.PDFException

检查是否可以删除文本。

返回

true 表示当前选中的文本可以被删除，false 表示不可以。

canDeselectAll()

boolean com.foxit.sdk.addon.pageeditor.ParagraphEditing.canDeselectAll

(

)

throws com.foxit.sdk.PDFException

检查是否可以取消选择所有文本。

返回

true 表示当前选中的文本可以被取消选择，false 表示不可以。

canPaste()

boolean com.foxit.sdk.addon.pageeditor.ParagraphEditing.canPaste

(

)

throws com.foxit.sdk.PDFException

检查是否可以粘贴文本。

返回

true 表示当前选中的文本可以被粘贴，false 表示不可以。

canSelectAll()

boolean com.foxit.sdk.addon.pageeditor.ParagraphEditing.canSelectAll

(

)

throws com.foxit.sdk.PDFException

检查是否可以全选文本。

返回

true 表示当前所有文本可以被选择，false 表示不可以。

copySelected()

boolean com.foxit.sdk.addon.pageeditor.ParagraphEditing.copySelected

(

)

throws com.foxit.sdk.PDFException

复制选中的文本。

返回

true 表示成功，false 表示失败。

cutSelected()

boolean com.foxit.sdk.addon.pageeditor.ParagraphEditing.cutSelected

(

)

throws com.foxit.sdk.PDFException

剪切选中的文本。

返回

true 表示成功，false 表示失败。

deactivate()

boolean com.foxit.sdk.addon.pageeditor.ParagraphEditing.deactivate

(

)

throws com.foxit.sdk.PDFException

停用段落编辑。

返回

true 表示成功，false 表示失败。

dedent()

void com.foxit.sdk.addon.pageeditor.ParagraphEditing.dedent

(

)

throws com.foxit.sdk.PDFException

减少文本缩进。

返回

无。

delete()

synchronized void com.foxit.sdk.addon.pageeditor.ParagraphEditing.delete

(

)

直接清除C++相关资源。

返回

无。

注解

一旦这个接口被调用，这个对象将不能再被使用。

deleteSelected()

boolean com.foxit.sdk.addon.pageeditor.ParagraphEditing.deleteSelected

(

)

throws com.foxit.sdk.PDFException

删除选中的文本。

返回

true 表示成功，false 表示失败。

deselectAll()

boolean com.foxit.sdk.addon.pageeditor.ParagraphEditing.deselectAll

(

)

throws com.foxit.sdk.PDFException

取消选择所有文本。

返回

true 表示成功，false 表示失败。

exitEditing()

void com.foxit.sdk.addon.pageeditor.ParagraphEditing.exitEditing

(

boolean

is_end_directly

)

throws com.foxit.sdk.PDFException

退出段落编辑。

参数

[in]

is_end_directly

是否直接结束编辑。

返回

无。

indent()

void com.foxit.sdk.addon.pageeditor.ParagraphEditing.indent

(

)

throws com.foxit.sdk.PDFException

增加文本缩进。

返回

无。

insertText()

boolean com.foxit.sdk.addon.pageeditor.ParagraphEditing.insertText

(

String

text

)

throws com.foxit.sdk.PDFException

在页面中插入文本时调用此函数。

参数

[in]

text

要插入的文本。

返回

true 表示成功，false 表示失败。

isEmpty()

boolean com.foxit.sdk.addon.pageeditor.ParagraphEditing.isEmpty

(

)

检查当前对象是否为空。

当当前对象为空时，意味着当前对象无用。

返回

true 表示当前对象为空，false 表示不为空。

onChar()

boolean com.foxit.sdk.addon.pageeditor.ParagraphEditing.onChar

(

int

char_code

)

throws com.foxit.sdk.PDFException

输入字符代码时调用此函数。

参数

[in]

char_code

字符代码，采用 UTF16-LE 编码。

返回

true 表示成功，false 表示失败。

onKeyDown()

boolean com.foxit.sdk.addon.pageeditor.ParagraphEditing.onKeyDown

(

int

key_code

)

throws com.foxit.sdk.PDFException

键盘按键按下时调用此函数。

参数

[in]

key_code

键代码。请参考从 com.foxit.sdk.pdf.interform.Filler.e_VkeyUnknown 开始的值， 应该是这些值中的一个。

返回

true 表示成功，false 表示失败。

onKeyUp()

boolean com.foxit.sdk.addon.pageeditor.ParagraphEditing.onKeyUp

(

int

key_code

)

throws com.foxit.sdk.PDFException

键盘按键抬起时调用此函数。

参数

[in]

key_code

键代码。请参考从 com.foxit.sdk.pdf.interform.Filler.e_VkeyUnknown 开始的值， 应该是这些值中的一个。

返回

true 表示成功，false 表示失败。

onLButtonDoubleClick()

boolean com.foxit.sdk.addon.pageeditor.ParagraphEditing.onLButtonDoubleClick	(	int	page_index,
		PointF	point
	)		throws com.foxit.sdk.PDFException

鼠标左键双击时调用此函数。

参数

[in]	page_index	页面索引。
[in]	point	鼠标左键在页面中双击的点，以设备坐标系表示。

返回

true 表示成功，false 表示失败。

onLButtonDown()

boolean com.foxit.sdk.addon.pageeditor.ParagraphEditing.onLButtonDown	(	int	page_index,
		PointF	point
	)		throws com.foxit.sdk.PDFException

鼠标左键按下时调用此函数。

参数

[in]	page_index	页面索引。
[in]	point	鼠标左键在页面中按下的点，以设备坐标系表示。

返回

true 表示成功，false 表示失败。

onLButtonUp()

boolean com.foxit.sdk.addon.pageeditor.ParagraphEditing.onLButtonUp	(	int	page_index,
		PointF	point
	)		throws com.foxit.sdk.PDFException

鼠标左键抬起时调用此函数。

参数

[in]	page_index	页面索引。
[in]	point	鼠标左键在页面中抬起的点，以设备坐标系表示。

返回

true 表示成功，false 表示失败。

onMouseMove()

boolean com.foxit.sdk.addon.pageeditor.ParagraphEditing.onMouseMove	(	int	page_index,
		PointF	point
	)		throws com.foxit.sdk.PDFException

鼠标移动时调用此函数。

参数

[in]	page_index	页面索引。
[in]	point	鼠标在页面中的点，以设备坐标系表示。

返回

true 表示成功，false 表示失败。

onMouseWheel()

boolean com.foxit.sdk.addon.pageeditor.ParagraphEditing.onMouseWheel	(	int	page_index,
		PointF	point,
		int	delta
	)		throws com.foxit.sdk.PDFException

鼠标滚轮滚动时调用此函数。

参数

[in]	page_index	页面索引。
[in]	point	鼠标在页面中的点，以设备坐标系表示。
[in]	delta	指示鼠标滚轮移动的量。正值表示向前移动， 负值表示向后移动。

返回

true 表示成功，false 表示失败。

pasteSelected()

boolean com.foxit.sdk.addon.pageeditor.ParagraphEditing.pasteSelected

(

)

throws com.foxit.sdk.PDFException

粘贴复制的文本。

返回

true 表示成功，false 表示失败。

render()

boolean com.foxit.sdk.addon.pageeditor.ParagraphEditing.render	(	Int32Array	page_index_array,
		Renderer	renderer
	)		throws com.foxit.sdk.PDFException

在渲染器上绘制当前段落编辑操作状态。

渲染过程中使用的矩阵由 ParagraphEditingProviderCallback.getRenderMatrix 返回。

参数

[in]	page_index_array	要渲染的页面索引数组。
[in]	renderer	用于渲染的有效渲染器对象。

返回

true 表示成功，false 表示失败。

selectAll()

boolean com.foxit.sdk.addon.pageeditor.ParagraphEditing.selectAll

(

)

throws com.foxit.sdk.PDFException

全选文本。

返回

true 表示成功，false 表示失败。

setAlignment()

void com.foxit.sdk.addon.pageeditor.ParagraphEditing.setAlignment

(

int

alignment

)

throws com.foxit.sdk.PDFException

为文本设置文本对齐方式。

参数

[in]

alignment

对齐值。请参考从 com.foxit.sdk.common.Constants.e_AlignmentLeft 开始的值， 应该是这些值中的一个。

返回

无。

setBold()

void com.foxit.sdk.addon.pageeditor.ParagraphEditing.setBold

(

boolean

is_bold

)

throws com.foxit.sdk.PDFException

为文本设置粗体状态。

参数

[in]

is_bold

是否将选中的文本设置为粗体。true 表示当前选中的文本将被设置为粗体，false 表示不设置。

返回

无。

setBulletedList()

void com.foxit.sdk.addon.pageeditor.ParagraphEditing.setBulletedList

(

int

bullet_type

)

throws com.foxit.sdk.PDFException

为文本设置项目符号列表。

在设置项目符号列表之前，请确保已安装 "wingding.ttf" 字体。

参数

[in]

bullet_type

项目符号类型。请参考从 foxit::addon::pageeditor::e_BulletTypeNone 开始的值， 应该是这些值中的一个。

返回

无。

setCharHorizontalScale()

void com.foxit.sdk.addon.pageeditor.ParagraphEditing.setCharHorizontalScale

(

int

scale

)

throws com.foxit.sdk.PDFException

为文本设置字符水平缩放。

参数

[in]

scale

缩放比例。应该大于 0。

返回

无。

setCharSpace()

void com.foxit.sdk.addon.pageeditor.ParagraphEditing.setCharSpace

(

float

char_space

)

throws com.foxit.sdk.PDFException

为文本设置字符间距。

参数

[in]

char_space

字符间距（单位为 1/72 英寸）。

返回

无。

setFontName()

void com.foxit.sdk.addon.pageeditor.ParagraphEditing.setFontName

(

String

font_name

)

throws com.foxit.sdk.PDFException

为文本设置字体名称。

参数

[in]

font_name

字体名称。

返回

无。

setFontSize()

void com.foxit.sdk.addon.pageeditor.ParagraphEditing.setFontSize

(

float

font_size

)

throws com.foxit.sdk.PDFException

为文本设置字体大小。

参数

[in]

font_size

字体大小。

返回

无。

setItalic()

void com.foxit.sdk.addon.pageeditor.ParagraphEditing.setItalic

(

boolean

is_italic

)

throws com.foxit.sdk.PDFException

为文本设置斜体状态。

参数

[in]

is_italic

是否将选中的文本设置为斜体。true 表示当前选中的文本将被设置为斜体，false 表示不设置。

返回

无。

setLineSpace()

void com.foxit.sdk.addon.pageeditor.ParagraphEditing.setLineSpace

(

float

line_space

)

throws com.foxit.sdk.PDFException

为文本设置行间距。

参数

[in]

line_space

行间距（单位为 1/72 英寸）。

返回

无。

setNumberedList()

void com.foxit.sdk.addon.pageeditor.ParagraphEditing.setNumberedList

(

int

numbering_type

)

throws com.foxit.sdk.PDFException

为文本设置编号列表的外观。

参数

[in]

numbering_type

编号类型。请参考从 foxit::addon::pageeditor::e_NumberingTypeNone 开始的值， 应该是这些值中的一个。

返回

无。

setParagraphSpacing()

void com.foxit.sdk.addon.pageeditor.ParagraphEditing.setParagraphSpacing

(

float

paragraph_space

)

throws com.foxit.sdk.PDFException

为文本设置段落间距。

参数

[in]

paragraph_space

段落间距。

返回

无。

setStrikethrough()

void com.foxit.sdk.addon.pageeditor.ParagraphEditing.setStrikethrough

(

boolean

is_striketrough

)

throws com.foxit.sdk.PDFException

为文本设置删除线样式。

参数

[in]

is_striketrough

true 表示设置删除线样式，false 表示不设置。

返回

无。

setSubscript()

void com.foxit.sdk.addon.pageeditor.ParagraphEditing.setSubscript

(

boolean

is_subscript

)

throws com.foxit.sdk.PDFException

为文本设置下标属性。

返回

无。

setSuperscript()

void com.foxit.sdk.addon.pageeditor.ParagraphEditing.setSuperscript

(

boolean

is_superscript

)

throws com.foxit.sdk.PDFException

为文本设置上标属性。

返回

无。

setTextColor()

void com.foxit.sdk.addon.pageeditor.ParagraphEditing.setTextColor

(

long

text_color

)

throws com.foxit.sdk.PDFException

为文本设置文本颜色。

参数

[in]

text_color

文本颜色。

返回

无。

setUnderline()

void com.foxit.sdk.addon.pageeditor.ParagraphEditing.setUnderline

(

boolean

is_underline

)

throws com.foxit.sdk.PDFException

为文本设置下划线。

参数

[in]

is_underline

true 表示给文本加下划线，false 表示不加。

返回

无。

startEditing()

void com.foxit.sdk.addon.pageeditor.ParagraphEditing.startEditing	(	int	page_index,
		PointF	start_point,
		PointF	end_point
	)		throws com.foxit.sdk.PDFException

开始段落编辑。

参数

[in]	page_index	页面索引。
[in]	start_point	在页面上开始编辑的点，以设备坐标系表示。
[in]	end_point	在页面上结束编辑的点，以设备坐标系表示。

返回

无。