com.itextpdf.forms.xfdf Documentation Differences

iText7 7.1.13 Overview Package Class Text Changes Statistics Help
Generated by
JDiff
PREV PACKAGE NEXT PACKAGE FRAMES NO FRAMES
com.itextpdf.forms.xfdf Documentation Differences

This file contains all the changes in documentation in the package com.itextpdf.forms.xfdf as colored differences. Deletions are shown ~~like this~~ , and additions are shown like this.
If no deletions or additions are shown in an entry, the HTML tags will be what has changed. The new HTML tags are shown in the differences. If no documentation existed, and then some was added in a later version, this change is noted in the appropriate class pages of differences, but the change is not shown on this page. Only changes in existing text are shown here. Similarly, documentation which was inherited from another class or interface is not shown here.
Note that an HTML error in the new documentation may cause the display of other documentation changes to be presented incorrectly. For instance, failure to close a tag will cause all subsequent paragraphs to be displayed differently.
 
  
 Class AnnotObject, ActionObject getAction() 
  
 
  
 
  
    Gets Action element, a child of OnActivation element of the link annotation. Corresponds to the A key in the link annotation dictionary. @return inner action object of annotation object 
  
 Class AnnotObject, String getAppearance() 
  
 
  
 
  
    Gets the string value of the appearance element, a child element of stamp element. Corresponds to the AP key in the annotation dictionary. Content model: Base64 encoded string. For more details see paragraph 6.5.1 in Xfdf document specification. @return String value of inner appearance element 
  
 Class AnnotObject, List getAttributes() 
  
 
  
 
  
    Gets a list of all attributes of the annotation. @return list containing all attribute objects of the annotation 
  
 Class AnnotObject, BorderStyleAltObject getBorderStyleAlt() 
  
 
  
 
  
    Gets the BorderStyleAlt element, a child of the link element. Corresponds to the Border key in the common annotation dictionary. For more details see paragraph 6.5.3 in Xfdf document specification. @return inner BorderStyleAlt object 
  
 Class AnnotObject, PdfString getContents() 
  
 
  
 
  
    Gets the string value of contents tag in Xfdf document structure. Contents is a child of caret, circle, fileattachment, freetext, highlight, ink, line, polygon, polyline, sound, square, squiggly, stamp, strikeout, text, and underline elements. Corresponds to Contents key in annotation dictionary. Content model: a string or a rich text string. For more details see paragraph 6.5.4 in Xfdf document specification. @return PdfString value of inner contents element of current annotation object 
  
 Class AnnotObject, PdfString getContentsRichText() 
  
 
  
 
  
    Gets the string value of contents-richtext tag in Xfdf document structure. It is a child of caret, circle, fileattachment, freetext, highlight, ink, line, polygon, polyline, sound, square, squiggly, stamp, strikeout, text, and underline elements. Corresponds to RC key in annotation dictionary. Content model: text string. For more details see paragraph 6.5.5 in Xfdf document specification. @return PdfString value of inner contents-richtext element of current annotation object 
  
 Class AnnotObject, String getDefaultAppearance() 
  
 
  
 
  
    Gets the string value of the defaultappearance element, a child of the caret and freetext elements. Corresponds to the DA key in the free text annotation dictionary. Content model: text string. For more details see paragraph 6.5.7 in Xfdf document specification. @return String value of inner deafultappearance element 
  
 Class AnnotObject, String getDefaultStyle() 
  
 
  
 
  
    Gets the string value of the defaultstyle element, a child of the freetext element. Corresponds to the DS key in the free text annotation dictionary. Content model : a text string. For more details see paragraph 6.5.9 in Xfdf document specification. @return String value of inner defaultstyle element 
  
 Class AnnotObject, DestObject getDestination() 
  
 
  
 
  
    Gets Dest element, a child element of link, GoTo, GoToR elements. Corresponds to the Dest key in link annotation dictionary. @return inner destination object of annotation object 
  
 Class AnnotObject, String getName() 
  
 
  
 
  
    Gets the string value of the type of annotation. Possible values: XfdfConstants.CARET, XfdfConstants.CIRCLE, XfdfConstants.FILEATTACHMENT, XfdfConstants.FREETEXT, XfdfConstants.HIGHLIGHT, XfdfConstants.INK, XfdfConstants.LINE, XfdfConstants.POLYGON, XfdfConstants.POLYLINE, XfdfConstants.SOUND, XfdfConstants.SQUARE, XfdfConstants.SQUIGGLY, XfdfConstants.STAMP, XfdfConstants.STRIKEOUT, XfdfConstants.TEXT, XfdfConstants.UNDERLINE. @return String value of the type of annotation 
  
 Class AnnotObject, AnnotObject getPopup() 
  
 
  
 
  
    Gets the popup annotation, an inner element of the annotation element. @return AnnotObject representing the inner popup annotation 
  
 Class AnnotObject, String getVertices() 
  
 
  
 
  
    Gets the string, containing vertices element, a child of the polygon and polyline elements. Corresponds to the Vertices key in the polygon or polyline annotation dictionary. For more details see paragraph 6.5.31 in Xfdf document specification. @return String value of inner vertices element 
  
 Class AnnotObject, boolean isHasPopup() 
  
 
  
 
  
    Gets the boolean, indicating if annotation has an inner popup element. @return true if annotation has an inner popup element, false otherwise 
  
 Class AnnotObject, AnnotObject setAction(ActionObject) 
  
 
  
 
  
    Sets Action element, a child of OnActivation element of the link annotation. Corresponds to the A key in the link annotation dictionary. @param action action object, an inner element of annotation object @return current annotation object 
  
 Class AnnotObject, AnnotObject setAppearance(String) 
  
 
  
 
  
    Gets the string value of the appearance element, a child element of stamp element. Corresponds to the AP key in the annotation dictionary. Content model: Base64 encoded string. @param appearance String value of inner appearance element of annotation object @return current annotation object 
  
 Class AnnotObject, AnnotObject setBorderStyleAlt(BorderStyleAltObject) 
  
 
  
 
  
    Sets the BorderStyleAlt element, a child of the link element. Corresponds to the Border key in the common annotation dictionary. @param borderStyleAlt inner BorderStyleAlt object @return current annotation object 
  
 Class AnnotObject, AnnotObject setContents(PdfString) 
  
 
  
 
  
    Sets the string value of contents tag in Xfdf document structure. @param contents string value of inner contents element @return current annotation object 
  
 Class AnnotObject, AnnotObject setContentsRichText(PdfString) 
  
 
  
 
   
     Gets 
   Sets the string value of contents-richtext tag in xfdf document structure. @param contentsRichRext rich text string value of inner contents-richtext element @return current annotation object 
  
 Class AnnotObject, AnnotObject setDefaultAppearance(String) 
  
 
  
 
  
    Sets the string value of the defaultappearance element, a child of the caret and freetext elements. Corresponds to the DA key in the free text annotation dictionary. Content model: text string. @param defaultAppearance String value of inner defaultappearance element of annotation object @return current annotation object 
  
 Class AnnotObject, AnnotObject setDefaultStyle(String) 
  
 
  
 
  
    Sets the string value of the defaultstyle element, a child of the freetext element. Corresponds to the DS key in the free text annotation dictionary. Content model : a text string. @param defaultStyle String value of inner defaultstyle element of annotation object @return current annotation object 
  
 Class AnnotObject, AnnotObject setDestination(DestObject) 
  
 
  
 
  
    Sets Dest element, a child element of link, GoTo, GoToR elements. Corresponds to the Dest key in link annotation dictionary. @param destination destination object, an inner element of annotation object @return current annotation object 
  
 Class AnnotObject, AnnotObject setHasPopup(boolean) 
  
 
  
 
  
    Sets the boolean, indicating if annotation has inner popup element. @param hasPopup a boolean indicating if annotation has inner popup element @return current annotation object 
  
 Class AnnotObject, AnnotObject setName(String) 
  
 
  
 
  
    Sets the string value of the type of annotation. Possible values: XfdfConstants.CARET, XfdfConstants.CIRCLE, XfdfConstants.FILEATTACHMENT, XfdfConstants.FREETEXT, XfdfConstants.HIGHLIGHT, XfdfConstants.INK, XfdfConstants.LINE, XfdfConstants.POLYGON, XfdfConstants.POLYLINE, XfdfConstants.SOUND, XfdfConstants.SQUARE, XfdfConstants.SQUIGGLY, XfdfConstants.STAMP, XfdfConstants.STRIKEOUT, XfdfConstants.TEXT, XfdfConstants.UNDERLINE. @param name String value of the type of annotation @return annotation object with set name 
  
 Class AnnotObject, AnnotObject setPopup(AnnotObject) 
  
 
  
 
  
    Sets the popup annotation, an inner element of the annotation element. @param popup annotation object representing inner popup annotation @return current annotation object 
  
 Class AnnotObject, AnnotObject setVertices(String) 
  
 
  
 
  
    Sets the string, containing vertices element, a child of the polygon and polyline elements. Corresponds to the Vertices key in the polygon or polyline annotation dictionary. @param vertices String value of inner vertices element @return current annotation object 
   
  
 Class FObject, String getHref() 
  
 
  
 
  
    Gets the name of the source or target file. @return the name of the source or target file 
  
 Class FObject, FObject setHref(String) 
  
 
  
 
  
    Sets the name of the source or target file. @param href the name of the source or target file @return current f object 
   
  
 Class FieldObject, String getName() 
  
 
  
 
  
    Gets the string value of the name attribute of the field element. Corresponds to the T key in the field dictionary. In a hierarchical form field, the name is the partial field name. For more details see paragraph 6.3.2.2 in XFDF document specification. @return String value of field name attribute 
  
 Class FieldObject, FieldObject getParent() 
  
 
  
 
  
    Gets a parent field of current field. @return parent field object of the current field 
  
 Class FieldObject, String getRichTextValue() 
  
 
  
 
  
    Gets the string representation of the value-richtext element, a child of the field element and contains the field's value formatted as a rich text string. Corresponds to the RV key in the variable text field dictionary. Content model: text strign or rich text string. For more details see paragraph 6.3.4 in XFDF document specification. @return String representation of inner value-richtext element of the field 
  
 Class FieldObject, String getValue() 
  
 
  
 
  
    Gets the string representation of the value element, a child of the field element and contains the field's value, whose format may vary depending on the field type. Corresponds to the V key in the FDF field dictionary. For more details see paragraph 6.3.3 in XFDF document specification. @return String representation of inner value element of the field 
  
 Class FieldObject, boolean isContainsRichText() 
  
 
  
 
  
    Gets a boolean indicating if a value-richtext element is present inside the field. @return true if a value-richtext element is present inside the field, false otherwise 
  
 Class FieldObject, void setContainsRichText(boolean) 
  
 
  
 
  
    Sets a boolean indicating if a value-richtext element is present inside the field. @param containsRichText a boolean indicating if a value-richtext element is present inside the field 
  
 Class FieldObject, void setName(String) 
  
 
  
 
  
    Sets the string value of the name attribute of the field element. Corresponds to the T key in the field dictionary. In a hierarchical form field, the name is the partial field name. @param name String value of field name attribute 
  
 Class FieldObject, void setParent(FieldObject) 
  
 
  
 
  
    Sets a parent field of current field. @param parent field object that is a parent of the current field 
  
 Class FieldObject, void setRichTextValue(String) 
  
 
  
 
  
    Sets the string representation of the value-richtext element, a child of the field element and contains the field's value formatted as a rich text string. Corresponds to the RV key in the variable text field dictionary. Content model: text 
     strign 
   string or rich text string. @param richTextValue String representation of inner value-richtext element of the field 
  
 Class FieldObject, void setValue(String) 
  
 
  
 
  
    Sets the string representation of the value element, a child of the field element and contains the field's value, whose format may vary depending on the field type. Corresponds to the V key in the FDF field dictionary. @param value String representation of inner value element of the field 
   
  
 Class FieldsObject, FieldsObject addField(FieldObject) 
  
 
  
 
  
    Adds a new field to the list. @param field FieldObject containing the info about the form field. @return current fields object 
  
 Class FieldsObject, List getFieldList() 
  
 
  
 
  
    Gets a list of children 
     fields 
   fields @return List containing all children field objects 
   
  
 Class FitObject, float getBottom() 
  
 
  
 
  
    Gets a float vertical coordinate positioned at the bottom edge of the window. @return bottom vertical coordinate 
  
 Class FitObject, float getLeft() 
  
 
  
 
  
    Gets a float horizontal coordinate positioned at the left edge of the window. @return left horizontal coordinate 
  
 Class FitObject, PdfObject getPage() 
  
 
  
 
  
    Gets the PdfObject representing the page displayed by current Fit element. Attribute of Fit, FitB, FitBH, FitBV, FitH, FitR, FitV, XYZ elements. @return page of the current Fit element 
  
 Class FitObject, float getRight() 
  
 
  
 
  
    Gets a float horizontal coordinate positioned at the right edge of the window. @return right horizontal coordinate 
  
 Class FitObject, float getTop() 
  
 
  
 
  
    Gets a float vertical coordinate positioned at the top edge of the window. @return top vertical coordinate 
  
 Class FitObject, float getZoom() 
  
 
  
 
  
    Gets a float representing the zoom ratio. Attribute of XYZ object. @return zoom ratio value 
  
 Class FitObject, FitObject setBottom(float) 
  
 
  
 
  
    Sets a float vertical coordinate positioned at the bottom edge of the window. @param bottom vertical coordinate value @return current fit object 
  
 Class FitObject, FitObject setLeft(float) 
  
 
  
 
  
    Sets a float horizontal coordinate positioned at the left edge of the window. @param left horizontal coordinate value @return current fit object 
  
 Class FitObject, FitObject setRight(float) 
  
 
  
 
  
    Sets a float horizontal coordinate positioned at the right edge of the window. @param right horizontal coordinate @return current fit object 
  
 Class FitObject, FitObject setTop(float) 
  
 
  
 
  
    Sets a float vertical coordinate positioned at the top edge of the window. @param top vertical coordinate value @return current fit object 
  
 Class FitObject, FitObject setZoom(float) 
  
 
  
 
  
    Sets a float representing the zoom ratio. Attribute of XYZ object. @param zoom ratio value @return current fit object 
   
  
 Class IdsObject, String getModified() 
  
 
  
 
  
    Gets the string value of the unique identifier for the modified version of the pdf and corresponding xfdf document. The modified attribute corresponds to the changing identifier that is based on the file's contents at the time it was last updated. The value shall be a hexadecimal number. @return the unique identifier value 
  
 Class IdsObject, String getOriginal() 
  
 
  
 
  
    Gets the string value of the permanent identifier which is based on the contents of the file at the time it was originally created. This value does not change when the file is incrementally updated. The value shall be a hexadecimal number. @return the permanent identifier value 
  
 Class IdsObject, IdsObject setModified(String) 
  
 
  
 
  
    Sets the string value of the unique identifier for the modified version of the pdf and corresponding xfdf document. The modified attribute corresponds to the changing identifier that is based on the file's contents at the time it was last updated. The value shall be a hexadecimal number. A common value for this is an MD5 checksum. @param modified the unique identifier value @return current ids object 
  
 Class IdsObject, IdsObject setOriginal(String) 
  
 
  
 
  
    Sets the string value of the permanent identifier which is based on the contents of the file at the time it was originally created. This value does not change when the file is incrementally updated. The value shall be a hexadecimal number. A common value for this is an MD5 checksum. @param original the permanent identifier value @return current ids object 
   
  
 Class XfdfObject, FObject getF() 
  
 
  
 
  
    Gets the f element, child of the xfdf element. Corresponds to the F key in the file dictionary. @return the f element 
  
 Class XfdfObject, FieldsObject getFields() 
  
 
  
 
  
    Gets the fields element, a child of the xfdf element and is the container for form field elements. @return the fields element 
  
 Class XfdfObject, IdsObject getIds() 
  
 
  
 
  
    Gets the ids element, child of the xfdf element. Corresponds to the ID key in the file dictionary. @return the ids element 
  
 Class XfdfObject, void setF(FObject) 
  
 
  
 
  
    Sets 
     the 
   f element, child of the xfdf element. Corresponds to the F key in the file dictionary. @param f element 
  
 Class XfdfObject, void setFields(FieldsObject) 
  
 
  
 
  
    Sets 
     the 
   fields element, a child of the xfdf element and is the container for form field elements. @param fields element 
  
 Class XfdfObject, void setIds(IdsObject) 
  
 
  
 
  
    Sets 
     the 
   ids element, child of the xfdf element. Corresponds to the ID key in the file dictionary. @param ids element