类 com.foxit.sdk.pdf.annots.Screen 继承关系图:

Public 成员函数
	Screen ()
	构造函数。

	Screen (Annot annot)
	构造函数，使用父类对象。更多...

synchronized void	delete ()
	直接清除C++相关资源。更多...

Action	getAction () throws com.foxit.sdk.PDFException
	获取动作。更多...

Bitmap	getBitmap () throws com.foxit.sdk.PDFException
	从当前屏幕注释获取位图。更多...

PDFDictionary	getMKDict () throws com.foxit.sdk.PDFException
	获取外观特征字典（也称为"MK"字典）。更多...

float	getOpacity () throws com.foxit.sdk.PDFException
	获取不透明度值。更多...

int	getRotation () throws com.foxit.sdk.PDFException
	获取用于当前屏幕注释外观的图像旋转。更多...

String	getTitle () throws com.foxit.sdk.PDFException
	获取当前屏幕注释的标题。更多...

void	removeAction () throws com.foxit.sdk.PDFException
	移除动作。更多...

void	setAction (Action action) throws com.foxit.sdk.PDFException
	设置动作。更多...

void	setImage (Image image, int frame_index, int compress) throws com.foxit.sdk.PDFException
	为当前屏幕注释设置图像，使用指定的帧索引。更多...

void	setMKDict (PDFDictionary dict) throws com.foxit.sdk.PDFException
	设置外观特征字典（也称为"MK"字典）。更多...

void	setOpacity (float opacity) throws com.foxit.sdk.PDFException
	设置不透明度值。更多...

void	setRotation (int rotate) throws com.foxit.sdk.PDFException
	设置用于当前屏幕注释外观的图像旋转。更多...

void	setTitle (String title) throws com.foxit.sdk.PDFException
	设置当前屏幕注释的标题。更多...

Public 成员函数继承自 com.foxit.sdk.pdf.annots.Annot
	Annot ()
	构造函数。

	Annot (Annot annot)
	构造函数，使用另一个注释对象。更多...

	Annot (PDFPage page, PDFDictionary annot_dict) throws com.foxit.sdk.PDFException
	构造函数，使用PDF页面和注释的PDF字典。更多...

PDFStream	getAppearanceStream (int type, String appearance_state) throws com.foxit.sdk.PDFException
	获取具有指定类型和状态的注释外观流。更多...

long	getBorderColor () throws com.foxit.sdk.PDFException
	获取边框颜色。更多...

BorderInfo	getBorderInfo () throws com.foxit.sdk.PDFException
	获取边框信息。更多...

String	getContent () throws com.foxit.sdk.PDFException
	获取内容。更多...

RectI	getDeviceRect (Matrix2D matrix) throws com.foxit.sdk.PDFException
	获取设备坐标系统中的注释矩形。更多...

PDFDictionary	getDict () throws com.foxit.sdk.PDFException
	获取注释的字典对象。更多...

Matrix2D	getDisplayMatrix (Matrix2D page_display_matrix) throws com.foxit.sdk.PDFException
	获取显示矩阵，从到目标设备坐标系统。更多...

int	getFlags () throws com.foxit.sdk.PDFException
	获取注释标志。更多...

int	getIndex () throws com.foxit.sdk.PDFException
	获取当前注释在其所属页面中的索引。更多...

DateTime	getModifiedDateTime () throws com.foxit.sdk.PDFException
	获取最后修改日期时间。更多...

PDFDictionary	getOptionalContent () throws com.foxit.sdk.PDFException
	获取注释可选内容的PDF字典。更多...

PDFPage	getPage () throws com.foxit.sdk.PDFException
	获取相关的PDF页面。更多...

RectF	getRect () throws com.foxit.sdk.PDFException
	获取矩形，以表示。更多...

int	getType () throws com.foxit.sdk.PDFException
	获取当前注释的实际注释类型。更多...

String	getUniqueID () throws com.foxit.sdk.PDFException
	获取唯一ID。更多...

boolean	hasProperty (int property) throws com.foxit.sdk.PDFException
	当前注释是否具有指定的注释属性。更多...

boolean	isEmpty ()
	检查当前对象是否为空。更多...

