- java.lang.Object
-
- java.awt.geom.Dimension2D
-
- java.awt.Dimension
-
- All Implemented Interfaces:
- Serializable, Cloneable
- Direct Known Subclasses:
- DimensionUIResource
public class Dimension extends Dimension2D implements Serializable
TheDimension
class encapsulates the width and height of a component (in integer precision) in a single object. The class is associated with certain properties of components. Several methods defined by theComponent
class and theLayoutManager
interface return aDimension
object.Normally the values of
width
andheight
are non-negative integers. The constructors that allow you to create a dimension do not prevent you from setting a negative value for these properties. If the value ofwidth
orheight
is negative, the behavior of some methods defined by other objects is undefined.- Since:
- 1.0
- See Also:
Component
,LayoutManager
, Serialized Form
-
-
Field Summary
Fields Modifier and Type Field and Description int
height
The height dimension; negative values can be used.int
width
The width dimension; negative values can be used.
-
Constructor Summary
Constructors Constructor and Description Dimension()
Creates an instance ofDimension
with a width of zero and a height of zero.Dimension(Dimension d)
Creates an instance ofDimension
whose width and height are the same as for the specified dimension.Dimension(int width, int height)
Constructs aDimension
and initializes it to the specified width and specified height.
-
Method Summary
Methods Modifier and Type Method and Description boolean
equals(Object obj)
Checks whether two dimension objects have equal values.double
getHeight()
Returns the height of thisDimension
in double precision.Dimension
getSize()
Gets the size of thisDimension
object.double
getWidth()
Returns the width of thisDimension
in double precision.int
hashCode()
Returns the hash code for thisDimension
.void
setSize(Dimension d)
Sets the size of thisDimension
object to the specified size.void
setSize(double width, double height)
Sets the size of thisDimension
object to the specified width and height in double precision.void
setSize(int width, int height)
Sets the size of thisDimension
object to the specified width and height.String
toString()
Returns a string representation of the values of thisDimension
object'sheight
andwidth
fields.
-
-
-
Field Detail
-
width
public int width
The width dimension; negative values can be used.- Since:
- 1.0
- See Also:
getSize()
,setSize(double, double)
-
height
public int height
The height dimension; negative values can be used.- Since:
- 1.0
- See Also:
getSize()
,setSize(double, double)
-
-
Constructor Detail
-
Dimension
public Dimension()
Creates an instance ofDimension
with a width of zero and a height of zero.
-
Dimension
public Dimension(Dimension d)
Creates an instance ofDimension
whose width and height are the same as for the specified dimension.- Parameters:
d
- the specified dimension for thewidth
andheight
values
-
Dimension
public Dimension(int width, int height)
Constructs aDimension
and initializes it to the specified width and specified height.- Parameters:
width
- the specified widthheight
- the specified height
-
-
Method Detail
-
getWidth
public double getWidth()
Returns the width of thisDimension
in double precision.- Specified by:
getWidth
in classDimension2D
- Returns:
- the width of this
Dimension
. - Since:
- 1.2
-
getHeight
public double getHeight()
Returns the height of thisDimension
in double precision.- Specified by:
getHeight
in classDimension2D
- Returns:
- the height of this
Dimension
. - Since:
- 1.2
-
setSize
public void setSize(double width, double height)
Sets the size of thisDimension
object to the specified width and height in double precision. Note that ifwidth
orheight
are larger thanInteger.MAX_VALUE
, they will be reset toInteger.MAX_VALUE
.- Specified by:
setSize
in classDimension2D
- Parameters:
width
- the new width for theDimension
objectheight
- the new height for theDimension
object- Since:
- 1.2
-
getSize
public Dimension getSize()
Gets the size of thisDimension
object. This method is included for completeness, to parallel thegetSize
method defined byComponent
.- Returns:
- the size of this dimension, a new instance of
Dimension
with the same width and height - Since:
- 1.1
- See Also:
setSize(double, double)
,Component.getSize()
-
setSize
public void setSize(Dimension d)
Sets the size of thisDimension
object to the specified size. This method is included for completeness, to parallel thesetSize
method defined byComponent
.- Parameters:
d
- the new size for thisDimension
object- Since:
- 1.1
- See Also:
getSize()
,Component.setSize(int, int)
-
setSize
public void setSize(int width, int height)
Sets the size of thisDimension
object to the specified width and height. This method is included for completeness, to parallel thesetSize
method defined byComponent
.- Parameters:
width
- the new width for thisDimension
objectheight
- the new height for thisDimension
object- Since:
- 1.1
- See Also:
getSize()
,Component.setSize(int, int)
-
equals
public boolean equals(Object obj)
Checks whether two dimension objects have equal values.- Overrides:
equals
in classObject
- Parameters:
obj
- the reference object with which to compare.- Returns:
true
if this object is the same as the obj argument;false
otherwise.- See Also:
Object.hashCode()
,HashMap
-
hashCode
public int hashCode()
Returns the hash code for thisDimension
.- Overrides:
hashCode
in classObject
- Returns:
- a hash code for this
Dimension
- See Also:
Object.equals(java.lang.Object)
,System.identityHashCode(java.lang.Object)
-
toString
public String toString()
Returns a string representation of the values of thisDimension
object'sheight
andwidth
fields. 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 benull
.
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-java/awt/dimension.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.