WidgetAction.State (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.State

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

Enclosing interface:: WidgetAction

public abstract static class WidgetAction.State
extends Object
extends Object

Represents a state of event processing.

Field Summary

static WidgetAction.State CHAIN_ONLY
          The state that means: The event is processed by the action and only actions that are in the same chain can process the event too.

static WidgetAction.State CONSUMED
          The state that means: The event is processed by the action and the processing has to stopped immediately (no other action should processed it).

static WidgetAction.State REJECTED
          The state that means: The event is not processed by the action and has to be processed by other actions too.

Method Summary

static WidgetAction.State createLocked(Widget lockedWidget, WidgetAction lockedAction)
          Creates a state that means: The event is processed and the processing has to stopped immediately (no other action should processed it).

abstract WidgetAction getLockedAction()
          Returns whether (and by which action) the next event has to be processed prior to regular processing.

abstract Widget getLockedWidget()
          Returns whether (and by which widget) the next event has to be processed prior to regular processing.

abstract boolean isConsumed()
          Returns whether the event is consumed

abstract boolean isLockedInChain()
          Returns whether the event processing has to be stopped after the processing by the chain where the actions is added.

Methods inherited from class java.lang.Object

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

Field Summary
`static WidgetAction.State`	`CHAIN_ONLY` The state that means: The event is processed by the action and only actions that are in the same chain can process the event too.
`static WidgetAction.State`	`CONSUMED` The state that means: The event is processed by the action and the processing has to stopped immediately (no other action should processed it).
`static WidgetAction.State`	`REJECTED` The state that means: The event is not processed by the action and has to be processed by other actions too.

Method Summary
`static WidgetAction.State`	`createLocked(Widget lockedWidget, WidgetAction lockedAction)` Creates a state that means: The event is processed and the processing has to stopped immediately (no other action should processed it).
`abstract WidgetAction`	`getLockedAction()` Returns whether (and by which action) the next event has to be processed prior to regular processing.
`abstract Widget`	`getLockedWidget()` Returns whether (and by which widget) the next event has to be processed prior to regular processing.
`abstract boolean`	`isConsumed()` Returns whether the event is consumed
`abstract boolean`	`isLockedInChain()` Returns whether the event processing has to be stopped after the processing by the chain where the actions is added.

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

Field Detail

REJECTED

public static final WidgetAction.State REJECTED

The state that means: The event is not processed by the action and has to be processed by other actions too.

CONSUMED

public static final WidgetAction.State CONSUMED

The state that means: The event is processed by the action and the processing has to stopped immediately (no other action should processed it).

CHAIN_ONLY

public static final WidgetAction.State CHAIN_ONLY

The state that means: The event is processed by the action and only actions that are in the same chain can process the event too.

Method Detail

createLocked

public static WidgetAction.State createLocked(Widget lockedWidget,
                                              WidgetAction lockedAction)

Creates a state that means: The event is processed and the processing has to stopped immediately (no other action should processed it). Next event will be processed by the lockedAction on lockedAction first. Only if the lockedAction reject the event, then the event will be processed regularly. It is used for locking the event processing for a long-term operation like moving, resizing, rectangular selection, ... (usually they are using mouse motion events).

isLockedInChain

public abstract boolean isLockedInChain()

Returns whether the event processing has to be stopped after the processing by the chain where the actions is added.

Returns:: true if locked in chain

isConsumed

public abstract boolean isConsumed()

Returns whether the event is consumed

Returns:: true if the event is consumed

getLockedWidget

public abstract Widget getLockedWidget()

Returns whether (and by which widget) the next event has to be processed prior to regular processing.

Returns:: the locked widget; if null, then there is no prior widget

getLockedAction

public abstract WidgetAction getLockedAction()

Returns whether (and by which action) the next event has to be processed prior to regular processing.

Returns:: the locked action; if null, then there is no prior action