boolean	isMarkup () throws com.foxit.sdk.PDFException
	检查当前注释是否为标记注释。更多...

boolean	move (RectF rect) throws com.foxit.sdk.PDFException
	将当前注释移动到新位置，由中的新矩形指定。更多...

boolean	move (RectF rect, boolean is_reset_appearance) throws com.foxit.sdk.PDFException
	将当前注释移动到新位置，由中的新矩形指定。更多...

boolean	removeProperty (int property) throws com.foxit.sdk.PDFException
	删除指定的注释属性。更多...

boolean	resetAppearanceStream () throws com.foxit.sdk.PDFException
	重置外观流。更多...

boolean	resetAppearanceStream (boolean is_generate_new_appearance_obj) throws com.foxit.sdk.PDFException
	重置外观流。更多...

void	setBorderColor (long color) throws com.foxit.sdk.PDFException
	设置边框颜色。更多...

void	setBorderInfo (BorderInfo border) throws com.foxit.sdk.PDFException
	设置边框信息。更多...

void	setContent (String content) throws com.foxit.sdk.PDFException
	设置内容。更多...

void	setFlags (int flags) throws com.foxit.sdk.PDFException
	设置注释标志。更多...

void	setModifiedDateTime (DateTime date_time) throws com.foxit.sdk.PDFException
	设置最后修改日期时间。更多...

void	setUniqueID (String unique_id) throws com.foxit.sdk.PDFException
	设置唯一ID。更多...

额外继承的成员函数
静态 Public 属性继承自 com.foxit.sdk.pdf.annots.Annot
static final int	e_3D = 25
	注释类型：3D注释。<PDF参考1.7>中的标准注释之一。

static final int	e_AppearanceTypeDown = 2
	注释的按下外观。

static final int	e_AppearanceTypeNormal = 0
	注释的正常外观。

static final int	e_AppearanceTypeRollover = 1
	注释的悬停外观。

static final int	e_Caret = 14
	注释类型：插入符注释。<PDF参考1.7>中的标准注释之一。

static final int	e_Circle = 6
	注释类型：圆形注释。<PDF参考1.7>中的标准注释之一。

static final int	e_FileAttachment = 17
	注释类型：文件附件注释。<PDF参考1.7>中的标准注释之一。

static final int	e_FlagHidden = 0x0002
	注释标志：隐藏。更多...

static final int	e_FlagInvisible = 0x0001
	注释标志：不可见。更多...

static final int	e_FlagLocked = 0x0080
	注释标志：锁定。更多...

static final int	e_FlagLockedContents = 0x0200
	注释标志：锁定内容。更多...

static final int	e_FlagNoRotate = 0x0010
	注释标志：无旋转。更多...

static final int	e_FlagNoView = 0x0020
	注释标志：无视图。更多...

static final int	e_FlagNoZoom = 0x0008
	注释标志：无缩放。更多...

static final int	e_FlagPrint = 0x0004
	注释标志：打印。更多...

static final int	e_FlagReadOnly = 0x0040
	注释标志：只读。更多...

static final int	e_FlagToggleNoView = 0x0100
	注释标志：切换无视图。更多...

static final int	e_FreeText = 3
	注释类型：自由文本注释。<PDF参考1.7>中的标准注释之一。

static final int	e_Highlight = 9
	注释类型：高亮注释。<PDF参考1.7>中的标准注释之一。

static final int	e_HighlightingInvert = 1
	高亮模式：反转，即反转注释矩形的内容。

static final int	e_HighlightingNone = 0
	高亮模式：无高亮。

static final int	e_HighlightingOutline = 2
	高亮模式：轮廓，即反转注释的边框。

static final int	e_HighlightingPush = 3
	高亮模式：按下，即显示注释的按下外观（如果有）。

static final int	e_HighlightingToggle = 4
	高亮模式：切换。这仅对小组件注释有用。

static final int	e_Ink = 15
	注释类型：墨迹注释。<PDF参考1.7>中的标准注释之一。

static final int	e_Line = 4
	注释类型：直线注释。<PDF参考1.7>中的标准注释之一。

static final int	e_Link = 2
	注释类型：链接注释。<PDF参考1.7>中的标准注释之一。

