Packages

com.aspose.pdf.facades

Interfaces

Classes

java.lang.Object
- com.aspose.pdf.facades.FormFieldFacade

public final class FormFieldFacade
extends Object

Class for representing field properties.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGN_BOTTOM` Defines vertical aglignment as bottom style.
`static int`	`ALIGN_CENTER` Defines aglignment to center style.
`static int`	`ALIGN_JUSTIFIED` Defines text justification alignment style.
`static int`	`ALIGN_LEFT` Defines aglignment to left style.
`static int`	`ALIGN_MIDDLE` Defines vertical aglignment as middle style.
`static int`	`ALIGN_RIGHT` Defines aglignment to right style.
`static int`	`ALIGN_TOP` Defines vertical aglignment as top style.
`static int`	`ALIGN_UNDEFINED` Undefined aglignment style.
`static int`	`BORDER_STYLE_BEVELED` Defines a beveled border style.
`static int`	`BORDER_STYLE_DASHED` Defines a dashed border style.
`static int`	`BORDER_STYLE_INSET` Defines an inseted border style.
`static int`	`BORDER_STYLE_SOLID` Defines a solid border style.
`static int`	`BORDER_STYLE_UNDEFINED` Undefined border style.
`static int`	`BORDER_STYLE_UNDERLINE` Defines an underlined border style.
`static float`	`BORDER_WIDTH_MEDIUM` Defines a medium border width.
`static float`	`BORDER_WIDTH_THICK` Defines a thick border width.
`static float`	`BORDER_WIDTH_THIN` Defines a thin border width.
`static float`	`BORDER_WIDTH_UNDEFINED` Undefined border width.
`static float`	`BORDER_WIDTH_UNDIFIED` Deprecated.
`static int`	`CHECK_BOX_STYLE_CHECK` Defines the shape of a check box field when it checked.
`static int`	`CHECK_BOX_STYLE_CIRCLE` Defines a circle check box style.
`static int`	`CHECK_BOX_STYLE_CROSS` Defines a cross check box style.
`static int`	`CHECK_BOX_STYLE_DIAMOND` Defines a diamond check box style.
`static int`	`CHECK_BOX_STYLE_SQUARE` Defines a square check box style.
`static int`	`CHECK_BOX_STYLE_STAR` Defines a star check box style.
`static int`	`CHECK_BOX_STYLE_UNDEFINED` Defines an undefined check box style.

Constructor Summary

Constructors
Constructor and Description

FormFieldFacade()

Constructors
Constructor and Description
`FormFieldFacade()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`int`	`getAlignment()` Get the alignment of a field text, default is left alignment.
`Color`	`getBackgroudColor()` Deprecated.
`Color`	`getBackgroundColor()` Get the color of a field background, default is white.
`Color`	`getBorderColor()` Gets color of a field border.
`int`	`getBorderStyle()` Gets style of a field border.
`float`	`getBorderWidth()` Get width of a field border.
`Rectangle`	`getBox()` Get a rectangle object holding field's location.
`int`	`getButtonStyle()` Get the style of check box or radio box field, defined by FormFieldFacade.CheckBoxStyle*.
`String`	`getCaption()` Get the normal caption of form field.
`String`	`getCustomFont()` Gets the name of the font when this is non-standart (other then 14 standard fonts).
`String[][]`	`getExportItems()` Get the options for adding a list/combo/radio box
`int`	`getFont()` Gets the font style type of a field text.
`float`	`getFontSize()` Gets the size of a field text.
`String[]`	`getItems()` Get an array of string, each representing an option of a combo box/list/radio box field.
`int`	`getPageNumber()` Get an integer value holding the number of page on which field locates.
`float[]`	`getPosition()` Get a rectangle object holding field's location.
`int`	`getRotation()` Get the rotation of a field text.
`Color`	`getTextColor()` Get the color of the field text.
`int`	`getTextEncoding()` Get the text encoding type of the field text.
`void`	`reset()` Reset all visual attribtues to empty value.
`void`	`setAlignment(int value)` Set the alignment of a field text, default is left alignment.
`void`	`setBackgroudColor(Color value)` Deprecated.
`void`	`setBackgroundColor(Color value)` Set the color of a field background, default is white.
`void`	`setBorderColor(Color value)` Sets color of a field border.
`void`	`setBorderStyle(int value)` Sets style of a field border.
`void`	`setBorderWidth(float value)` Set width of a field border.
`void`	`setBox(Rectangle value)` Set a rectangle object holding field's location.
`void`	`setButtonStyle(int value)` Set the style of check box or radio box field, defined by FormFieldFacade.CheckBoxStyle*.
`void`	`setCaption(String value)` Set the normal caption of form field.
`void`	`setCustomFont(String value)` Sets the name of the font when this is non-standart (other then 14 standard fonts).
`void`	`setExportItems(String[][] value)` Set the options for adding a list/combo/radio box
`void`	`setFont(int value)` Sets the font style type of a field text.
`void`	`setFontSize(float value)` Sets the size of a field text.
`void`	`setItems(String[] value)` Set an array of string, each representing an option of a combo box/list/radio box field.
`void`	`setPageNumber(int value)` Set an integer value holding the number of page on which field locates.
`void`	`setPosition(float[] value)` Set a rectangle object holding field's location.
`void`	`setRotation(int value)` Set the rotation of a field text.
`void`	`setTextColor(Color value)` Set the color of the field text.
`void`	`setTextEncoding(int value)` Set the `EncodingType` text encoding type of the field text.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - BORDER_WIDTH_UNDIFIED
```
@Deprecated
public static final float BORDER_WIDTH_UNDIFIED
```
    Deprecated.
    
    Undefined border width.
    
    See Also:
    
    Constant Field Values
  - BORDER_WIDTH_UNDEFINED
