java::awt::Insets Class Reference

Inheritance diagram for java::awt::Insets:

Inheritance graph
java::lang::Object
[legend]
Collaboration diagram for java::awt::Insets:

Collaboration graph
java::lang::Object
[legend]

List of all members.


Detailed Description

An Insets object is a representation of the borders of a container.

It specifies the space that a container must leave at each of its edges. The space can be a border, a blank space, or a title.

Version:
1.28, 01/23/03
Author:
Arthur van Hoff

Sami Shaio

See also:
java.awt.LayoutManager

java.awt.Container

Since:
JDK1.0

Public Member Functions

 Insets ()
 Default constructor.
 Insets (jint _top, jint _left, jint _bottom, jint _right)
 Creates and initializes a new Insets object with the specified top, left, bottom, and right insets.
virtual jboolean equals (const Object &obj) const
 Checks whether two insets objects are equal.
virtual jint hashCode () const
 Returns the hash code for this Insets.
virtual String toString () const
 Returns a string representation of this Insets object.
Insetsoperator+= (const Insets &insets)
 Returns a insets that is the combination of this instance and provided insets.
Insets operator+ (const Insets &insets) const
 Returns a new insets that is the combination of two insets.

Public Attributes

jint top
 The inset from the top.
jint left
 The inset from the left.
jint bottom
 The inset from the bottom.
jint right
 The inset from the right.

Constructor & Destructor Documentation

java::awt::Insets::Insets (  ) 

Default constructor.

java::awt::Insets::Insets ( jint  _top,
jint  _left,
jint  _bottom,
jint  _right 
)

Creates and initializes a new Insets object with the specified top, left, bottom, and right insets.

Parameters:
top the inset from the top.
left the inset from the left.
bottom the inset from the bottom.
right the inset from the right.


Member Function Documentation

virtual jboolean java::awt::Insets::equals ( const Object obj  )  const [virtual]

Checks whether two insets objects are equal.

Two instances of Insets are equal if the four integer values of the fields top, left, bottom, and right are all equal.

Returns:
true if the two insets are equal; otherwise false.
Since:
JDK1.1

Reimplemented from java::lang::Object.

virtual jint java::awt::Insets::hashCode (  )  const [virtual]

Returns the hash code for this Insets.

Returns:
a hash code for this Insets.

Reimplemented from java::lang::Object.

virtual String java::awt::Insets::toString (  )  const [virtual]

Returns a string representation of this Insets object.

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 Insets object.

Reimplemented from java::lang::Object.

Insets& java::awt::Insets::operator+= ( const Insets insets  ) 

Returns a insets that is the combination of this instance and provided insets.

Parameters:
insets the insets to be merged
Returns:
a merged insets.

Insets java::awt::Insets::operator+ ( const Insets insets  )  const

Returns a new insets that is the combination of two insets.

Parameters:
i1 the first insets to be merged
i2 the second insets to be merged
Returns:
a merged insets.


Member Data Documentation

jint java::awt::Insets::top

The inset from the top.

This value is added to the Top of the rectangle to yield a new location for the Top.

See also:
clone()

jint java::awt::Insets::left

The inset from the left.

This value is added to the Left of the rectangle to yield a new location for the Left edge.

See also:
clone()

jint java::awt::Insets::bottom

The inset from the bottom.

This value is subtracted from the Bottom of the rectangle to yield a new location for the Bottom.

See also:
clone()

jint java::awt::Insets::right

The inset from the right.

This value is subtracted from the Right of the rectangle to yield a new location for the Right edge.

See also:
clone()


The documentation for this class was generated from the following file:
Generated on Fri May 16 11:56:00 2008 for CrossPlatformJavaLikeC++API by  doxygen 1.5.3