org.faceless.pdf2
Class WidgetAnnotation

java.lang.Object
  extended byorg.faceless.pdf2.PDFObject
      extended byorg.faceless.pdf2.PDFMap
          extended byorg.faceless.pdf2.PDFAnnotation
              extended byorg.faceless.pdf2.WidgetAnnotation
All Implemented Interfaces:
Cloneable

public final class WidgetAnnotation
extends PDFAnnotation

The WidgetAnnotation class represents the type of annotation used to represent the visual contents of a FormElement on the page.

Since:
2.0

Method Summary
 PDFAction getAction(Event event)
          Return the action that occurs when the specified event happens to this annotation.
 PDFStyle getBackgroundStyle()
          Get the background style for this annotation.
 PDFImage getButtonImage()
          For a FormButton annotation, return the image that is drawn on the button, or null if the field is not a button or no image is specified.
 FormElement getField()
          Return the FormElement that this annotation represents on the page.
 PDFStyle getTextStyle()
          Get the text style for this widget.
 String getValue()
           Get the value of this Widget annotation - the value of the box for RadioButton and Checkbox annotations, the text on the Button for Button annotations, or null otherwise.
 void setAction(Event event, PDFAction action)
           Set an action to occur when the specified event happens to this annotation.
 void setBackgroundStyle(PDFStyle style)
          Set the background style for this annotation.
 void setButtonImage(PDFImage image)
          For FormButton annotations, set the image to display on the button.
 void setTextStyle(PDFStyle style)
          Set the text style for this annotation.
 void setValue(String value)
          Set the value of this annotation for for PushButton, RadioButton and Checkbox annotations.
 
Methods inherited from class org.faceless.pdf2.PDFAnnotation
equals, getCreationDate, getInReplyTo, getModifyDate, getPage, getRectangle, getSubject, getType, getUniqueID, isPrintable, isReadOnly, isVisible, setInReplyTo, setPage, setPrintable, setReadOnly, setRectangle, setSubject, setUniqueID, setVisible, toString
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getField

public FormElement getField()
Return the FormElement that this annotation represents on the page.

Since:
2.0

getValue

public String getValue()

Get the value of this Widget annotation - the value of the box for RadioButton and Checkbox annotations, the text on the Button for Button annotations, or null otherwise.

For example, a RadioButton used to select a type of credit card may have three annotations with the values "Visa", "MasterCard" and "Amex". For fields other than Push Buttons, RadioButtons and Checkboxes this method will return null - in this case the value of the field can be read by calling the FormElement.getValue() method instead.

Since:
2.0

setValue

public void setValue(String value)
Set the value of this annotation for for PushButton, RadioButton and Checkbox annotations. (see the getValue() method for a discussion of annotation values).

Since:
2.0

getBackgroundStyle

public PDFStyle getBackgroundStyle()
Get the background style for this annotation. The style returned will typically have a fill or line color, a FormStyle, and, if appropriate, a RadioButton or Checkbox style.

Since:
2.0

getTextStyle

public PDFStyle getTextStyle()
Get the text style for this widget. This will typically have a font and fill color set, but nothing else.

Since:
2.0

setBackgroundStyle

public void setBackgroundStyle(PDFStyle style)
Set the background style for this annotation. Typically the style will have one or more of the Fill Color, Line Color, FormStyle, Radio Button style or Check Box style attributes set. A value of null means the default style for the form will be used.

Since:
2.0

setTextStyle

public void setTextStyle(PDFStyle style)
Set the text style for this annotation. The style must have a Font and fill color set, although the font size may be 0 to specified "Auto" sized text. It may also have a text alignment specified, which is used for FormButton and FormText annotations. A value of null means the default style for the form will be used.

Since:
2.0

setButtonImage

public void setButtonImage(PDFImage image)
For FormButton annotations, set the image to display on the button. Where the image is positioned in relation to the text depends on the value of the text-alignment in the style specified by setTextStyle(org.faceless.pdf2.PDFStyle). A value of null removes any current image from the button annotation. Calling this method on an annotation for any type of field other than a Button will result in an IllegalStateException being thrown

Parameters:
image - the image to display on the button
Throws:
IllegalStateException - if this method is called on an annotation for anything other than a FormButton
Since:
2.0

getButtonImage

public PDFImage getButtonImage()
For a FormButton annotation, return the image that is drawn on the button, or null if the field is not a button or no image is specified.

Since:
2.0

setAction

public void setAction(Event event,
                      PDFAction action)

Set an action to occur when the specified event happens to this annotation. These event actions are only used for annotations created by form elements - those returned from FormElement.getAnnotations().

The event can be one of Event.CLICK, Event.MOUSEOVER, Event.MOUSEOUT, Event.MOUSEDOWN, Event.MOUSEUP, Event.FOCUS, Event.BLUR, Event.CHANGE, Event.KEYPRESS or Event.FORMAT - although not every event type is applicable for every type of widget.

Parameters:
event - the event the action applies to
action - the action you wish to occur, or null to remove the action
Since:
2.0
See Also:
FormElement.setAction(org.faceless.pdf2.Event, org.faceless.pdf2.PDFAction)

getAction

public PDFAction getAction(Event event)
Return the action that occurs when the specified event happens to this annotation. This is only used with annotations returned from form fields via the FormElement.getAnnotations() method.

Parameters:
event - the event you want the action for - one of the events listed in setAction(org.faceless.pdf2.Event, org.faceless.pdf2.PDFAction)
Returns:
the action for that event, or null if no action is specified
Since:
2.0
See Also:
FormElement


Copyright © 2001-2004 Big Faceless Organization