WidgetAnnotation

遗产： java.lang.Object, com.aspose.pdf.BaseParagraph, com.aspose.pdf.Annotation

public class WidgetAnnotation extends Annotation

表示小部件注释的类。

构造函数

构造函数	描述
WidgetAnnotation(IDocument doc)	创建注释（用于生成器）

方法

方法	描述
accept(AnnotationSelector visitor)	接待来访者。
changeAfterResize(Matrix transform)	根据矩阵变换更新参数和外观。
createAnnotation(IPdfObject annotEngineObj, Page page)	仅供内部使用
deepClone()	克隆此实例。
equals(Object arg0)
flatten()	直接在页面上放置注释内容，注释对象将被移除。
getActiveState()	获取当前注释外观状态。
getAlignment()	注释对齐。
getAnnotationActions()	获取注解动作。
getAnnotationType()	获取注解类型。
getAppearance()	获取注解的外观字典。
getBorder()	获取注释边框特征。
getCharacteristics()	获取注解特征。
getClass()
getColor()	获取注释颜色。
getContents()	获取注释文本。
getDefaultAppearance()	获取字段的默认外观。
getEngineDict()	仅限内部
getEngineObj()	仅供内部使用
getExportable()	获取字段的可导出标志。
getFlags()	获取注释的标志。
getFullName()	获取注释的完整限定名称。
getHeight()	获取注释的高度。
getHighlighting()	注释突出显示模式。
getHorizontalAlignment()	获取段落的水平对齐方式
getHorizontalAlignment_Annotation_New()	获取或设置注释的文本对齐方式。
getHyperlink()	获取片段超链接（用于 pdf 生成器）。
getMargin()	获取段落的外边距（用于生成 pdf）
getModified()	获取最近修改注释的日期和时间。
getModifiedInternal()	获取最近修改注释的日期和时间。
getName()	获取页面上的注释名称。
getNormalAppearance()	获得正常外观。
getOnActivated()	获取激活注释时应执行的操作。
getPage()	获取与此注释关联的页面对象。
getPageIndex()	获取包含注释的页面索引。
getPageIndex(Annotation annotation)	获取包含注释的页面索引。
getParent()	获取注解父级。
getPdfActions()	获取注释操作列表。
getReadOnly()	获取字段的只读状态。
getRect()	获取注释矩形。
getRectangle(boolean considerRotation)	返回考虑页面旋转的注释矩形。
getRequired()	获取字段的必需状态。
getStates()	获取标注的外观字典。
getTextHorizontalAlignment()	获取注释的文本对齐方式。
getVerticalAlignment()	获取段落的垂直对齐方式
getWidth()	获取注释的宽度。
getZIndex()	获取一个 int 值，该值指示图形的 Z 顺序。
hashCode()
initialize(IDocument doc)	实例初始化
isFirstParagraphInColumn()	获取或设置一个 bool 值，该值指示该段落是否位于下一列。
isInLineParagraph()	获取一个段落是内联的。
isInNewPage()	获取强制此段落在新页面生成的 bool 值。
isKeptWithNext()	获取一个布尔值，该值指示当前段落是否与下一段保持在同一页面中。
isUpdateAppearanceOnConvert()	如果为真，注释外观将在将 PF 文档转换为图像之前更新。
isUseFontSubset()	如果此属性设置为 true，字体将作为子集添加到文档中。
notify()
notifyAll()
setActiveState(String value)	设置当前注释外观状态。
setAlignment(int value)	注释对齐。
setBorder(Border value)	设置注释边框特征。
setColor(Color value)	设置注释颜色。
setContents(String value)	设置注释文本。
setDefaultAppearance(DefaultAppearance value)	设置字段的默认外观。
setExportable(boolean value)	设置字段的只读状态。
setFirstParagraphInColumn(boolean value)	获取或设置一个 bool 值，该值指示该段落是否位于下一列。
setFlags(int value)	设置注释的标志。
setHeight(double value)	设置注释的高度。
setHighlighting(int value)	注释突出显示模式。
setHorizontalAlignment(int value)	设置段落的水平对齐方式
setHorizontalAlignment_Annotation_New(int value)	获取或设置注释的文本对齐方式。
setHyperlink(Hyperlink value)	设置超链接（用于 pdf 生成器）。
setInLineParagraph(boolean value)	设置一个段落是内联的。
setInNewPage(boolean value)	设置一个布尔值，强制此段落在新页面生成。
setKeptWithNext(boolean value)	设置一个布尔值，指示当前段落是否与下一段保持在同一页面中。
setMargin(MarginInfo value)	设置段落的外边距（用于生成 pdf）
setModified(Date value)	设置最近修改注释的日期和时间。
setModifiedInternal(System.DateTime value)	设置最近修改注释的日期和时间。
setName(String value)	在页面上设置注释名称。
setOnActivated(PdfAction value)	设置激活注释时应执行的操作。
setReadOnly(boolean value)	设置字段的只读状态。
setRect(Rectangle value)	设置注释矩形。
setRequired(boolean value)	设置字段的只读状态。
setTextHorizontalAlignment(int value)	设置注释的文本对齐方式。
setUpdateAppearanceOnConvert(boolean value)	如果为真，注释外观将在将 PF 文档转换为图像之前更新。
setUseFontSubset(boolean value)	如果此属性设置为 true，字体将作为子集添加到文档中。
setVerticalAlignment(int value)	设置段落的垂直对齐方式
setWidth(double value)	设置注释的宽度。
setZIndex(int value)	设置一个指示图形 Z 顺序的 int 值。
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

