Package com.iizix.prop.vs

Interface IVSComponentReferenceProvider

All Known Implementing Classes:
EditorScreenFieldProp, ScreenFieldProp
public interface IVSComponentReferenceProvider
Interface used to provide the type of VS component reference supported. The property container owning the VSTypeReference should implement this interface.
Author:
Christopher Mindus

  • Method Details

    • getVSComponentReferenceClasses

      Class<?>[] getVSComponentReferenceClasses(VSComponentReference ref)
      Gets the possible component classes for the references, i.e. combination of VSTable, VSColumnHeader, VSField.
      Parameters:
      ref - The reference holder.
      Returns:
      An array of the valid classes.

    • isVSComponentReferenceValid

      boolean isVSComponentReferenceValid(Atom refAtom, VSComponent component)
      Validates the VS component reference that has been looked up when the reference property doesn't exist.
      Parameters:
      refAtom - The reference holder's atom.
      component - The VS component to validate.
      Returns:
      true if valid, false otherwise.

    • isVSComponentReferenceValid

      default boolean isVSComponentReferenceValid(VSComponentReference ref, VSComponent component)
      Validates the VS component reference that has been looked up.
      Parameters:
      ref - The reference holder.
      component - The VS component to validate.
      Returns:
      true if valid, false otherwise.

    • getReferenceType

      IPropReference.RefType getReferenceType(VSComponentReference ref)
      Gets the reference Type.
      Parameters:
      ref - The reference holder.
      Returns:
      The reference type, generally a value from the enum IPropReference.RefType, otherwise a static final implementation of the reference type with locale support. Returns e.g. RefType.VSField or RefType.VSTable.