oracle.jdeveloper.uieditor.datatransfer

Class OperationProcessor

java.lang.Object

oracle.jdeveloper.uieditor.datatransfer.OperationProcessor

public class OperationProcessor
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	SHOW_ALL_OPERATIONS

Constructor Summary

Constructors

Constructor and Description
OperationProcessor(View view)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	forceSimpleApply() Applies the first supported operation to the first supported datum at the first supported spot.
java.util.List	getListOfDataAndPositions(Operation operation) Returns the list of DataAndPositions supported for the given operation.
UIPosition	getRepresentativeOperationPosition() Returns the position, given the current state from the last call to #consider, that best represents where an operation would be performed.
java.util.Iterator	getSupportedOperations() Returns an iterator of the Operations supported at the given state.
boolean	hasSupportedOperation() Returns whether, given the current state from the last call to #consider, we have any operations that could be invoked.
void	setActionMask(int actionMask) Updates the supported action mask.
void	setEditable(boolean editable) Updates whether the target is considered editable.
void	setTargetModel(CmtModel targetModel)
void	setTransferable(oracle.javatools.datatransfer.ExtendedTransferable transferable)
void	setView(View view)
void	update(java.util.List positions) Updates the current state of the processor.

Methods inherited from class java.lang.Object

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

Field Detail

SHOW_ALL_OPERATIONS

public static final int SHOW_ALL_OPERATIONS

See Also:

Constant Field Values

Constructor Detail

OperationProcessor

public OperationProcessor(View view)

Method Detail

setTransferable

public void setTransferable(oracle.javatools.datatransfer.ExtendedTransferable transferable)

setView

public void setView(View view)

setTargetModel

public void setTargetModel(CmtModel targetModel)

setActionMask

public void setActionMask(int actionMask)

Updates the supported action mask. This automatically clears cached results.

Parameters:

actionMask - Action mask (using DnDConstants's values) to consider. An operation is not considered if its action mask does not overlap with this. If this is SHOW_ALL_OPERATIONS, then all operations will be considered regardless of action.

setEditable

public void setEditable(boolean editable)

Updates whether the target is considered editable. This automatically clears cached results.

Parameters:

editable - Whether the target is considered editable. If not, then any action that mutates the model is not considered.

update

public void update(java.util.List positions)

Updates the current state of the processor. This changes the state of the processor that affects future calls to get supported operations.

Parameters:

positions - List of UIPositions to consider operating at

hasSupportedOperation

public boolean hasSupportedOperation()

Returns whether, given the current state from the last call to #consider, we have any operations that could be invoked.

getRepresentativeOperationPosition

public UIPosition getRepresentativeOperationPosition()

Returns the position, given the current state from the last call to #consider, that best represents where an operation would be performed. Returns null if no operation is valid.

getSupportedOperations

public java.util.Iterator getSupportedOperations()

Returns an iterator of the Operations supported at the given state. This iterator runs in rank order. Never returns null.

getListOfDataAndPositions

public java.util.List getListOfDataAndPositions(Operation operation)

Returns the list of DataAndPositions supported for the given operation. Returns null if this operation is not actually supported.

forceSimpleApply

public boolean forceSimpleApply()
                         throws java.io.IOException

Applies the first supported operation to the first supported datum at the first supported spot. Used in situations like paste where our only option is to just do something without input or other cases where the caller just wants to apply the highest-ranked operation that can work. If the operation's apply method returns false, it'll keep trying other datums and options. This method must be called when the target model is *not* in a transaction, as the OperationProcessor expects to dispatch a TransactionToken after it is done. TODO: Perhaps we should never do this behavior and should instead always pop some kind of UI if there are choices?

Returns:

result of Operation.apply(oracle.jdeveloper.cmt.CmtModel, oracle.jdeveloper.uieditor.datatransfer.UIPosition, oracle.javatools.datatransfer.TransferDataInfo). Note that if one returns false, this method tries the next. Thus, a false result means they all returned false.

Throws:

java.lang.IllegalStateException - if ! hasSupportedOperation or if the model is currently in a transaction

XmlCommitException - from Operation.apply(oracle.jdeveloper.cmt.CmtModel, oracle.jdeveloper.uieditor.datatransfer.UIPosition, oracle.javatools.datatransfer.TransferDataInfo)

java.io.IOException - from Operation.apply(oracle.jdeveloper.cmt.CmtModel, oracle.jdeveloper.uieditor.datatransfer.UIPosition, oracle.javatools.datatransfer.TransferDataInfo)