intarsys PDF library API

de.intarsys.pdf.pd
Class PDAFTextField

java.lang.Object
  extended by de.intarsys.pdf.cos.COSBasedObject
      extended by de.intarsys.pdf.pd.PDObject
          extended by de.intarsys.pdf.pd.PDAcroFormNode
              extended by de.intarsys.pdf.pd.PDAcroFormField
                  extended by de.intarsys.pdf.pd.PDAFTextField
All Implemented Interfaces:
ICOSObjectListener, IAdditionalActionSupport, IAttributeSupport

public class PDAFTextField
extends PDAcroFormField

A logical text field within an AcroForm.


Nested Class Summary
static class PDAFTextField.MetaClass
          The meta class implementation
 
Field Summary
static PDAFTextField.MetaClass META
          The meta class instance
 
Fields inherited from class de.intarsys.pdf.pd.PDAcroFormField
ACROFORMFIELD_ACTION_TRIGGERS, ALIGNMENT_CENTER, ALIGNMENT_LEFT, ALIGNMENT_RIGHT, CN_FT_Btn, CN_FT_Ch, CN_FT_Sig, CN_FT_Tx, DK_DS, DK_DV, DK_Ff, DK_FT, DK_Kids, DK_MaxLen, DK_Parent, DK_RV, DK_T, DK_TM, DK_TU, DK_V
 
Fields inherited from class de.intarsys.pdf.pd.PDAcroFormNode
DK_DA, DK_DR, DK_Encoding, DK_Font, DK_Q
 
Fields inherited from class de.intarsys.pdf.pd.PDObject
DK_Subtype, DK_Type
 
Fields inherited from interface de.intarsys.pdf.pd.IAdditionalActionSupport
DK_AA
 
Method Summary
 COSName cosGetExpectedFieldType()
          The AcroForm field type expected for this.
 String getDefaultValueString()
          The value from cosGetDefaultValue() converted to a String
 String getValueString()
          The value from cosGetValue() converted to a String
 boolean isTypeTx()
          Return true if this is a text field.
 void reset()
          Reset this to its default value.
 void setDefaultValue(String value)
          Assign a new default value.
 void setValueString(String value)
          Set the value of this.
 
Methods inherited from class de.intarsys.pdf.pd.PDAcroFormField
addAnnotation, addField, basicGetFieldFlags, basicSetFieldFlags, copy, cosGetDefaultValue, cosGetFieldType, cosGetValue, cosSetValue, dispose, getAcroForm, getAdditionalActions, getAlternateFieldName, getAnyAnnotation, getFieldFlags, getGenericChildren, getGenericParent, getKids, getLocalName, getLocalName, getLogicalParent, getLogicalRoot, getMaxLen, getParent, getQualifiedName, getQualifiedName, getSupportedTriggerEvents, invalidateCaches, isAlignmentCenter, isAlignmentLeft, isAlignmentRight, isAnnotation, isComb, isDoNotScroll, isMultiline, isNoExport, isReadOnly, isTypeBtn, isTypeCh, isTypeSig, removeField, setAdditionalActions, setAlignmentCenter, setAlignmentLeft, setAlignmentRight, setAlternateFieldName, setComb, setDoNotScroll, setLocalName, setMaxLength, setMultiline, setNoExport, setReadOnly, setValueStrings, toString
 
Methods inherited from class de.intarsys.pdf.pd.PDAcroFormNode
canonicalize, collectLeafFields, getAnnotation, getAnnotations, getDefaultAppearanceContent, getDefaultAppearanceFont, getDefaultAppearanceFontColor, getDefaultAppearanceFontName, getDefaultAppearanceFontSize, getField, getField, getQuadding, setDefaultAppearanceContent, setDefaultAppearanceFont, setDefaultAppearanceFontColor, setDefaultAppearanceFontSize, setQuadding
 
Methods inherited from class de.intarsys.pdf.pd.PDObject
cosGetFieldDescendant, cosGetFieldInheritable, cosGetFieldInherited, cosGetSubtype, cosGetType, cosRemoveFieldInheritable, cosSetFieldInheritable, cosSetSubtype, cosSetType, getDoc, setGenericParent
 
Methods inherited from class de.intarsys.pdf.cos.COSBasedObject
changed, cosGetArray, cosGetDict, cosGetDoc, cosGetField, cosGetObject, cosGetStream, cosHasField, cosRemoveField, cosSetField, getAttribute, getFieldBoolean, getFieldDate, getFieldFixed, getFieldFixedArray, getFieldInt, getFieldMLString, getFieldString, removeAttribute, setAttribute, setFieldBoolean, setFieldFixed, setFieldInt, setFieldMLString, setFieldName, setFieldObject, setFieldString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

META

public static final PDAFTextField.MetaClass META
The meta class instance

Method Detail

cosGetExpectedFieldType

public COSName cosGetExpectedFieldType()
Description copied from class: PDAcroFormField
The AcroForm field type expected for this.

Specified by:
cosGetExpectedFieldType in class PDAcroFormField
Returns:
The AcroForm field type expected for this.

setValueString

public void setValueString(String value)
Description copied from class: PDAcroFormField
Set the value of this.

Overrides:
setValueString in class PDAcroFormField
Parameters:
value - The new value of this, represented by a String.

setDefaultValue

public void setDefaultValue(String value)
Description copied from class: PDAcroFormField
Assign a new default value. The default value is used if no value (/V) is available.

Overrides:
setDefaultValue in class PDAcroFormField
Parameters:
value - The new default value.

getValueString

public String getValueString()
Description copied from class: PDAcroFormField
The value from cosGetValue() converted to a String

Overrides:
getValueString in class PDAcroFormField
Returns:
The value from cosGetValue() converted to a String

getDefaultValueString

public String getDefaultValueString()
Description copied from class: PDAcroFormField
The value from cosGetDefaultValue() converted to a String

Overrides:
getDefaultValueString in class PDAcroFormField
Returns:
The value from cosGetDefaultValue() converted to a String

isTypeTx

public boolean isTypeTx()
Description copied from class: PDAcroFormField
Return true if this is a text field.

"Tx" means this is a text style object.

Overrides:
isTypeTx in class PDAcroFormField
Returns:
Return true if this is a field of type "Tx".

reset

public void reset()
Description copied from class: PDAcroFormField
Reset this to its default value.

Overrides:
reset in class PDAcroFormField

intarsys PDF library API

Copyright © 2006 intarsys consulting GmbH. All Rights Reserved.