ButtonIconFit Class

Specifies how a button icon is scaled and positioned within a button field.

Declaration

public class ButtonIconFit extends JavaObject

Remarks

Use the ButtonIconFit class to define when an icon is scaled, how it is scaled, its alignment, and whether it fits the annotation bounds.

Refer to the following help topic for additional information: Work with PDF Forms (AcroForms).

Inherited Members

com.devexpress.system.JavaObject.clone()

com.devexpress.system.JavaObject.equals(java.lang.Object)

com.devexpress.system.JavaObject.hashCode()

com.devexpress.system.JavaObject.initFields()

com.devexpress.system.JavaObject.memberwiseClone()

com.devexpress.system.JavaObject.toString()

java.lang.Object.finalize()

java.lang.Object.getClass()

java.lang.Object.notify()

java.lang.Object.notifyAll()

java.lang.Object.wait()

java.lang.Object.wait(long)

java.lang.Object.wait(long,int)

Inheritance

Object

com.devexpress.system.JavaObject

ButtonIconFit

ButtonIconFit()

Initializes a new instance of the ButtonIconFit class.

Declaration

public ButtonIconFit()

Methods

deepClone() Method

Creates a deep copy of the current object.

Declaration

public ButtonIconFit deepClone()

Returns

Type	Description
ButtonIconFit	A deep copy of the current object.

getFitToAnnotationBounds() Method

Returns whether the button icon is scaled to fit the annotation bounds.

Declaration

public boolean getFitToAnnotationBounds()

Returns

Type	Description
boolean	true if the icon is scaled to fit the annotation bounds; otherwise, false.

getHorizontalPosition() Method

Returns the horizontal position of the button icon.

Declaration

public double getHorizontalPosition()

Returns

Type	Description
double	A value from 0.0 (left) to 1.0 (right).

getScalingCircumstances() Method

Returns circumstances under which the button icon is scaled.

Declaration

public ButtonIconScalingCircumstances getScalingCircumstances()

Returns

Type	Description
ButtonIconScalingCircumstances	A value that specifies when to scale the button icon.

getScalingType() Method

Returns a value that specifies how to scale a button icon.

Declaration

public ButtonIconScalingType getScalingType()

Returns

Type	Description
ButtonIconScalingType	A ButtonIconScalingType value that specifies how to scale the button icon.

getVerticalPosition() Method

Returns the vertical position of the button icon.

Declaration

public double getVerticalPosition()

Returns

Type	Description
double	A value from 0.0 (bottom) to 1.0 (top).

setFitToAnnotationBounds(boolean value) Method

Sets whether the button icon is scaled to fit the annotation bounds.

Declaration

public void setFitToAnnotationBounds(boolean value)

Parameters

Name	Type	Description
value	boolean	true if the icon is scaled to fit the annotation bounds; otherwise, false.

setHorizontalPosition(double value) Method

Sets the horizontal position of the button icon.

Declaration

public void setHorizontalPosition(double value)

Parameters

Name	Type	Description
value	double	A value from 0.0 (left) to 1.0 (right).

setScalingCircumstances(ButtonIconScalingCircumstances value) Method

Specifies circumstances under which the button icon is scaled.

Declaration

public void setScalingCircumstances(ButtonIconScalingCircumstances value)

Parameters

Name	Type	Description
value	ButtonIconScalingCircumstances	A value that specifies when to scale the button icon.

setScalingType(ButtonIconScalingType value) Method

Specifies how to scale a button icon.

Declaration

public void setScalingType(ButtonIconScalingType value)

Parameters

Name	Type	Description
value	ButtonIconScalingType	A ButtonIconScalingType value that specifies how to scale the button icon.

setVerticalPosition(double value) Method

Sets the vertical position of the button icon.

Declaration

public void setVerticalPosition(double value)

Parameters

Name	Type	Description
value	double	A value from 0.0 (bottom) to 1.0 (top).