Interface IUICreationFromVS

All Superinterfaces:
IAdaptable, ILinkCapable
All Known Implementing Classes:
EditorVirtualSpace, EditorVSAction, EditorVSField, EditorVSGroup, EditorVSTable

public interface IUICreationFromVS extends ILinkCapable
Interface implemented by VS components VSAction, VSField, VSTable, VSGroup used for UI creation when VS components are dropped in a UI container, UIComps or layout manager.
Author:
Christopher Mindus
  • Method Details

    • getVirtualSpace

      EditorVirtualSpace getVirtualSpace()
      Gets the VirtualSpace.
      Returns:
      The VirtualSpace instance.
    • canCreateUI

      default boolean canCreateUI(LinkData data)
      Method returning if this property could potentially be (action, field or table) or contain (group) properties that can create UI components when drag-dropped.
      Parameters:
      data - The link data.
      Returns:
      true if the result would lead to UI creations, false otherwise.
    • addCreateUILinkOperations

      default void addCreateUILinkOperations(LinkData data, Collection<ILinkOperation> linkOps)
      Adds all possible operations that could be done in a link operation for UI creation from VS.
      Parameters:
      data - The link data.
      linkOps - List of link operations is filled in when operations are found.
    • 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.
    • 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.
    • getDragDropText

      default String getDragDropText()
      Gets the link text to display when drag-dropping into JavaScript Panel Editor.
      Specified by:
      getDragDropText in interface ILinkCapable
      Returns:
      The drag-drop text to use, or null if the method ILinkCapable.getDragDropHTML() is used instead.