Class ExtensionImpl

    • Method Detail

      • dispose

        public void dispose()
        Description copied from interface: Extension
        Disposes this extension.

        This will erase any data held by the extension.

        Specified by:
        dispose in interface Extension
      • getElement

        public Element getElement()
        Description copied from interface: Extension
        Gets the DOM element held by this extension.

        The DOM element correspond to the "extension" element in the component XML descriptor.

        Specified by:
        getElement in interface Extension
        Returns:
        the DOM element
      • setElement

        public void setElement​(Element element)
        Description copied from interface: Extension
        Sets the DOM element that defines this extension.
        Specified by:
        setElement in interface Extension
        Parameters:
        element - the extension DOM element
      • getContributions

        public Object[] getContributions()
        Description copied from interface: Extension
        Gets the extension contribution objects.

        These objects are generated by the extension point from the DOM element and then attached to the extension.

        Specified by:
        getContributions in interface Extension
        Returns:
        the contribution objects or null if none
      • setContributions

        public void setContributions​(Object[] contributions)
        Description copied from interface: Extension
        Sets the contribution objects.

        This method is used by the extension point to attach the contribution objects to the extension.

        Specified by:
        setContributions in interface Extension
        Parameters:
        contributions - the contribution objects
      • getId

        public String getId()
        Description copied from interface: Extension
        Identifies the extension inside the contributing component. The id should be unique in the application. It is recommended to use the following name convention for the ID: 'component_name#contribution_name'.

        The id is never null. If the user is not specifying an ID, one will be generated as follow: componentName#targetExtensionPoint.randomNumber

        Specified by:
        getId in interface Extension
      • getDocumentation

        public String getDocumentation()
        Description copied from interface: Extension
        Gets any comment on this extension.

        Comments can be used to document extensions.

        Comments should be short because they are stored in memory.

        Specified by:
        getDocumentation in interface Extension