oracle.jdeveloper.uieditor.datatransfer

Class Operation

java.lang.Object

oracle.jdeveloper.uieditor.datatransfer.Operation

Direct Known Subclasses:

AbstractSingleFlavorOperation

public abstract class Operation
extends java.lang.Object

An operation is something that can be performed based on a data transfer during drag and drop or paste.

See Also:

AbstractSingleFlavorOperation

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OPERATION_ICON Meta data key for fetching an icon from a given TransferDataInfo for use in a menu item associated with this Operation.
static float	STANDARD_OPERATIONS_RANK The rank that built-in standard operations (move, copy, etc) use.

Constructor Summary

Constructors

Constructor and Description
Operation()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	apply(CmtModel model, UIPosition pos, oracle.javatools.datatransfer.TransferDataInfo data) Applies this operation, returning whether it was applied successfully.
javax.swing.Action	createAsAction(CmtModel model, java.util.List listOfDataAndPositions) Creates an Action that represents the way(s) in which this operation could be applied to the given model and the given list of DataAndPositions (which was returned from getApplicableDataAndPositions(oracle.jdeveloper.cmt.CmtModel, java.util.List, oracle.javatools.datatransfer.ExtendedTransferable).
boolean	doesActionMutateModel() Hook for an action to be able to say it doesn't mutate the model.
abstract java.util.List	getApplicableDataAndPositions(CmtModel model, java.util.List positions, oracle.javatools.datatransfer.ExtendedTransferable transferable) Gets the possible TransferDataInfos upon which this action could be applied near the given position, and also returns the actual position at which the operation could be performed.
abstract java.lang.String	getDisplayName(CmtModel model, oracle.javatools.datatransfer.TransferDataInfo info) Gets the display name for this operation, inserting the display name of the given data info.
protected java.lang.String	getPositionDisplayName(CmtModel model, UIPosition position)
abstract float	getSuitabilityRank() Gets a floating point number indicating how suitable this operation is TODO: Should this take data info, position, model?
abstract int	getSupportedActions() Gets supported dnd action, using DnD's constants

Methods inherited from class java.lang.Object

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

Field Detail

STANDARD_OPERATIONS_RANK

public static final float STANDARD_OPERATIONS_RANK

The rank that built-in standard operations (move, copy, etc) use. Useful for adding or subtracting from this rank to ensure that a new operation will be higher or lower ranked than a standard one.

See Also:

Constant Field Values

OPERATION_ICON

public static final java.lang.String OPERATION_ICON

Meta data key for fetching an icon from a given TransferDataInfo for use in a menu item associated with this Operation.

See Also:

Constant Field Values

Constructor Detail

Operation

public Operation()

Method Detail

getSupportedActions

public abstract int getSupportedActions()

Gets supported dnd action, using DnD's constants

doesActionMutateModel

public boolean doesActionMutateModel()

Hook for an action to be able to say it doesn't mutate the model. Could be useful for supporting "open this file in an editor" as an operation, since this doesn't modify the target.

getApplicableDataAndPositions

public abstract java.util.List getApplicableDataAndPositions(CmtModel model,
                                           java.util.List positions,
                                           oracle.javatools.datatransfer.ExtendedTransferable transferable)

Gets the possible TransferDataInfos upon which this action could be applied near the given position, and also returns the actual position at which the operation could be performed.

Parameters:

model - Model on which the operation may be applied

positions - List of CmtModelNodes to consider. The order of this list should be preserved in any return DataAndPosition.

transferable - Data being transfered

Returns:

List of DataAndPositions to be applied "near" the given position list, ordered by suitability (first return is most preferable datum). Each DataAndPosition's position list should be in a similar order to the positions parameter.

apply

public boolean apply(CmtModel model,
            UIPosition pos,
            oracle.javatools.datatransfer.TransferDataInfo data)
              throws java.io.IOException

Applies this operation, returning whether it was applied successfully.

Parameters:

model - Model to apply the operation on

pos - Position to consider, which is guaranteed to be the result of an earlier call to #convertOperationPosition for this model and data.

data - Data to use, which is guaranteed to be a result of an earlier call to #getApplicableData with this model and position.

Returns:

whether the operation was applied successfully

Throws:

java.io.IOException - if there is an I/O error fetching the data

createAsAction

public javax.swing.Action createAsAction(CmtModel model,
                                java.util.List listOfDataAndPositions)

Creates an Action that represents the way(s) in which this operation could be applied to the given model and the given list of DataAndPositions (which was returned from getApplicableDataAndPositions(oracle.jdeveloper.cmt.CmtModel, java.util.List, oracle.javatools.datatransfer.ExtendedTransferable). The default behavior is as follows:

• If there is only one datum and one position, just return a simple action for that spot.
• If there is more than one datum, return a grouping action with one child action per datum. Each child uses the first applicable position.
• If there is one datum and more than one position, return a grouping action with one child action per position.

See Also:

PerformOperationAction, for how to return more than one

getDisplayName

public abstract java.lang.String getDisplayName(CmtModel model,
                              oracle.javatools.datatransfer.TransferDataInfo info)

Gets the display name for this operation, inserting the display name of the given data info. ie: Insert uix:table If info is null, it's for the operation in general. ie: Insert

Parameters:

info - Data being operated on, or null if none in particular

Returns:

display name for the operation

getPositionDisplayName

protected final java.lang.String getPositionDisplayName(CmtModel model,
                                      UIPosition position)

getSuitabilityRank

public abstract float getSuitabilityRank()

Gets a floating point number indicating how suitable this operation is TODO: Should this take data info, position, model?