ButtonComponent
Inheritance: java.lang.Object, com.groupdocs.annotation.models.annotationmodels.AnnotationBase
All Implemented Interfaces: com.groupdocs.annotation.models.formatspecificcomponents.pdf.interfaces.IButtonComponent
public class ButtonComponent extends AnnotationBase implements IButtonComponent
Represents Button properties
Learn more
| Constructor | Description |
|---|---|
| ButtonComponent() | Initializes new instance of ButtonComponent class. |
Methods
| Method | Description |
|---|---|
| getBox() | Gets or sets component position |
| setBox(Rectangle value) | Gets or sets component position |
| getStyle() | Gets or sets annotation border |
| setStyle(Byte value) | Gets or sets annotation border |
| getBorderWidth() | Gets or sets annotation border width |
| setBorderWidth(Integer value) | Gets or sets annotation border width |
| getBorderColor() | Gets or sets annotation border color |
| setBorderColor(Integer value) | Gets or sets annotation border color |
| getAlternateName() | Gets or sets component alternate name Alternate name is used as field tooltip in Adobe Acrobat. |
| setAlternateName(String value) | Gets or sets component alternate name Alternate name is used as field tooltip in Adobe Acrobat. |
| getPartialName() | Gets or sets component partial name |
| setPartialName(String value) | Gets or sets component partial name |
| getNormalCaption() | Gets or sets component normal caption |
| setNormalCaption(String value) | Gets or sets component normal caption |
| getRolloverCaption() | Gets or sets rollover caption of button which shall be displayed when the user rolls the cursor into its active area without pressing the mouse button. |
| setRolloverCaption(String value) | Gets or sets rollover caption of button which shall be displayed when the user rolls the cursor into its active area without pressing the mouse button. |
| getPenColor() | Gets or sets component pen color |
| setPenColor(Integer value) | Gets or sets component pen color |
| getButtonColor() | Gets or sets component color |
| setButtonColor(Integer value) | Gets or sets component color |
| equals(ButtonComponent other) | Compares Button Components using IEquatable Equals method |
| equals(Object obj) | Compares Button Components using standard object Equals method |
| hashCode() | Returns HashCode of Button Component |
| deepClone() | Returns new Instance with same values |
| toString() | |
| toString(ToStringStyle toStringStyle) |
ButtonComponent()
public ButtonComponent()
Initializes new instance of ButtonComponent class.
getBox()
public final Rectangle getBox()
Gets or sets component position
Returns: Rectangle
setBox(Rectangle value)
public final void setBox(Rectangle value)
Gets or sets component position
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Rectangle |
getStyle()
public final Byte getStyle()
Gets or sets annotation border
Returns: java.lang.Byte -
setStyle(Byte value)
public final void setStyle(Byte value)
Gets or sets annotation border
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.Byte |
getBorderWidth()
public final Integer getBorderWidth()
Gets or sets annotation border width
Returns: java.lang.Integer -
setBorderWidth(Integer value)
public final void setBorderWidth(Integer value)
Gets or sets annotation border width
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.Integer |
getBorderColor()
public final Integer getBorderColor()
Gets or sets annotation border color
Returns: java.lang.Integer -
setBorderColor(Integer value)
public final void setBorderColor(Integer value)
Gets or sets annotation border color
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.Integer |
getAlternateName()
public final String getAlternateName()
Gets or sets component alternate name Alternate name is used as field tooltip in Adobe Acrobat.
Returns: java.lang.String -
setAlternateName(String value)
public final void setAlternateName(String value)
Gets or sets component alternate name Alternate name is used as field tooltip in Adobe Acrobat.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
getPartialName()
public final String getPartialName()
Gets or sets component partial name
Returns: java.lang.String -
setPartialName(String value)
public final void setPartialName(String value)
Gets or sets component partial name
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
getNormalCaption()
public final String getNormalCaption()
Gets or sets component normal caption
Returns: java.lang.String -
setNormalCaption(String value)
public final void setNormalCaption(String value)
Gets or sets component normal caption
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
getRolloverCaption()
public final String getRolloverCaption()
Gets or sets rollover caption of button which shall be displayed when the user rolls the cursor into its active area without pressing the mouse button.
Returns: java.lang.String -
setRolloverCaption(String value)
public final void setRolloverCaption(String value)
Gets or sets rollover caption of button which shall be displayed when the user rolls the cursor into its active area without pressing the mouse button.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
getPenColor()
public final Integer getPenColor()
Gets or sets component pen color
Returns: java.lang.Integer -
setPenColor(Integer value)
public final void setPenColor(Integer value)
Gets or sets component pen color
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.Integer |
getButtonColor()
public final Integer getButtonColor()
Gets or sets component color
Returns: java.lang.Integer -
setButtonColor(Integer value)
public final void setButtonColor(Integer value)
Gets or sets component color
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.Integer |
equals(ButtonComponent other)
public final boolean equals(ButtonComponent other)
Compares Button Components using IEquatable Equals method
Parameters:
| Parameter | Type | Description |
|---|---|---|
| other | ButtonComponent | The ButtonComponent object to compare with the current object |
Returns: boolean -
equals(Object obj)
public boolean equals(Object obj)
Compares Button Components using standard object Equals method
Parameters:
| Parameter | Type | Description |
|---|---|---|
| obj | java.lang.Object | The object to compare with the current object |
Returns: boolean
hashCode()
public int hashCode()
Returns HashCode of Button Component
Returns: int
deepClone()
public Object deepClone()
Returns new Instance with same values
Returns: java.lang.Object -
toString()
public String toString()
Returns: java.lang.String
toString(ToStringStyle toStringStyle)
public String toString(ToStringStyle toStringStyle)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| toStringStyle | org.apache.commons.lang3.builder.ToStringStyle |
Returns: java.lang.String