Class EditorVSColumnHeader

All Implemented Interfaces:
IShowJavaSource, ICopyOperation, IDeleteOperation, IPropDesigner, IPropRenameable, IEVSComponent, IBackReferenceProvider, EventListener, IFocusComp, IMessageBox, ICustomDataProvider, IGProp<GProp<?>[]>, IPatternOwner, IPropCnr, IVSComponent, IVSComponentListener, IVSComponentState, IVSMessageComponent, Cloneable, IAdaptable

public class EditorVSColumnHeader extends VSColumnHeader implements IEVSComponent, IBackReferenceProvider, ICopyOperation, IDeleteOperation
The Editor VirtualSpace Column property class.
Author:
Christopher Mindus
  • Constructor Details

    • EditorVSColumnHeader

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

      public EditorVSColumnHeader(Atom propertyAtom)
      Creates the VirtualSpace Field 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

    • getVirtualSpace

      public EditorVirtualSpace getVirtualSpace()
      Gets the VirtualSpace instance.
      Specified by:
      getVirtualSpace in interface IVSComponent
      Overrides:
      getVirtualSpace in class VSComponent
      Returns:
      The VirtualSpace instance (an ancestor of this property or itself), or null if not found (i.e. property is not yet attached to a VirtualSpace).
    • createFieldActors

      protected FieldActors createFieldActors()
      Creates a new instance of the field actors.
      Overrides:
      createFieldActors in class VSColumnHeader
    • getActors

      public EditorFieldActors getActors()
      Gets the field actors container.
      Overrides:
      getActors in class VSColumnHeader
      Returns:
      The field actors for this field if the field is located in the VirtualSpace or in a VirtualSpace group, otherwise the table column field actors if inside a table.
    • getDesigner

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

      public EditorVSColumnHeader clone()
      Clone must be overridden.
      Overrides:
      clone in class VSColumnHeader
    • getTable

      public EditorVSTable getTable()
      Gets the table of the headerBackground.
      Overrides:
      getTable in class VSColumnHeader
      Returns:
      The VirtualSpace Table instance, or null if headerBackground is not added to a table.
    • setValueType

      public boolean setValueType(Value.Type type)
      Sets the value type of the column.
      Parameters:
      type - The value type.
      Returns:
      true for changes, false for no change of type.
    • onListenerChanged

      protected void onListenerChanged(IVSColumnListener listener)
      Called when a listener is added or removed. This method is overridden by the Designer to update connections.
      Overrides:
      onListenerChanged in class VSColumnHeader
    • getBaseJavaReference

      public PropCnr getBaseJavaReference()
      Gets the base reference path for the Java reference, from the owner of this container, e.g. the VSColumnHeader.
      Specified by:
      getBaseJavaReference in interface IBackReferenceProvider
    • isBackReferenceValid

      public String isBackReferenceValid(AnnotationType annotationType, String name, boolean isRefOnly)
      Validates if the back-reference specified is referenced in the first place, i.e. is valid or not. /** Validates if the back-reference specified is referenced in the first place, i.e. is valid or not.
      Specified by:
      isBackReferenceValid in interface IBackReferenceProvider
      Parameters:
      annotationType - The annotation type.
      name - The class or method name.
      isRefOnly - Flag indicating the back reference is not required, but must be valid otherwise.
      Returns:
      null for valid, otherwise an error message.
    • createUninitializedField

      public EditorVSField createUninitializedField()
      Creates a new UNNAMED uninitialized field.
      Overrides:
      createUninitializedField in class VSColumnHeader
    • createUninitializedField

      public EditorVSField createUninitializedField(Atom fieldName)
      Creates a new uninitialized field.
      Overrides:
      createUninitializedField in class VSColumnHeader
      Parameters:
      fieldName - The field name.
    • createEmptyField

      public EditorVSField createEmptyField()
      Creates an empty field for this column, depending on defined types, null attributes, etc. If the column value type is not set, a default String field value is used. If null is not allowed for the column, a default value of the value type is set.
      Overrides:
      createEmptyField in class VSColumnHeader
      Returns:
      A new UNNAMED field property.
    • createEmptyField

      public EditorVSField createEmptyField(Atom fieldName)
      Creates an empty field for this column, depending on defined types, null attributes, etc. If the column value type is not set, a default String field value is used. If null is not allowed for the column, a default value of the value type is set.
      Overrides:
      createEmptyField in class VSColumnHeader
      Parameters:
      fieldName - The field name.
      Returns:
      A new field property.
    • getCopyProperty

      public GProp<?> getCopyProperty()
      Gets the property to add to clipboard.
      Specified by:
      getCopyProperty in interface ICopyOperation
      Returns:
      The property to place in the clipboard.
    • performDelete

      public boolean performDelete(Set<GProp<?>> afterOperationSelection, ComplexOperation op)
      Performs the delete operation on the property.
      Specified by:
      performDelete in interface IDeleteOperation
      Parameters:
      afterOperationSelection - Fill the properties to select after operation completes.
      op - The complex operation instance.
      Returns:
      true for success, false for failure (further operations will not take place).
    • onEventSelf

      public void onEventSelf(GEvent event)
      Checks for state change events and fires it to listeners.
      Specified by:
      onEventSelf in interface IGProp<GProp<?>[]>
      Overrides:
      onEventSelf in class VSComponent
      Parameters:
      event - The property event.
    • getExtendsPossibleClasses

      public Class<?>[] getExtendsPossibleClasses()
      Gets the possible classes this container supports for the Extends Framework. The default implementation is to return null.
      Specified by:
      getExtendsPossibleClasses in interface IPropCnr
      Overrides:
      getExtendsPossibleClasses in class PropCnr
      Returns:
      List of supported classes, or null for none.
    • 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.