public class

Dimension

extends Dimension2D
implements Serializable
java.lang.Object
   ↳ java.awt.geom.Dimension2D
     ↳ java.awt.Dimension
Known Direct Subclasses

Class Overview

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.

See Also

Summary

Fields
public int height The height dimension; negative values can be used.@serial
public int width The width dimension; negative values can be used.@serial
Public Constructors
Dimension()
Creates an instance of Dimension with a width of zero and a height of zero.
Dimension(Dimension d)
Creates an instance of Dimension whose width and height are the same as for the specified dimension.
Dimension(int width, int height)
Constructs a Dimension and initializes it to the specified width and specified height.
Public Methods
boolean equals(Object obj)
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(double width, double height)
Sets the size of this Dimension object to the specified width and height in double precision.
void setSize(Dimension d)
Sets the size of this Dimension object to the specified size.
void setSize(int width, int height)
Sets the size of this Dimension object to the specified width and height.
String toString()
Returns a string representation of the values of this Dimension object's height and width fields.
[Expand]
Inherited Methods
From class java.awt.geom.Dimension2D
From class java.lang.Object

Fields

public int height

The height dimension; negative values can be used.@serial

See Also

public int width

The width dimension; negative values can be used.@serial

See Also

Public Constructors

public Dimension ()

Creates an instance of Dimension with a width of zero and a height of zero.

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 the width and height values

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

Public Methods

public boolean equals (Object obj)

Checks whether two dimension objects have equal values.

Parameters
obj the reference object with which to compare.
Returns
  • true if this object is the same as the obj argument; false otherwise.

public double getHeight ()

Returns the height of this Dimension in double precision.

Returns
  • the height of this Dimension.

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 Dimension with the same width and height
See Also

public double getWidth ()

Returns the width of this Dimension in double precision.

Returns
  • the width of this Dimension.

public int hashCode ()

Returns the hash code for this Dimension.

Returns
  • a hash code for this Dimension

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.

Parameters
width the new width for the Dimension object
height the new height for the Dimension object

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 this Dimension object
See Also

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 this Dimension object
height the new height for this Dimension object
See Also

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.

Returns
  • a string representation of this Dimension object