public class Dimension extends java.lang.Object implements java.lang.Cloneable, java.io.Serializable, Translatable
Modifier and Type | Field and Description |
---|---|
int |
height
The height.
|
static Dimension |
SINGLETON
A singleton for use in short calculations.
|
int |
width
The width.
|
Constructor and Description |
---|
Dimension()
Constructs a Dimension of zero width and height.
|
Dimension(Dimension d)
Constructs a Dimension with the width and height of the passed Dimension.
|
Dimension(Image image)
Constructs a Dimension with the width and height of the Image supplied as
input.
|
Dimension(int w,
int h)
Constructs a Dimension with the supplied width and height values.
|
Dimension(Point p)
Constructs a Dimension where the width and height are the x and y
distances of the input point from the origin.
|
Modifier and Type | Method and Description |
---|---|
boolean |
contains(Dimension d)
Returns
true if the input Dimension fits into this
Dimension. |
boolean |
containsProper(Dimension d)
Returns
true if this Dimension properly contains the one
specified. |
boolean |
equals(int w,
int h)
Returns
true if this Dimension's width and height are equal
to the given width and height. |
boolean |
equals(java.lang.Object o)
Returns whether the input Object is equivalent to this Dimension.
|
Dimension |
expand(Dimension d)
Expands the size of this Dimension by the specified amount.
|
Dimension |
expand(double w,
double h)
Expands the size of this Dimension by the specified width and height.
|
Dimension |
expand(int w,
int h)
Expands the size of this Dimension by the specified width and height.
|
Dimension |
expand(Point p)
Deprecated.
Use
expand(int, int) instead. |
int |
getArea()
Returns the area of this Dimension.
|
Dimension |
getCopy()
Creates and returns a copy of this Dimension.
|
Dimension |
getDifference(Dimension d)
Deprecated.
Use
getShrinked(Dimension) instead. |
Dimension |
getExpanded(Dimension d)
Creates and returns a Dimension representing the sum of this Dimension
and the one specified.
|
Dimension |
getExpanded(double w,
double h)
Creates and returns a new Dimension representing the sum of this
Dimension and the one specified.
|
Dimension |
getExpanded(int w,
int h)
Creates and returns a new Dimension representing the sum of this
Dimension and the one specified.
|
Dimension |
getIntersected(Dimension d)
Creates and returns a new Dimension representing the intersection of this
Dimension and the one specified.
|
Dimension |
getNegated()
Creates and returns a new Dimension with negated values.
|
Dimension |
getScaled(double amount)
Creates a new Dimension with its width and height scaled by the specified
value.
|
Dimension |
getShrinked(Dimension d)
Creates and returns a new Dimension whose size will be reduced by the
width and height of the given Dimension.
|
Dimension |
getShrinked(double w,
double h)
Creates and returns a new Dimension whose size will be reduced by the
width and height of the given Dimension.
|
Dimension |
getShrinked(int w,
int h)
Creates and returns a new Dimension whose size will be reduced by the
width and height of the given Dimension.
|
Dimension |
getTransposed()
Creates a new Dimension with its height and width swapped.
|
Dimension |
getUnioned(Dimension d)
Creates a new Dimension representing the union of this Dimension with the
one specified.
|
int |
hashCode() |
int |
height()
Returns the height of this dimension.
|
Dimension |
intersect(Dimension d)
This Dimension is intersected with the one specified.
|
boolean |
isEmpty()
Returns
true if either dimension is less than or equal to 0. |
static Dimension |
max(Dimension d1,
Dimension d2)
Creates a new Dimension representing the MAX of two provided Dimensions.
|
static Dimension |
min(Dimension d1,
Dimension d2)
Creates a new Dimension representing the MIN of two provided Dimensions.
|
Dimension |
negate()
Negates the width and height of this Dimension.
|
void |
performScale(double factor)
Scales this object by the scale factor.
|
void |
performTranslate(int dx,
int dy)
Translates this object horizontally by
dx and vertically by
dy . |
double |
preciseHeight()
Returns
double height |
double |
preciseWidth()
Returns
double width |
Dimension |
scale(double factor)
Scales the width and height of this Dimension by the amount supplied, and
returns this for convenience.
|
Dimension |
scale(double widthFactor,
double heightFactor)
Scales the width of this Dimension by w and scales the height of
this Dimension by h.
|
Dimension |
setHeight(int height)
Sets the height of this Rectangle to the specified one.
|
void |
setSize(Dimension d)
Copies the width and height values of the input Dimension to this
Dimension.
|
Dimension |
setSize(int w,
int h)
Sets the size of this dimension to the specified width and height.
|
Dimension |
setWidth(int width)
Sets the width of this Rectangle to the specified one.
|
Dimension |
shrink(Dimension d)
Shrinks the size of this Dimension by the width and height values of the
given Dimension.
|
Dimension |
shrink(double w,
double h)
Reduces the width of this Dimension by w, and reduces the height
of this Dimension by h.
|
Dimension |
shrink(int w,
int h)
Reduces the width of this Dimension by w, and reduces the height
of this Dimension by h.
|
java.lang.String |
toString() |
Dimension |
transpose()
Swaps the width and height of this Dimension, and returns this for
convenience.
|
Dimension |
union(Dimension d)
Sets the width of this Dimension to the greater of this Dimension's width
and d.width.
|
int |
width()
Returns the width of this dimension
|
public static final Dimension SINGLETON
public int width
public int height
public Dimension()
public Dimension(Dimension d)
d
- the Dimension supplying the initial valuespublic Dimension(int w, int h)
w
- the widthh
- the heightpublic Dimension(Image image)
image
- the image supplying the dimensionspublic Dimension(Point p)
p
- the Point supplying the initial valuespublic static Dimension max(Dimension d1, Dimension d2)
d1
- first dimensiond2
- second dimensionpublic static Dimension min(Dimension d1, Dimension d2)
d1
- first dimensiond2
- second dimensionpublic boolean contains(Dimension d)
true
if the input Dimension fits into this
Dimension. A Dimension of the same size is considered to "fit".d
- the dimension being testedtrue
if this Dimension contains dpublic boolean containsProper(Dimension d)
true
if this Dimension properly contains the one
specified. Proper containment is defined as containment using \"<\",
instead of \"<=\".d
- the dimension being testedtrue
if this Dimension properly contains the one
specifiedpublic boolean equals(int w, int h)
true
if this Dimension's width and height are equal
to the given width and height.w
- the widthh
- the heighttrue
if this dimension's width and height are equal
to those given.public boolean equals(java.lang.Object o)
true
if the Object is a Dimension and its width and height
are equal to this Dimension's width and height, false
otherwise.equals
in class java.lang.Object
o
- the Object being tested for equalitytrue
if the given object is equal to this dimensionpublic Dimension expand(Dimension d)
d
- the Dimension providing the expansion width and heightthis
for conveniencepublic Dimension expand(double w, double h)
w
- Value by which the width should be increasedh
- Value by which the height should be increasedthis
for conveniencepublic Dimension expand(int w, int h)
w
- Value by which the width should be increasedh
- Value by which the height should be increasedthis
for conveniencepublic Dimension expand(Point p)
expand(int, int)
instead.p
- the Point supplying the dimensional valuesthis
for conveniencepublic int getArea()
public Dimension getCopy()
public Dimension getDifference(Dimension d)
getShrinked(Dimension)
instead.d
- the dimension being comparedpublic Dimension getExpanded(Dimension d)
d
- the dimension providing the expansion width and heightpublic Dimension getExpanded(double w, double h)
w
- value by which the width of this is to be expandedh
- value by which the height of this is to be expandedpublic Dimension getExpanded(int w, int h)
w
- value by which the width of this is to be expandedh
- value by which the height of this is to be expandedpublic Dimension getIntersected(Dimension d)
d
- the Dimension to intersect withpublic Dimension getNegated()
public Dimension getScaled(double amount)
amount
- Value by which the width and height are scaledpublic Dimension getShrinked(Dimension d)
d
- the dimension whose width and height values will be consideredpublic Dimension getShrinked(double w, double h)
w
- the value by which the width is to be reducedh
- the value by which the height is to be reducedpublic Dimension getShrinked(int w, int h)
w
- the value by which the width is to be reducedh
- the value by which the height is to be reducedpublic Dimension getTransposed()
public Dimension getUnioned(Dimension d)
d
- the Dimension to be unionedpublic int hashCode()
hashCode
in class java.lang.Object
Object.hashCode()
public int height()
public Dimension intersect(Dimension d)
d
- the Dimension used to perform the min()this
for conveniencepublic boolean isEmpty()
true
if either dimension is less than or equal to 0.true
if either dimension is less than or equal to 0.public Dimension negate()
this
for conveniencepublic void performScale(double factor)
Translatable
performScale
in interface Translatable
factor
- The scale factorTranslatable.performScale(double)
public void performTranslate(int dx, int dy)
Translatable
dx
and vertically by
dy
.performTranslate
in interface Translatable
dx
- The amount to translate horizontallydy
- The amount to translate verticallyTranslatable.performTranslate(int, int)
public double preciseHeight()
double
heightdouble
heightpublic double preciseWidth()
double
widthdouble
widthpublic Dimension scale(double factor)
factor
- value by which this Dimension's width and height are to be
scaledthis
for conveniencepublic Dimension scale(double widthFactor, double heightFactor)
widthFactor
- the value by which the width is to be scaledheightFactor
- the value by which the height is to be scaledthis
for conveniencepublic Dimension setHeight(int height)
height
- The new heightpublic void setSize(Dimension d)
d
- the dimension supplying the valuespublic Dimension setSize(int w, int h)
w
- The new widthh
- The new heightpublic Dimension setWidth(int width)
width
- The new widthpublic Dimension shrink(Dimension d)
d
- The dimension whose width and height values are to be usedthis
for conveniencepublic Dimension shrink(double w, double h)
w
- the value by which the width is to be reducedh
- the value by which the height is to be reducedthis
for conveniencepublic Dimension shrink(int w, int h)
w
- the value by which the width is to be reducedh
- the value by which the height is to be reducedthis
for conveniencepublic java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public Dimension transpose()
this
for conveniencepublic Dimension union(Dimension d)
d
- the Dimension to union with this Dimensionthis
for conveniencepublic int width()
Copyright (c) IBM Corp. and others 2000, 2011. All Rights Reserved.