AdjustCoordinate Class
An adjustment coordinate in a presentation shape.
Declaration
public final class AdjustCoordinate extends Struct<AdjustCoordinate> implements IEquatable<AdjustCoordinate>
Implements
Inherited Members
Inheritance
Constructors
AdjustCoordinate() Constructor
Initializes an empty instance of the AdjustCoordinate class.
Declaration
public AdjustCoordinate()
AdjustCoordinate(float value) Constructor
Initializes a new instance of the AdjustCoordinate class with specified coordinate.
Declaration
public AdjustCoordinate(float value)
Parameters
| Name | Type | Description |
|---|---|---|
| value | float | The coordinate. |
AdjustCoordinate(String guideName) Constructor
Initializes a new instance of the AdjustCoordinate class with specified guide name.
Declaration
public AdjustCoordinate(String guideName)
Parameters
| Name | Type | Description |
|---|---|---|
| guideName | String | The name of the adjustment guide associated with the coordinate. |
Fields
EMPTY Field
An empty AdjustCoordinate instance.
Declaration
public static final AdjustCoordinate EMPTY
Field Value
| Type | Description |
|---|---|
AdjustCoordinate |
The empty |
Methods
equals(AdjustCoordinate other) Method
Determines whether the specified object is equal to the current AdjustCoordinate object.
Declaration
public boolean equals(AdjustCoordinate other)
Parameters
| Name | Type | Description |
|---|---|---|
| other | AdjustCoordinate |
The |
Returns
| Type | Description |
|---|---|
| boolean |
|
equals(Object obj) Method
Determines whether the specified object is equal to the current AdjustCoordinate object.
Declaration
public boolean equals(Object obj)
Parameters
| Name | Type | Description |
|---|---|---|
| obj | Object | An object to compare with the current |
Returns
| Type | Description |
|---|---|
| boolean |
|
getGuideName() Method
Returns the name of the adjustment guide.
Declaration
public String getGuideName()
Returns
| Type | Description |
|---|---|
| String | The guide name. |
getIsEmpty() Method
Indicates whether the coordinate is empty.
Declaration
public boolean getIsEmpty()
Returns
| Type | Description |
|---|---|
| boolean |
|
getMode() Method
Returns the adjustment mode.
Declaration
public AdjustmentMode getMode()
Returns
| Type | Description |
|---|---|
| AdjustmentMode | An enumeration value that specifies the adjustment mode. |
Remarks
The adjustment mode specifies whether AdjustCoordinate stores:
- a numeric value
- a guide name
- an empty value.
getValue() Method
Returns the coordinate of the AdjustCoordinate object.
Declaration
public float getValue()
Returns
| Type | Description |
|---|---|
| float | The coordinate value. |
hashCode() Method
Returns a hash code for the AdjustCoordinate object.
Declaration
public int hashCode()
Returns
| Type | Description |
|---|---|
| int | The hash code. |