Apache POI - Common 5.3.0 · org.apache.poi.sl.usermodel.Insets2D

Modifier and Type	Field and Description
public double	bottom The inset from the bottom.
public double	left The inset from the left.
public double	right The inset from the right.
public double	top The inset from the top.

Access	Constructor and Description
public	Insets2D(double the inset from the top. top, double the inset from the left. left, double the inset from the bottom. bottom, double the inset from the right. right) Creates and initializes a new `Insets` object with the specified top, left, bottom, and right insets.

Method Summary

Modifier and Type	Method and Description
public Insets2D	Returns: a copy of this `Insets2D` object. copy() Implements org.apache.poi.common.Duplicatable.copy. Create a copy of this object.
public boolean	Returns: `true` if the two insets are equal; otherwise `false`. equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Checks whether two insets objects are equal.
public int	Returns: a hash code for this Insets. hashCode() Overrides java.lang.Object.hashCode. Returns the hash code for this Insets.
public void	set(double the inset from the top. top, double the inset from the left. left, double the inset from the bottom. bottom, double the inset from the right. right) Set top, left, bottom, and right to the specified values
public String	Returns: a string representation of this `Insets` object. toString() Overrides java.lang.Object.toString. Returns a string representation of this `Insets` object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

bottom	back to summary
public double bottom The inset from the bottom. This value is subtracted from the Bottom of the rectangle to yield a new location for the Bottom.

left	back to summary
public double left The inset from the left. This value is added to the Left of the rectangle to yield a new location for the Left edge.

right	back to summary
public double right The inset from the right. This value is subtracted from the Right of the rectangle to yield a new location for the Right edge.

top	back to summary
public double top The inset from the top. This value is added to the Top of the rectangle to yield a new location for the Top.

Constructor Detail

Insets2D back to summary

Insets2D	back to summary
public Insets2D(double top, double left, double bottom, double right) Creates and initializes a new `Insets` object with the specified top, left, bottom, and right insets. Parameters top:double the inset from the top. left:double the inset from the left. bottom:double the inset from the bottom. right:double the inset from the right.

public Insets2D(double top, double left, double bottom, double right)

Creates and initializes a new Insets object with the specified top, left, bottom, and right insets.

Parameters

top:double: the inset from the top.
left:double: the inset from the left.
bottom:double: the inset from the bottom.
right:double: the inset from the right.

Method Detail

copy back to summary

copy	back to summary
public Insets2D copy() Implements org.apache.poi.common.Duplicatable.copy. Create a copy of this object. Returns:Insets2D a copy of this `Insets2D` object. Annotations @Override

public Insets2D copy()

Implements org.apache.poi.common.Duplicatable.copy.

Create a copy of this object.

Returns:Insets2D

a copy of this Insets2D object.

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Checks whether two insets objects are equal. Two instances of `Insets` are equal if the four integer values of the fields `top`, `left`, `bottom`, and `right` are all equal. Parameters obj:Object Doc from java.lang.Object.equals. the reference object with which to compare. Returns:boolean `true` if the two insets are equal; otherwise `false`. Since JDK1.1

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Checks whether two insets objects are equal. Two instances of Insets are equal if the four integer values of the fields top, left, bottom, and right are all equal.

Parameters

obj:Object

Doc from java.lang.Object.equals.

the reference object with which to compare.

Returns:boolean

true if the two insets are equal; otherwise false.

Since

JDK1.1

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Returns the hash code for this Insets. Returns:int a hash code for this Insets.

hashCode

back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Returns the hash code for this Insets.

Returns:int: a hash code for this Insets.

set	back to summary
public void set(double top, double left, double bottom, double right) Set top, left, bottom, and right to the specified values Parameters top:double the inset from the top. left:double the inset from the left. bottom:double the inset from the bottom. right:double the inset from the right. Since 1.5

set

back to summary

public void set(double top, double left, double bottom, double right)

Set top, left, bottom, and right to the specified values

Parameters

top:double: the inset from the top.
left:double: the inset from the left.
bottom:double: the inset from the bottom.
right:double: the inset from the right.

Since

1.5

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Returns a string representation of this `Insets` object. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not be `null`. Returns:String a string representation of this `Insets` object.

public String toString()

Overrides java.lang.Object.toString.

Returns a string representation of this Insets object. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not be null.

Returns:String: a string representation of this Insets object.

public final Class Insets2D

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail