de.intarsys.pdf.pd
Class PDWidgetAnnotation

java.lang.Object
  de.intarsys.pdf.cos.COSBasedObject
      de.intarsys.pdf.pd.PDObject
          de.intarsys.pdf.pd.PDAnnotation
              de.intarsys.pdf.pd.PDWidgetAnnotation

All Implemented Interfaces:

ICOSObjectListener, IAdditionalActionSupport, IAttributeSupport

public class PDWidgetAnnotation
extends PDAnnotation

The annotation representing a field in an AcroForm.

Nested Class Summary

static class

PDWidgetAnnotation.MetaClass The meta class implementation

Field Summary

static COSName	CN_H_I highlightning: I: Invert
static COSName	CN_H_N highlightning: N: None
static COSName	CN_H_O highlightning: O: Outline
static COSName	CN_H_P highlightning: P: Push
static COSName	CN_H_T highlightning: T: Toggle
static COSName	CN_State_Off
static COSName	CN_Subtype_Widget
static COSName	DK_H Highlighting Mode
static COSName	DK_MK
static PDWidgetAnnotation.MetaClass	META The meta class instance

Fields inherited from class de.intarsys.pdf.pd.PDAnnotation

ANNOTATION_ACTION_TRIGGERS, CN_Type_Annot, DK_A, DK_AP, DK_AS, DK_Border, DK_BS, DK_C, DK_CA, DK_Contents, DK_F, DK_IC, DK_M, DK_NM, DK_OC, DK_P, DK_Rect, DK_StructParent

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

boolean	canReceiveFocus() true if this can receive the focus in an interactive viewer.
COSObject	cosSetField(COSName name, COSObject cosObj) Set a field value in this.
void	dispose()
PDAcroFormField	getAcroFormField()
COSName	getAltAppearanceState()
PDAppearanceCharacteristics	getAppearanceCharacteristics()
COSName	getHighlightingMode()
CDSRectangle	getNormalizedRectangle() Convenience method to access a normalized copy of the receivers rectangle.
String	getSubtypeLabel() A String representation of this.
boolean	isOff()
boolean	isWidgetAnnotation() true if this is a PDWidgetAnnotation.
void	setAppearanceCharacteristics(PDAppearanceCharacteristics newAppearanceCharacteristics)
void	setHighlightingMode(COSName newHighlightingMode)
void	transform(CDSRectangle rect, CDSMatrix matrix) Change a given rectangle and matrix (belonging to a form) according to the annotations defined rotation.

Methods inherited from class de.intarsys.pdf.pd.PDAnnotation

addAction, basicGetFlags, basicSetFlags, copy, getAction, getAdditionalActions, getAppearance, getAppearanceState, getAppearanceStates, getBorderStyle, getBorderStyleName, getBorderStyleWidth, getColor, getContents, getFlags, getModified, getName, getPage, getRectangle, getSupportedTriggerEvents, invalidateCaches, isHidden, isInvisible, isLocked, isMarkupAnnotation, isNoRotate, isNoView, isNoZoom, isPrint, isReadOnly, isToggleNoView, setAction, setAdditionalActions, setAppearance, setAppearanceState, setBorderStyle, setBorderStyleName, setBorderStyleWidth, setColor, setContents, setHidden, setInvisible, setLocked, setName, setNoRotate, setNoView, setNoZoom, setPrint, setReadOnly, setRectangle, setToggleNoView, supportsPrint, toString, touch

Methods inherited from class de.intarsys.pdf.pd.PDObject

cosGetFieldDescendant, cosGetFieldInheritable, cosGetFieldInherited, cosGetSubtype, cosGetType, cosRemoveFieldInheritable, cosSetFieldInheritable, cosSetSubtype, cosSetType, getDoc, getGenericChildren, getGenericParent, setGenericParent

Methods inherited from class de.intarsys.pdf.cos.COSBasedObject

changed, cosGetArray, cosGetDict, cosGetDoc, cosGetField, cosGetObject, cosGetStream, cosHasField, cosRemoveField, 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 PDWidgetAnnotation.MetaClass META

The meta class instance

DK_H

public static final COSName DK_H

Highlighting Mode

CN_H_N

public static final COSName CN_H_N

highlightning: N: None

CN_H_I

public static final COSName CN_H_I

highlightning: I: Invert

CN_H_O

public static final COSName CN_H_O

highlightning: O: Outline

CN_H_P

public static final COSName CN_H_P

highlightning: P: Push

CN_H_T

public static final COSName CN_H_T

highlightning: T: Toggle

DK_MK

public static final COSName DK_MK

CN_Subtype_Widget

public static final COSName CN_Subtype_Widget

CN_State_Off

public static final COSName CN_State_Off

Method Detail

getAcroFormField

public PDAcroFormField getAcroFormField()

getAltAppearanceState

public COSName getAltAppearanceState()

setAppearanceCharacteristics

public void setAppearanceCharacteristics(PDAppearanceCharacteristics newAppearanceCharacteristics)

getAppearanceCharacteristics

public PDAppearanceCharacteristics getAppearanceCharacteristics()

setHighlightingMode

public void setHighlightingMode(COSName newHighlightingMode)

getHighlightingMode

public COSName getHighlightingMode()

getNormalizedRectangle

public CDSRectangle getNormalizedRectangle()

Description copied from class: PDAnnotation

Convenience method to access a normalized copy of the receivers rectangle.

Overrides:

getNormalizedRectangle in class PDAnnotation

isOff

public boolean isOff()

isWidgetAnnotation

public boolean isWidgetAnnotation()

Description copied from class: PDAnnotation

true if this is a PDWidgetAnnotation.

Overrides:

isWidgetAnnotation in class PDAnnotation

Returns:

true if this is a PDWidgetAnnotation.

canReceiveFocus

public boolean canReceiveFocus()

Description copied from class: PDAnnotation

true if this can receive the focus in an interactive viewer.

Overrides:

canReceiveFocus in class PDAnnotation

Returns:

true if this can receive the focus in an interactive viewer.

transform

public void transform(CDSRectangle rect,
                      CDSMatrix matrix)

Change a given rectangle and matrix (belonging to a form) according to the annotations defined rotation.

Parameters:

rect - The rectangle to transform

matrix - The matrix to change

getSubtypeLabel

public String getSubtypeLabel()

Description copied from class: PDAnnotation

A String representation of this.

Specified by:

getSubtypeLabel in class PDAnnotation

Returns:

A String representation of this.

dispose

public void dispose()

Overrides:

dispose in class PDAnnotation

cosSetField

public COSObject cosSetField(COSName name,
                             COSObject cosObj)

Description copied from class: COSBasedObject

Set a field value in this. The previously associated object is returned.

This method requires the base object to be a COSDictionary.

Overrides:

cosSetField in class COSBasedObject

Parameters:

name - The field to set

cosObj - The object to set in the field

Returns:

The previously associated object is returned.