com.technia.tvc.structurebrowser.dragdrop

Interface DragDropHandler

public interface DragDropHandler

Since:

2013.2.0

Method Summary

Methods

Modifier and Type	Method and Description
ConnectMode	getConnectMode()
java.lang.String[]	getSelects(boolean dragged)
java.util.Collection<Connection>	perform(DragDropContext context) Implement this method to include custom connection logic
java.lang.String	validate(SelectedData data, boolean dragged) Validates if a connection could be made between the source and target objects.

Method Detail

getConnectMode

ConnectMode getConnectMode()

Returns:

The mode which this connection is appearing visually; For example, it will be a new row in the structure (insert) or it will refresh a row in the table (refresh).

Since:

2013.2.0

perform

java.util.Collection<Connection> perform(DragDropContext context)
                                         throws TVCException

Implement this method to include custom connection logic

Parameters:

context - The DragDropContext.

Returns:

A collection of connections created

Throws:

TVCException

Since:

2013.2.0

getSelects

java.lang.String[] getSelects(boolean dragged)

Parameters:

dragged - True if it is for the dragged object, false for the dropped object.

Returns:

An array of select statements that you need from the source and target objects in order to determine if a connection could be made. NOTE: type, name, revision and current is always selected so you do not need to specify them.

Since:

2013.2.0

validate

java.lang.String validate(SelectedData data,
                        boolean dragged)

Validates if a connection could be made between the source and target objects. This method is called once for the dragged object and once for the dropped object.

The information required to determine if this should possible, is available within the SelectedData instances provided.

NOTE: The information selected is controlled through the getSelects method.

Parameters:

data - The selected data information

dragged - True if it is for the dragged object, false otherwise.

Returns:

null if the validation is OK. If not null, the returned string is used as error message.

Since:

2013.2.0