```
public static final float BORDER_WIDTH_UNDEFINED
```
    Undefined border width.
    
    See Also:
    
    Constant Field Values
  - BORDER_WIDTH_THIN
```
public static final float BORDER_WIDTH_THIN
```
    Defines a thin border width.
    
    See Also:
    
    Constant Field Values
  - BORDER_WIDTH_MEDIUM
```
public static final float BORDER_WIDTH_MEDIUM
```
    Defines a medium border width.
    
    See Also:
    
    Constant Field Values
  - BORDER_WIDTH_THICK
```
public static final float BORDER_WIDTH_THICK
```
    Defines a thick border width.
    
    See Also:
    
    Constant Field Values
  - BORDER_STYLE_SOLID
```
public static final int BORDER_STYLE_SOLID
```
    Defines a solid border style.
    
    See Also:
    
    Constant Field Values
  - BORDER_STYLE_DASHED
```
public static final int BORDER_STYLE_DASHED
```
    Defines a dashed border style.
    
    See Also:
    
    Constant Field Values
  - BORDER_STYLE_BEVELED
```
public static final int BORDER_STYLE_BEVELED
```
    Defines a beveled border style.
    
    See Also:
    
    Constant Field Values
  - BORDER_STYLE_INSET
```
public static final int BORDER_STYLE_INSET
```
    Defines an inseted border style.
    
    See Also:
    
    Constant Field Values
  - BORDER_STYLE_UNDERLINE
```
public static final int BORDER_STYLE_UNDERLINE
```
    Defines an underlined border style.
    
    See Also:
    
    Constant Field Values
  - BORDER_STYLE_UNDEFINED
```
public static final int BORDER_STYLE_UNDEFINED
```
    Undefined border style.
    
    See Also:
    
    Constant Field Values
  - ALIGN_LEFT
```
public static final int ALIGN_LEFT
```
    Defines aglignment to left style.
    
    See Also:
    
    Constant Field Values
  - ALIGN_CENTER
```
public static final int ALIGN_CENTER
```
    Defines aglignment to center style.
    
    See Also:
    
    Constant Field Values
  - ALIGN_RIGHT
```
public static final int ALIGN_RIGHT
```
    Defines aglignment to right style.
    
    See Also:
    
    Constant Field Values
  - ALIGN_UNDEFINED
```
public static final int ALIGN_UNDEFINED
```
    Undefined aglignment style.
    
    See Also:
    
    Constant Field Values
  - ALIGN_JUSTIFIED
```
public static final int ALIGN_JUSTIFIED
```
    Defines text justification alignment style.
    
    See Also:
    
    Constant Field Values
  - ALIGN_TOP
```
public static final int ALIGN_TOP
```
    Defines vertical aglignment as top style.
    
    See Also:
    
    Constant Field Values
  - ALIGN_MIDDLE
```
public static final int ALIGN_MIDDLE
```
    Defines vertical aglignment as middle style.
    
    See Also:
    
    Constant Field Values
  - ALIGN_BOTTOM
```
public static final int ALIGN_BOTTOM
```
    Defines vertical aglignment as bottom style.
    
    See Also:
    
    Constant Field Values
  - CHECK_BOX_STYLE_CIRCLE
```
public static final int CHECK_BOX_STYLE_CIRCLE
```
    Defines a circle check box style.
    
    See Also:
    
    Constant Field Values
  - CHECK_BOX_STYLE_CHECK
