Package ucar.unidata.idv.control.drawing

Class GlyphCreatorCommand

java.lang.Object

ucar.unidata.idv.control.drawing.DrawingCommand

ucar.unidata.idv.control.drawing.GlyphCreatorCommand

public abstract class GlyphCreatorCommand
extends DrawingCommand

Class GlyphCreatorCommand represents when a glyph should be created

Version:

$Revision: 1.21 $

Author:

IDV Development Team

Field Summary

Fields

Modifier and Type	Field	Description
static final DrawingCommand	CMD_ARROW	command
static final DrawingCommand	CMD_CLOSEDPOLYGON	command to create a closed polygon
static final DrawingCommand	CMD_DIAMOND	command
static final DrawingCommand	CMD_HARROW	command
static final DrawingCommand	CMD_HIGH	command
static final DrawingCommand	CMD_IMAGE	command
static final DrawingCommand	CMD_LINE	command
static final DrawingCommand	CMD_LOW	command
static final DrawingCommand	CMD_MOVIE	command
static final DrawingCommand	CMD_OVAL	command
static final DrawingCommand	CMD_POLYGON	command
static final DrawingCommand	CMD_RECTANGLE	command
static final DrawingCommand	CMD_SMOOTHPOLYGON	command
static final DrawingCommand	CMD_SYMBOL	command
static final DrawingCommand	CMD_TEXT	command
static final DrawingCommand	CMD_TRANSECT	command
static final DrawingCommand	CMD_VARROW	command
static final DrawingCommand	CMD_WAYPOINT	command

Constructor Summary

Constructors

Constructor	Description
GlyphCreatorCommand(String label, String message, String iconPath)	Ctor
GlyphCreatorCommand(String label, String message, String iconPath, boolean needsMouse)	Ctor
GlyphCreatorCommand(String label, String message, String iconPath, int flags)	Ctor
GlyphCreatorCommand(String label, String message, String iconPath, int flags, boolean needsMouse)	Ctor

Method Summary

Modifier and Type	Method	Description
abstract DrawingGlyph	createGlyph(DrawingControl control, DisplayEvent event)	Create the glyph
boolean	getNeedsMouse()	Get the NeedsMouse property.

Methods inherited from class ucar.unidata.idv.control.drawing.DrawingCommand

equals, getFlags, getIconPath, getLabel, getMessage, isCapable, setFlags, setIconPath, setLabel, setMessage

Methods inherited from class java.lang.Object

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

Field Details

CMD_SMOOTHPOLYGON

public static final DrawingCommand CMD_SMOOTHPOLYGON

command

CMD_CLOSEDPOLYGON

public static final DrawingCommand CMD_CLOSEDPOLYGON

command to create a closed polygon

CMD_POLYGON

public static final DrawingCommand CMD_POLYGON

command

CMD_LINE

public static final DrawingCommand CMD_LINE

command

CMD_SYMBOL

public static final DrawingCommand CMD_SYMBOL

command

CMD_TRANSECT

public static final DrawingCommand CMD_TRANSECT

command

CMD_RECTANGLE

public static final DrawingCommand CMD_RECTANGLE

command

CMD_ARROW

public static final DrawingCommand CMD_ARROW

command

CMD_HARROW

public static final DrawingCommand CMD_HARROW

command

CMD_VARROW

public static final DrawingCommand CMD_VARROW

command

CMD_DIAMOND

public static final DrawingCommand CMD_DIAMOND

command

CMD_OVAL

public static final DrawingCommand CMD_OVAL

command

CMD_TEXT

public static final DrawingCommand CMD_TEXT

command

CMD_WAYPOINT

public static final DrawingCommand CMD_WAYPOINT

command

CMD_IMAGE

public static final DrawingCommand CMD_IMAGE

command

CMD_MOVIE

public static final DrawingCommand CMD_MOVIE

command

CMD_HIGH

public static final DrawingCommand CMD_HIGH

command

CMD_LOW

public static final DrawingCommand CMD_LOW

command

Constructor Details

GlyphCreatorCommand

public GlyphCreatorCommand(String label,
 String message,
 String iconPath)

Ctor

Parameters:

label - Label

message - Message

iconPath - The icon to display

GlyphCreatorCommand

public GlyphCreatorCommand(String label,
 String message,
 String iconPath,
 boolean needsMouse)

Ctor

Parameters:

label - Label

message - Message

iconPath - The icon to display

needsMouse - Does this glyph creation need a mouse press

GlyphCreatorCommand

public GlyphCreatorCommand(String label,
 String message,
 String iconPath,
 int flags)

Ctor

Parameters:

label - Label

message - Message

iconPath - The icon to display

flags - Command flags

GlyphCreatorCommand

public GlyphCreatorCommand(String label,
 String message,
 String iconPath,
 int flags,
 boolean needsMouse)

Ctor

Parameters:

label - Label

message - Message

iconPath - The icon to display

flags - Command flags

needsMouse - Does this glyph creation need a mouse press

Method Details

getNeedsMouse

public boolean getNeedsMouse()

Get the NeedsMouse property.

Returns:

The NeedsMouse

createGlyph

public abstract DrawingGlyph createGlyph(DrawingControl control,
 DisplayEvent event)
                                  throws VisADException,
RemoteException

Create the glyph

Parameters:

control - DrawingControl we are in

event - The event

Returns:

The glyph

Throws:

RemoteException - On badness

VisADException - On badness