Package com.iizigo.ws.prop

Class EditorOutputVariable

java.lang.Object
com.iizix.prop.GProp<GProp<?>[]>
com.iizix.prop.PropCnr
com.iizix.prop.vs.AbstractVSVariable<VSField,VSFieldReference>
com.iizix.ws.prop.OutputVariable
com.iizigo.ws.prop.EditorOutputVariable
All Implemented Interfaces:
ILinkCapable, IJavaInterfaceLinkEnabler, IPropDesigner, IWSPropDesigner, EventListener, IClassInstantiationAtResolve, IGProp<GProp<?>[]>, IPropCnr, Cloneable, org.eclipse.core.runtime.IAdaptable
public class EditorOutputVariable extends OutputVariable implements IWSPropDesigner, IJavaInterfaceLinkEnabler
Editor version of the Output Variable connects a reference variable from the reply output with a VSField.
Author:
Christopher Mindus

  • Constructor Details

    • EditorOutputVariable

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

    • EditorOutputVariable

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

    • getOutputVariables

      public EditorOutputVariables getOutputVariables()
      Gets the output variables properties container.
      Overrides:
      getOutputVariables in class OutputVariable
      Returns:
      The instance, or null if orphaned.

    • getOutputProps

      public EditorOutputProps getOutputProps()
      Gets the output properties.
      Overrides:
      getOutputProps in class OutputVariable
      Returns:
      The instance, or null if orphaned.

    • clone

      public EditorOutputVariable clone()
      Clone must be overridden.
      Overrides:
      clone in class OutputVariable

    • setIdentification

      public void setIdentification(boolean on)
      Indicates this variable is an identification variable and if it's not present in the output reply, then the processor doesn't match.
      Parameters:
      on - Flag for identification.

    • onEventSelf

      public void onEventSelf(GEvent event)
      Processes events that may change wrapped elements.
      Specified by:
      onEventSelf in interface IGProp<GProp<?>[]>
      Overrides:
      onEventSelf in class GProp<GProp<?>[]>
      Parameters:
      event - The property event.

    • getVSField

      public EditorVSField getVSField()
      Gets the VSField.
      Overrides:
      getVSField in class OutputVariable
      Returns:
      The VSField associated, or null for none (or unresolved).

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

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

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

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