WidgetAnnotation(IDocument doc)

public WidgetAnnotation(IDocument doc)

创建注释（用于生成器）

参数：

范围	类型	描述
doc	IDocument	将在其中创建注释的文档。

accept(AnnotationSelector visitor)

public void accept(AnnotationSelector visitor)

接待来访者。

参数：

范围	类型	描述
visitor	AnnotationSelector	接待来访者。

changeAfterResize(Matrix transform)

public void changeAfterResize(Matrix transform)

根据矩阵变换更新参数和外观。

参数：

范围	类型	描述
transform	Matrix	用于转换（调整大小）的矩阵。

createAnnotation(IPdfObject annotEngineObj, Page page)

public static Annotation createAnnotation(IPdfObject annotEngineObj, Page page)

仅供内部使用

从描述注释的 PDF 对象初始化注释。

参数：

范围	类型	描述
annotEngineObj	IPdfObject	描述注释的 PDF 对象
page	Page	页面对象

退货： Annotation 创建适当类型的注释对象

deepClone()

public Object deepClone()

克隆此实例。虚拟方法。始终返回空值。

退货： java.lang.Object - 空

equals(Object arg0)

public boolean equals(Object arg0)

参数：

范围	类型	描述
arg0	java.lang.Object

退货： 布尔值

flatten()

public void flatten()

直接在页面上放置注释内容，注释对象将被移除。

getActiveState()

public String getActiveState()

获取当前注释外观状态。

退货： java.lang.String - 字符串值

getAlignment()

public int getAlignment()

注释对齐。此属性已过时。使用 getHorizontalAlignment_注解_New 代替。

退货： int - TextAlignment 元素

getAnnotationActions()

public AnnotationActionCollection getAnnotationActions()

获取注解动作。

退货： AnnotationActionCollection - AnnotationActionCollection 对象

getAnnotationType()

public int getAnnotationType()

获取注解类型。

退货： int - AnnotationType 元素

getAppearance()

public AppearanceDictionary getAppearance()

获取注解的外观字典。

退货： AppearanceDictionary AppearanceDictionary 对象

getBorder()

public Border getBorder()

获取注释边框特征。边界

退货： Border 边框对象

getCharacteristics()

public Characteristics getCharacteristics()

获取注解特征。

退货： Characteristics 特征对象

getClass()

public final native Class<?> getClass()

退货： java.lang.Class

getColor()

public Color getColor()

获取注释颜色。

