com.ptc.core.ca.co.client.selection
Class CoClipboard

java.lang.Object
  com.ptc.core.ca.co.client.selection.CoClipboard

All Implemented Interfaces:

Externalizable, Serializable

Deprecated.

@Deprecated
public class CoClipboard
extends Object
implements Externalizable

The conceptual clipboard. The clipboard is designed to support Cut/Copy/Paste operations in DCA.

The clipboard stores externalized addresses of the clipped instance holders instead of storing their references. This is to avoid having them being referenced after their frames were aged out from cache. A set of special methods is provided to resolve addresses to references and to release references after use.

Supported API: true

Extendable: false

See Also:

Serialized Form

Method Summary

ArrayList	getItems() Deprecated. Gets the value of the attribute: items; the list of items on the clipboard.
CoClipboardMode	getMode() Deprecated. Gets the value of the attribute: mode; the mode of the clipboard.
CoClippingReason	getReason() Deprecated. Gets the value of the attribute: reason; the clipping reason.
void	put(ArrayList instanceHolders, CoEnvData envData) Deprecated. Places a list of instance holders on the clipboard.
void	put(CoInstanceHolder instanceHolder, CoEnvData envData) Deprecated. Places the instance holder on the clipboard.
void	releaseReferences(CoEnvData envData) Deprecated. Releases referenes to the conceptual elements from the clipboard.
void	resolveAddresses(CoEnvData envData) Deprecated. Resolves addresses of the conceptual elements on the clipboard into references to them.
void	setItems(ArrayList a_Items) Deprecated. Sets the value of the attribute: items; the list of items on the clipboard.
void	setMode(CoClipboardMode a_Mode) Deprecated. Sets the value of the attribute: mode; the mode of the clipboard.
void	setReason(CoClippingReason a_Reason) Deprecated. Sets the value of the attribute: reason; the clipping reason.

Methods inherited from class java.lang.Object

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

Method Detail

getMode

public CoClipboardMode getMode()

Deprecated.

Gets the value of the attribute: mode; the mode of the clipboard. Two modes are supported at the moment - clipboard and shopping cart. The former clears up the clipboard when a new object is placed on it, the later just adds it to the existing set of items.

Supported API: true

Returns:

CoClipboardMode

setMode

public void setMode(CoClipboardMode a_Mode)

Deprecated.

Sets the value of the attribute: mode; the mode of the clipboard. Two modes are supported at the moment - clipboard and shopping cart. The former clears up the clipboard when a new object is placed on it, the later just adds it to the existing set of items.

Supported API: true

Parameters:

a_Mode -

getReason

public CoClippingReason getReason()

Deprecated.

Gets the value of the attribute: reason; the clipping reason.

Supported API: true

Returns:

CoClippingReason

setReason

public void setReason(CoClippingReason a_Reason)

Deprecated.

Sets the value of the attribute: reason; the clipping reason.

Supported API: true

Parameters:

a_Reason -

getItems

public ArrayList getItems()

Deprecated.

Gets the value of the attribute: items; the list of items on the clipboard. Contains objects of CoClipboardItem class.

Supported API: true

Returns:

ArrayList

setItems

public void setItems(ArrayList a_Items)

Deprecated.

Sets the value of the attribute: items; the list of items on the clipboard. Contains objects of CoClipboardItem class.

Supported API: true

Parameters:

a_Items -

resolveAddresses

public void resolveAddresses(CoEnvData envData)
                      throws WTException

Deprecated.

Resolves addresses of the conceptual elements on the clipboard into references to them.

Supported API: true

Parameters:

envData -

Throws:

WTException

releaseReferences

public void releaseReferences(CoEnvData envData)

Deprecated.

Releases referenes to the conceptual elements from the clipboard.

Supported API: true

Parameters:

envData -

put

public void put(CoInstanceHolder instanceHolder,
                CoEnvData envData)
         throws WTException

Deprecated.

Places the instance holder on the clipboard. The external form of the address will be stored instead of a reference.

Supported API: true

Parameters:

instanceHolder -

envData -

Throws:

WTException

put

public void put(ArrayList instanceHolders,
                CoEnvData envData)
         throws WTException

Deprecated.

Places a list of instance holders on the clipboard. The external form of the addresses will be stored instead of references.

Supported API: true

Parameters:

instanceHolders -

envData -

Throws:

WTException