Package org.geotools.swing

Enum JMapFrame.Tool

Object

Enum<JMapFrame.Tool>

Tool

All Implemented Interfaces:

Serializable, Comparable<JMapFrame.Tool>

Enclosing class:

JMapFrame

public static enum JMapFrame.Tool
extends Enum<JMapFrame.Tool>

Constants for available toolbar buttons used with the JMapFrame.enableTool(org.geotools.swing.JMapFrame.Tool...) method.

Enum Constant Summary

Enum Constants

Enum Constant	Description
INFO	The feature info cursor tool
PAN	The panning cursor tool.
POINTER	Simple mouse cursor, used to unselect previous cursor tool.
RESET	The reset map extent cursor tool.
SCROLLWHEEL	The map should zoom with the mouse wheel.
ZOOM	The zoom display cursor tools.

Method Summary

Modifier and Type	Method	Description
static JMapFrame.Tool	valueOf(String name)	Returns the enum constant of this type with the specified name.
static JMapFrame.Tool[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

POINTER

public static final JMapFrame.Tool POINTER

Simple mouse cursor, used to unselect previous cursor tool.

INFO

public static final JMapFrame.Tool INFO

The feature info cursor tool

PAN

public static final JMapFrame.Tool PAN

The panning cursor tool.

RESET

public static final JMapFrame.Tool RESET

The reset map extent cursor tool.

ZOOM

public static final JMapFrame.Tool ZOOM

The zoom display cursor tools.

SCROLLWHEEL

public static final JMapFrame.Tool SCROLLWHEEL

The map should zoom with the mouse wheel. No button shown for this.

Method Detail

values

public static JMapFrame.Tool[] 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 (JMapFrame.Tool c : JMapFrame.Tool.values())
    System.out.println(c);

Returns:

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

valueOf

public static JMapFrame.Tool valueOf(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:

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

NullPointerException - if the argument is null