Class CaptureRootProp

    • Constructor Detail

      • CaptureRootProp

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

        public CaptureRootProp​(Atom propertyAtom)
        Creates the capture root 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

      • getPropRootPropMgr

        public PropMgr getPropRootPropMgr()
        Gets the Property Manager used for communication for the root container. If this is not the root container, the parent function is called upwards in tree.
        Specified by:
        getPropRootPropMgr in interface IGProp<GProp<?>[]>
        Overrides:
        getPropRootPropMgr in class GProp<GProp<?>[]>
        Returns:
        The Property Manager, or null when not attached to a root.
      • getRootName

        public java.lang.String getRootName​(GProp<?> requestor)
        Gets and checks if this container is the root. The name returned is in the Editor "module:" and in "" (empty string) when running in the Server.

        When running with assertions, this call throws an assertion error by default, showing that the call is directed to a non-root property container.

        Overrides:
        getRootName in class GProp<GProp<?>[]>
        Parameters:
        requestor - The requestor property.
        Returns:
        Name string if this is the root as "project:" for the Designer, and "" for the Server, null otherwise.
      • getRootFromName

        public PropCnr getRootFromName​(GProp<?> requestor,
                                       java.lang.String module)
        Gets the module root for a name. In the Editor, the module is the project, and that root container is returned. In the Server, the module doesn't matter, so the real root returns itself.

        When running with assertions, this call throws an assertion error by default, showing that the call is directed to a non-root property container.

        Overrides:
        getRootFromName in class GProp<GProp<?>[]>
        Parameters:
        requestor - The requestor property.
        module - The module name (without colon), i.e. the project name in the Designer.
        Returns:
        The root property container, or null if this container is not the root, or if the module name is not found. The default implementation returns null.
      • clone

        public CaptureRootProp clone()
                              throws java.lang.CloneNotSupportedException
        Clone must be overridden.
        Overrides:
        clone in class PropCnr
        Throws:
        java.lang.CloneNotSupportedException - If cloning fails.