Home  Products  Purchase  Downloads  Demos  Forums  Blogs  Ticket  Wiki  API  Corporate

com.aspose.pdf.kit
Class FormFieldFacade

java.lang.Object
  extended bycom.aspose.pdf.kit.FormFieldFacade

public class FormFieldFacade
extends java.lang.Object

Represents a class which is used to record visual attributes of a field.


Field Summary
static int ALIGN_CENTER
          Defines aglignment as center style.
static int ALIGN_LEFT
          Defines aglignment as left style, which is also the default.
static int ALIGN_RIGHT
          Defines aglignment as right style.
static int ALIGN_UNDIFINED
          Undefined aglignment style.
static int BDSTYLE_BEVELED
          Defines a beveled border style.
static int BDSTYLE_DASHED
          Defines a dashed border style.
static int BDSTYLE_INSET
          Defines an inserted border style.
static int BDSTYLE_SOLID
          Defines a solid border style, which is also the default.
static int BDSTYLE_UNDERLINE
          Defines an underlined border style.
static int BDSTYLE_UNDIFINED
          Undefined border style.
static float BDWIDTH_MEDIUM
          Defines a medium border width.
static float BDWIDTH_THICK
          Defines a thick border width.
static float BDWIDTH_THIN
          Defines a thin border width, which is also the default.
static float BDWIDTH_UNDIFINED
          Undefined border width.
static int BTNSTYLE_CHECK
          Defines a check button style.
static int BTNSTYLE_CIRCLE
          Defines a circle button style.
static int BTNSTYLE_CROSS
          Defines a cross button style.
static int BTNSTYLE_DIAMOND
          Defines a diamond button style.
static int BTNSTYLE_SQUARE
          Defines a square button style.
static int BTNSTYLE_STAR
          Defines a star button style.
static int BTNSTYLE_UNDEFINED
          Represents a undefined button style.
 
Constructor Summary
FormFieldFacade()
          Represents the constructor of the FormFieldFacade object without any parameter
 
Method Summary
 int getAlignment()
          Getter of alignment.
 java.awt.Color getBackgroudColor()
          Getter of backgroudColor.
 java.awt.Color getBorderColor()
          Getter of borderColor.
 int getBorderStyle()
          Getter of borderStyle.
 float getBorderWidth()
          Getter of borderWidth.
 com.aspose.pdf.kit.Rectangle getBox()
          Getter of box.
 int getButtonStyle()
           
 java.lang.String getCaption()
          Getter of caption.
 java.lang.String getFont()
          Getter of font.
 float getFontSize()
          Getter of fontSize.
 int getRotation()
          Getter of rotation.
 java.awt.Color getTextColor()
          Getter of textColor.
 void reset()
           
 void setAlignment(int alignment)
          Setter of alignment.
 void setBackgroudColor(java.awt.Color backgroudColor)
          Setter of backgroudColor.
 void setBorderColor(java.awt.Color borderColor)
          Setter of borderColor.
 void setBorderStyle(int borderStyle)
          Setter of borderStyle.
 void setBorderWidth(float borderWidth)
          Setter of borderWidth.
 void setBox(com.aspose.pdf.kit.Rectangle box)
          Setter of box.
 void setButtonStyle(int buttonStyle)
           
 void setCaption(java.lang.String caption)
          Setter of caption.
 void setFont(java.lang.String fontName)
          Setter of font.
 void setFontSize(float fontSize)
          Setter of fontSize.
 void setRotation(int rotation)
          Setter of rotation.
 void setTextColor(java.awt.Color textColor)
          Setter of textColor.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

BDWIDTH_THIN

public static final float BDWIDTH_THIN
Defines a thin border width, which is also the default.

See Also:
Constant Field Values

BDWIDTH_MEDIUM

public static final float BDWIDTH_MEDIUM
Defines a medium border width.

See Also:
Constant Field Values

BDWIDTH_THICK

public static final float BDWIDTH_THICK
Defines a thick border width.

See Also:
Constant Field Values

BDWIDTH_UNDIFINED

public static final float BDWIDTH_UNDIFINED
Undefined border width.

See Also:
Constant Field Values

BDSTYLE_SOLID

public static final int BDSTYLE_SOLID
Defines a solid border style, which is also the default.

See Also:
Constant Field Values

BDSTYLE_DASHED

public static final int BDSTYLE_DASHED
Defines a dashed border style.

See Also:
Constant Field Values

BDSTYLE_BEVELED

public static final int BDSTYLE_BEVELED
Defines a beveled border style.

See Also:
Constant Field Values

BDSTYLE_INSET

public static final int BDSTYLE_INSET
Defines an inserted border style.

See Also:
Constant Field Values

BDSTYLE_UNDERLINE

public static final int BDSTYLE_UNDERLINE
Defines an underlined border style.

See Also:
Constant Field Values

BDSTYLE_UNDIFINED

