Interface IVSParticipant

All Superinterfaces:
IGProp<GProp<?>[]>, IPropCnr, IReferrerParticipant, IVSAccessor
All Known Subinterfaces:
IUIPanelOwner
All Known Implementing Classes:
AbstractInputProps, EditorInputProps, EditorOutputProps, EditorRESTfulInputProps, EditorResultProps, EditorResultSetProps, EditorScreenProp, EMUISimpleDialog, EUIContextMenu, EUIDialog, EUIPanel, EUIPanelPart, InputProps, MUISimpleDialog, OutputProps, RESTfulInputProps, ResultProps, ResultSetProps, ScreenProp, UIContextMenu, UIDialog, UIPanel, UIPanelBase, UIPanelPart

public interface IVSParticipant extends IVSAccessor, IReferrerParticipant
Interface implemented by a container being a participant in the VirtualSpace.
Author:
Christopher Mindus
  • Method Details

    • onVirtualSpaceVirtualized

      void onVirtualSpaceVirtualized(IAppSessionGyro appGyro, VirtualSpace virtualizedVirtualSpace)
      Called when the VirtualSpace has been virtualized, giving the opportunity for e.g. data connectors to prepare it's virtualized counterparts if this is required.

      This call is done to the non-virtualized instance of the VirtualSpace participant.

      Parameters:
      appGyro - The application gyro instance.
      virtualizedVirtualSpace - The virtualized VirtualSpace instance.
    • getVSParticipantAtom

      default Atom getVSParticipantAtom()
      Returns the atom name used for the VSParticipant property.
      Returns:
      Atom.VIRTUALSPACE by default.
    • assignVirtualSpace

      default boolean assignVirtualSpace(VirtualSpace virtualSpace, IComplexOperation op)
      Sets the VirtualSpace participant's VirtualSpace reference. This method can only be called in the Designer and will throw an exception otherwise.
      Parameters:
      virtualSpace - The new VirtualSpace.
      op - The complex operation.
      Returns:
      true for changed, false for no change.
      Throws:
      IllegalStateException - If the call is done outside of the Designer, e.g. in Server.