退货： Color 颜色对象

getContents()

public String getContents()

获取注释文本。

退货： java.lang.String - 字符串值

getDefaultAppearance()

public DefaultAppearance getDefaultAppearance()

获取字段的默认外观。

退货： DefaultAppearance 默认外观对象

getEngineDict()

public IPdfDictionary getEngineDict()

仅限内部

退货： IPdfDictionary IPdfDictionary 对象

getEngineObj()

public IPdfObject getEngineObj()

仅供内部使用

退货： IPdfObject 内部项目

getExportable()

public boolean getExportable()

获取字段的可导出标志。

退货： boolean - 布尔值

getFlags()

public int getFlags()

获取注释的标志。

退货： int - 注释的标志

getFullName()

public String getFullName()

获取注释的完整限定名称。

退货： java.lang.String - 字符串值

getHeight()

public double getHeight()

获取注释的高度。

退货： 注释的双倍高度

getHighlighting()

public int getHighlighting()

注释突出显示模式。

退货： int - HighlightingMode 值

getHorizontalAlignment()

public int getHorizontalAlignment()

获取段落的水平对齐方式

退货： int - HorizontalAlignment 值

getHorizontalAlignment_Annotation_New()

public final int getHorizontalAlignment_Annotation_New()

获取或设置注释的文本对齐方式。

退货： int - 注释的文本对齐方式。

getHyperlink()

public Hyperlink getHyperlink()

获取片段超链接（用于 pdf 生成器）。

退货： Hyperlink - 片段超链接（用于 pdf 生成器）。

getMargin()

public MarginInfo getMargin()

获取段落的外边距（用于生成 pdf）

退货： MarginInfo - 保证金信息值

getModified()

public Date getModified()

获取最近修改注释的日期和时间。

退货： Date 最近修改注释的日期和时间。

getModifiedInternal()

public System.DateTime getModifiedInternal()

获取最近修改注释的日期和时间。

退货： com.aspose.ms.System.DateTime - 日期时间对象

getName()

public String getName()

获取页面上的注释名称。

退货： java.lang.String - 字符串值

getNormalAppearance()

public XForm getNormalAppearance()

获得正常外观。

退货： XForm 变形对象

getOnActivated()

public PdfAction getOnActivated()

获取激活注释时应执行的操作。

退货： PdfAction -PdfAction 对象

getPage()

public Page getPage()

获取与此注释关联的页面对象。

退货： Page 页面对象

getPageIndex()

public int getPageIndex()

获取包含注释的页面索引。

退货： int - 整数值

getPageIndex(Annotation annotation)

public int getPageIndex(Annotation annotation)

获取包含注释的页面索引。

参数：

范围	类型	描述
annotation	Annotation	注释对象

退货： int - 整数值

getParent()

public Field getParent()

获取注解父级。

退货： Field - 字段对象

getPdfActions()

public PdfActionCollection getPdfActions()

获取注释操作列表。

退货： PdfActionCollection PdfActionCollection 实例

getReadOnly()

public boolean getReadOnly()

获取字段的只读状态。

退货： boolean - 布尔值

getRect()

public Rectangle getRect()

获取注释矩形。

退货： Rectangle - 矩形对象

getRectangle(boolean considerRotation)

public Rectangle getRectangle(boolean considerRotation)

返回考虑页面旋转的注释矩形。

参数：

范围	类型	描述
considerRotation	boolean	如果为真，则考虑页面旋转。

退货： Rectangle - 矩形对象

getRequired()

public boolean getRequired()

获取字段的必需状态。

退货： boolean - 布尔值

getStates()

public AppearanceDictionary getStates()

获取标注的外观字典。

退货： AppearanceDictionary AppearanceDictionary 对象

getTextHorizontalAlignment()

public int getTextHorizontalAlignment()

获取注释的文本对齐方式。

退货： int - 注释的文本对齐方式。

getVerticalAlignment()

public int getVerticalAlignment()

获取段落的垂直对齐方式

退货： int - VerticalAlignment 元素

getWidth()

