|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.faceless.pdf2.PDFObject
org.faceless.pdf2.PDFMap
org.faceless.pdf2.PDFAnnotation
org.faceless.pdf2.WidgetAnnotation
The WidgetAnnotation
class represents the type of annotation
used to represent the visual contents of a FormElement
on the page.
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 |
public FormElement getField()
FormElement
that this annotation represents on the page.
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.
public void setValue(String value)
getValue()
method for a discussion of annotation values).
public PDFStyle getBackgroundStyle()
FormStyle
,
and, if appropriate, a RadioButton
or Checkbox
style.
public PDFStyle getTextStyle()
public void setBackgroundStyle(PDFStyle style)
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.
public void setTextStyle(PDFStyle style)
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.
public void setButtonImage(PDFImage image)
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
image
- the image to display on the button
IllegalStateException
- if this method is called on an annotation for anything
other than a FormButton
public PDFImage getButtonImage()
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.
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.
event
- the event the action applies toaction
- the action you wish to occur, or null
to remove the actionFormElement.setAction(org.faceless.pdf2.Event, org.faceless.pdf2.PDFAction)
public PDFAction getAction(Event event)
FormElement.getAnnotations()
method.
event
- the event you want the action for - one of the events listed in setAction(org.faceless.pdf2.Event, org.faceless.pdf2.PDFAction)
null
if no action is specifiedFormElement
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |