WidgetAction.LockedAdapter (Visual Library API) - NetBeans API Javadoc (Current Development Version)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

org.netbeans.api.visual 2.2

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.netbeans.api.visual.action
Class WidgetAction.LockedAdapter

java.lang.Object
  org.netbeans.api.visual.action.WidgetAction.LockedAdapter

All Implemented Interfaces:: WidgetAction

Enclosing interface:: WidgetAction

public abstract static class WidgetAction.LockedAdapter
extends Object
implements WidgetAction
extends Object
implements WidgetAction

An adapter of the widget action. All methods return locked or rejected event state based on a result of isLocked method. This is often used for long-term actions like MoveAction.

Nested Class Summary

Nested classes/interfaces inherited from interface org.netbeans.api.visual.action.WidgetAction

WidgetAction.Adapter, WidgetAction.Chain, WidgetAction.LockedAdapter, WidgetAction.State, WidgetAction.WidgetDropTargetDragEvent, WidgetAction.WidgetDropTargetDropEvent, WidgetAction.WidgetDropTargetEvent, WidgetAction.WidgetEvent, WidgetAction.WidgetFocusEvent, WidgetAction.WidgetKeyEvent, WidgetAction.WidgetLocationEvent, WidgetAction.WidgetMouseEvent, WidgetAction.WidgetMouseWheelEvent

Constructor Summary

WidgetAction.LockedAdapter()


Method Summary

WidgetAction.State dragEnter(Widget widget, WidgetAction.WidgetDropTargetDragEvent event)
          Called for handling a dragEnter event.

WidgetAction.State dragExit(Widget widget, WidgetAction.WidgetDropTargetEvent event)
          Called for handling a dragExit event.

WidgetAction.State dragOver(Widget widget, WidgetAction.WidgetDropTargetDragEvent event)
          Called for handling a dragOver event.

WidgetAction.State drop(Widget widget, WidgetAction.WidgetDropTargetDropEvent event)
          Called for handling a drop event.

WidgetAction.State dropActionChanged(Widget widget, WidgetAction.WidgetDropTargetDragEvent event)
          Called for handling a dropActionChanged event.

WidgetAction.State focusGained(Widget widget, WidgetAction.WidgetFocusEvent event)
          Called for handling a focusGained event.

WidgetAction.State focusLost(Widget widget, WidgetAction.WidgetFocusEvent event)
          Called for handling a focusLost event.

protected abstract boolean isLocked()
          Called by event handlers to resolve whether they should return locked or rejected event state.

WidgetAction.State keyPressed(Widget widget, WidgetAction.WidgetKeyEvent event)
          Called for handling a keyPressed event.

WidgetAction.State keyReleased(Widget widget, WidgetAction.WidgetKeyEvent event)
          Called for handling a keyReleased event.

WidgetAction.State keyTyped(Widget widget, WidgetAction.WidgetKeyEvent event)
          Called for handling a keyTyped event.

WidgetAction.State mouseClicked(Widget widget, WidgetAction.WidgetMouseEvent event)
          Called for handling a mouseClicked event.

WidgetAction.State mouseDragged(Widget widget, WidgetAction.WidgetMouseEvent event)
          Called for handling a mouseDragged event.

WidgetAction.State mouseEntered(Widget widget, WidgetAction.WidgetMouseEvent event)
          Called for handling a mouseEntered event.

WidgetAction.State mouseExited(Widget widget, WidgetAction.WidgetMouseEvent event)
          Called for handling a mouseExited event.

WidgetAction.State mouseMoved(Widget widget, WidgetAction.WidgetMouseEvent event)
          Called for handling a mouseMoved event.

WidgetAction.State mousePressed(Widget widget, WidgetAction.WidgetMouseEvent event)
          Called for handling a mousePressed event.

WidgetAction.State mouseReleased(Widget widget, WidgetAction.WidgetMouseEvent event)
          Called for handling a mouseReleased event.

WidgetAction.State mouseWheelMoved(Widget widget, WidgetAction.WidgetMouseWheelEvent event)
          Called for handling a mouseWheelMoved event.

Methods inherited from class java.lang.Object

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

Nested classes/interfaces inherited from interface org.netbeans.api.visual.action.WidgetAction
`WidgetAction.Adapter, WidgetAction.Chain, WidgetAction.LockedAdapter, WidgetAction.State, WidgetAction.WidgetDropTargetDragEvent, WidgetAction.WidgetDropTargetDropEvent, WidgetAction.WidgetDropTargetEvent, WidgetAction.WidgetEvent, WidgetAction.WidgetFocusEvent, WidgetAction.WidgetKeyEvent, WidgetAction.WidgetLocationEvent, WidgetAction.WidgetMouseEvent, WidgetAction.WidgetMouseWheelEvent`

Constructor Summary
`WidgetAction.LockedAdapter()`

Method Summary
`WidgetAction.State`	`dragEnter(Widget widget, WidgetAction.WidgetDropTargetDragEvent event)` Called for handling a dragEnter event.
`WidgetAction.State`	`dragExit(Widget widget, WidgetAction.WidgetDropTargetEvent event)` Called for handling a dragExit event.
`WidgetAction.State`	`dragOver(Widget widget, WidgetAction.WidgetDropTargetDragEvent event)` Called for handling a dragOver event.
`WidgetAction.State`	`drop(Widget widget, WidgetAction.WidgetDropTargetDropEvent event)` Called for handling a drop event.
`WidgetAction.State`	`dropActionChanged(Widget widget, WidgetAction.WidgetDropTargetDragEvent event)` Called for handling a dropActionChanged event.
`WidgetAction.State`	`focusGained(Widget widget, WidgetAction.WidgetFocusEvent event)` Called for handling a focusGained event.
`WidgetAction.State`	`focusLost(Widget widget, WidgetAction.WidgetFocusEvent event)` Called for handling a focusLost event.
`protected abstract boolean`	`isLocked()` Called by event handlers to resolve whether they should return locked or rejected event state.
`WidgetAction.State`	`keyPressed(Widget widget, WidgetAction.WidgetKeyEvent event)` Called for handling a keyPressed event.
`WidgetAction.State`	`keyReleased(Widget widget, WidgetAction.WidgetKeyEvent event)` Called for handling a keyReleased event.
`WidgetAction.State`	`keyTyped(Widget widget, WidgetAction.WidgetKeyEvent event)` Called for handling a keyTyped event.
`WidgetAction.State`	`mouseClicked(Widget widget, WidgetAction.WidgetMouseEvent event)` Called for handling a mouseClicked event.
`WidgetAction.State`	`mouseDragged(Widget widget, WidgetAction.WidgetMouseEvent event)` Called for handling a mouseDragged event.
`WidgetAction.State`	`mouseEntered(Widget widget, WidgetAction.WidgetMouseEvent event)` Called for handling a mouseEntered event.
`WidgetAction.State`	`mouseExited(Widget widget, WidgetAction.WidgetMouseEvent event)` Called for handling a mouseExited event.
`WidgetAction.State`	`mouseMoved(Widget widget, WidgetAction.WidgetMouseEvent event)` Called for handling a mouseMoved event.
`WidgetAction.State`	`mousePressed(Widget widget, WidgetAction.WidgetMouseEvent event)` Called for handling a mousePressed event.
`WidgetAction.State`	`mouseReleased(Widget widget, WidgetAction.WidgetMouseEvent event)` Called for handling a mouseReleased event.
`WidgetAction.State`	`mouseWheelMoved(Widget widget, WidgetAction.WidgetMouseWheelEvent event)` Called for handling a mouseWheelMoved event.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

WidgetAction.LockedAdapter

public WidgetAction.LockedAdapter()

Method Detail

isLocked

protected abstract boolean isLocked()

Called by event handlers to resolve whether they should return locked or rejected event state.

Returns:: if true, then locked event state is used; if false, then rejected event state is used.

mouseClicked

public WidgetAction.State mouseClicked(Widget widget,
                                       WidgetAction.WidgetMouseEvent event)

Called for handling a mouseClicked event.

Specified by:: mouseClicked in interface WidgetAction

Parameters:: widget - the widget where the action is assigned; event - the mouse event
Returns:: the event state

mousePressed

public WidgetAction.State mousePressed(Widget widget,
                                       WidgetAction.WidgetMouseEvent event)

Called for handling a mousePressed event.

Specified by:: mousePressed in interface WidgetAction

Parameters:: widget - the widget where the action is assigned; event - the mouse event
Returns:: the event state

mouseReleased

public WidgetAction.State mouseReleased(Widget widget,
                                        WidgetAction.WidgetMouseEvent event)

Called for handling a mouseReleased event.

Specified by:: mouseReleased in interface WidgetAction

Parameters:: widget - the widget where the action is assigned; event - the mouse event
Returns:: the event state

mouseEntered

public WidgetAction.State mouseEntered(Widget widget,
                                       WidgetAction.WidgetMouseEvent event)

Called for handling a mouseEntered event.

