org.netbeans.api.visual 2.21.1

org.netbeans.api.visual.action
Interface SelectProvider


public interface SelectProvider

This interface controls a select action.


Method Summary
 boolean isAimingAllowed(Widget widget, Point localLocation, boolean invertSelection)
          Called to check whether aiming is allowed
 boolean isSelectionAllowed(Widget widget, Point localLocation, boolean invertSelection)
          Called to check whether the selection is allowed.
 void select(Widget widget, Point localLocation, boolean invertSelection)
          Called to perform the selection.
 

Method Detail

isAimingAllowed

boolean isAimingAllowed(Widget widget,
                        Point localLocation,
                        boolean invertSelection)
Called to check whether aiming is allowed

Parameters:
widget - the aimed widget
localLocation - the local location of a mouse cursor while aiming is invoked by an user
invertSelection - if true, then the invert selection is invoked by an user.
Returns:
true, if aiming is allowed and widget is set to aimed state while mouse button is pressed; false, if aiming is disallowed and widget is not set to aimed state at any time.

isSelectionAllowed

boolean isSelectionAllowed(Widget widget,
                           Point localLocation,
                           boolean invertSelection)
Called to check whether the selection is allowed.

Parameters:
widget - the selected widget
localLocation - the local location of a mouse cursor while selection is invoked by an user
invertSelection - if true, then the invert selection is invoked by an user.
Returns:
true, if selection is allowed; false, if selection is disallowed

select

void select(Widget widget,
            Point localLocation,
            boolean invertSelection)
Called to perform the selection.

Parameters:
widget - the selected widget
localLocation - the local location of a mouse cursor while selection is invoked by an user
invertSelection - if true, then the invert selection is invoked by an user.

org.netbeans.api.visual 2.21.1

Built on December 28 2011.  |  Portions Copyright 1997-2011 Sun Microsystems, Inc. All rights reserved.