static final int	e_MKEntryBackgroundColor = 2
	背景颜色条目。MK字典中的"BG"。

static final int	e_MKEntryBorderColor = 1
	边框颜色条目。MK字典中的"BC"。

static final int	e_MKEntryDownCaption = 5
	按下标题（或备用标题）条目。MK字典中的"AC"。更多...

static final int	e_MKEntryDownIcon = 8
	按下图标（或备用图标）条目。MK字典中的"IX"。更多...

static final int	e_MKEntryIconCaptionRelation = 10
	图标和标题关系条目。MK字典中的"TP"。更多...

static final int	e_MKEntryIconFit = 9
	图标适配信息条目。MK字典中的"IF"。更多...

static final int	e_MKEntryNormalCaption = 3
	正常标题条目。MK字典中的"CA"。更多...

static final int	e_MKEntryNormalIcon = 6
	正常图标条目。MK字典中的"I"。更多...

static final int	e_MKEntryRolloverCaption = 4
	悬停标题条目。MK字典中的"RC"。更多...

static final int	e_MKEntryRolloverIcon = 7
	悬停图标条目。MK字典中的"RI"。更多...

static final int	e_MKEntryRotation = 0
	旋转条目。MK字典中的"R"。

static final int	e_MKRelationCaptionAboveIcon = 3
	标题在图标上方。

static final int	e_MKRelationCaptionBelowIcon = 2
	标题在图标下方。

static final int	e_MKRelationCaptionLeft = 5
	标题在图标左侧。

static final int	e_MKRelationCaptionOvrlayOnIcon = 6
	标题直接覆盖在图标上。

static final int	e_MKRelationCaptionRight = 4
	标题在图标右侧。

static final int	e_MKRelationNoCaption = 1
	无标题；仅图标。

static final int	e_MKRelationNoIcon = 0
	无图标；仅标题。

static final int	e_Movie = 19
	注释类型：电影注释。<PDF参考1.7>中的标准注释之一。

static final int	e_Note = 1
	注释类型：注记注释，即"文本"注释 - <PDF参考1.7>中的标准注释之一。

static final int	e_PagingSeal = 29
	注释类型：分页印章注释。福昕PDF SDK自定义注释类型（非标准注释类型）。

static final int	e_Polygon = 7
	注释类型：多边形注释。<PDF参考1.7>中的标准注释之一。

static final int	e_PolyLine = 8
	注释类型：折线注释。<PDF参考1.7>中的标准注释之一。

static final int	e_Popup = 26
	注释类型：弹出注释。<PDF参考1.7>中的标准注释之一。

static final int	e_PrinterMark = 22
	注释类型：印刷标记注释。<PDF参考1.7>中的标准注释之一。

static final int	e_PropertyBorderColor = 2
	注释属性：边框颜色。更多...

static final int	e_PropertyCreationDate = 1
	注释属性：创建日期。更多...

static final int	e_PropertyFillColor = 3
	注释属性：填充颜色更多...

static final int	e_PropertyModifiedDate = 0
	注释属性：修改日期。

static final int	e_PSInk = 16
	注释类型：压力敏感墨迹注释。

static final int	e_Redact = 27
	注释类型：编辑注释。

static final int	e_RichMedia = 28
	注释类型：富媒体注释。

static final int	e_Screen = 21
	注释类型：屏幕注释。<PDF参考1.7>中的标准注释之一。

static final int	e_Sound = 18
	注释类型：声音注释。<PDF参考1.7>中的标准注释之一。

static final int	e_Square = 5
	注释类型：矩形注释。<PDF参考1.7>中的标准注释之一。

static final int	e_Squiggly = 11
	注释类型：波浪线注释。<PDF参考1.7>中的标准注释之一。

static final int	e_Stamp = 13
	注释类型：印章注释。<PDF参考1.7>中的标准注释之一。

static final int	e_StrikeOut = 12
	注释类型：删除线注释。<PDF参考1.7>中的标准注释之一。

static final int	e_TrapNet = 23
	注释类型：陷阱网络注释。<PDF参考1.7>中的标准注释之一。

static final int	e_Underline = 10
	注释类型：下划线注释。<PDF参考1.7>中的标准注释之一。

