com.compdfkit.core.annotation.form

Class CPDFTextWidget

java.lang.Object

com.compdfkit.core.annotation.CPDFAnnotation

com.compdfkit.core.annotation.form.CPDFWidget

com.compdfkit.core.annotation.form.CPDFTextWidget

public class CPDFTextWidget
extends CPDFWidget

A text form field in a PDF form. Allows the user to enter custom text.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CPDFTextWidget.TextFiledSpecial Types of text field.
static class	CPDFTextWidget.TPDFTextWidgetAttr

Nested classes/interfaces inherited from class com.compdfkit.core.annotation.form.CPDFWidget

CPDFWidget.BorderStyle, CPDFWidget.CheckStyle, CPDFWidget.WidgetType

Nested classes/interfaces inherited from class com.compdfkit.core.annotation.CPDFAnnotation

CPDFAnnotation.AppearanceType, CPDFAnnotation.BorderEffectIntensity, CPDFAnnotation.CPDFBorderEffectType, CPDFAnnotation.MarkState, CPDFAnnotation.MediaSourceType, CPDFAnnotation.ReviewState, CPDFAnnotation.Type

Field Summary

Fields inherited from class com.compdfkit.core.annotation.CPDFAnnotation

index

Method Summary

Modifier and Type	Method and Description
void	applyAnnotationAttr(CPDFAnnotationUndoAttr annotationAttr)
CPDFAnnotationUndoAttr	getAnnotationAttr()
int	getFontColor() Gets the font color of text content in TextField.
java.lang.String	getFontName() Gets the text content font in TextField, get the font type in CPDFTextAttribute.FontNameHelper.FontType according to font names.
float	getFontSize() Gets the font size of text content in TextField.
java.lang.String	getText() Gets the text content in TextField.
CPDFTextAlignment	getTextAlignment() Gets the the text alignment in TextField, more: CPDFTextAlignment
CPDFTextWidget.TextFiledSpecial	getTextFieldSpecial() Gets the content format of TextField, format type:CPDFTextWidget.TextFiledSpecial
boolean	isMultiLine() Whether to display multiline PDF text fields.
boolean	isPassword() Whether the TextField content display password, password :*****
boolean	resetForm() Resets TextField forms, content of TextField is cleared up
boolean	setFontColor(int color) Sets the font color of text content in TextField.
boolean	setFontName(java.lang.String fontName) Sets the font format of text content, get the font name byCPDFTextAttribute.FontNameHelper Such asCPDFTextAttribute.FontNameHelper#obtainFontName(CPDFTextAttribute.FontNameHelper.FontType, boolean, boolean)
boolean	setFontSize(float fontsize) Sets the font size of text content in TextField.
boolean	setMultiLine(boolean isMultiLine) Sets to display multiline PDF text fields.
boolean	setText(java.lang.String text) Sets the text content in TextField.
boolean	setTextAlignment(CPDFTextAlignment alignment) Sets the text alignment in TextField, more: CPDFTextAlignment
boolean	setTextFieldSpecial(boolean isDateSpecial) Sets the content format of TextField, format type: CPDFTextWidget.TextFiledSpecial

Methods inherited from class com.compdfkit.core.annotation.form.CPDFWidget

clearBorderColor, clearFillColor, getBorderColor, getBorderStyles, getBorderWidth, getCheckStyle, getFieldFlag, getFieldName, getFieldType, getFillAlpha, getFillColor, getRect, getWidgetType, isReadOnly, setBorderColor, setBorderStyles, setBorderWidth, setCheckStyle, setFieldFlag, setFieldName, setFieldType, setFillAlpha, setFillColor, setReadOnly, setRect, updateAp, updateAp

Methods inherited from class com.compdfkit.core.annotation.CPDFAnnotation

addToPage, close, createReplyAnnotation, disableListenAttrChanged, enableListenAttrChanged, equal, equal, getAllReplyAnnotations, getAnnotIndexFromNative, getAnnotPtr, getAppearance, getAppearanceByPixel, getApRotation, getBordEffectIntensity, getBordEffectType, getContent, getCreationDate, getFlags, getMarkedAnnotState, getName, getRecentlyModifyDate, getReviewAnnotState, getRotateRectPoint, getRotation, getSourceRect, getTitle, getType, getVertices, hasAp, isAllowCorrectAnnotationAp, isHidden, isLocked, isValid, moveAnnotIndex, removeAp, removeFromPage, removeFromPageIncludeReplyAnnot, setAllowCorrectAnnotationAp, setAnnotTop, setBordEffectIntensity, setBordEffectType, setContent, setCreationDate, setFlags, setHidden, setLocked, setMarkedAnnotState, setName, setOnAnnotationChangedListener, setRecentlyModifyDate, setReviewAnnotState, setRotation, setSourceRect, setTitle, setVertices, updateApWithBitmap, updateApWithImage

