net.refractions.udig.tools.edit
Interface EnablementBehaviour

All Known Implementing Classes:
ValidToolDetectionActivator, WithinLegalLayerBoundsBehaviour

public interface EnablementBehaviour

A behaviour that is responsible for determining whether a tool is valid for a given event

Since:
1.1.0
Author:
Jesse

Method Summary
 java.lang.String isEnabled(EditToolHandler handler, MapMouseEvent e, EventType eventType)
          If method returns a String then no other behaviours will be executed and the string will be used as the status bar's Error message.
 

Method Detail

isEnabled

java.lang.String isEnabled(EditToolHandler handler,
                           MapMouseEvent e,
                           EventType eventType)
If method returns a String then no other behaviours will be executed and the string will be used as the status bar's Error message. If null is returned then the te rest of the behaviours can be ran and the error tate will be cleared.

Parameters:
handler - EditToolHandler for the current tool
e - the event that just occurred
eventType - the type of event
Returns:
If String then no other behaviours will be executed and the string will be used as the status bar's Error message. If null is returned then the the rest of the behaviours can be ran and the error tate will be cleared.