public static final int BDSTYLE_UNDIFINED
Undefined border style.

See Also:
Constant Field Values

ALIGN_LEFT

public static final int ALIGN_LEFT
Defines aglignment as left style, which is also the default.

See Also:
Constant Field Values

ALIGN_CENTER

public static final int ALIGN_CENTER
Defines aglignment as center style.

See Also:
Constant Field Values

ALIGN_RIGHT

public static final int ALIGN_RIGHT
Defines aglignment as right style.

See Also:
Constant Field Values

ALIGN_UNDIFINED

public static final int ALIGN_UNDIFINED
Undefined aglignment style.

See Also:
Constant Field Values

BTNSTYLE_CHECK

public static final int BTNSTYLE_CHECK
Defines a check button style.

See Also:
Constant Field Values

BTNSTYLE_CIRCLE

public static final int BTNSTYLE_CIRCLE
Defines a circle button style.

See Also:
Constant Field Values

BTNSTYLE_CROSS

public static final int BTNSTYLE_CROSS
Defines a cross button style.

See Also:
Constant Field Values

BTNSTYLE_DIAMOND

public static final int BTNSTYLE_DIAMOND
Defines a diamond button style.

See Also:
Constant Field Values

BTNSTYLE_STAR

public static final int BTNSTYLE_STAR
Defines a star button style.

See Also:
Constant Field Values

BTNSTYLE_SQUARE

public static final int BTNSTYLE_SQUARE
Defines a square button style.

See Also:
Constant Field Values

BTNSTYLE_UNDEFINED

public static final int BTNSTYLE_UNDEFINED
Represents a undefined button style.

See Also:
Constant Field Values
Constructor Detail

FormFieldFacade

public FormFieldFacade()
Represents the constructor of the FormFieldFacade object without any parameter

Method Detail

reset

public void reset()

setAlignment

public void setAlignment(int alignment)
Setter of alignment.

Parameters:
alignment - The alignment style of field text, should be FormFieldFacade.ALIGN_*.

setBackgroudColor

public void setBackgroudColor(java.awt.Color backgroudColor)
Setter of backgroudColor.

Parameters:
backgroudColor - The color of a field background, default is white.

setBorderColor

public void setBorderColor(java.awt.Color borderColor)
Setter of borderColor.

Parameters:
borderColor - The color of a field border.

setBorderStyle

public void setBorderStyle(int borderStyle)
Setter of borderStyle.

Parameters:
borderStyle - The style of a field border, Should be FormFieldFacade.BDSTYLE_*, default is BDSTYLE_SOLID.

setBorderWidth

public void setBorderWidth(float borderWidth)
Setter of borderWidth.

Parameters:
borderWidth - The width of a field border, should be FormFieldFacade.BDWIDTH_*, default is BDWIDTH_THIN.

setBox

public void setBox(com.aspose.pdf.kit.Rectangle box)
Setter of box.

Parameters:
box - The rectangle containing a field.

setFont

public void setFont(java.lang.String fontName)
Setter of font.

Parameters:
fontName - The font name of a field text, should be FontStyle.*, default is Helvetica.

setFontSize

public void setFontSize(float fontSize)
Setter of fontSize.

Parameters:
fontSize - The size of a field text. 0 means auto-suiting.

setRotation

public void setRotation(int rotation)
Setter of rotation.

Parameters:
rotation - The rotation of a field text, default is zero.

setTextColor

public void setTextColor(java.awt.Color textColor)
Setter of textColor.

Parameters:
textColor - The color of a field text, default is black.

setCaption

public void setCaption(java.lang.String caption)
Setter of caption.

Parameters:
caption - The normal caption of field.

getAlignment

public int getAlignment()
Getter of alignment.

Returns:
Field alignment style.

getBackgroudColor

public java.awt.Color getBackgroudColor()
Getter of backgroudColor.

Returns:
Field backgroud color.

getBorderColor

public java.awt.Color getBorderColor()
Getter of borderColor.

Returns:
Field border color.

getBorderStyle

public int getBorderStyle()
Getter of borderStyle.

Returns:
Field border style.

getBorderWidth

public float getBorderWidth()
Getter of borderWidth.

Returns:
Field border width.

getBox

public com.aspose.pdf.kit.Rectangle getBox()
Getter of box.

Returns:
A rectangle containing the field.

getCaption

public java.lang.String getCaption()
Getter of caption.

Returns:
Field caption.

getFont

public java.lang.String getFont()
Getter of font.

Returns:
The formal name of font.

getFontSize

public float getFontSize()
Getter of fontSize.

Returns:
The font size.

getRotation

public int getRotation()
Getter of rotation.

Returns:
The rotaion of text in a field.

getTextColor

public java.awt.Color getTextColor()
Getter of textColor.

Returns:
The color of text in a field.

getButtonStyle

public int getButtonStyle()

setButtonStyle

public void setButtonStyle(int buttonStyle)