public double getWidth()

获取注释的宽度。

退货： double - double 值，注释的宽度。

getZIndex()

public int getZIndex()

获取一个 int 值，该值指示图形的 Z 顺序。具有较大 ZIndex 的图形将被放置在具有较小 ZIndex 的图形之上。 ZIndex 可以是负数。具有负 ZIndex 的图形将放置在页面中文本的后面。

退货： int - 整数值

hashCode()

public native int hashCode()

退货： 整数

initialize(IDocument doc)

public void initialize(IDocument doc)

实例初始化

参数：

范围	类型	描述
doc	IDocument	文档对象

isFirstParagraphInColumn()

public boolean isFirstParagraphInColumn()

获取或设置一个 bool 值，该值指示该段落是否位于下一列。默认为 false。（用于生成 pdf）

退货： boolean - 布尔值

isInLineParagraph()

public boolean isInLineParagraph()

获取一个段落是内联的。默认为 false。（用于生成 pdf）

退货： boolean - 布尔值

isInNewPage()

public boolean isInNewPage()

获取强制此段落在新页面生成的 bool 值。默认为 false。（用于生成 pdf）

退货： boolean - 布尔值

isKeptWithNext()

public boolean isKeptWithNext()

获取一个布尔值，该值指示当前段落是否与下一段保持在同一页面中。默认为 false。（用于生成 pdf）

退货： boolean - 布尔值

isUpdateAppearanceOnConvert()

public static synchronized boolean isUpdateAppearanceOnConvert()

如果为真，注释外观将在将 PF 文档转换为图像之前更新。这允许正确转换字段，但可能需要更多时间。

退货： boolean - 布尔值

isUseFontSubset()

public static synchronized boolean isUseFontSubset()

如果此属性设置为 true，字体将作为子集添加到文档中。默认值为真。

退货： boolean - 布尔值

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

setActiveState(String value)

public void setActiveState(String value)

设置当前注释外观状态。

参数：

范围	类型	描述
value	java.lang.String	字符串值

setAlignment(int value)

public void setAlignment(int value)

注释对齐。此属性已过时。使用 getHorizontalAlignment_注解_New 代替。

参数：

范围	类型	描述
value	int	TextAlignment 元素

setBorder(Border value)

public void setBorder(Border value)

设置注释边框特征。边界

参数：

范围	类型	描述
value	Border	边界值

setColor(Color value)

public void setColor(Color value)

设置注释颜色。

参数：

范围	类型	描述
value	Color	色值

setContents(String value)

public void setContents(String value)

设置注释文本。

参数：

范围	类型	描述
value	java.lang.String	字符串值

setDefaultAppearance(DefaultAppearance value)

public void setDefaultAppearance(DefaultAppearance value)

设置字段的默认外观。

参数：

范围	类型	描述
value	DefaultAppearance	DefaultAppearance 对象

setExportable(boolean value)

public void setExportable(boolean value)

设置字段的只读状态。

参数：

范围	类型	描述
value	boolean	布尔值

setFirstParagraphInColumn(boolean value)

public void setFirstParagraphInColumn(boolean value)

获取或设置一个 bool 值，该值指示该段落是否位于下一列。默认为 false。（用于生成 pdf）

参数：

范围	类型	描述
value	boolean	布尔值

setFlags(int value)

public void setFlags(int value)

设置注释的标志。

参数：

范围	类型	描述
value	int	注释的标志

setHeight(double value)

public void setHeight(double value)

设置注释的高度。

参数：

范围	类型	描述
value	double	注释的高度

setHighlighting(int value)

public void setHighlighting(int value)

注释突出显示模式。

参数：

范围	类型	描述
value	int	HighlightingMode 值

setHorizontalAlignment(int value)

public void setHorizontalAlignment(int value)

设置段落的水平对齐方式

参数：

范围	类型	描述
value	int	HorizontalAlignment 值

setHorizontalAlignment_Annotation_New(int value)

public final void setHorizontalAlignment_Annotation_New(int value)