static final int	e_UnknownType = 0
	注释类型：未知。

static final int	e_Watermark = 24
	注释类型：水印注释。<PDF参考1.7>中的标准注释之一。

static final int	e_Widget = 20
	注释类型：小组件注释。<PDF参考1.7>中的标准注释之一。更多...

详细描述

屏幕注释指定页面上可以播放媒体剪辑的区域。它还作为可以触发动作的对象。通常，演出动作被设置给屏幕注释，以便屏幕注释可以用于播放媒体剪辑。
类com.foxit.sdk.pdf.annots.Screen 派生自Annot ，并提供获取/设置链接注释属性和重置屏幕注释外观流的函数。屏幕注释的外观流用于打印（如果可能）以及当相关媒体剪辑未播放时。

注解: 对于新创建的屏幕注释，它没有边框信息和边框颜色。

参见: Annot

构造及析构函数说明

◆ Screen()

com.foxit.sdk.pdf.annots.Screen.Screen ( Annot annot )

构造函数，使用父类对象。

参数

[in] annot 父类对象。

成员函数说明

◆ delete()

synchronized void com.foxit.sdk.pdf.annots.Screen.delete ( )

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

返回: 无。

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

重载 com.foxit.sdk.pdf.annots.Annot .

◆ getAction()

Action com.foxit.sdk.pdf.annots.Screen.getAction ( ) throws com.foxit.sdk.PDFException

获取动作。

此函数不能用于获取用作附加动作的动作。如果用户想要获取任何附加动作，请参考类com.foxit.sdk.pdf.actions.AdditionalAction 了解更多详细信息。

返回: 接收动作数据的动作对象。如果返回的动作对象的函数 actions.Action.isEmpty 的返回值为true，那意味着没有动作。

◆ getBitmap()

Bitmap com.foxit.sdk.pdf.annots.Screen.getBitmap ( ) throws com.foxit.sdk.PDFException

从当前屏幕注释获取位图。

返回: 位图对象。如果返回的位图对象的函数common.Bitmap.isEmpty 的返回值为true，那意味着当前屏幕注释没有位图。

◆ getMKDict()

PDFDictionary com.foxit.sdk.pdf.annots.Screen.getMKDict ( ) throws com.foxit.sdk.PDFException

获取外观特征字典（也称为"MK"字典）。

如果此字典未设置给屏幕注释（包括当前注释），请调用函数objects.PDFObject.release （从com.foxit.sdk.pdf.objects.PDFDictionary 的父类继承）来释放它。

返回: 表示"MK"字典的PDF字典。如果没有"MK"条目或发生任何错误，此函数将返回null。

◆ getOpacity()

float com.foxit.sdk.pdf.annots.Screen.getOpacity ( ) throws com.foxit.sdk.PDFException

获取不透明度值。

此属性对注释的外观有影响。

返回: 不透明度值。有效范围：0.0到1.0。 0.0表示完全透明，1.0表示完全不透明。

◆ getRotation()

int com.foxit.sdk.pdf.annots.Screen.getRotation ( ) throws com.foxit.sdk.PDFException

获取用于当前屏幕注释外观的图像旋转。

返回: 图像的旋转值。请参考从com.foxit.sdk.common.Constants.e_Rotation0 开始的值，这将是这些值中的一个。

◆ getTitle()

String com.foxit.sdk.pdf.annots.Screen.getTitle ( ) throws com.foxit.sdk.PDFException

获取当前屏幕注释的标题。

返回: 标题字符串。

◆ removeAction()

void com.foxit.sdk.pdf.annots.Screen.removeAction ( ) throws com.foxit.sdk.PDFException

移除动作。

此函数不能用于移除用作附加动作的动作。如果用户想要移除任何附加动作，请参考类com.foxit.sdk.pdf.actions.AdditionalAction 了解更多详细信息。

返回: 无。

◆ setAction()

void com.foxit.sdk.pdf.annots.Screen.setAction ( Action action ) throws com.foxit.sdk.PDFException

设置动作。

此函数不能用于设置用作附加动作的动作。如果用户想要设置任何附加动作，请参考类com.foxit.sdk.pdf.actions.AdditionalAction 了解更多详细信息。

