com.jidesoft.gauge
Class NeedleDescriptor

java.lang.Object
  com.jidesoft.gauge.NeedleDescriptor

public class NeedleDescriptor
extends Object

A class that contains the name and shape of a needle. Instances of this class may be returned by methods that determine whether a point (esp. the cursor location) is currently over a needle.

Constructor Summary

NeedleDescriptor(String needleName, Shape needleShape)
Create a NeedleDescriptor object from the name of the needle and its rendered Shape.

NeedleDescriptor(String needleName, Shape needleShape, int index)
Create a NeedleDescriptor object from the name of the needle and its rendered Shape.

Method Summary

int	getIndex() Returns the index of the needle in the list of needles maintained by the dial
String	getNeedleName() Returns the name of the needle
Shape	getNeedleShape() Returns the shape of the needle
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

NeedleDescriptor

public NeedleDescriptor(String needleName,
                        Shape needleShape)

Create a NeedleDescriptor object from the name of the needle and its rendered Shape.

Parameters:

needleName - the name of the needle

needleShape - the rendered shape of the needle

See Also:

Shape

NeedleDescriptor

public NeedleDescriptor(String needleName,
                        Shape needleShape,
                        int index)

Create a NeedleDescriptor object from the name of the needle and its rendered Shape.

Parameters:

needleName - the name of the needle

needleShape - the rendered shape of the needle

See Also:

Shape

Method Detail

getNeedleName

public String getNeedleName()

Returns the name of the needle

Returns:

the name of the needle

getNeedleShape

public Shape getNeedleShape()

Returns the shape of the needle

Returns:

the shape of the needle

getIndex

public int getIndex()

Returns the index of the needle in the list of needles maintained by the dial

Returns:

the index of the needle in the list of needles maintained by the dial

toString

public String toString()

Overrides:

toString in class Object