获取或设置注释的文本对齐方式。

参数：

范围	类型	描述
value	int	注释的文本对齐方式。

setHyperlink(Hyperlink value)

public void setHyperlink(Hyperlink value)

设置超链接（用于 pdf 生成器）。

参数：

范围	类型	描述
value	Hyperlink	超链接（用于 pdf 生成器）。

setInLineParagraph(boolean value)

public void setInLineParagraph(boolean value)

设置一个段落是内联的。默认为 false。（用于生成 pdf）

参数：

范围	类型	描述
value	boolean	布尔值

setInNewPage(boolean value)

public void setInNewPage(boolean value)

设置一个布尔值，强制此段落在新页面生成。默认为 false。（用于生成 pdf）

参数：

范围	类型	描述
value	boolean	布尔值

setKeptWithNext(boolean value)

public final void setKeptWithNext(boolean value)

设置一个布尔值，指示当前段落是否与下一段保持在同一页面中。默认为 false。（用于生成 pdf）

参数：

范围	类型	描述
value	boolean	布尔值

setMargin(MarginInfo value)

public void setMargin(MarginInfo value)

设置段落的外边距（用于生成 pdf）

参数：

范围	类型	描述
value	MarginInfo	MarginInfo 对象

setModified(Date value)

public void setModified(Date value)

设置最近修改注释的日期和时间。

参数：

范围	类型	描述
value	java.util.Date	日期对象

setModifiedInternal(System.DateTime value)

public void setModifiedInternal(System.DateTime value)

设置最近修改注释的日期和时间。

参数：

范围	类型	描述
value	com.aspose.ms.System.DateTime	日期时间对象

setName(String value)

public void setName(String value)

在页面上设置注释名称。

参数：

范围	类型	描述
value	java.lang.String	字符串值

setOnActivated(PdfAction value)

public void setOnActivated(PdfAction value)

设置激活注释时应执行的操作。

参数：

范围	类型	描述
value	PdfAction	PdfAction 对象

setReadOnly(boolean value)

public void setReadOnly(boolean value)

设置字段的只读状态。

参数：

范围	类型	描述
value	boolean	布尔值

setRect(Rectangle value)

public void setRect(Rectangle value)

设置注释矩形。

参数：

范围	类型	描述
value	Rectangle	矩形值

setRequired(boolean value)

public void setRequired(boolean value)

设置字段的只读状态。

参数：

范围	类型	描述
value	boolean	布尔值

setTextHorizontalAlignment(int value)

public void setTextHorizontalAlignment(int value)

设置注释的文本对齐方式。

参数：

范围	类型	描述
value	int	注释的文本对齐方式。

setUpdateAppearanceOnConvert(boolean value)

public static synchronized void setUpdateAppearanceOnConvert(boolean value)

如果为真，注释外观将在将 PF 文档转换为图像之前更新。这允许正确转换字段，但可能需要更多时间。

参数：

范围	类型	描述
value	boolean	布尔值

setUseFontSubset(boolean value)

public static synchronized void setUseFontSubset(boolean value)

如果此属性设置为 true，字体将作为子集添加到文档中。默认值为真。

参数：

范围	类型	描述
value	boolean	布尔值

setVerticalAlignment(int value)

public void setVerticalAlignment(int value)

设置段落的垂直对齐方式

参数：

范围	类型	描述
value	int	VerticalAlignment 元素

setWidth(double value)

public void setWidth(double value)

设置注释的宽度。

参数：

范围	类型	描述
value	double	注释的宽度。

setZIndex(int value)

public void setZIndex(int value)

设置一个指示图形 Z 顺序的 int 值。具有较大 ZIndex 的图形将被放置在具有较小 ZIndex 的图形之上。 ZIndex 可以是负数。具有负 ZIndex 的图形将放置在页面中文本的后面。

参数：

范围	类型	描述
value	int	整数值

toString()

public String toString()

退货： java.lang.字符串

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

参数：

范围	类型	描述
arg0	long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

参数：

范围	类型	描述
arg0	long
arg1	int