Methods inherited from class java.lang.Object

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

Method Detail

setText

public boolean setText(java.lang.String text)

Sets the text content in TextField.

Parameters:

text - Text content.

Returns:

Returns whether to successfully set the text content in TextField.

getText

public java.lang.String getText()

Gets the text content in TextField.

Returns:

Returns the text content in TextField.

isMultiLine

public boolean isMultiLine()

Whether to display multiline PDF text fields.

Returns:

Returns whether to display multiline PDF text fields.

setMultiLine

public boolean setMultiLine(boolean isMultiLine)

Sets to display multiline PDF text fields.

Parameters:

isMultiLine - Whether to display multiline PDF text fields.

Returns:

Returns whether to successfully display multiline PDF text fields.

isPassword

public boolean isPassword()

Whether the TextField content display password, password :*****

Returns:

Returns whether the TextField content display password.

setFontName

public boolean setFontName(java.lang.String fontName)

Sets the font format of text content, get the font name byCPDFTextAttribute.FontNameHelper Such asCPDFTextAttribute.FontNameHelper#obtainFontName(CPDFTextAttribute.FontNameHelper.FontType, boolean, boolean)

Parameters:

fontName - Font name of text.

Returns:

Whether to successfully set the text content font in TextField.

getFontName

public java.lang.String getFontName()

Gets the text content font in TextField, get the font type in CPDFTextAttribute.FontNameHelper.FontType according to font names. Whether the font is italic according to font namesCPDFTextAttribute.FontNameHelper#isItalic(String), Whether to be boldCPDFTextAttribute.FontNameHelper#isBold(String)

Returns:

Returns font names in TextField

setFontSize

public boolean setFontSize(float fontsize)

Sets the font size of text content in TextField.

Parameters:

fontsize - Font size.

Returns:

Returns whether to successfully set the font size of text.

getFontSize

public float getFontSize()

Gets the font size of text content in TextField.

Returns:

Returns the font size of text content in TextField.

setFontColor

public boolean setFontColor(int color)

Sets the font color of text content in TextField.

Parameters:

color - Text color.

Returns:

Returns whether to set text color successfully.

getFontColor

public int getFontColor()

Gets the font color of text content in TextField.

Returns:

Returns the font color of text content in TextField.

setTextAlignment

public boolean setTextAlignment(CPDFTextAlignment alignment)

Sets the text alignment in TextField, more: CPDFTextAlignment

Parameters:

alignment - Alignment.

Returns:

Returns whether to successfully set the text alignment.

getTextAlignment

public CPDFTextAlignment getTextAlignment()

Gets the the text alignment in TextField, more: CPDFTextAlignment

Returns:

Returns text alignment.

setTextFieldSpecial

public boolean setTextFieldSpecial(boolean isDateSpecial)

Sets the content format of TextField, format type: CPDFTextWidget.TextFiledSpecial

Parameters:

isDateSpecial - Whether to be date format.

Returns:

Returns whether to successfully set content format of TextField.

getTextFieldSpecial

public CPDFTextWidget.TextFiledSpecial getTextFieldSpecial()

Gets the content format of TextField, format type:CPDFTextWidget.TextFiledSpecial

Returns:

Returns the content format of TextField.

resetForm

public boolean resetForm()

Resets TextField forms, content of TextField is cleared up

Overrides:

resetForm in class CPDFWidget

Returns:

Returns whether to successfully reset TextField forms.

getAnnotationAttr

public CPDFAnnotationUndoAttr getAnnotationAttr()

Specified by:

getAnnotationAttr in class CPDFAnnotation

applyAnnotationAttr

public void applyAnnotationAttr(CPDFAnnotationUndoAttr annotationAttr)

Specified by:

applyAnnotationAttr in class CPDFAnnotation