com.azalient.api.ui.clipboard
Interface IClippable

All Superinterfaces:

IDeletable, RecordW, SortableData

All Known Subinterfaces:

IDwell, IService, ISignalRule, ITrail, ITransportTrip

public interface IClippable
extends IDeletable, RecordW

If an associate can be copied or cut to the clipboard it will return a non-null IClippable interface when the copy() or cut() method in IAssociate is called. Normally, the associate implements IClippable itself, and thus returns itself as the IClippable interface. The table name that is returned must correspond to a TableAdapter object on the ClipBoard. The TableAdapter must have an ICreator interface that makes a new object of the right type on demand. This new object must implement the IPastable interface so that once it is created, and all the fields have been set, it can be finished() with the relative location data. To make an Associate object Clippable:

• make sure the ISelectable object picked returns the object as an Associate, or the object is returned by the tree of references()
• implement IClippable
• implement IPastable
• override clip() : { return this; }
• add an ICreator to Network or Control or ...
• add a TableAdapter to ClipBoard

See Also:

IPastable, ICreator

Field Summary

static ArrayList<IClippable>	scratch
static IClippable[]	ZERO

Method Summary

IClippable[]	children() Return an array of network "child" objects that are deleted if this object is deleted.
Object	getAlt(Object key, Object data) substitute a new data value for the one retrieved from the copied object.
IAssociate[]	references() An array of other associates that this clippable requires to be selected - for example, clipping a link requires that both end nodes are also clipped.
String	tableName() The table from which to get the field definitions

Methods inherited from interface com.azalient.api.ui.clipboard.IDeletable

delete, deleted, name

Methods inherited from interface com.azalient.api.file.RecordW

extraCols, extraGet, extraGetB, extraGetD, extraGetI, extraGetS, extraGetT, get, isVolatile

Field Detail

ZERO

static final IClippable[] ZERO

scratch

static final ArrayList<IClippable> scratch

Method Detail

tableName

String tableName()

The table from which to get the field definitions

references

IAssociate[] references()

An array of other associates that this clippable requires to be selected - for example, clipping a link requires that both end nodes are also clipped. Returns null or a zero-length array if there are no references. Even if this object cannot be picked directly, this object might itself be referenced, so it should always pass on anything it requires

getAlt

Object getAlt(Object key,
              Object data)

substitute a new data value for the one retrieved from the copied object. Returns null if there is no substitute

children

IClippable[] children()

Return an array of network "child" objects that are deleted if this object is deleted. If none, must return IClippable.ZERO, not null