```
public static final int CHECK_BOX_STYLE_CHECK
```
    Defines the shape of a check box field when it checked.
    
    See Also:
    
    Constant Field Values
  - CHECK_BOX_STYLE_CROSS
```
public static final int CHECK_BOX_STYLE_CROSS
```
    Defines a cross check box style.
    
    See Also:
    
    Constant Field Values
  - CHECK_BOX_STYLE_DIAMOND
```
public static final int CHECK_BOX_STYLE_DIAMOND
```
    Defines a diamond check box style.
    
    See Also:
    
    Constant Field Values
  - CHECK_BOX_STYLE_STAR
```
public static final int CHECK_BOX_STYLE_STAR
```
    Defines a star check box style.
    
    See Also:
    
    Constant Field Values
  - CHECK_BOX_STYLE_SQUARE
```
public static final int CHECK_BOX_STYLE_SQUARE
```
    Defines a square check box style.
    
    See Also:
    
    Constant Field Values
  - CHECK_BOX_STYLE_UNDEFINED
```
public static final int CHECK_BOX_STYLE_UNDEFINED
```
    Defines an undefined check box style.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - FormFieldFacade
```
public FormFieldFacade()
```
- Method Detail
  - getBorderColor
```
public Color getBorderColor()
```
    Gets color of a field border.
    
    Returns:
    
    color of a field border.
  - setBorderColor
```
public void setBorderColor(Color value)
```
    Sets color of a field border.
    
    Parameters:
    
    value - color of a field border.
  - getBorderStyle
```
public int getBorderStyle()
```
    Gets style of a field border.
    
    Returns:
    
    style of a field border.
  - setBorderStyle
```
public void setBorderStyle(int value)
```
    Sets style of a field border.
    
    Parameters:
    
    value - style of a field border.
  - getBorderWidth
```
public float getBorderWidth()
```
    Get width of a field border.
    
    Returns:
    
    width of a field border.
  - setBorderWidth
```
public void setBorderWidth(float value)
```
    Set width of a field border.
    
    Parameters:
    
    value - width of a field border.
  - getFont
```
public int getFont()
```
    Gets the font style type of a field text.
    
    Returns:
    
    FontStyle element
    
    See Also:
    
    FontStyle
  - setFont
```
public void setFont(int value)
```
    Sets the font style type of a field text.
    
    Parameters:
    
    value - FontStyle
    
    See Also:
    
    FontStyle
  - getCustomFont
```
public String getCustomFont()
```
    Gets the name of the font when this is non-standart (other then 14 standard fonts).
    
    Returns:
    
    String value
  - setCustomFont
```
public void setCustomFont(String value)
```
    Sets the name of the font when this is non-standart (other then 14 standard fonts).
    
    Parameters:
    
    value - String value
  - getFontSize
```
public float getFontSize()
```
    Gets the size of a field text.
    
    Returns:
    
    float value
  - setFontSize
```
public void setFontSize(float value)
```
    Sets the size of a field text.
    
    Parameters:
    
    value - float value
  - getTextColor
```
public Color getTextColor()
```
    Get the color of the field text.
    
    Returns:
    
    Color element
  - setTextColor
```
public void setTextColor(Color value)
```
    Set the color of the field text.
    
    Parameters:
    
    value - Color element
  - getTextEncoding
```
public int getTextEncoding()
```
    Get the text encoding type of the field text.
    
    Returns:
    
    EncodingType element
    
    See Also:
    
    EncodingType
  - setTextEncoding
```
public void setTextEncoding(int value)
```
    Set the EncodingType text encoding type of the field text.
    
    Parameters:
    
    value - EncodingType element
    
    See Also:
    
    EncodingType
  - getAlignment
```
public int getAlignment()
```
    Get the alignment of a field text, default is left alignment.
    
    Returns:
    
    int value
  - setAlignment
```
public void setAlignment(int value)
```
    Set the alignment of a field text, default is left alignment.
    
    Parameters:
    
    value - int value
  - getRotation
```
public int getRotation()
```
    Get the rotation of a field text.
    
    Returns:
    
    int value
  - setRotation
```
public void setRotation(int value)
```
    Set the rotation of a field text.
    
    Parameters:
    
    value - int value
  - getCaption
```
public String getCaption()
```
    Get the normal caption of form field.
    
    Returns:
    
    String value
  - setCaption
```
public void setCaption(String value)
```
    Set the normal caption of form field.
    
    Parameters:
    
    value - String value
  - getButtonStyle
