javax.swing
Class LayoutComparator

java.lang.Object
  |
  +--javax.swing.LayoutComparator

All Implemented Interfaces:

Comparator, Serializable

final class LayoutComparator

extends Object

implements Comparator, Serializable

Comparator which attempts to sort Components based on their size and position. Code adapted from original javax.swing.DefaultFocusManager implementation.

Version:

1.2, 12/03/01

Author:

David Mendenhall

Field Summary

private boolean	horizontal
private boolean	leftToRight
private static int	ROW_TOLERANCE

Constructor Summary

(package private)

LayoutComparator()

Method Summary

int	compare(Object o1, Object o2) Enabled: Compares its two arguments for order.
(package private) void	setComponentOrientation(ComponentOrientation orientation)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Comparator

equals

Field Detail

ROW_TOLERANCE

private static final int ROW_TOLERANCE

horizontal

private boolean horizontal

leftToRight

private boolean leftToRight

Constructor Detail

LayoutComparator

LayoutComparator()

Method Detail

setComponentOrientation

void setComponentOrientation(ComponentOrientation orientation)

compare

public int compare(Object o1,
                   Object o2)

Description copied from interface: Comparator

Enabled: Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

The implementor must ensure that sgn(compare(x, y)) == -sgn(compare(y, x)) for all x and y. (This implies that compare(x, y) must throw an exception if and only if compare(y, x) throws an exception.)

The implementor must also ensure that the relation is transitive: ((compare(x, y)>0) && (compare(y, z)>0)) implies compare(x, z)>0.

Finally, the implementer must ensure that compare(x, y)==0 implies that sgn(compare(x, z))==sgn(compare(y, z)) for all z.

It is generally the case, but not strictly required that (compare(x, y)==0) == (x.equals(y)). Generally speaking, any comparator that violates this condition should clearly indicate this fact. The recommended language is "Note: this comparator imposes orderings that are inconsistent with equals."

Specified by:

compare in interface Comparator

Parameters:

o1 - the first object to be compared.

o2 - the second object to be compared.

Returns:

a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.