FileDocCategorySizeDatePackage
Dimension.javaAPI DocJava SE 6 API6556Tue Jun 10 00:25:14 BST 2008java.awt

Dimension

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.

version
1.34, 02/24/06
author
Sami Shaio
author
Arthur van Hoff
see
java.awt.Component
see
java.awt.LayoutManager
since
1.0

Fields Summary
public int
width
The width dimension; negative values can be used.
public int
height
The height dimension; negative values can be used.
private static final long
serialVersionUID
Constructors Summary
public Dimension()
Creates an instance of Dimension with a width of zero and a height of zero.


               
        

     
        /* ensure that the necessary native libraries are loaded */
	Toolkit.loadLibraries();
        if (!GraphicsEnvironment.isHeadless()) {
            initIDs();
        }
    
	this(0, 0);
    
public Dimension(Dimension d)
Creates an instance of Dimension whose width and height are the same as for the specified dimension.

param
d the specified dimension for the width and height values

	this(d.width, d.height);
    
public Dimension(int width, int height)
Constructs a Dimension and initializes it to the specified width and specified height.

param
width the specified width
param
height the specified height

	this.width = width;
	this.height = height;
    
Methods Summary
public booleanequals(java.lang.Object obj)
Checks whether two dimension objects have equal values.

	if (obj instanceof Dimension) {
	    Dimension d = (Dimension)obj;
	    return (width == d.width) && (height == d.height);
	}
	return false;
    
public doublegetHeight()
{@inheritDoc}

since
1.2

	return height;
    
public java.awt.DimensiongetSize()
Gets the size of this Dimension object. This method is included for completeness, to parallel the getSize method defined by Component.

return
the size of this dimension, a new instance of Dimension with the same width and height
see
java.awt.Dimension#setSize
see
java.awt.Component#getSize
since
1.1

	return new Dimension(width, height);
    
public doublegetWidth()
{@inheritDoc}

since
1.2

	return width;
    
public inthashCode()
Returns the hash code for this Dimension.

return
a hash code for this Dimension

        int sum = width + height;
        return sum * (sum + 1)/2 + width;
    
private static native voidinitIDs()
Initialize JNI field and method IDs

public voidsetSize(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.

param
width the new width for this Dimension object
param
height the new height for this Dimension object
see
java.awt.Dimension#getSize
see
java.awt.Component#setSize
since
1.1

    	this.width = width;
    	this.height = height;
    
public voidsetSize(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.

param
width the new width for the Dimension object
param
height the new height for the Dimension object
since
1.2

	this.width = (int) Math.ceil(width);
	this.height = (int) Math.ceil(height);
    
public voidsetSize(java.awt.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.

param
d the new size for this Dimension object
see
java.awt.Dimension#getSize
see
java.awt.Component#setSize
since
1.1

	setSize(d.width, d.height);
    
public java.lang.StringtoString()
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.

return
a string representation of this Dimension object

	return getClass().getName() + "[width=" + width + ",height=" + height + "]";