Specified by:: mouseEntered in interface WidgetAction

Parameters:: widget - the widget where the action is assigned; event - the mouse event
Returns:: the event state

mouseExited

public WidgetAction.State mouseExited(Widget widget,
                                      WidgetAction.WidgetMouseEvent event)

Called for handling a mouseExited event.

Specified by:: mouseExited in interface WidgetAction

Parameters:: widget - the widget where the action is assigned; event - the mouse event
Returns:: the event state

mouseDragged

public WidgetAction.State mouseDragged(Widget widget,
                                       WidgetAction.WidgetMouseEvent event)

Called for handling a mouseDragged event.

Specified by:: mouseDragged in interface WidgetAction

Parameters:: widget - the widget where the action is assigned; event - the mouse event
Returns:: the event state

mouseMoved

public WidgetAction.State mouseMoved(Widget widget,
                                     WidgetAction.WidgetMouseEvent event)

Called for handling a mouseMoved event.

Specified by:: mouseMoved in interface WidgetAction

Parameters:: widget - the widget where the action is assigned; event - the mouse event
Returns:: the event state

mouseWheelMoved

public WidgetAction.State mouseWheelMoved(Widget widget,
                                          WidgetAction.WidgetMouseWheelEvent event)

Called for handling a mouseWheelMoved event.

Specified by:: mouseWheelMoved in interface WidgetAction

Parameters:: widget - the widget where the action is assigned; event - the mouse wheel event
Returns:: the event state

keyTyped

public WidgetAction.State keyTyped(Widget widget,
                                   WidgetAction.WidgetKeyEvent event)

Called for handling a keyTyped event.

Specified by:: keyTyped in interface WidgetAction

Parameters:: widget - the widget where the action is assigned; event - the key event
Returns:: the event state

keyPressed

public WidgetAction.State keyPressed(Widget widget,
                                     WidgetAction.WidgetKeyEvent event)

Called for handling a keyPressed event.

Specified by:: keyPressed in interface WidgetAction

Parameters:: widget - the widget where the action is assigned; event - the key event
Returns:: the event state

keyReleased

public WidgetAction.State keyReleased(Widget widget,
                                      WidgetAction.WidgetKeyEvent event)

Called for handling a keyReleased event.

Specified by:: keyReleased in interface WidgetAction

Parameters:: widget - the widget where the action is assigned; event - the key event
Returns:: the event state

focusGained

public WidgetAction.State focusGained(Widget widget,
                                      WidgetAction.WidgetFocusEvent event)

Called for handling a focusGained event.

Specified by:: focusGained in interface WidgetAction

Parameters:: widget - the widget where the action is assigned; event - the focus event
Returns:: the event state

focusLost

public WidgetAction.State focusLost(Widget widget,
                                    WidgetAction.WidgetFocusEvent event)

Called for handling a focusLost event.

Specified by:: focusLost in interface WidgetAction

Parameters:: widget - the widget where the action is assigned; event - the focus event
Returns:: the event state

dragEnter

public WidgetAction.State dragEnter(Widget widget,
                                    WidgetAction.WidgetDropTargetDragEvent event)

Called for handling a dragEnter event.

Specified by:: dragEnter in interface WidgetAction

Parameters:: widget - the widget where the action is assigned; event - the drop target drag event
Returns:: the event state

dragOver

public WidgetAction.State dragOver(Widget widget,
                                   WidgetAction.WidgetDropTargetDragEvent event)

Called for handling a dragOver event.

Specified by:: dragOver in interface WidgetAction

Parameters:: widget - the widget where the action is assigned; event - the drop target drag event
Returns:: the event state

dropActionChanged

public WidgetAction.State dropActionChanged(Widget widget,
                                            WidgetAction.WidgetDropTargetDragEvent event)

Called for handling a dropActionChanged event.

Specified by:: dropActionChanged in interface WidgetAction

Parameters:: widget - the widget where the action is assigned; event - the drop target drag event
Returns:: the event state

dragExit

public WidgetAction.State dragExit(Widget widget,
                                   WidgetAction.WidgetDropTargetEvent event)

Called for handling a dragExit event.

Specified by:: dragExit in interface WidgetAction

Parameters:: widget - the widget where the action is assigned; event - the drop target event
Returns:: the event state

drop

public WidgetAction.State drop(Widget widget,
                               WidgetAction.WidgetDropTargetDropEvent event)

Called for handling a drop event.

Specified by:: drop in interface WidgetAction

Parameters:: widget - the widget where the action is assigned; event - the drop target drop event
Returns:: the event state