Packageorg.purepdf.pdf.forms
Classpublic class PushbuttonField
InheritancePushbuttonField Inheritance FieldBase Inheritance Object


Public Properties
 PropertyDefined By
 Inheritedalignment : int
FieldBase
 InheritedbackgroundColor : RGBColor
FieldBase
 InheritedborderColor : RGBColor
FieldBase
 InheritedborderStyle : int
FieldBase
 InheritedborderWidth : Number
FieldBase
 Inheritedfont : BaseFont
FieldBase
 InheritedfontSize : Number
FieldBase
  iconFitToBounds : Boolean
If true the icon will be scaled to fit fully within the bounds of the annotation, if false the border width will be taken into account.
PushbuttonField
  iconHorizontalAdjustment : Number
A number between 0 and 1 indicating the fraction of leftover space to allocate at the left of the icon.
PushbuttonField
  iconReference : PRIndirectReference
Sets the reference to an existing icon.
PushbuttonField
  iconVerticalAdjustment : Number
A number between 0 and 1 indicating the fraction of leftover space to allocate at the bottom of the icon.
PushbuttonField
  image : ImageElement
PushbuttonField
  layout : int
Sets the icon and label layout.
PushbuttonField
  proportionalIcon : Boolean
Sets the way the icon is scaled.
PushbuttonField
  scaleIcon : int
Sets the way the icon will be scaled.
PushbuttonField
  template : PdfTemplate
PushbuttonField
 Inheritedtext : String
FieldBase
 InheritedtextColor : RGBColor
FieldBase
Protected Properties
 PropertyDefined By
 Inherited_alignment : int = 0
FieldBase
 Inherited_backgroundColor : RGBColor
FieldBase
 Inherited_borderColor : RGBColor
FieldBase
 Inherited_borderStyle : int
FieldBase
 Inherited_borderWidth : Number = 1
FieldBase
 Inheritedbox : RectangleElement
FieldBase
 InheritedfieldName : String
FieldBase
 Inherited_font : BaseFont
FieldBase
 Inherited_fontSize : Number = 0
FieldBase
 InheritedmaxCharacterLength : int
FieldBase
 Inheritedoptions : int
FieldBase
 Inheritedrotation : int = 0
FieldBase
 Inherited_text : String
FieldBase
 Inherited_textColor : RGBColor
FieldBase
 Inheritedvisibility : int = 0
FieldBase
 Inheritedwriter : PdfWriter
FieldBase
Public Methods
 MethodDefined By
  
PushbuttonField($writer:PdfWriter, $box:RectangleElement, $fieldName:String)
PushbuttonField
  
getAppearance():PdfAppearance
Gets the button appearance.
PushbuttonField
  
getField():PdfFormField
Gets the pushbutton field.
PushbuttonField
Protected Methods
 MethodDefined By
 Inherited
getBorderAppearance():PdfAppearance
FieldBase
 Inherited
getRealFont():BaseFont
FieldBase
Public Constants
 ConstantDefined By
 InheritedBORDER_WIDTH_MEDIUM : Number = 2
[static]
FieldBase
 InheritedBORDER_WIDTH_THICK : Number = 3
[static]
FieldBase
 InheritedBORDER_WIDTH_THIN : Number = 1
[static]
FieldBase
 InheritedCOMB : int
[static]
FieldBase
 InheritedDO_NOT_SCROLL : int
[static]
FieldBase
 InheritedDO_NOT_SPELL_CHECK : int
[static]
FieldBase
 InheritedEDIT : int
[static]
FieldBase
 InheritedFILE_SELECTION : int
[static]
FieldBase
 InheritedHIDDEN : int = 1
[static]
FieldBase
 InheritedHIDDEN_BUT_PRINTABLE : int = 3
[static]
FieldBase
  LAYOUT_ICON_LEFT_LABEL_RIGHT : int = 5
[static]
PushbuttonField
  LAYOUT_ICON_ONLY : int = 2
[static]
PushbuttonField
  LAYOUT_ICON_TOP_LABEL_BOTTOM : int = 3
[static]
PushbuttonField
  LAYOUT_LABEL_LEFT_ICON_RIGHT : int = 6
[static]
PushbuttonField
  LAYOUT_LABEL_ONLY : int = 1
[static]
PushbuttonField
  LAYOUT_LABEL_OVER_ICON : int = 7
[static]
PushbuttonField
  LAYOUT_LABEL_TOP_ICON_BOTTOM : int = 4
[static]
PushbuttonField
 InheritedMULTILINE : int
[static]
FieldBase
 InheritedMULTISELECT : int
[static]
FieldBase
 InheritedPASSWORD : int
[static]
FieldBase
 InheritedREAD_ONLY : int
[static]
FieldBase
 InheritedREQUIRED : int
[static]
FieldBase
  SCALE_ICON_ALWAYS : int = 1
[static]
PushbuttonField
  SCALE_ICON_IS_TOO_BIG : int = 3
[static]
PushbuttonField
  SCALE_ICON_IS_TOO_SMALL : int = 4
[static]
PushbuttonField
  SCALE_ICON_NEVER : int = 2
[static]
PushbuttonField
 InheritedVISIBLE : int = 0
