Class Dimension
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
The
Dimension 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 the Component class and the LayoutManager interface return a Dimension object. Normally the values of width and height 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 of width or height is negative, the behavior of some methods defined by other objects is undefined.
- Since:
- 1.0
- See Also:
Field Summary
| Modifier and Type | Field | Description |
|---|---|---|
int |
height |
The height dimension; negative values can be used. |
int |
width |
The width dimension; negative values can be used. |
Constructor Summary
| Constructor | Description |
|---|---|
Dimension() |
Creates an instance of Dimension with a width of zero and a height of zero. |
Dimension |
Constructs a Dimension and initializes it to the specified width and specified height. |
Dimension |
Creates an instance of Dimension whose width and height are the same as for the specified dimension. |
Method Summary
| Modifier and Type | Method | Description |
|---|---|---|
boolean |
equals |
Checks whether two dimension objects have equal values. |
double |
getHeight() |
Returns the height of this Dimension in double precision. |
Dimension |
getSize() |
Gets the size of this Dimension object. |
double |
getWidth() |
Returns the width of this Dimension in double precision. |
int |
hashCode() |
Returns the hash code for this Dimension. |
void |
setSize |
Sets the size of this Dimension object to the specified width and height in double precision. |
void |
setSize |
Sets the size of this Dimension object to the specified width and height. |
void |
setSize |
Sets the size of this Dimension object to the specified size. |
String |
toString() |
Returns a string representation of the values of this Dimension object's height and width fields. |
Methods declared in class Dimension2D
clone, setSize | Modifier and Type | Method | Description |
|---|---|---|
Object |
clone() |
Creates a new object of the same class as this object. |
void |
setSize |
Sets the size of this Dimension2D object to match the specified size. |
Methods declared in class Object
finalize, getClass, notify, notifyAll, wait, wait, wait | Modifier and Type | Method | Description |
|---|---|---|
protected void |
finalize() |
Deprecated, for removal: This API element is subject to removal in a future version. Finalization is deprecated and subject to removal in a future release. |
final Class |
getClass() |
Returns the runtime class of this Object. |
final void |
notify() |
Wakes up a single thread that is waiting on this object's monitor. |
final void |
notifyAll() |
Wakes up all threads that are waiting on this object's monitor. |
final void |
wait() |
Causes the current thread to wait until it is awakened, typically by being notified or interrupted. |
final void |
wait |
Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. |
final void |
wait |
Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. |
Field Details
width
public int width
The width dimension; negative values can be used.
- Since:
- 1.0
- See Also:
height
public int height
The height dimension; negative values can be used.
- Since:
- 1.0
- See Also:
Constructor Details
Dimension
public Dimension()
Creates an instance of
Dimension with a width of zero and a height of zero.Dimension
public Dimension(Dimension d)
Creates an instance of
Dimension whose width and height are the same as for the specified dimension.- Parameters:
-
d- the specified dimension for thewidthandheightvalues
Dimension
public Dimension(int width, int height)
Constructs a
Dimension and initializes it to the specified width and specified height.- Parameters:
-
width- the specified width -
height- the specified height
Method Details
getWidth
public double getWidth()
Returns the width of this
Dimension in double precision.- Specified by:
-
getWidthin classDimension2D - Returns:
- the width of this
Dimension. - Since:
- 1.2
getHeight
public double getHeight()
Returns the height of this
Dimension in double precision.- Specified by:
-
getHeightin classDimension2D - Returns:
- the height of this
Dimension. - Since:
- 1.2
setSize
public void setSize(double width, double height)
Sets the size of this
Dimension object to the specified width and height in double precision. Note that if width or height are larger than Integer.MAX_VALUE, they will be reset to Integer.MAX_VALUE.- Specified by:
-
setSizein classDimension2D - Parameters:
-
width- the new width for theDimensionobject -
height- the new height for theDimensionobject - Since:
- 1.2
getSize
public Dimension getSize()
Gets the size of this
Dimension object. This method is included for completeness, to parallel the getSize method defined by Component.- Returns:
- the size of this dimension, a new instance of
Dimensionwith the same width and height - Since:
- 1.1
- See Also:
setSize
public void setSize(Dimension d)
Sets the size of this
Dimension object to the specified size. This method is included for completeness, to parallel the setSize method defined by Component.- Parameters:
-
d- the new size for thisDimensionobject - Since:
- 1.1
- See Also:
setSize
public void setSize(int width, int height)
Sets the size of this
Dimension object to the specified width and height. This method is included for completeness, to parallel the setSize method defined by Component.- Parameters:
-
width- the new width for thisDimensionobject -
height- the new height for thisDimensionobject - Since:
- 1.1
- See Also:
equals
hashCode
toString
public String toString()
Returns a string representation of the values of this
Dimension object's height and width 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 be null.
© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.