```
public int getButtonStyle()
```
    Get the style of check box or radio box field, defined by FormFieldFacade.CheckBoxStyle*.
    
    Returns:
    
    int value
  - setButtonStyle
```
public void setButtonStyle(int value)
```
    Set the style of check box or radio box field, defined by FormFieldFacade.CheckBoxStyle*.
    
    Parameters:
    
    value - int value
  - getBox
```
public Rectangle getBox()
```
    Get a rectangle object holding field's location.
    
    Returns:
    
    Rectangle element
  - setBox
```
public void setBox(Rectangle value)
```
    Set a rectangle object holding field's location.
    
    Parameters:
    
    value - Rectangle element
  - getPosition
```
public float[] getPosition()
```
    Get a rectangle object holding field's location.
    
    Returns:
    
    array of float value
  - setPosition
```
public void setPosition(float[] value)
```
    Set a rectangle object holding field's location.
    
    Parameters:
    
    value - array of float value
  - getPageNumber
```
public int getPageNumber()
```
    Get an integer value holding the number of page on which field locates.
    
    Returns:
    
    int value
  - setPageNumber
```
public void setPageNumber(int value)
```
    Set an integer value holding the number of page on which field locates.
    
    Parameters:
    
    value - int value
  - getItems
```
public String[] getItems()
```
    Get an array of string, each representing an option of a combo box/list/radio box field.
    
    Returns:
    
    array of String value
  - setItems
```
public void setItems(String[] value)
```
    Set an array of string, each representing an option of a combo box/list/radio box field.
    
    Parameters:
    
    value - array of String value
  - getExportItems
```
public String[][] getExportItems()
```
    Get the options for adding a list/combo/radio box
    
    Returns:
    
    array of String value
  - setExportItems
```
public void setExportItems(String[][] value)
```
    Set the options for adding a list/combo/radio box
    
    Parameters:
    
    value - array of String value
  - getBackgroundColor
```
public Color getBackgroundColor()
```
    Get the color of a field background, default is white.
    
    Returns:
    
    Color element
  - setBackgroundColor
```
public void setBackgroundColor(Color value)
```
    Set the color of a field background, default is white.
    
    Parameters:
    
    value - Color element
  - reset
```
public void reset()
```
    Reset all visual attribtues to empty value.
  - getBackgroudColor
```
@Deprecated
public Color getBackgroudColor()
```
    Deprecated.
    
    Obsolete property. Use BackgroundColor. This method is Deprecated.
    
    Returns:
    
    background color
  - setBackgroudColor
```
@Deprecated
public void setBackgroudColor(Color value)
```
    Deprecated.
    
    Obsolete property. Use BackgroundColor. This method is Deprecated.
    
    Parameters:
    
    value - background color

Packages

com.aspose.pdf.facades

Interfaces

Classes

Class FormFieldFacade

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BORDER_WIDTH_UNDIFIED

BORDER_WIDTH_UNDEFINED

BORDER_WIDTH_THIN

BORDER_WIDTH_MEDIUM

BORDER_WIDTH_THICK

BORDER_STYLE_SOLID

BORDER_STYLE_DASHED

BORDER_STYLE_BEVELED

BORDER_STYLE_INSET

BORDER_STYLE_UNDERLINE

BORDER_STYLE_UNDEFINED

ALIGN_LEFT

ALIGN_CENTER

ALIGN_RIGHT

ALIGN_UNDEFINED

ALIGN_JUSTIFIED

ALIGN_TOP

ALIGN_MIDDLE

ALIGN_BOTTOM

CHECK_BOX_STYLE_CIRCLE

CHECK_BOX_STYLE_CHECK

CHECK_BOX_STYLE_CROSS

CHECK_BOX_STYLE_DIAMOND

CHECK_BOX_STYLE_STAR

CHECK_BOX_STYLE_SQUARE

CHECK_BOX_STYLE_UNDEFINED

Constructor Detail

FormFieldFacade

Method Detail

getBorderColor

setBorderColor

getBorderStyle

setBorderStyle

getBorderWidth

setBorderWidth

getFont

setFont

getCustomFont

setCustomFont

getFontSize

setFontSize

getTextColor

setTextColor

getTextEncoding

setTextEncoding

getAlignment

setAlignment

getRotation

setRotation

getCaption

setCaption

getButtonStyle

setButtonStyle

getBox

setBox

getPosition

setPosition

getPageNumber

setPageNumber

getItems

setItems

getExportItems

setExportItems

getBackgroundColor

setBackgroundColor

reset

getBackgroudColor

setBackgroudColor