[static]
FieldBase
 InheritedVISIBLE_BUT_DOES_NOT_PRINT : int = 2
[static]
FieldBase
Property Detail
iconFitToBoundsproperty
iconFitToBounds:Boolean

If true the icon will be scaled to fit fully within the bounds of the annotation, if false the border width will be taken into account. The default is false.


Implementation
    public function get iconFitToBounds():Boolean
    public function set iconFitToBounds(value:Boolean):void
iconHorizontalAdjustmentproperty 
iconHorizontalAdjustment:Number

A number between 0 and 1 indicating the fraction of leftover space to allocate at the left of the icon. A value of 0 positions the icon at the left of the annotation rectangle. A value of 0.5 centers it within the rectangle. The default is 0.5.


Implementation
    public function get iconHorizontalAdjustment():Number
    public function set iconHorizontalAdjustment(value:Number):void
iconReferenceproperty 
iconReference:PRIndirectReference

Sets the reference to an existing icon.


Implementation
    public function get iconReference():PRIndirectReference
    public function set iconReference(value:PRIndirectReference):void
iconVerticalAdjustmentproperty 
iconVerticalAdjustment:Number

A number between 0 and 1 indicating the fraction of leftover space to allocate at the bottom of the icon. A value of 0 positions the icon at the bottom of the annotation rectangle. A value of 0.5 centers it within the rectangle. The default is 0.5.


Implementation
    public function get iconVerticalAdjustment():Number
    public function set iconVerticalAdjustment(value:Number):void
imageproperty 
image:ImageElement


Implementation
    public function get image():ImageElement
    public function set image(value:ImageElement):void
layoutproperty 
layout:int

Sets the icon and label layout. Possible values are LAYOUT_LABEL_ONLY, LAYOUT_ICON_ONLY, LAYOUT_ICON_TOP_LABEL_BOTTOM, LAYOUT_LABEL_TOP_ICON_BOTTOM, LAYOUT_ICON_LEFT_LABEL_RIGHT, LAYOUT_LABEL_LEFT_ICON_RIGHT and LAYOUT_LABEL_OVER_ICON. The default is LAYOUT_LABEL_ONLY.


Implementation
    public function get layout():int
    public function set layout(value:int):void

Throws
ArgumentError
proportionalIconproperty 
proportionalIcon:Boolean

Sets the way the icon is scaled. If true the icon is scaled proportionally, if false the scaling is done anamorphicaly.


Implementation
    public function get proportionalIcon():Boolean
    public function set proportionalIcon(value:Boolean):void
scaleIconproperty 
scaleIcon:int

Sets the way the icon will be scaled. Possible values are SCALE_ICON_ALWAYS, SCALE_ICON_NEVER, SCALE_ICON_IS_TOO_BIG and SCALE_ICON_IS_TOO_SMALL. The default is SCALE_ICON_ALWAYS.


Implementation
    public function get scaleIcon():int
    public function set scaleIcon(value:int):void
templateproperty 
template:PdfTemplate


Implementation
    public function get template():PdfTemplate
    public function set template(value:PdfTemplate):void
Constructor Detail
PushbuttonField()Constructor
public function PushbuttonField($writer:PdfWriter, $box:RectangleElement, $fieldName:String)



Parameters
$writer:PdfWriter
 
$box:RectangleElement
 
$fieldName:String
Method Detail
getAppearance()method
public function getAppearance():PdfAppearance

Gets the button appearance.

Returns
PdfAppearance — the button appearance

Throws
IOException — on error
 
DocumentException — on error
getField()method 
public function getField():PdfFormField

Gets the pushbutton field.

Returns
PdfFormField — the pushbutton field

Throws
IOException — on error
 
DocumentException — on error
Constant Detail
LAYOUT_ICON_LEFT_LABEL_RIGHTConstant
public static const LAYOUT_ICON_LEFT_LABEL_RIGHT:int = 5

LAYOUT_ICON_ONLYConstant 
public static const LAYOUT_ICON_ONLY:int = 2

LAYOUT_ICON_TOP_LABEL_BOTTOMConstant 
public static const LAYOUT_ICON_TOP_LABEL_BOTTOM:int = 3

LAYOUT_LABEL_LEFT_ICON_RIGHTConstant 
public static const LAYOUT_LABEL_LEFT_ICON_RIGHT:int = 6

LAYOUT_LABEL_ONLYConstant 
public static const LAYOUT_LABEL_ONLY:int = 1

LAYOUT_LABEL_OVER_ICONConstant 
public static const LAYOUT_LABEL_OVER_ICON:int = 7

LAYOUT_LABEL_TOP_ICON_BOTTOMConstant 
public static const LAYOUT_LABEL_TOP_ICON_BOTTOM:int = 4

SCALE_ICON_ALWAYSConstant 
public static const SCALE_ICON_ALWAYS:int = 1

SCALE_ICON_IS_TOO_BIGConstant 
public static const SCALE_ICON_IS_TOO_BIG:int = 3

SCALE_ICON_IS_TOO_SMALLConstant 
public static const SCALE_ICON_IS_TOO_SMALL:int = 4

SCALE_ICON_NEVERConstant 
public static const SCALE_ICON_NEVER:int = 2





Thu May 27 2010, 07:51 AM +02:00