Package com.iizigo.ws.prop

Class EditorOutputProps

java.lang.Object
com.iizix.prop.GProp<GProp<?>[]>
com.iizix.prop.PropCnr
com.iizix.ws.prop.OutputProps
com.iizigo.ws.prop.EditorOutputProps
All Implemented Interfaces:
ILinkCapable, IJavaInterfaceLinkEnabler, IPropDesigner, IVSLinkEnabler, IVSParticipantLinkEnabler, IWSPropDesigner, EventListener, IClassInstantiationAtResolve, IGProp<GProp<?>[]>, IPropCnr, IReferrerParticipant, IVSAccessor, IVSParticipant, Cloneable, IAdaptable
public class EditorOutputProps extends OutputProps implements IWSPropDesigner, IVSParticipantLinkEnabler, IJavaInterfaceLinkEnabler
Editor version of result set property that ties a result set from the execution of a web service transaction to VirtualSpace.
Author:
Christopher Mindus

  • Constructor Details

    • EditorOutputProps

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

    • EditorOutputProps

      public EditorOutputProps(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

    • createOutputVariables

      protected EditorOutputVariables createOutputVariables()
      Creates the output properties.
      Overrides:
      createOutputVariables in class OutputProps

    • getOutputVariables

      public EditorOutputVariables getOutputVariables()
      Gets the output variables.
      Overrides:
      getOutputVariables in class OutputProps
      Returns:
      The output variables instance.

    • getDesigner

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

    • getCNImage

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

    • clone

      public EditorOutputProps clone()
      Clone must be overridden.
      Overrides:
      clone in class OutputProps

    • getWebServiceProp

      public EditorWebServiceProp getWebServiceProp()
      Gets the Web Service property.
      Overrides:
      getWebServiceProp in class OutputProps
      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 OutputProps
      Returns:
      The VirtualSpace connected to the result set, or null for none.

    • getWrappedElements

      public List<IWrappedElement> getWrappedElements(String ref)
      Gets all wrapped fields that has the reference specified.
      Parameters:
      ref - The reference to get.
      Returns:
      The list of wrapped elements.

    • getCNImage

      public 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 Composite createCNToolTip(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.

    • getMatchingProcessor

      public IEditorReplyProcessor getMatchingProcessor(IReplyContent reply)
      Verifies if the reply matches the current output properties.
      Overrides:
      getMatchingProcessor in class OutputProps
      Parameters:
      reply - The reply contents.
      Returns:
      null for match, otherwise an error message.

    • createCNToolTip

      public Composite createCNToolTip(Composite parent)
      Creates a tooltip for the result set.
      Specified by:
      createCNToolTip in interface IWSPropDesigner
      Parameters:
      parent - The parent composite.
      Returns:
      The created composite in the parent.

    • getProcessor

      public IEditorReplyProcessor getProcessor(GProp<?> gp)
      Gets a reply processor from a property.
      Parameters:
      gp - The property.
      Returns:
      The reply processor, null if not found.

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