参数

[in] action 要设置的新动作。它应该是有效的。目前只支持以下类型作为新动作：
com.foxit.sdk.pdf.actions.Action.e_TypeGoto 、 com.foxit.sdk.pdf.actions.Action.e_TypeURI 、 com.foxit.sdk.pdf.actions.Action.e_TypeJavaScript 、 com.foxit.sdk.pdf.actions.Action.e_TypeNamed 、 com.foxit.sdk.pdf.actions.Action.e_TypeGoToR 、 com.foxit.sdk.pdf.actions.Action.e_TypeGoToE 、 com.foxit.sdk.pdf.actions.Action.e_TypeSubmitForm 、 com.foxit.sdk.pdf.actions.Action.e_TypeResetForm 、 com.foxit.sdk.pdf.actions.Action.e_TypeHide 、 com.foxit.sdk.pdf.actions.Action.e_TypeLaunch 、 com.foxit.sdk.pdf.actions.Action.e_TypeImportData 、 com.foxit.sdk.pdf.actions.Action.e_TypeRendition 。

返回: 无。

◆ setImage()

void com.foxit.sdk.pdf.annots.Screen.setImage	(	Image	image,
		int	frame_index,
		int	compress
	)		throws com.foxit.sdk.PDFException

为当前屏幕注释设置图像，使用指定的帧索引。

输入图像可能包含多个帧，只有图像的一个帧可以设置给当前屏幕注释。
如果用户希望效果显示在注释的外观中，请在此函数后调用函数 Annot.resetAppearanceStream 。

参数

[in]	image	图像。其中一个帧将被设置给当前屏幕。此图像至少包含一个帧，且图像类型不应为 com.foxit.sdk.common.Image.e_Unknown 。
[in]	frame_index	帧索引。有效范围：从0到（count-1）。 count由函数common.Image.getFrameCount 返回。
[in]	compress	用于压缩图像数据的压缩算法类型。目前，它只支持2个有效值： 0：不压缩。 1：执行默认压缩。

返回: 无。

◆ setMKDict()

void com.foxit.sdk.pdf.annots.Screen.setMKDict ( PDFDictionary dict ) throws com.foxit.sdk.PDFException

设置外观特征字典（也称为"MK"字典）。

参数

[in] dict 表示要设置的新"MK"字典的PDF字典。用户在将其设置给屏幕注释后不应释放此字典。

◆ setOpacity()

void com.foxit.sdk.pdf.annots.Screen.setOpacity ( float opacity ) throws com.foxit.sdk.PDFException

设置不透明度值。

此属性对注释的外观有影响。如果用户希望效果显示在注释的外观中，请在此函数后调用函数Annot.resetAppearanceStream 。

参数

[in] opacity 新的不透明度值。有效范围：0.0到1.0。 0.0表示完全透明，1.0表示完全不透明。

返回: 无。

◆ setRotation()

void com.foxit.sdk.pdf.annots.Screen.setRotation ( int rotate ) throws com.foxit.sdk.PDFException

设置用于当前屏幕注释外观的图像旋转。

此属性对注释的外观有影响。如果用户希望效果显示在注释的外观中，请在此函数后调用函数Annot.resetAppearanceStream 。

参数

[in] rotate 旋转值。请参考从com.foxit.sdk.common.Constants.e_Rotation0 开始的值，这应该是这些值中的一个，除了com.foxit.sdk.common.Constants.e_RotationUnknown 。

返回: 无。

◆ setTitle()

void com.foxit.sdk.pdf.annots.Screen.setTitle ( String title ) throws com.foxit.sdk.PDFException

设置当前屏幕注释的标题。

参数

[in] title 要设置的标题字符串。

返回: 无。

Public 成员函数

额外继承的成员函数

详细描述

构造及析构函数说明

◆ Screen()

成员函数说明

◆ delete()

◆ getAction()

◆ getBitmap()

◆ getMKDict()

◆ getOpacity()

◆ getRotation()

◆ getTitle()

◆ removeAction()

◆ setAction()

◆ setImage()

◆ setMKDict()

◆ setOpacity()

◆ setRotation()

◆ setTitle()