Interface IVSActionLinkEnabler

All Superinterfaces:
IAdaptable, IGProp<GProp<?>[]>, ILinkCapable, IPropCnr, IVSActionListener, IVSComponentListener, IVSComponentState
All Known Implementing Classes:
EUIButton, EUIImage, EUIMenuItem
public interface IVSActionLinkEnabler extends ILinkCapable, IPropCnr, IVSActionListener
The link enabler for a standard VSAction in VSActionReference named Atom.ACTION or another name using getLinkVSActionName(LinkData).
Author:
Christopher Mindus

  • Method Details

    • isVSActionLinkCapable

      default boolean isVSActionLinkCapable(LinkData data)
      Returns if this property container could potentially be link capable.

      This call is done many times during drag-drop and must be very fast and not cause too much garbage collection.

      Parameters:
      data - The link data.
      Returns:
      true if linkable with a VSField, false otherwise.

    • isLinkCapable

      default IStatus isLinkCapable(LinkData data)
      Returns if this property container could potentially be link capable.

      This call is done many times during drag-drop and must be very fast and not cause too much garbage collection.

      Specified by:
      isLinkCapable in interface ILinkCapable
      Parameters:
      data - The link data.
      Returns:
      The status of capability of the operation.

    • getLinkVSActionName

      default Atom getLinkVSActionName(LinkData data)
      Gets the atom for the linking. Override to support multiple or different names.
      Parameters:
      data - The link data.
      Returns:
      Default is Atom.ACTION.

    • addVSActionLinkOperations

      default void addVSActionLinkOperations(LinkData data, Collection<ILinkOperation> linkOps)
      Called when the drag-drop is to be performed (link or paste-link menu item). The link-capable instance fills in only what it handles.
      Parameters:
      data - The link data.
      linkOps - List of link operations is filled in when operations are found.

    • getLinkOperations

      default Collection<ILinkOperation> getLinkOperations(LinkData data)
      Called when the drag-drop is to be performed (link or paste-link menu item). The link-capable instance fills in only what it handles.
      Specified by:
      getLinkOperations in interface ILinkCapable
      Parameters:
      data - The link data.
      Returns:
      The list of operations required.