com.luciad.view.lightspeed.editor.operation

LuciadLightspeedClass TLspEditOperation

java.lang.Object

com.luciad.view.lightspeed.editor.operation.TLspEditOperation

public final class TLspEditOperation
extends Object

An event that represents a high-level description of an editing interaction with an object.

The editing operation contains the following things:

• The edit operation type
• The properties of the operation. This list should contain at least the editing operation descriptor, with the editing property key as a key, and the operation descriptor as a value. The property key can be retrieved from the editing operation type

Since:

2012.0

Constructor Summary

Constructors

Constructor and Description
TLspEditOperation(TLspEditOperationType aType, Map<Object,Object> aProperties) Creates a new edit operation.

Method Summary

Modifier and Type	Method and Description
Map<Object,Object>	getProperties() Returns an immutable map containing the edit operation properties.
TLspEditOperationType	getType() Returns the edit operation type

Methods inherited from class java.lang.Object

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

Constructor Detail

TLspEditOperation

public TLspEditOperation(TLspEditOperationType aType,
                         Map<Object,Object> aProperties)

Creates a new edit operation. This constructor does not explicitly make a copy of the given properties, and it is assumed that the properties are no longer modified after this operation has been created.

Parameters:

aType - the edit operation type

aProperties - the properties. These will be wrapped in an immutable map, so that external access is limited to read-only. Note that this map should contain at least the editing operation descriptor, with the editing property key as a key, and the operation descriptor as a value.

Method Detail

getType

public TLspEditOperationType getType()

Returns the edit operation type

Returns:

the edit operation type

getProperties

public Map<Object,Object> getProperties()

Returns an immutable map containing the edit operation properties.

This map should contain at least the editing operation descriptor, with the editing property key as a key, and the operation descriptor as a value.

To retrieve the editing descriptor, use TLspEditOperationType.getPropertyKey() as a key.

Returns:

an immutable map containing the edit operation properties.