Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

java.awt
Class Dimension  view Dimension download Dimension.java

java.lang.Object
  extended byjava.awt.geom.Dimension2D
      extended byjava.awt.Dimension
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable

public class Dimension
extends java.awt.geom.Dimension2D
implements java.io.Serializable

This class holds a width and height value pair. This is used in plenty of windowing classes, but also has geometric meaning.

It is valid for a dimension to have negative width or height; but it is considered to have no area. Therefore, the behavior in various methods is undefined in such a case.

There are some public fields; if you mess with them in an inconsistent manner, it is your own fault when you get invalid results. Also, this class is not threadsafe.

Since:
1.0

Field Summary
 int height
          The height of this object.
private static long serialVersionUID
          Compatible with JDK 1.0+.
 int width
          The width of this object.
 
Constructor Summary
Dimension()
          Create a new Dimension with a width and height of zero.
Dimension(Dimension d)
          Create a new Dimension with width and height identical to that of the specified dimension.
Dimension(int w, int h)
          Create a new Dimension with the specified width and height.
 
Method Summary
 boolean equals(java.lang.Object obj)
          Tests this object for equality against the specified object.
 double getHeight()
          Gets the height of this dimension.
 Dimension getSize()
          Returns the size of this dimension.
 double getWidth()
          Gets the width of this dimension.
 int hashCode()
          Return the hashcode for this object.
 void setSize(Dimension d)
          Sets the width and height of this object to match that of the specified object.
 void setSize(double w, double h)
          Sets the size of this dimension.
 void setSize(int w, int h)
          Sets the width and height of this object to the specified values.
 java.lang.String toString()
          Returns a string representation of this object.
 
Methods inherited from class java.awt.geom.Dimension2D
clone, setSize
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

serialVersionUID

private static final long serialVersionUID
Compatible with JDK 1.0+.

See Also:
Constant Field Values

width

public int width
The width of this object.

See Also:
getSize() 55 , setSize(double, double) 55

height

public int height
The height of this object.

See Also:
getSize() 55 , setSize(double, double) 55
Constructor Detail

Dimension

public Dimension()
Create a new Dimension with a width and height of zero.


Dimension

public Dimension(Dimension d)
Create a new Dimension with width and height identical to that of the specified dimension.


Dimension

public Dimension(int w,
                 int h)
Create a new Dimension with the specified width and height.

Method Detail

getWidth

public double getWidth()
Gets the width of this dimension.


getHeight

public double getHeight()
Gets the height of this dimension.


setSize

public void setSize(double w,
                    double h)
Sets the size of this dimension. The values are rounded to int.

Since:
1.2

getSize

public Dimension getSize()
Returns the size of this dimension. A pretty useless method, as this is already a dimension.

Since:
1.1

setSize

public void setSize(Dimension d)
Sets the width and height of this object to match that of the specified object.

Since:
1.1

setSize

public void setSize(int w,
                    int h)
Sets the width and height of this object to the specified values.


equals

public boolean equals(java.lang.Object obj)
Tests this object for equality against the specified object. This will be true if and only if the specified object is an instance of Dimension2D, and has the same width and height.


hashCode

public int hashCode()
Return the hashcode for this object. It is not documented, but appears to be ((width + height) * (width + height + 1) / 2) + width.


toString

public java.lang.String toString()
Returns a string representation of this object. The format is: getClass().getName() + "[width=" + width + ",height=" + height + ']'.