Package com.iizix.prop.vs
Interface IVSComponentReferenceProvider
- All Known Implementing Classes:
- EditorScreenFieldProp,- ScreenFieldProp
 - public interface IVSComponentReferenceProviderInterface used to provide the type of VS component reference supported. The property container owning the VSTypeReference should implement this interface.- Author:
- Christopher Mindus
 
- Method Summary- All Methods Instance Methods Abstract Methods Default Methods - Modifier and Type - Method - Description - java.lang.Class<?>[]- getVSComponentReferenceClasses(VSComponentReference ref)Gets the possible component classes for the references, i.e.- java.lang.String- getVSComponentReferenceDescription(VSComponentReference ref)Gets a short description of this reference.- boolean- isVSComponentReferenceValid(Atom refAtom, VSComponent component)Validates the VS component reference that has been looked up when the reference property doesn't exist.- default boolean- isVSComponentReferenceValid(VSComponentReference ref, VSComponent component)Validates the VS component reference that has been looked up.
 
- Method Detail- getVSComponentReferenceClasses- java.lang.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.
 
 - getVSComponentReferenceDescription- java.lang.String getVSComponentReferenceDescription(VSComponentReference ref) Gets a short description of this reference.- Parameters:
- ref- The reference holder.
- Returns:
- E.g. "VS Field" for a VSField, etc...