|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectaspose.pdf.Paragraph
aspose.pdf.FormField
public class FormField
Represents a formfield Paragraph
in the Pdf document.
Typical usages are the following:
Nested Class Summary |
---|
Nested classes/interfaces inherited from class aspose.pdf.Paragraph |
---|
Paragraph.VerticalPositionInfo |
Field Summary | |
---|---|
int |
Flag
|
boolean |
isWidthSet
|
Fields inherited from class aspose.pdf.Paragraph |
---|
INNER_INDENT, isNeedAddToPage, isPositionProcessed, RealPageNumber, VerticalPosInfo |
Constructor Summary | |
---|---|
FormField()
Constructor - initializes a new instance of the FormField class. |
Method Summary | |
---|---|
java.lang.Object |
clone()
|
java.lang.Object |
completeClone()
|
java.awt.Color |
getBackgroundColor()
Gets a Color object that indicates the color of the background. |
java.awt.Color |
getBorderColor()
Gets a Color object. object that indicates the color of the border. |
java.awt.Color |
getButtonColor()
Gets a Color object that indicates the color of the button. |
boolean |
getCheckBoxIsChecked()
Gets a boolean value that indicates whether the checkbox is checked. |
java.lang.String[] |
getChoiceOptions()
Gets a string array that indicates the options of combo or list field. |
int[] |
getChoiceSelections()
Gets an int array that indicates the choice selection indexes. |
boolean |
getComboIsEditable()
Gets a boolean value that indicates whether the combo is editable. |
java.lang.String |
getFieldName()
Gets a string that indicates the name of the field. |
java.lang.String |
getFieldValue()
Gets a string that indicates the value of the field. |
FormFieldType |
getFormFieldType()
Gets a FormFieldType enumeration that indicates the formfield type. |
float |
getFormHeight()
Gets a float value that indicates the height of the formfield. |
float |
getFormWidth()
Gets a float value that indicates the width of the formfield. |
Segment |
getInlineSeg()
Gets the inline Segment object. |
Text |
getInWhichText()
Gets a Text object that this form field lies in. |
boolean |
getIsBordered()
Gets a boolean value that indicates whether the text field is bordered. |
boolean |
getIsMultiSelect()
Gets a boolean value that indicates if multiple selecting is allowed. |
boolean |
getIsReadOnly()
Gets a boolean value that indicates if the field is read only. |
boolean |
getIsSizeSet()
Sets a boolean value that indicates whether size has been set. |
int |
getRadioButtonCheckedIndex()
Gets an int value that indicates the index of the radiobutton that has been checked. |
RadioButtons |
getRadioButtons()
Gets a RadioButtons collection that indicates the radiobuttons in this field. |
java.awt.Color |
getTextColor()
Gets a Color object that indicates the color of the text field. |
java.lang.String |
getTextFontName()
Gets a string that indicates the font name of the text field. |
float |
getTextFontSize()
Gets a float value that indicates the font size of the text field. |
boolean |
getTextIsMultiLine()
Gets a boolean value that indicate whether the text field can be multiline. |
boolean |
getTextIsPassword()
Gets a boolean value that indicates whether the text field is password. |
int |
getTextMaxLength()
Gets an int value that indicates the max length of the text can be entered in this field. |
int |
getTopIndex()
Gets an int value that indicates the top index (in the options array) of combo or list field. |
void |
setBackgroundColor(java.awt.Color value)
Sets a Color object. object that indicates the color of the background. |
void |
setBorderColor(java.awt.Color value)
Sets a Color object that indicates the color of the border. |
void |
setButtonColor(java.awt.Color value)
Sets a Color object that indicates the color of the button. |
void |
setCheckBoxIsChecked(boolean value)
Sets a bool value that indicates whether the checkbox is checked. |
void |
setChoiceOptions(java.lang.String[] value)
Sets a string array that indicates the options of combo or list field. |
void |
setChoiceSelections(int[] value)
Sets an int array that indicates the choice selection indexes. |
void |
setComboIsEditable(boolean value)
Sets a boolean value that indicates whether the combo is editable. |
void |
setFieldName(java.lang.String value)
Sets a string that indicates the name of the field. |
void |
setFieldValue(java.lang.String value)
Sets a string that indicates the value of the field. |
void |
setFormFieldType(FormFieldType value)
Sets a FormFieldType enumeration that indicates the formfield type. |
void |
setFormHeight(float value)
Sets a float value that indicates the height of the formfield. |
void |
setFormWidth(float value)
Sets a float value that indicates the width of the formfield. |
void |
setInlineSeg(Segment value)
Sets the inline Segment object. |
void |
setInWhichText(Text value)
Sets a Text object that this form field lies in. |
void |
setIsBordered(boolean value)
Sets a booleab value that indicates whether the text field is bordered. |
void |
setIsMultiSelect(boolean value)
Sets a boolean value that indicates if multiple selecting is allowed. |
void |
setIsReadOnly(boolean value)
Sets a boolean value that indicates if the field is read only. |
void |
setRadioButtonCheckedIndex(int value)
Sets an int value that indicates the index of the radiobutton that has been checked. |
void |
setRadioButtons(RadioButtons value)
Sets a RadioButtons collection that indicates the radiobuttons in this field. |
void |
setTextColor(java.awt.Color value)
Sets a Color object. object that indicates the color of the text field. |
void |
setTextFontName(java.lang.String value)
Sets a string that indicates the font name of the text field. |
void |
setTextFontSize(float value)
Sets a float value that indicates the font size of the text field. |
void |
setTextIsMultiLine(boolean value)
Sets a boolean value that indicate whether the text field can be multiline. |
void |
setTextIsPassword(boolean value)
Sets a boolean value that indicates whether the text field is password. |
void |
setTextMaxLength(int value)
Sets an int value that indicates the max length of the text can be entered in this field. |
void |
setTopIndex(int value)
Sets an int value that indicates the top index (in the options array) of combo or list field. |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public boolean isWidthSet
public int Flag
Constructor Detail |
---|
public FormField()
FormField
class.
Method Detail |
---|
public FormFieldType getFormFieldType()
FormFieldType
enumeration that indicates the formfield type.
FormFieldType
object.public void setFormFieldType(FormFieldType value)
FormFieldType
enumeration that indicates the formfield type.
value
- A FormFieldType
object.public boolean getComboIsEditable()
public void setComboIsEditable(boolean value)
value
- A boolean value.public java.lang.String[] getChoiceOptions()
public void setChoiceOptions(java.lang.String[] value)
value
- A String list.public int[] getChoiceSelections()
public void setChoiceSelections(int[] value)
value
- An int list.public int getTopIndex()
public void setTopIndex(int value)
value
- An int value.public java.lang.String getFieldName()
public void setFieldName(java.lang.String value)
value
- A String value.public java.lang.String getFieldValue()
public void setFieldValue(java.lang.String value)
value
- A String value.public float getFormWidth()
public void setFormWidth(float value)
value
- A float value.public float getFormHeight()
public void setFormHeight(float value)
value
- A float value.public boolean getCheckBoxIsChecked()
public void setCheckBoxIsChecked(boolean value)
value
- A boolen value.public java.lang.String getTextFontName()
public void setTextFontName(java.lang.String value)
value
- Font name.public java.awt.Color getTextColor()
Color
object that indicates the color of the text field.
Color
objectpublic void setTextColor(java.awt.Color value)
Color
object. object that indicates the color of the text field.
value
- A Color
object.public java.awt.Color getBackgroundColor()
Color
object.public void setBackgroundColor(java.awt.Color value)
Color
object. object that indicates the color of the background.
value
- A Color
object.public java.awt.Color getBorderColor()
Color
object. object that indicates the color of the border.
Color
object.public void setBorderColor(java.awt.Color value)
value
- A Color
object.public java.awt.Color getButtonColor()
Color
object.public void setButtonColor(java.awt.Color value)
value
- A Color
object.public float getTextFontSize()
public void setTextFontSize(float value)
value
- A float value.public boolean getTextIsMultiLine()
public void setTextIsMultiLine(boolean value)
value
- A boolean value.public boolean getTextIsPassword()
public void setTextIsPassword(boolean value)
value
- A boolean value.public int getTextMaxLength()
public void setTextMaxLength(int value)
value
- An int value.public boolean getIsBordered()
public void setIsBordered(boolean value)
value
- A boolean value.public RadioButtons getRadioButtons()
RadioButtons
object.public void setRadioButtons(RadioButtons value)
value
- A RadioButtons
object.public int getRadioButtonCheckedIndex()
public void setRadioButtonCheckedIndex(int value)
value
- An int value.public boolean getIsReadOnly()
public void setIsReadOnly(boolean value)
value
- A boolean value.public boolean getIsMultiSelect()
public void setIsMultiSelect(boolean value)
value
- A boolean value.public boolean getIsSizeSet()
public Text getInWhichText()
Text
object that this form field lies in.
Text
object.public void setInWhichText(Text value)
Text
object that this form field lies in.
value
- An Text
object.public Segment getInlineSeg()
Segment
object.
Segment
object.public void setInlineSeg(Segment value)
Segment
object.
value
- A Segment
object.public java.lang.Object completeClone()
completeClone
in class Paragraph
public java.lang.Object clone()
clone
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |