com.aspose.words

Class PreferredWidth

java.lang.Object

com.aspose.words.PreferredWidth

public final class PreferredWidth
extends java.lang.Object

Represents a value and its unit of measure that is used to specify the preferred width of a table or a cell.

Preferred width can be specified as a percentage, number of points or a special "none/auto" value.

The instances of this class are immutable.

See Also:

Table.getPreferredWidth(), Table.setPreferredWidth(com.aspose.words.PreferredWidth), CellFormat.getPreferredWidth(), CellFormat.setPreferredWidth(com.aspose.words.PreferredWidth)

Field Summary

Fields

Modifier and Type	Field and Description
static PreferredWidth	AUTO Returns an instance that represents the "preferred width is not specified" value.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Determines whether the specified object is equal in value to the current object.
boolean	equals(PreferredWidth other) Determines whether the specified PreferredWidth is equal in value to the current PreferredWidth.
static PreferredWidth	fromPercent(double percent) A creation method that returns a new instance that represents a preferred width specified as a percentage.
static PreferredWidth	fromPoints(double points) A creation method that returns a new instance that represents a preferred width specified using a number of points.
int	getType() Gets the unit of measure used for this preferred width value.
double	getValue() Gets the preferred width value.
int	hashCode()
java.lang.String	toString() Returns a user-friendly string that displays the value of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

AUTO

public static PreferredWidth AUTO

Returns an instance that represents the "preferred width is not specified" value.

Method Detail

fromPercent

public static PreferredWidth fromPercent(double percent)

A creation method that returns a new instance that represents a preferred width specified as a percentage.

Parameters:

percent - The value must be from 0 to 100.

fromPoints

public static PreferredWidth fromPoints(double points)

A creation method that returns a new instance that represents a preferred width specified using a number of points.

Parameters:

points - The value must be from 0 to 22 inches (22 * 72 points).

getType

public final int getType()

Gets the unit of measure used for this preferred width value.

Returns:

The unit of measure used for this preferred width value. The returned value is one of PreferredWidthType constants.

getValue

public final double getValue()

Gets the preferred width value. The unit of measure is specified in the getType() property.

Returns:

The preferred width value.

equals

public final boolean equals(PreferredWidth other)

Determines whether the specified PreferredWidth is equal in value to the current PreferredWidth.

equals

public final boolean equals(java.lang.Object obj)

Determines whether the specified object is equal in value to the current object.

Overrides:

equals in class java.lang.Object

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public final java.lang.String toString()

Returns a user-friendly string that displays the value of this object.

Overrides:

toString in class java.lang.Object