Class EditorRESTfulInputProps

All Implemented Interfaces:
ILinkCapable, IJavaInterfaceLinkEnabler, IPropDesigner, IVSLinkEnabler, IVSParticipantLinkEnabler, IWSPropDesigner, EventListener, IClassInstantiationAtResolve, IGProp<GProp<?>[]>, IPropCnr, IReferrerParticipant, IVSAccessor, IVSParticipant, IExecuteWebService, Cloneable, org.eclipse.core.runtime.IAdaptable

public class EditorRESTfulInputProps extends RESTfulInputProps implements IWSPropDesigner, IVSParticipantLinkEnabler, IJavaInterfaceLinkEnabler
Editor version of the Input Properties that ties the input to the execution of a RESTful Web Service transaction request to VirtualSpace.
Author:
Christopher Mindus
  • Constructor Details

    • EditorRESTfulInputProps

      public EditorRESTfulInputProps()
      Creates the property container without a name. The name must be set in all cases using the setPropertyAtom call.
    • EditorRESTfulInputProps

      public EditorRESTfulInputProps(Atom propertyAtom)
      Creates the property container with the specified name. All system-reserved names for components begins with "$".
      Parameters:
      propertyAtom - the name of the component, unique within it's parent.
  • Method Details

    • getDesigner

      public WebServiceDesignerProp getDesigner()
      Gets the Designer Extension for Properties.
      Specified by:
      getDesigner in interface IPropDesigner
      Returns:
      The instance of the Designer Extension.
    • clone

      public EditorRESTfulInputProps clone()
      Clone must be overridden.
      Overrides:
      clone in class RESTfulInputProps
    • getWebServiceProp

      public EditorWebServiceProp getWebServiceProp()
      Gets the Web Service property.
      Overrides:
      getWebServiceProp in class AbstractInputProps
      Returns:
      The Web Service property, or null if this property is orphaned.
    • getRetargetedVerifyContainer

      protected PropCnr getRetargetedVerifyContainer()
      Gets the retargeted verification property container.
      Overrides:
      getRetargetedVerifyContainer in class PropCnr
      Returns:
      The default is to return this.
    • getVirtualSpace

      public EditorVirtualSpace getVirtualSpace()
      Gets the VirtualSpace.
      Specified by:
      getVirtualSpace in interface IVSAccessor
      Overrides:
      getVirtualSpace in class AbstractInputProps
      Returns:
      The VirtualSpace connected the the variable input, or null for none.
    • getPossibleChildren

      public Class<?>[] getPossibleChildren()
      Gets the acceptable children property classes that can be used in conjunction with e.g. a Paste operation.
      Specified by:
      getPossibleChildren in interface IPropCnr
      Overrides:
      getPossibleChildren in class PropCnr
      Returns:
      An array containing the classes of possible children, or null for no support.
    • getCNImage

      public org.eclipse.swt.graphics.Image getCNImage()
      Gets the image for the Common Navigator.
      Specified by:
      getCNImage in interface IWSPropDesigner
      Returns:
      Image or null if there is no image.
    • getCNText

      public String getCNText()
      Gets the label text for the Common Navigator.
      Specified by:
      getCNText in interface IWSPropDesigner
      Returns:
      The text.
    • getCNDescriptionType

      public String getCNDescriptionType()
      Provide a type description for the status bar view, if available.
      Specified by:
      getCNDescriptionType in interface IWSPropDesigner
      Returns:
      A type description for the status bar view, or null if not available.
    • getDragDropText

      public 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.
    • getCNImage

      public org.eclipse.swt.graphics.Image getCNImage(int columnIndex)
      Gets the image for the Common Navigator.
      Specified by:
      getCNImage in interface IWSPropDesigner
      Parameters:
      columnIndex - Index of column.
      Returns:
      Image or null if there is no image.
    • getCNText

      public String getCNText(int columnIndex)
      Gets the label text for the Common Navigator.
      Specified by:
      getCNText in interface IWSPropDesigner
      Parameters:
      columnIndex - Index of column.
      Returns:
      The column text.
    • createCNToolTip

      public org.eclipse.swt.widgets.Composite createCNToolTip(org.eclipse.swt.widgets.Composite parent, int columnIndex)
      Requests creates of the Composite used to show the tooltip.
      Specified by:
      createCNToolTip in interface IWSPropDesigner
      Parameters:
      parent - The parent composite.
      columnIndex - Index of column.
      Returns:
      The created composite in the parent, or null for none.
    • createCNToolTip

      public org.eclipse.swt.widgets.Composite createCNToolTip(org.eclipse.swt.widgets.Composite parent)
      Creates a tooltip for the input variables.
      Specified by:
      createCNToolTip in interface IWSPropDesigner
      Parameters:
      parent - The parent composite.
      Returns:
      The created composite in the parent.
    • getInterfaceDefinitions

      public IJavaInterfaceLinkEnabler.InterfaceDefinition[] getInterfaceDefinitions()
      Gets the interface definitions for the property used for drag-drop or linking in the Designer.
      Specified by:
      getInterfaceDefinitions in interface IJavaInterfaceLinkEnabler
      Returns:
      An array of the definitions, not null.
    • verify

      public boolean verify(PropVerification verification)
      Verifies this property container. The check performed is the extension of classes and that no circular reference is present.
      Specified by:
      verify in interface IGProp<GProp<?>[]>
      Overrides:
      verify in class PropCnr
      Parameters:
      verification - The property verification class.
      Returns:
      true if verification should proceed, false if disposed of and verification should not take place.