com.partnersoft.maps.actors
Enum SnapshotHandleType

java.lang.Object
  java.lang.Enum<SnapshotHandleType>
      com.partnersoft.maps.actors.SnapshotHandleType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SnapshotHandleType>

public enum SnapshotHandleType
extends java.lang.Enum<SnapshotHandleType>

Enumerated type describing the various handles on a snapshot.

Copyright 2008 Partner Software, Inc.

Version:

$Id$

Author:

Paul Reavis

Enum Constant Summary

CENTER

NE_CORNER

NW_CORNER

OUTLINE

SE_CORNER

SW_CORNER

Method Summary

java.lang.String	getName()
static SnapshotHandleType	handleTypeFor(MapViewFrame snapshotFrame, XyPoint location, double scale) Gives you the closest handle for the given parameters.
boolean	isCenter()
boolean	isCorner()
boolean	isOutline()
static SnapshotHandleType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SnapshotHandleType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NW_CORNER

public static final SnapshotHandleType NW_CORNER

NE_CORNER

public static final SnapshotHandleType NE_CORNER

SW_CORNER

public static final SnapshotHandleType SW_CORNER

SE_CORNER

public static final SnapshotHandleType SE_CORNER

CENTER

public static final SnapshotHandleType CENTER

OUTLINE

public static final SnapshotHandleType OUTLINE

Method Detail

values

public static SnapshotHandleType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SnapshotHandleType c : SnapshotHandleType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SnapshotHandleType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

handleTypeFor

public static SnapshotHandleType handleTypeFor(MapViewFrame snapshotFrame,
                                               XyPoint location,
                                               double scale)

Gives you the closest handle for the given parameters.

isCorner

public boolean isCorner()

isCenter

public boolean isCenter()

isOutline

public boolean isOutline()

getName

public java.lang.String getName()