Package com.iizigo.vs.prop

Class EditorVirtualSpace

    • Constructor Detail

      • EditorVirtualSpace

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

      • EditorVirtualSpace

        public EditorVirtualSpace​(Atom propertyAtom)
        Creates the VirtualSpace 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 Detail

      • getClassReference

        public EditorClassReference getClassReference()
        Gets the ClassReference in the property container from the ClassReference instance.
        Specified by:
        getClassReference in interface IClassReferenceOwner
        Returns:
        The resolved class reference instance, null if not resolved or found.

      • getClassReference

        public EditorClassReference getClassReference​(java.lang.String id,
                                              boolean doCreateIfNotPresent)
        Gets or creates the ClassReference in the property container.
        Specified by:
        getClassReference in interface IClassReferenceOwner
        Specified by:
        getClassReference in interface IJavaClassLinkEnabler
        Specified by:
        getClassReference in interface IVSClassReferenceOwner
        Parameters:
        id - ID for the class reference if several exist, null for default.
        doCreateIfNotPresent - Flag to create the property (this flag can only be true in Designer)!
        Returns:
        The resolved class reference instance, null if the ClassReference doesn't exist if the create flag is false. If flag is true, an orphan unresolved EditorClassReference instance (ONLY for the Designer).

      • getUndoContext

        public org.eclipse.core.commands.operations.IUndoContext getUndoContext()
        Gets the undo context.
        Specified by:
        getUndoContext in interface IPropUndoContext
        Returns:
        The undo context for the Editor part(s) for this container.

      • getPossibleChildren

        public java.lang.Class<?>[] getPossibleChildren()
        Gets the acceptable children property classes that can be used in conjunction with e.g. a Paste operation.
        Specified by:
        getPossibleChildren in interface IPropCnr
        Overrides:
        getPossibleChildren in class PropCnr
        Returns:
        An array containing the classes of possible children, or null for no support.

      • getPersistentMemento

        public MementoPropCnr getPersistentMemento​(boolean doCreate)
        Gets the memento used to save the editor in this property.
        Parameters:
        doCreate - The create flag if it didn't exist before.
        Returns:
        A property container that implements IMemento, or null if this container is disposed of.

      • getExtendsPossibleClasses

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

      • getSelectPropViewerFilter

        public org.eclipse.jface.viewers.ViewerFilter getSelectPropViewerFilter()
        Gets the viewer filter for the tree in the dialog for selecting extends property name.
        Specified by:
        getSelectPropViewerFilter in interface IExtendsSelection

      • getRelativeMethodAnnotationReference

        public java.lang.String getRelativeMethodAnnotationReference()
        Gets the annotation relative reference to the element.
        Specified by:
        getRelativeMethodAnnotationReference in interface IJavaMethodLinkEnabler
        Returns:
        The relative reference in the method annotation of e.g. "OnUIFocus" for this component.

      • canCreateUI

        public boolean canCreateUI​(LinkData data)
        Method returning if this property could potentially be (action, field or table) or contain (group) properties that can create UI components when drag-dropped.

        The VirtualSpace recurses down its VS components to query them for creation support.

        Specified by:
        canCreateUI in interface IUICreationFromVS
        Parameters:
        data - The link data.
        Returns:
        true if the result would lead to UI creations, false otherwise.

      • addCreateUILinkOperations

        public void addCreateUILinkOperations​(LinkData data,
                                      java.util.Collection<ILinkOperation> linkOps)
        Adds all possible operations that could be done in a link operation for UI creation from VS.

        The VirtualSpace recurses down its VS components so that they can add what is required.

        Specified by:
        addCreateUILinkOperations in interface IUICreationFromVS
        Parameters:
        data - The link data.
        linkOps - List of link operations is filled in when operations are found.

      • createVSComponents

        public java.lang.String createVSComponents​(java.util.List<VSComponentCreation<?>> list,
                                           ComplexOperation op)
        Creates the list of VS components required.
        Parameters:
        list - The list of components.
        op - The complex operation.
        Returns:
        null for success, otherwise an error message.